Struct qcell::TCellOwner

pub struct TCellOwner<Q: 'static> { /* fields omitted */ }

Borrowing-owner of zero or more TCell instances.

See crate documentation.

Methods

impl<Q: 'static> TCellOwner<Q>

pub fn new() -> Self

Create the singleton owner instance. Each owner may be used to create many TCell instances. There may be only one instance of this type per process at any given time for each different marker type Q. This call panics if a second simultaneous instance is created.

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

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

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

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

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

Borrow contents of a TCell mutably (read-write). Only one TCell 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, U>(
    &'a mut self,
    tc1: &'a TCell<Q, T>,
    tc2: &'a TCell<Q, U>
) -> (&'a mut T, &'a mut U)

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

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

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

Trait Implementations

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

fn default() -> Self

Returns the "default value" for a type.

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

fn drop(&mut self)

Executes the destructor for this type.