Struct ObjectRef

pub struct ObjectRef<T: 'static>(/* private fields */);

When the concrete type of an object is known statically, we can provide an ObjectRef wrapper around the ObjectId in order to make downcasting simpler.

This is primarily useful when vending self references to MessageReceviers.

Implementations

impl<T> ObjectRef<T>

pub fn from_id(id: ObjectId) -> Self

pub fn id(&self) -> ObjectId

pub fn get<'a>(&self, client: &'a Client) -> Result<&'a T, ObjectLookupError>

Provides an immutable reference to an object, downcasted to |T|.

pub fn try_get<'a>(&self, client: &'a Client) -> Option<&'a T>

Provides an immutable reference to an object, downcasted to |T|, if available.

pub fn get_mut<'a>( &self, client: &'a mut Client, ) -> Result<&'a mut T, ObjectLookupError>

Provides a mutable reference to an object, downcasted to |T|.

pub fn try_get_mut<'a>(&self, client: &'a mut Client) -> Option<&'a mut T>

Provides a mutable reference to an object, downcasted to |T|, if available.

pub fn is_valid(&self, client: &mut Client) -> bool

Returns true iff the underlying object is still valid.

Here ‘valid’ means that the object_id exists and refers to an object of type T. This method will still return true if the associated object_id has been deleted and recreated with the same type T. If this is not desirable then the caller must track instance with some state embedded into T`.

This can be useful to verify prior to sending events using the associated object_id but the host object itself is not required.

Trait Implementations

impl<T: 'static> Clone for ObjectRef<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: 'static> Debug for ObjectRef<T>

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

Formats the value using the given formatter.

impl<T> From<u32> for ObjectRef<T>

fn from(id: ObjectId) -> Self

Converts to this type from the input type.

impl<T> Hash for ObjectRef<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> PartialEq for ObjectRef<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: 'static> Copy for ObjectRef<T>

impl<T> Eq for ObjectRef<T>