diff options
| author | Ulf Lilleengen <lulf@redhat.com> | 2022-08-23 13:54:40 +0200 |
|---|---|---|
| committer | Ulf Lilleengen <lulf@redhat.com> | 2022-08-23 13:54:40 +0200 |
| commit | 06011f67b277427531398e64030366886cc2d260 (patch) | |
| tree | 2b82b87f38678e9d4e8d3cf3d3f2095b82828f80 | |
| parent | 7b97e52886d584347e15fa2c8b651b79180256fc (diff) | |
| download | embassy-06011f67b277427531398e64030366886cc2d260.zip | |
Add README for embassy-sync
| -rw-r--r-- | embassy-sync/README.md | 12 | ||||
| -rw-r--r-- | embassy-sync/src/lib.rs | 2 |
2 files changed, 13 insertions, 1 deletions
diff --git a/embassy-sync/README.md b/embassy-sync/README.md new file mode 100644 index 00000000..106295c0 --- /dev/null +++ b/embassy-sync/README.md @@ -0,0 +1,12 @@ +# embassy-sync + +Synchronization primitives and data structures with an async API: + +- [`Channel`](channel::Channel) - A Multiple Producer Multiple Consumer (MPMC) channel. Each message is only received by a single consumer. +- [`PubSubChannel`](pubsub::PubSubChannel) - A broadcast channel (publish-subscribe) channel. Each message is received by all consumers. +- [`Signal`](signal::Signal) - Signalling latest value to a single consumer. +- [`Mutex`](mutex::Mutex) - A Mutex for synchronizing state between asynchronous tasks. +- [`Pipe`](pipe::Pipe) - Byte stream implementing `embedded_io` traits. +- [`WakerRegistration`](waitqueue::WakerRegistration) - Utility to register and wake a `Waker`. +- [`AtomicWaker`](waitqueue::AtomicWaker) - A variant of `WakerRegistration` accessible using a non-mut API. +- [`MultiWakerRegistration`](waitqueue::MultiWakerRegistration) - Utility registering and waking multiple `Waker`'s. diff --git a/embassy-sync/src/lib.rs b/embassy-sync/src/lib.rs index 8e81e5cb..25150e8a 100644 --- a/embassy-sync/src/lib.rs +++ b/embassy-sync/src/lib.rs @@ -1,7 +1,7 @@ #![cfg_attr(not(any(feature = "std", feature = "wasm")), no_std)] #![cfg_attr(feature = "nightly", feature(generic_associated_types, type_alias_impl_trait))] #![allow(clippy::new_without_default)] -#![doc = include_str!("../../README.md")] +#![doc = include_str!("../README.md")] #![warn(missing_docs)] // This mod MUST go first, so that the others see its macros. |