Struct Handle 

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

Handle is some sort of non-owning reference to content in a pool. It stores index of object and additional information that allows to ensure that handle is still valid (points to the same object as when handle was created).

Implementations

impl<T> Handle<T>

pub const NONE: Handle<T>

pub fn to_base<B>(self) -> Handle<B>

where T: ObjectOrVariant<B>,

Converts the handle to its base variant. In other words, if there are two related types and A is a variant of B, then this method converts Handle<A> -> Handle<B>.

pub fn to_variant<V>(self) -> Handle<V>

where V: ObjectOrVariant<T>,

Converts the handle of a base object to the handle of its variant.

pub fn is_none(self) -> bool

pub fn is_some(self) -> bool

pub fn index(self) -> u32

pub fn generation(self) -> u32

pub fn new(index: u32, generation: u32) -> Self

pub fn transmute<U>(&self) -> Handle<U>

pub fn decode_from_u128(num: u128) -> Self

pub fn encode_to_u128(&self) -> u128

Trait Implementations

impl<T> Clone for Handle<T>

fn clone(&self) -> Handle<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Handle<T>

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

Formats the value using the given formatter.

impl<T> Default for Handle<T>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for Handle<T>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Display for Handle<T>

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

Formats the value using the given formatter.

impl<T> From<AtomicHandle> for Handle<T>

fn from(atomic_handle: AtomicHandle) -> Self

Converts to this type from the input type.

impl<T> From<ErasedHandle> for Handle<T>

fn from(erased_handle: ErasedHandle) -> Self

Converts to this type from the input type.

impl<T> From<Handle<T>> for ErasedHandle

fn from(h: Handle<T>) -> Self

Converts to this type from the input type.

impl<T> Hash for Handle<T>

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

where H: Hasher,

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, U, Container> Index<Handle<U>> for Pool<T, Container>

where T: 'static, U: ObjectOrVariant<T>, Container: PayloadContainer<Element = T> + 'static,

type Output = U

The returned type after indexing.

fn index(&self, index: Handle<U>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T, U, Container> IndexMut<Handle<U>> for Pool<T, Container>

where T: 'static, U: ObjectOrVariant<T>, Container: PayloadContainer<Element = T> + 'static,

fn index_mut(&mut self, index: Handle<U>) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<T> Ord for Handle<T>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T, U: ObjectOrVariant<T>> PartialEq<Handle<U>> for Handle<T>

fn eq(&self, other: &Handle<U>) -> 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> PartialOrd for Handle<T>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Reflect> Reflect for Handle<T>

fn source_path() -> &'static str

fn derived_types() -> &'static [TypeId]

where Self: Sized,

fn try_clone_box(&self) -> Option<Box<dyn Reflect>>

fn query_derived_types(&self) -> &'static [TypeId]

fn type_name(&self) -> &'static str

fn doc(&self) -> &'static str

fn assembly_name(&self) -> &'static str

Returns a parent assembly name of the type that implements this trait. WARNING: You should use proc-macro (#[derive(Reflect)]) to ensure that this method will return correct assembly name. In other words - there’s no guarantee, that any implementation other than proc-macro will return a correct name of the assembly. Alternatively, you can use env!("CARGO_PKG_NAME") as an implementation.

fn type_assembly_name() -> &'static str

Returns a parent assembly name of the type that implements this trait. WARNING: You should use proc-macro (#[derive(Reflect)]) to ensure that this method will return correct assembly name. In other words - there’s no guarantee, that any implementation other than proc-macro will return a correct name of the assembly. Alternatively, you can use env!("CARGO_PKG_NAME") as an implementation.

fn fields_ref(&self, func: &mut dyn FnMut(&[FieldRef<'_, '_>]))

fn fields_mut(&mut self, func: &mut dyn FnMut(&mut [FieldMut<'_, '_>]))

fn into_any(self: Box<Self>) -> Box<dyn Any>

fn as_any(&self, func: &mut dyn FnMut(&dyn Any))

fn as_any_mut(&mut self, func: &mut dyn FnMut(&mut dyn Any))

fn as_reflect(&self, func: &mut dyn FnMut(&dyn Reflect))

fn as_reflect_mut(&mut self, func: &mut dyn FnMut(&mut dyn Reflect))

fn set( &mut self, value: Box<dyn Reflect>, ) -> Result<Box<dyn Reflect>, Box<dyn Reflect>>

fn as_handle(&self, func: &mut dyn FnMut(Option<&dyn ReflectHandle>))

fn as_handle_mut( &mut self, func: &mut dyn FnMut(Option<&mut dyn ReflectHandle>), )

fn set_field( &mut self, field_name: &str, value: Box<dyn Reflect>, func: &mut dyn FnMut(Result<Box<dyn Reflect>, SetFieldError>), )

Calls user method specified with #[reflect(setter = ..)] or falls back to Reflect::field_mut

fn field(&self, name: &str, func: &mut dyn FnMut(Option<&dyn Reflect>))

fn field_mut( &mut self, name: &str, func: &mut dyn FnMut(Option<&mut dyn Reflect>), )

fn as_array(&self, func: &mut dyn FnMut(Option<&dyn ReflectArray>))

fn as_array_mut(&mut self, func: &mut dyn FnMut(Option<&mut dyn ReflectArray>))

fn as_list(&self, func: &mut dyn FnMut(Option<&dyn ReflectList>))

fn as_list_mut(&mut self, func: &mut dyn FnMut(Option<&mut dyn ReflectList>))

fn as_inheritable_variable( &self, func: &mut dyn FnMut(Option<&dyn ReflectInheritableVariable>), )

fn as_inheritable_variable_mut( &mut self, func: &mut dyn FnMut(Option<&mut dyn ReflectInheritableVariable>), )

fn as_hash_map(&self, func: &mut dyn FnMut(Option<&dyn ReflectHashMap>))

fn as_hash_map_mut( &mut self, func: &mut dyn FnMut(Option<&mut dyn ReflectHashMap>), )

impl<T: Reflect> ReflectHandle for Handle<T>

fn reflect_inner_type_id(&self) -> TypeId

fn reflect_inner_type_name(&self) -> &'static str

fn reflect_is_some(&self) -> bool

fn reflect_set_index(&mut self, index: u32)

fn reflect_index(&self) -> u32

fn reflect_set_generation(&mut self, generation: u32)

fn reflect_generation(&self) -> u32

fn reflect_as_erased(&self) -> ErasedHandle

impl<T> Serialize for Handle<T>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> TypeUuidProvider for Handle<T>

where T: TypeUuidProvider,

fn type_uuid() -> Uuid

Return type UUID.

impl<T> Visit for Handle<T>

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> VisitResult

Read or write this value, depending on whether Visitor::is_reading() is true or false.

impl<T> Copy for Handle<T>

impl<T> Eq for Handle<T>

impl<T> Send for Handle<T>

impl<T> Sync for Handle<T>