Struct 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, S: Storage<T>> GenerationalBox<T, S>

pub fn leak(value: T, location: &'static Location<'static>) -> Self

Create a new generational box by leaking a value into the storage. This is useful for creating a box that needs to be manually dropped with no owners.

pub fn leak_rc(value: T, location: &'static Location<'static>) -> Self

Create a new reference counted generational box by leaking a value into the storage. This is useful for creating a box that needs to be manually dropped with no owners.

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<'static, T>, BorrowError>

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

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

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

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

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

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

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

pub fn set(&self, value: T)

where T: 'static,

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 manually_drop(&self)

where T: 'static,

Drop the value out of the generational box and invalidate the generational box.

pub fn created_at(&self) -> Option<&'static Location<'static>>

Try to get the location the generational box was created at. In release mode this will always return None.

pub fn leak_reference(&self) -> BorrowResult<GenerationalBox<T, S>>

Get a reference to the value

pub fn point_to(&self, other: GenerationalBox<T, S>) -> BorrowResult

Change this box to point to another generational box

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, S: AnyStorage> Debug for GenerationalBox<T, S>

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

Formats the value using the given formatter.

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