Struct Ref

pub struct Ref<'b, T: ?Sized, Tk: Token + ?Sized = BoxToken> { /* private fields */ }

A wrapper type for an immutably borrowed value from a TokenRefCell.

The token used for borrowing synchronization is also borrowed. Dedicated methods allows reusing the token for further borrowing.

Implementations

impl<'b, T: ?Sized, Tk: Token + ?Sized> Ref<'b, T, Tk>

pub fn into_ref(self) -> &'b T

Unwraps the inner reference.

Examples found in repository

examples/graph.rs (line 30)

    pub fn get_node(&self, id: NodeId) -> Option<&Node> {
        Some(self.nodes.get(&id)?.borrow(&self.token).into_ref())
    }

pub fn clone(this: &Self) -> Self

Copies a Ref.

This is an associated function that needs to be used as Ref::clone(...). A Clone implementation or a method would interfere with the widespread use of cell.borrow(&token).clone() to clone the contents of a TokenRefCell.

pub fn reborrow<U: ?Sized>( &self, cell: impl FnOnce(&T) -> &TokenRefCell<U, Tk>, ) -> Ref<'_, U, Tk>

Uses borrowed token shared reference to reborrow a TokenRefCell.

Panics

See TokenRefCell::borrow.

pub fn try_reborrow<U: ?Sized>( &self, cell: impl FnOnce(&T) -> &TokenRefCell<U, Tk>, ) -> Result<Ref<'_, U, Tk>, BorrowError>

Uses borrowed token shared reference to reborrow a TokenRefCell.

See TokenRefCell::try_borrow.

pub fn reborrow_opt<U: ?Sized>( &self, cell: impl FnOnce(&T) -> Option<&TokenRefCell<U, Tk>>, ) -> Option<Ref<'_, U, Tk>>

Uses borrowed token shared reference to optionally reborrow a TokenRefCell.

Panics

See TokenRefCell::borrow.

pub fn try_reborrow_opt<U: ?Sized>( &self, cell: impl FnOnce(&T) -> Option<&TokenRefCell<U, Tk>>, ) -> Option<Result<Ref<'_, U, Tk>, BorrowError>>

Uses borrowed token shared reference to optionally reborrow a TokenRefCell.

See TokenRefCell::try_borrow.

pub fn reborrow_stateful<'a, S>( &'a self, state: impl FnOnce(&'a T) -> S, ) -> Reborrow<'a, S, Tk>

Wraps the borrowed token shared reference into a stateful Reborrow instance.

It can be used for example to reborrow cells from an iterator.

pub fn token_id(&self) -> Tk::Id

Get the id of the borrowed token.

Trait Implementations

impl<T: ?Sized + Debug, Tk: Token + ?Sized> Debug for Ref<'_, T, Tk>

where Tk::Id: Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: ?Sized, Tk: Token + ?Sized> Deref for Ref<'_, T, Tk>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: ?Sized + Display, Tk: Token + ?Sized> Display for Ref<'_, T, Tk>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.