Struct Cache 

pub struct Cache<A: AtomicArcRef> { /* private fields */ }

A cache for a shared AtomicArc.

Built as a wrapper around AtomicArc::load_cached, it essentially makes loads of up-to-date Arcs free, but requires a mutable reference.

As the cache stores the latest loaded Arc, it can delay its reclamation until a new Arc is loaded.

Examples

let atomic_arc = Arc::new(AtomicArc::<usize>::from(0));
let mut cache = hazarc::Cache::new(atomic_arc);
assert_eq!(**cache.load(), 0);

It also works with AtomicOptionArc.

let atomic_arc = Arc::new(AtomicOptionArc::<usize>::none());
let mut cache = hazarc::Cache::new(atomic_arc);
assert_eq!(cache.load(), None);

Implementations

impl<A: AtomicArcRef> Cache<A>

pub fn new(inner: A) -> Self

Constructs a new Cache, loading and storing the up-to-date Arc.

pub fn inner(&self) -> &A

Accesses the inner shared AtomicArc.

pub fn into_inner(self) -> A

Consumes the cache to returns the inner shared AtomicArc.

pub fn load(&mut self) -> A::LoadCached<'_>

Returns the cached Arc if it is up-to-date, or loads and caches the latest Arc.

Trait Implementations

impl<A: Clone + AtomicArcRef> Clone for Cache<A>

where A::Owned: Clone,

fn clone(&self) -> Cache<A>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<A: Debug + AtomicArcRef> Debug for Cache<A>

where A::Owned: Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de, A: AtomicArcRef + Deserialize<'de>> Deserialize<'de> for Cache<A>

Available on crate feature serde only.

fn deserialize<De: Deserializer<'de>>( deserializer: De, ) -> Result<Self, De::Error>

Deserialize this value from the given Serde deserializer.

impl<A: AtomicArcRef> From<A> for Cache<A>

fn from(value: A) -> Self

Converts to this type from the input type.

impl<A: AtomicArcRef + Serialize> Serialize for Cache<A>

Available on crate feature serde only.

fn serialize<Ser: Serializer>( &self, serializer: Ser, ) -> Result<Ser::Ok, Ser::Error>

Serialize this value into the given Serde serializer.