spin 0.12.0

Spin-based synchronization primitives
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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

[package]
name = "spin"
version = "0.12.0"
authors = [
    "Mathijs van de Nes <git@mathijs.vd-nes.nl>",
    "John Ericson <git@JohnEricson.me>",
    "Joshua Barretto <joshua.s.barretto@gmail.com>",
]
license = "MIT"
repository = "https://codeberg.org/zesterer/spin"
keywords = ["spinlock", "mutex", "rwlock"]
description = "Spin-based synchronization primitives"
rust-version = "1.71"
edition = "2021"

[dependencies]
lock_api_crate = { package = "lock_api", version = "0.4", optional = true }
# Enable require-cas feature to provide a better error message if the end user forgets to use the cfg or feature.
portable-atomic = { version = "1.3", optional = true, default-features = false, features = ["require-cas"] }
# Allows this crate to be used as a dependency of the Rust standard library
core = { version = "1.0.0", optional = true, package = "rustc-std-workspace-core" }

[features]
default = ["lock_api", "mutex", "spin_mutex", "rwlock", "once", "lazylock", "barrier"]

# Enables `Mutex`. Must be used with either `spin_mutex` or `use_ticket_mutex`.
mutex = []

# Enables `SpinMutex` and the default spin mutex implementation for `Mutex`.
spin_mutex = ["mutex"]

# Enables `TicketMutex`.
ticket_mutex = ["mutex"]

# Enables `FairMutex`.
fair_mutex = ["mutex"]

# Enables the non-default ticket mutex implementation for `Mutex`.
use_ticket_mutex = ["mutex", "ticket_mutex"]

# Enables `RwLock`.
rwlock = []

# Enables `Once`.
once = []

# Enables `LazyLock`.
lazylock = ["once"]

# Enables `LazyLock`. This feature flag is here for compatibility reasons and may be dropped in future versions. 
lazy = ["lazylock"]

# Enables `Barrier`. Because this feature uses `mutex`, either `spin_mutex` or `use_ticket_mutex` must be enabled.
barrier = ["mutex"]

# Enables `lock_api`-compatible types that use the primitives in this crate internally.
lock_api = ["dep:lock_api_crate"]

# Enables std-only features such as yield-relaxing.
std = []

# Use the `portable-atomic` crate to support platforms without native atomic operations.
# The `portable_atomic_unsafe_assume_single_core` cfg or `critical-section` feature
# of `portable-atomic` crate must also be set by the final binary crate.
# See the documentation for the `portable-atomic` crate for more information
# with some requirements for no-std build:
# https://github.com/taiki-e/portable-atomic#optional-features
portable-atomic = ["dep:portable-atomic"]

# Deprecated alias:
portable_atomic = ["portable-atomic"]

rustc-dep-of-std = ["core"]

[package.metadata.docs.rs]
all-features = true
rustdoc-args = ["--cfg", "docsrs"]

[dev-dependencies]
criterion = "0.4"

[[bench]]
name = "mutex"
harness = false
required-features = ["ticket_mutex"]

[[example]]
name = "debug"
required-features = ["mutex", "rwlock"]