Struct AtomicArcPtr 

pub struct AtomicArcPtr<A: ArcPtr, D: Domain, W: WritePolicy> { /* private fields */ }

An atomic storage for generic Arc-like pointers.

All atomic operations are sequentially consistent and pseudo wait-free.

Implementations

impl<A: ArcPtr, D: Domain, W: WritePolicy> AtomicArcPtr<A, D, W>

pub fn new(arc: A) -> Self

Constructs a new Arc atomic storage.

pub fn load(&self) -> ArcPtrBorrow<A>

Loads a borrowed Arc.

pub fn load_owned(&self) -> A

Loads an owned Arc.

pub fn load_if_outdated<'a>(&self, arc: &'a A) -> Result<&'a A, ArcPtrBorrow<A>>

Returns Arc reference passed if it is up-to-date, or load a borrowed Arc.

This method can be used in workflows where the atomic Arc is not expected to be updated. Contrary to load_cached, it doesn’t require a mutable reference.

pub fn load_cached<'a>(&self, cached: &'a mut A) -> &'a A

Returns a reference to the cached Arc, updating it when it is outdated.

See Cache for a convenient wrapper around this method.

pub fn swap(&self, arc: A) -> A

Stores the Arc and returns the previous one.

pub fn store(&self, arc: A)

Stores the Arc, dropping the previous one.

pub fn into_owned(self) -> A

Consumes the atomic storage and returns the stored Arc.

impl<A: ArcPtr, D: Domain> AtomicArcPtr<A, D, Concurrent>

pub fn compare_exchange<C: ArcRef<A>>( &self, current: C, new: A, ) -> Result<A, ArcPtrBorrow<A>>

Stores the new Arc if the current one matches the argument.

Returns the previous Arc if store succeeds, or loads the current Arc otherwise.

pub fn fetch_update<F: FnMut(&A) -> Option<R>, R: Into<A>>( &self, f: F, ) -> Result<A, ArcPtrBorrow<A>>

Fetches the current Arc, applies a function on it and tries to store the result if the current Arc has not changed.

Returns Err with the current Arc if the function returns None.

impl<A: NonNullArcPtr, D: Domain, W: WritePolicy> AtomicArcPtr<Option<A>, D, W>

pub const fn none() -> Self

Constructs a new Arc atomic storage with None.

pub fn is_none(&self) -> bool

Returns true if the stored Arc is None.

Trait Implementations

impl<A: ArcPtr, D: Domain, W: WritePolicy> AtomicArcRef for AtomicArcPtr<A, D, W>

type Arc = A

The concrete Arc pointer used by the AtomicArc.

type Owned = A

The owned Arc pointer loaded from the AtomicArc.

type LoadCached<'a> = &'a A where Self::Arc: 'a

The value returned by AtomicArc::load_cached.

fn load_owned(&self) -> Self::Owned

Load an owned Arc pointer.

fn load_cached<'a>(&self, cached: &'a mut Self::Owned) -> Self::LoadCached<'a>

Load an Arc pointer using a given cached value, updating it if necessary.

impl<A: ArcPtr + Debug, D: Domain, W: WritePolicy> Debug for AtomicArcPtr<A, D, W>

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

Formats the value using the given formatter.

impl<A: ArcPtr + Default, D: Domain, W: WritePolicy> Default for AtomicArcPtr<A, D, W>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, A: ArcPtr + Deserialize<'de>, D: Domain, W: WritePolicy> Deserialize<'de> for AtomicArcPtr<A, D, W>

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: ArcPtr, D: Domain, W: WritePolicy> Drop for AtomicArcPtr<A, D, W>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a, A: NonNullArcPtr, D: Domain, W: WritePolicy> From<&'a AtomicArcPtr<Option<A>, D, W>> for &'a AtomicOptionArcPtr<A, D, W>

fn from(value: &'a AtomicArcPtr<Option<A>, D, W>) -> Self

Converts to this type from the input type.

impl<A: ArcPtr, D: Domain, W: WritePolicy> From<A> for AtomicArcPtr<A, D, W>

fn from(value: A) -> Self

Converts to this type from the input type.

impl<A: NonNullArcPtr, D: Domain, W: WritePolicy> From<A> for AtomicArcPtr<Option<A>, D, W>

fn from(value: A) -> Self

Converts to this type from the input type.

impl<T, D: Domain, W: WritePolicy> From<Option<T>> for AtomicArcPtr<Option<Arc<T>>, D, W>

fn from(value: Option<T>) -> Self

Converts to this type from the input type.

impl<T, D: Domain, W: WritePolicy> From<T> for AtomicArcPtr<Arc<T>, D, W>

fn from(value: T) -> Self

Converts to this type from the input type.

impl<T, D: Domain, W: WritePolicy> From<T> for AtomicArcPtr<Option<Arc<T>>, D, W>

fn from(value: T) -> Self

Converts to this type from the input type.

impl<A: ArcPtr + Serialize, D: Domain, W: WritePolicy> Serialize for AtomicArcPtr<A, D, W>

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.