rustix-futex-sync 0.2.1

Linux futex-based synchronization
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

<div align="center">
  <h1><code>rustix-futex-sync</code></h1>

  <p>
    <strong>Linux futex-based synchronization</strong>
  </p>

  <p>
    <a href="https://github.com/sunfishcode/rustix-futex-sync/actions?query=workflow%3ACI"><img src="https://github.com/sunfishcode/rustix-futex-sync/workflows/CI/badge.svg" alt="Github Actions CI Status" /></a>
    <a href="https://bytecodealliance.zulipchat.com/#narrow/stream/206238-general"><img src="https://img.shields.io/badge/zulip-join_chat-brightgreen.svg" alt="zulip chat" /></a>
    <a href="https://crates.io/crates/rustix-futex-sync"><img src="https://img.shields.io/crates/v/rustix-futex-sync.svg" alt="crates.io page" /></a>
    <a href="https://docs.rs/rustix-futex-sync"><img src="https://docs.rs/rustix-futex-sync/badge.svg" alt="docs.rs docs" /></a>
  </p>
</div>

Linux futex-based implementations of [`Mutex`], [`RwLock`], [`Condvar`],
[`Once`], and [`OnceLock`], as well as [`RawMutex`], [`RawRwLock`], and
[`RawCondvar`], derived from the futex code in std, factored out to a
standalone `no_std` crate using [`rustix`] to do the futex and [`lock_api`] to
provide most of the public `Mutex` and `RwLock` API.

`lock_api` does not support poisoning, so support for poisoning is omitted.

In this library, `Condvar`, `RawCondvar`, `RawMutex`, and `Once` are guaranteed
to be `repr(transparent)` wrappers around a single `AtomicU32`. `RawRwLock` is
guaranteed to be a `repr(C)` wrapper around two `AtomicU32`s. The contents of
these `AtomicU32`s are not documented, except that all these types'
`const fn new()` and `INIT` are guaranteed to initialize them to all zeros.

[`Mutex`]: https://docs.rs/rustix-futex-sync/latest/rustix_futex_sync/type.Mutex.html
[`RwLock`]: https://docs.rs/rustix-futex-sync/latest/rustix_futex_sync/type.RwLock.html
[`Condvar`]: https://docs.rs/rustix-futex-sync/latest/rustix_futex_sync/struct.Condvar.html
[`Once`]: https://docs.rs/rustix-futex-sync/latest/rustix_futex_sync/struct.Once.html
[`OnceLock`]: https://docs.rs/rustix-futex-sync/latest/rustix_futex_sync/struct.OnceLock.html
[`RawMutex`]: https://docs.rs/rustix-futex-sync/latest/rustix_futex_sync/struct.RawMutex.html
[`RawRwLock`]: https://docs.rs/rustix-futex-sync/latest/rustix_futex_sync/struct.RawRwLock.html
[`RawCondvar`]: https://docs.rs/rustix-futex-sync/latest/rustix_futex_sync/type.RawCondvar.html
[`rustix`]: https://github.com/bytecodealliance/rustix#readme
[`lock_api`]: https://crates.io/crates/lock_api