Skip to main content

SharedAtom

Struct SharedAtom 

Source
pub struct SharedAtom {
    pub cell: Arc<ArcSwap<SharedValue>>,
    pub meta: Mutex<Option<SharedValue>>,
}
Expand description

A cross-isolate mutable reference backed by a lock-free ArcSwap.

reset! and swap! promote the new value and perform an atomic pointer swap — no locking, O(1) for simple resets, O(retries) for CAS-retry swap! under write contention. deref is a single atomic load plus an Arc reference-count bump.

Wrapped in Value::SharedAtom(Arc<SharedAtom>). The Arc gives the atom identity (pointer equality) and allows any number of isolates to hold a reference.

Fields§

§cell: Arc<ArcSwap<SharedValue>>§meta: Mutex<Option<SharedValue>>

Implementations§

Source§

impl SharedAtom

Source

pub fn new(val: SharedValue) -> Self

Source

pub fn deref_val(&self) -> Arc<SharedValue>

Load the current value. Lock-free atomic load + refcount bump.

Source

pub fn reset(&self, val: SharedValue) -> Arc<SharedValue>

Atomically replace the value and return the new Arc.

Source

pub fn swap<F>(&self, f: F) -> Arc<SharedValue>

CAS-retry swap: apply f to the current value and store the result. Returns the new value. Retries automatically if another writer races.

Source

pub fn compare_and_set( &self, current: &Arc<SharedValue>, new: SharedValue, ) -> bool

Single lock-free compare-and-set. Atomically stores new iff the cell still holds current (by Arc identity). Returns true on success.

This is the primitive used by Clojure-level compare-and-set! and by the retry loop behind swap!: a caller that needs to run arbitrary (interpreter) code between the load and the store cannot use the closure form of [swap], so it loads via deref_val, computes the next value, then commits with this method, retrying on contention.

Trait Implementations§

Source§

impl Debug for SharedAtom

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more