Struct generational_box::GenerationalBox

pub struct GenerationalBox<T, S: 'static = UnsyncStorage> { /* private fields */ }

The core Copy state type. The generational box will be dropped when the Owner is dropped.

Implementations

impl<T: 'static, S: Storage<T>> GenerationalBox<T, S>

pub fn raw_ptr(&self) -> *const ()

Get the raw pointer to the value.

pub fn id(&self) -> GenerationalBoxId

Get the id of the generational box.

pub fn try_read(&self) -> Result<S::Ref<T>, BorrowError>

Try to read the value. Returns None if the value is no longer valid.

pub fn read(&self) -> S::Ref<T>

Read the value. Panics if the value is no longer valid.

pub fn try_write(&self) -> Result<S::Mut<T>, BorrowMutError>

Try to write the value. Returns None if the value is no longer valid.

pub fn write(&self) -> S::Mut<T>

Write the value. Panics if the value is no longer valid.

pub fn set(&self, value: T)

Set the value. Panics if the value is no longer valid.

pub fn ptr_eq(&self, other: &Self) -> bool

Returns true if the pointer is equal to the other pointer.

pub fn take(&self) -> Option<T>

Take the value out of the generational box and invalidate the generational box. This will return the value if the value was taken.

Trait Implementations

impl<T, S> Clone for GenerationalBox<T, S>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: 'static, S: AnyStorage> Debug for GenerationalBox<T, S>

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

Formats the value using the given formatter.

impl<T, S: 'static> Copy for GenerationalBox<T, S>