Struct RefMutStack 

pub struct RefMutStack<'a, R, T> { /* private fields */ }

The stack of mutable references and their holders.

It allows to simulate recursion where each level holds a mutable reference to the one held by the caller with an iteration.

It is made in such a way that the rules enforced by the borrow checker during the theoretical recursion are still enforced during iterations. On that purpose, each object holding a mutable reference becomes unreachable when the recursion is simulated: it is stacked until it becomes usable again.

In order to use it:

• create a new stack with the root mutable reference using RefMutStack::new
• call RefMutStack::borrow_mut to create the root holder of type T
• enable recursion in T itself by calling ParkableRefMut::parker and park the holder with Parker::park
• finish recursion by calling ParkableRefMut::unpark

See builder examples in tests for more details.

Implementations

impl<'a, R, T> RefMutStack<'a, R, T>

pub fn new(r: &'a mut R) -> Self

Creates a new stack with the root mutable reference.

pub fn borrow_mut(&'a mut self) -> ParkableRefMut<'a, R, T>

Borrows the current mutable reference at the top of the stack in order to use it.