Struct MultiBorrowContext 

pub struct MultiBorrowContext<'a, T, P = Option<T>>
where
    T: Sized,
    P: PayloadContainer<Element = T> + 'static,
{ /* private fields */ }

Multi-borrow context allows you to get as many unique references to elements in a pool as you want.

Implementations

impl<'a, T, P> MultiBorrowContext<'a, T, P>

where T: Sized, P: PayloadContainer<Element = T> + 'static,

pub fn new(pool: &'a mut Pool<T, P>) -> Self

pub fn try_get<'b: 'a>( &'b self, handle: Handle<T>, ) -> Result<Ref<'a, 'b, T>, MultiBorrowError<T>>

Tries to get a mutable reference to a pool element located at the given handle. The method could fail in three main reasons:

1. A reference to an element is already taken - returning multiple mutable references to the same element is forbidden by Rust safety rules.
2. You’re trying to get more references that the context could handle (there is not enough space in the internal handles storage) - in this case you must increase N.
3. A given handle is invalid.

pub fn get<'b: 'a>(&'b self, handle: Handle<T>) -> Ref<'a, 'b, T>

pub fn try_get_mut<'b: 'a>( &'b self, handle: Handle<T>, ) -> Result<RefMut<'a, 'b, T>, MultiBorrowError<T>>

pub fn get_mut<'b: 'a>(&'b self, handle: Handle<T>) -> RefMut<'a, 'b, T>

pub fn free(&self, handle: Handle<T>) -> Result<T, MultiBorrowError<T>>

impl<'a, T, P> MultiBorrowContext<'a, T, P>

where T: Sized + ComponentProvider, P: PayloadContainer<Element = T> + 'static,

pub fn try_get_component_of_type<'b: 'a, C>( &'b self, handle: Handle<T>, ) -> Result<Ref<'a, 'b, C>, MultiBorrowError<T>>

where C: 'static,

Tries to mutably borrow an object and fetch its component of specified type.

pub fn try_get_component_of_type_mut<'b: 'a, C>( &'b self, handle: Handle<T>, ) -> Result<RefMut<'a, 'b, C>, MultiBorrowError<T>>

where C: 'static,

Tries to mutably borrow an object and fetch its component of specified type.

Trait Implementations

impl<T, P> Drop for MultiBorrowContext<'_, T, P>

where T: Sized, P: PayloadContainer<Element = T> + 'static,

fn drop(&mut self)

Executes the destructor for this type.