Struct TVar

pub struct TVar<T> { /* private fields */ }

TVar is the public interface to lift data into the transactional context for subsequent read and write operations. TVar is our handle to a variable, but reading and writing go through a transaction. It also tracks which threads are waiting on it.

Implementations

impl<T: Any + Sync + Send + Clone> TVar<T>

pub fn new(value: T) -> TVar<T>

Create a new TVar. The initial version is 0, so that if a TVar is created in the middle of a transaction it will not cause any MVCC conflict during the commit.

pub fn read_clone(&self) -> Stm<T>

Read the value of the TVar as a clone, for subsequent modification. Only call this inside [atomically].

pub fn read(&self) -> Stm<Arc<T>>

Read the value of the TVar. Only call this inside [atomically].

pub fn write(&self, value: T) -> Stm<()>

Replace the value of the TVar. Only call this inside [atomically].

pub fn update<F>(&self, f: F) -> Stm<()>

where F: FnOnce(T) -> T,

Apply an update on the value of the TVar. Only call this inside [atomically].

pub fn update_mut<F>(&self, f: F) -> Stm<()>

where F: FnOnce(&mut T),

Apply an update on the value of the TVar. Only call this inside [atomically].

pub fn modify<F, R>(&self, f: F) -> Stm<R>

where F: FnOnce(T) -> (T, R),

Apply an update on the value of the TVar and return a value. Only call this inside [atomically].

pub fn modify_mut<F, R>(&self, f: F) -> Stm<R>

where F: FnOnce(&mut T) -> R,

Apply an update on the value of the TVar and return a value. Only call this inside [atomically].

pub fn replace(&self, value: T) -> Stm<Arc<T>>

Replace the value of the TVar and return the previous value. Only call this inside [atomically].

Trait Implementations

impl<T: Clone> Clone for TVar<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Default for TVar<T>

where T: Any + Sync + Send + Clone + Default,

fn default() -> Self

Returns the “default value” for a type.