shared-state 0.1.3

Concurrent state utilities: readiness gates, TTL caches, shared counters, type aliases
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

#![forbid(unsafe_code)]
#![deny(missing_docs)]

//! Concurrent state utilities for Rust services.
//!
//! Provides [`ReadyGate`] for readiness probing, [`ttl::TtlCache`] for time-expiring
//! caches, [`counter::SharedCounter`] for atomic counters, and type aliases for common
//! concurrent patterns.

pub mod counter;
pub mod ready;
pub mod ttl;

#[cfg(loom)]
mod loom_tests;

pub use ready::ReadyGate;
// `TtlCache` was fully implemented behind `pub mod ttl` but never re-exported
// from the crate root, so the obvious `use shared_state::TtlCache` failed with
// an unresolved import pointing nowhere near the real path. Found by the
// estate-integration `systems_substrate` suite.
pub use ttl::TtlCache;

/// Type alias for a shared concurrent map backed by `tokio::sync::RwLock`.
pub type SharedMap<K, V> = std::sync::Arc<tokio::sync::RwLock<std::collections::HashMap<K, V>>>;

/// Type alias for a shared concurrent cache backed by `DashMap`.
pub type SharedCache<K, V> = std::sync::Arc<dashmap::DashMap<K, V>>;

/// Create a new [`SharedMap`].
pub fn shared_map<K: Eq + std::hash::Hash, V>() -> SharedMap<K, V> {
    std::sync::Arc::new(tokio::sync::RwLock::new(std::collections::HashMap::new()))
}

/// Create a new [`SharedCache`].
pub fn shared_cache<K: Eq + std::hash::Hash + Clone, V: Clone>() -> SharedCache<K, V> {
    std::sync::Arc::new(dashmap::DashMap::new())
}