Struct RefMut

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

A wrapper type for a mutably borrowed value from a TokenRefCell.

The token can be reused for further borrowing.

Implementations

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

pub fn into_mut(self) -> &'b mut T

Unwraps the inner reference.

pub fn as_ref(&self) -> Ref<'_, T, Tk>

Borrows a RefMut as a Ref.

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

Uses borrowed token exclusive reference to reborrow a TokenRefCell.

Panics

See TokenRefCell::borrow_mut.

pub fn try_reborrow_mut<U: ?Sized>( &mut self, cell: impl FnOnce(&mut T) -> &TokenRefCell<U, Tk>, ) -> Result<RefMut<'_, U, Tk>, BorrowMutError>

Uses borrowed token exclusive reference to reborrow a TokenRefCell.

See TokenRefCell::try_borrow_mut.

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

Uses borrowed token exclusive reference to optionally reborrow a TokenRefCell.

Panics

See TokenRefCell::borrow_mut.

pub fn try_reborrow_opt_mut<U: ?Sized>( &mut self, cell: impl FnOnce(&mut T) -> Option<&TokenRefCell<U, Tk>>, ) -> Option<Result<RefMut<'_, U, Tk>, BorrowMutError>>

Uses borrowed token exclusive reference to optionally reborrow a TokenRefCell.

See TokenRefCell::try_borrow_mut.

pub fn reborrow_stateful_mut<'a, S>( &'a mut self, state: impl FnOnce(&'a mut T) -> S, ) -> ReborrowMut<'a, S, Tk>

Wraps the borrowed token exclusive reference into a stateful ReborrowMut instance.

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

Examples found in repository

examples/graph.rs (line 46)

    pub fn remove_node(&mut self, id: NodeId) -> bool {
        let Some(node) = self.nodes.remove(&id) else {
            return false;
        };
        let mut node_mut = node.borrow_mut(&mut self.token);
        let mut reborrow_mut =
            node_mut.reborrow_stateful_mut(|node| node.edges.values().map(AsRef::as_ref));
        while let Some(mut other) = reborrow_mut.reborrow_opt_mut(|edges| edges.next()) {
            other.edges.remove(&id);
        }
        true
    }

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 RefMut<'_, 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 RefMut<'_, T, Tk>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T: ?Sized, Tk: Token + ?Sized> DerefMut for RefMut<'_, T, Tk>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

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

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

Formats the value using the given formatter.