Struct stakker::Share

pub struct Share<T> { /* fields omitted */ }

Ref-counted shared mutable data

By default borrow-checking of access to the contents is handled at compile-time using a TCell or TLCell with its owner in Core. There are no access overheads at runtime. (With some feature settings, these would be replaced with QCell which does have some overhead.) Cloning has the normal Rc overheads.

Be careful using this because it can easily lead to dependency on the order of execution of actors. So treat this as similar in danger level to shared memory between threads or IPC shared memory between processes. You don't need locking however because if you get a mutable reference to the contents you'll have exclusive access until you give it up thanks to Rust's borrow checker.

Methods

impl<T> Share<T>

pub fn new(core: &Core, val: T) -> Self

Create a new Share instance

pub fn ro<'a>(&'a self, core: &'a Core) -> &'a T

Get a read-only (immutable, shared) reference to the contents of the Share instance

pub fn rw<'a>(&'a self, core: &'a mut Core) -> &'a mut T

Get a read-write (mutable, exclusive) reference to the contents of the Share instance

Trait Implementations

impl<T> Clone for Share<T>

fn clone(&self) -> Self

Return another reference to the shared data

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

Performs copy-assignment from source.