subms-spsc-ring-buffer 0.10.0

submillisecond.com cookbook recipe - concurrency: subms-spsc-ring-buffer. Wait-free SPSC ring buffer with cache-line padded counters and opposite-index caching; tens-of-nanoseconds enqueue/dequeue.
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

[package]
name = "subms-spsc-ring-buffer"
version = "0.10.0"
edition = "2024"
rust-version = "1.85"
authors = ["Kieran Smith <oss@submillisecond.com>"]
description = "submillisecond.com cookbook recipe - concurrency: subms-spsc-ring-buffer. Wait-free SPSC ring buffer with cache-line padded counters and opposite-index caching; tens-of-nanoseconds enqueue/dequeue."
license = "MIT OR Apache-2.0"
readme = "README.md"
homepage = "https://www.submillisecond.com/cookbook/recipes/subms-spsc-ring-buffer"
documentation = "https://www.submillisecond.com/cookbook/recipes/subms-spsc-ring-buffer"
repository = "https://github.com/submillisecond/subms-cookbook/tree/main/recipes/subms-spsc-ring-buffer"
keywords = ["spsc", "ring-buffer", "lock-free", "concurrency", "subms"]
categories = ["concurrency", "data-structures"]

[package.metadata.docs.rs]
all-features = true

[lib]
name = "subms_spsc_ring_buffer"
path = "src/lib.rs"

[[example]]
name = "perf_main"
required-features = ["harness"]

[[example]]
name = "perf_features"
required-features = ["harness", "bulk", "wait-strategies", "mpsc-fan-in", "mpmc-disruptor", "metrics"]

[features]
default = []

# Bench-harness wiring: `SubMsRecipe` impl + perf_main example.
harness = ["dep:subms"]

# ----- Opt-in feature catalog (subms 0.5+) -----
# Each feature lives in src/features/<name>.rs behind a #[cfg(feature)]
# gate. Base ring stays wait-free SPSC + zero-dep std-only; opt-ins add
# focused capabilities. Pick what you need:
#
#   subms-spsc-ring-buffer = { version = "0.10.0", features = ["bulk"] }
#   subms-spsc-ring-buffer = { version = "0.10.0", features = ["bulk", "wait-strategies"] }
#
# `bulk`            - try_enqueue_bulk / try_dequeue_bulk amortise the
#                     per-item atomic ops behind a single fence per call.
# `wait-strategies` - blocking wrappers around the base producer/consumer
#                     that take a wait strategy (BusySpin / Yield / Park).
# `mpsc-fan-in`     - N-producer 1-consumer demuxer over N independent
#                     SPSC rings. Each producer is still wait-free SPSC.
# `mpmc-disruptor`  - LMAX-Disruptor-style multi-producer multi-consumer
#                     ring with sequence barriers + CAS claim. Independent
#                     of the base SPSC structures.
# `metrics`         - per-instance counters: enqueue/dequeue success +
#                     fail, max depth, CAS retries (mpmc only).
bulk = []
wait-strategies = []
mpsc-fan-in = []
mpmc-disruptor = []
metrics = []

# Every std-only capability at once, for the coverage gate.
full = ["bulk", "wait-strategies", "mpsc-fan-in", "mpmc-disruptor", "metrics"]

[dependencies]
subms = { version = "0.9.3", optional = true }