moirai-core 0.7.0

Core abstractions and traits for the Moirai concurrency library
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

//! Unified high-performance channel implementations for Moirai.
//!
//! This module provides zero-cost channel abstractions that work seamlessly
//! across different execution contexts following DRY and SOLID principles.
//!
//! # Design Principles
//! - **Zero-copy**: Minimize data copies for maximum performance
//! - **Cache-friendly**: Align data structures to cache lines
//! - **Lock-free**: Use atomic operations where possible
//! - **Unified API**: Single interface for different channel types
//!
//! # Safety
//! All channel implementations maintain memory safety through:
//! - Sequence number validation before reading uninitialized memory
//! - Proper memory ordering with acquire-release semantics
//! - Safe cleanup on drop with reference counting

/// Ordering for channel protocols that require a two-sided StoreLoad barrier.
///
/// A waiter publishes its registration before checking channel state while a
/// notifier publishes channel state before checking the waiter registration.
/// Acquire/release does not forbid both later loads from seeing stale values;
/// sequential consistency is the weakest Rust ordering that supplies the
/// required global order. Ordinary queue publication and counter maintenance
/// keep their weaker acquire/release or relaxed orderings.
pub(crate) const CHANNEL_STORE_LOAD_ORDER: std::sync::atomic::Ordering =
    std::sync::atomic::Ordering::SeqCst;

pub mod config;
pub mod error;
pub mod hybrid;
pub mod mpmc;
pub mod roles;
pub mod select;
pub mod spsc;
pub mod stats;
pub mod unified;

pub use config::{ChannelConfig, DEFAULT_CHANNEL_CAPACITY};
pub use error::{Channel, ChannelError, Result};
pub use hybrid::{HybridChannel, HybridReceiver, HybridSender};
pub use mpmc::{MpmcChannel, MpmcReceiver, MpmcSender};
pub use roles::{Consumer, Producer};
pub use select::{Select, mpmc, spsc, unbounded};
pub use spsc::{SpscConsumer, SpscProducer, SpscReceiver, SpscRing, SpscSender};
pub use stats::ChannelStatistics;
pub use unified::{
    UnifiedChannel, UnifiedReceiver, UnifiedSender, unified_channel, unified_channel_with_config,
};

#[cfg(test)]
mod tests;