https://github.com/Matthias247/futures-intrusive

Synchronization primitives for Futures and async/await based on intrusive collections
https://github.com/Matthias247/futures-intrusive

async async-await futures-rs multithreading rust synchronization

Last synced: about 1 month ago
JSON representation

Synchronization primitives for Futures and async/await based on intrusive collections

• Host: GitHub
• URL: https://github.com/Matthias247/futures-intrusive
• Owner: Matthias247
• License: apache-2.0
• Created: 2019-05-22T05:41:19.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-03-25T05:27:15.000Z (9 months ago)
• Last Synced: 2024-10-29T12:16:17.644Z (about 2 months ago)
• Topics: async, async-await, futures-rs, multithreading, rust, synchronization
• Language: Rust
• Homepage:
• Size: 271 KB
• Stars: 175
• Watchers: 10
• Forks: 29
• Open Issues: 11
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        
futures-intrusive

=================

This crate provides a variety of `Futures`-based and `async/await` compatible

types that are based on the idea of intrusive collections:

- Channels in a variety of flavors:

  - Oneshot

  - Multi-Producer Multi-Consumer (MPMC)

  - State Broadcast

- Synchronization Primitives:

  - Manual Reset Event

  - Mutex

  - Semaphore

- A timer

Please refer to the [documentation](https://docs.rs/futures-intrusive) for details.

In addition to the documentation the examples provide a quick overview on how

the primitives can be used.

## Usage

Add this to your `Cargo.toml`:

```toml

[dependencies]

futures-intrusive = "^0.5"

```

In order to use the crate in a `no-std` environment, it needs to be compiled

without default features:

```toml

[dependencies]

futures-intrusive = { version = "^0.5", default-features = false }

```

The crate defines a feature `alloc`, which can be used in order to re-enable

`alloc` features. Also defined is `std`, which can be used in order to re-enable

`std` features.

## Minimum Rust version

The minimum required Rust version is 1.36, due to reliance on stable

`Future`, `Context` and `Waker` types.

## License

Licensed under either of

 * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)

 * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

at your option.