Struct qcell::TLCellOwner

pub struct TLCellOwner<Q: 'static> { /* private fields */ }

Available on crate feature std only.

Borrowing-owner of zero or more TLCell instances.

See crate documentation.

Implementations

impl<Q: 'static> TLCellOwner<Q>

pub fn new() -> Self

Create the singleton owner instance. Each owner may be used to create many TLCell instances. There may be only one instance of this type per thread at any given time for each different marker type Q. This call panics if a second simultaneous instance is created. Since the owner is only valid to use in the thread it is created in, it does not support Send or Sync.

pub fn cell<T>(&self, value: T) -> TLCell<Q, T>

Create a new cell owned by this owner instance. See also TLCell::new.

pub fn ro<'a, T: ?Sized>(&'a self, tc: &'a TLCell<Q, T>) -> &'a T

Borrow contents of a TLCell immutably (read-only). Many TLCell instances can be borrowed immutably at the same time from the same owner.

pub fn rw<'a, T: ?Sized>(&'a mut self, tc: &'a TLCell<Q, T>) -> &'a mut T

Borrow contents of a TLCell mutably (read-write). Only one TLCell at a time can be borrowed from the owner using this call. The returned reference must go out of scope before another can be borrowed.

pub fn rw2<'a, T: ?Sized, U: ?Sized>( &'a mut self, tc1: &'a TLCell<Q, T>, tc2: &'a TLCell<Q, U> ) -> (&'a mut T, &'a mut U)

Borrow contents of two TLCell instances mutably. Panics if the two TLCell instances point to the same memory.

pub fn rw3<'a, T: ?Sized, U: ?Sized, V: ?Sized>( &'a mut self, tc1: &'a TLCell<Q, T>, tc2: &'a TLCell<Q, U>, tc3: &'a TLCell<Q, V> ) -> (&'a mut T, &'a mut U, &'a mut V)

Borrow contents of three TLCell instances mutably. Panics if any pair of TLCell instances point to the same memory.

Trait Implementations

impl<Q: 'static> Default for TLCellOwner<Q>

fn default() -> Self

Returns the “default value” for a type.

impl<Q: 'static> Drop for TLCellOwner<Q>

fn drop(&mut self)

Executes the destructor for this type.