History

Dario Nieuwenhuis 2c45b5c519 sync/pipe: update to clarify docs that it is byte-oriented. There was some language copypasted from Channel talking about "messages" or "values", that is not really accurate with Pipe.		2023-03-26 23:32:12 +02:00
..
src	sync/pipe: update to clarify docs that it is byte-oriented.	2023-03-26 23:32:12 +02:00
build.rs	split `embassy-util` into `embassy-futures`, `embassy-sync`.	2022-08-22 22:18:13 +02:00
Cargo.toml	Remove unnecessary use of atomic-polyfill.	2022-12-23 20:46:49 +01:00
README.md	Add required info to embassy-sync package	2022-10-04 16:38:11 +02:00

README.md

embassy-sync

An Embassy project.

Synchronization primitives and data structures with async support:

Channel - A Multiple Producer Multiple Consumer (MPMC) channel. Each message is only received by a single consumer.
PubSubChannel - A broadcast channel (publish-subscribe) channel. Each message is received by all consumers.
Signal - Signalling latest value to a single consumer.
Mutex - Mutex for synchronizing state between asynchronous tasks.
Pipe - Byte stream implementing embedded_io traits.
WakerRegistration - Utility to register and wake a Waker.
AtomicWaker - A variant of WakerRegistration accessible using a non-mut API.
MultiWakerRegistration - Utility registering and waking multiple Waker's.

Interoperability

Futures from this crate can run on any executor.

Minimum supported Rust version (MSRV)

Embassy is guaranteed to compile on the latest stable Rust version at the time of release. It might compile with older versions but that may change in any new patch release.

License

This work is licensed under either of

Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.