Struct StoreHandle

pub struct StoreHandle<T> { /* private fields */ }

Handle to an object managed by a context.

Internally this is just an integer index into a context. A reference to the context must be passed in separately to access the actual object.

Implementations

impl<T: StoreObject> StoreHandle<T>

pub fn new(ctx: &mut StoreObjects, val: T) -> Self

Moves the given object into a context and returns a handle to it.

pub fn get<'a>(&self, ctx: &'a StoreObjects) -> &'a T

Returns a reference to the object that this handle points to.

pub fn get_mut<'a>(&self, ctx: &'a mut StoreObjects) -> &'a mut T

Returns a mutable reference to the object that this handle points to.

pub fn internal_handle(&self) -> InternalStoreHandle<T>

Returns the internal handle contains within this handle.

pub fn store_id(&self) -> StoreId

Returns the ID of the context associated with the handle.

pub fn set_store_id(&mut self, id: StoreId)

Overrides the store id with a new ID

pub unsafe fn from_internal( id: StoreId, internal: InternalStoreHandle<T>, ) -> Self

Constructs a StoreHandle from a StoreId and an InternalStoreHandle.

Safety

Handling InternalStoreHandle values is unsafe because they do not track context ID.

Trait Implementations

impl<T> Clone for StoreHandle<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: StoreObject> Debug for StoreHandle<T>

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

Formats the value using the given formatter.

impl<T> Hash for StoreHandle<T>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: StoreObject> PartialEq for StoreHandle<T>

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: StoreObject> Eq for StoreHandle<T>