https://github.com/mitsuhiko/fragile

Utility wrapper to send non send types to other threads safely
https://github.com/mitsuhiko/fragile

Last synced: 4 days ago
JSON representation

Utility wrapper to send non send types to other threads safely

• Host: GitHub
• URL: https://github.com/mitsuhiko/fragile
• Owner: mitsuhiko
• License: apache-2.0
• Created: 2018-06-20T20:21:30.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-01-08T12:46:47.000Z (12 months ago)
• Last Synced: 2024-10-29T12:11:42.625Z (2 months ago)
• Language: Rust
• Size: 61.5 KB
• Stars: 168
• Watchers: 5
• Forks: 12
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Fragile

[![Build Status](https://github.com/mitsuhiko/fragile/workflows/Tests/badge.svg?branch=master)](https://github.com/mitsuhiko/fragile/actions?query=workflow%3ATests)

[![Crates.io](https://img.shields.io/crates/d/fragile.svg)](https://crates.io/crates/fragile)

[![License](https://img.shields.io/github/license/mitsuhiko/fragile)](https://github.com/mitsuhiko/fragile/blob/master/LICENSE)

[![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)

[![Documentation](https://docs.rs/fragile/badge.svg)](https://docs.rs/fragile)

This library provides wrapper types that permit sending non Send types to other

threads and use runtime checks to ensure safety.

It provides the `Fragile`, `Sticky` and `SemiSticky` types which are

similar in nature but have different behaviors with regards to how destructors

are executed.  The `Fragile` will panic if the destructor is called in another

thread, `Sticky` will temporarily leak the object until the thread shuts down.

`SemiSticky` is a compromise of the two.  It behaves like `Sticky` but it

avoids the use of thread local storage if the type does not need `Drop`.

## Example

```rust

use std::thread;

// creating and using a fragile object in the same thread works

let val = Fragile::new(true);

assert_eq!(*val.get(), true);

assert!(val.try_get().is_ok());

// once send to another thread it stops working

thread::spawn(move || {

    assert!(val.try_get().is_err());

}).join()

    .unwrap();

```

## License and Links

- [Documentation](https://docs.rs/fragile/)

- [Issue Tracker](https://github.com/mitsuhiko/fragile/issues)

- License: [Apache 2.0](https://github.com/mitsuhiko/fragile/blob/master/LICENSE)