1# Fragile
2
3[![Build Status](https://github.com/mitsuhiko/fragile/workflows/Tests/badge.svg?branch=master)](https://github.com/mitsuhiko/fragile/actions?query=workflow%3ATests)
4[![Crates.io](https://img.shields.io/crates/d/fragile.svg)](https://crates.io/crates/fragile)
5[![License](https://img.shields.io/github/license/mitsuhiko/fragile)](https://github.com/mitsuhiko/fragile/blob/master/LICENSE)
6[![rustc 1.42.0](https://img.shields.io/badge/rust-1.42%2B-orange.svg)](https://img.shields.io/badge/rust-1.42%2B-orange.svg)
7[![Documentation](https://docs.rs/fragile/badge.svg)](https://docs.rs/fragile)
8
9This library provides wrapper types that permit sending non Send types to other
10threads and use runtime checks to ensure safety.
11
12It provides the `Fragile<T>`, `Sticky<T>` and `SemiSticky<T>` types which are
13similar in nature but have different behaviors with regards to how destructors
14are executed.  The `Fragile<T>` will panic if the destructor is called in another
15thread, `Sticky<T>` will temporarily leak the object until the thread shuts down.
16`SemiSticky<T>` is a compromise of the two.  It behaves like `Sticky<T>` but it
17avoids the use of thread local storage if the type does not need `Drop`.
18
19## Example
20
21```rust
22use std::thread;
23
24// creating and using a fragile object in the same thread works
25let val = Fragile::new(true);
26assert_eq!(*val.get(), true);
27assert!(val.try_get().is_ok());
28
29// once send to another thread it stops working
30thread::spawn(move || {
31    assert!(val.try_get().is_err());
32}).join()
33    .unwrap();
34```
35
36## License and Links
37
38- [Documentation](https://docs.rs/fragile/)
39- [Issue Tracker](https://github.com/mitsuhiko/fragile/issues)
40- License: [Apache 2.0](https://github.com/mitsuhiko/fragile/blob/master/LICENSE)
41