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_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 invalid<T>(&self) -> GenerationalBox<T, S>

where T: 'static,

Creates an invalid handle. This is useful for creating a handle that will be filled in later. If you use this before the value is filled in, you will get may get a panic or an out of date value.

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.