Struct Orbital 

pub struct Orbital<T: CellType> { /* private fields */ }

One cell, typed. Cheap to clone; every clone is the same place.

Implementations

impl<T: CellType> Orbital<T>

pub fn id(&self) -> CellId

pub fn load(&self) -> Result<T>

pub fn store(&self, value: T) -> Result<()>

pub fn swap(&self, value: T) -> Result<T>

Replace the value and return what it was.

pub fn version(&self) -> Result<u32>

The write count, the thing Self::wait_changed waits on. Take it before reading the value, and the wait misses nothing in between.

pub fn wait_changed(&self, since: u32) -> Result<u32>

Park until the cell has been written since since, then return the count now. Coalescing: ten writes while parked wake the caller once, and Self::load gives the latest. A released cell wakes every waiter with Error::Stale. Blocking; an async runtime wraps it.

pub fn compare_exchange(&self, current: T, new: T) -> Result<Result<T, T>>

Store new only if the cell still holds current. Ok(Ok(previous)) on success, Ok(Err(actual)) when it held something else.

pub fn release(self) -> Result<()>

Give the cell back; this and every other handle to it go stale.

impl Orbital<i64>

pub fn fetch_add(&self, by: i64) -> Result<i64>

Add by (negative to subtract) and return the value after.

pub fn fetch_sub(&self, by: i64) -> Result<i64>

impl Orbital<u64>

pub fn fetch_add(&self, by: u64) -> Result<u64>

pub fn fetch_sub(&self, by: u64) -> Result<u64>

impl Orbital<f64>

pub fn fetch_add(&self, by: f64) -> Result<f64>

Add by and return the value after. A compare-and-swap loop: floats have no fetch-add of their own.

impl Orbital<bool>

pub fn set(&self) -> Result<bool>

Set the flag and return whether it was already set.

pub fn clear(&self) -> Result<bool>

Clear the flag and return whether it was set.

Trait Implementations

impl<T: Clone + CellType> Clone for Orbital<T>

fn clone(&self) -> Orbital<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.