Struct freya::prelude::Owner

pub struct Owner<S = UnsyncStorage>(/* private fields */)
where
    S: AnyStorage + 'static;

Owner: Handles dropping generational boxes. The owner acts like a runtime lifetime guard. Any states that you create with an owner will be dropped when that owner is dropped.

Implementations

impl<S> Owner<S>

where S: AnyStorage,

pub fn insert<T>(&self, value: T) -> GenerationalBox<T, S>

where T: 'static, S: Storage<T>,

Insert a value into the store. The value will be dropped when the owner is dropped.

pub fn insert_rc<T>(&self, value: T) -> GenerationalBox<T, S>

where T: 'static, S: Storage<T>,

Create a new reference counted box. The box will be dropped when all references are dropped.

pub fn insert_rc_with_caller<T>( &self, value: T, caller: &'static Location<'static>, ) -> GenerationalBox<T, S>

where T: 'static, S: Storage<T>,

Insert a value into the store with a specific location blamed for creating the value. The value will be dropped when the owner is dropped.

pub fn insert_with_caller<T>( &self, value: T, caller: &'static Location<'static>, ) -> GenerationalBox<T, S>

where T: 'static, S: Storage<T>,

Insert a value into the store with a specific location blamed for creating the value. The value will be dropped when the owner is dropped.

pub fn insert_reference<T>( &self, other: GenerationalBox<T, S>, ) -> Result<GenerationalBox<T, S>, BorrowError>

where T: 'static, S: Storage<T>,

Create a new reference to an existing box. The reference will be dropped when the owner is dropped.

This method may return an error if the other box is no longer valid or it is already borrowed mutably.

Trait Implementations

impl<S> Clone for Owner<S>

where S: AnyStorage,

fn clone(&self) -> Owner<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S> Default for Owner<S>

where S: AnyStorage,

fn default() -> Owner<S>

Returns the “default value” for a type.