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 INDEX: &'static str = "index"

pub const GENERATION: &'static str = "generation"

impl<T> Handle<T>

pub const NONE: Handle<T>

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) -> Handle<T>

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

pub fn decode_from_u128(num: u128) -> Handle<T>

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<(), Error>

Formats the value using the given formatter.

impl<T> Default for Handle<T>

fn default() -> Handle<T>

Returns the “default value” for a type.

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

fn deserialize<__D>( __deserializer: __D, ) -> Result<Handle<T>, <__D as Deserializer<'de>>::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<(), Error>

Formats the value using the given formatter.

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

fn from(atomic_handle: AtomicHandle) -> Handle<T>

Converts to this type from the input type.

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

fn from(erased_handle: ErasedHandle) -> Handle<T>

Converts to this type from the input type.

impl<Node> From<Handle<Node>> for VariantResult<Node>

fn from(value: Handle<Node>) -> VariantResult<Node>

Converts to this type from the input type.

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

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

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> Index<Handle<Animation<T>>> for AnimationContainer<T>

where T: EntityId,

type Output = Animation<T>

The returned type after indexing.

fn index( &self, index: Handle<Animation<T>>, ) -> &<AnimationContainer<T> as Index<Handle<Animation<T>>>>::Output

Performs the indexing (container[index]) operation.

impl<B: Clone + 'static> Index<Handle<BehaviorNode<B>>> for BehaviorTree<B>

type Output = BehaviorNode<B>

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<Handle<Navmesh>> for NavMeshContainer

type Output = Navmesh

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<Handle<Node>> for Graph

type Output = Node

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<Handle<Scene>> for SceneContainer

type Output = Scene

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<T> Index<Handle<T>> for Graph

where T: NodeTrait,

type Output = T

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<T, P> Index<Handle<T>> for Pool<T, P>

where T: 'static, P: PayloadContainer<Element = T> + 'static,

type Output = T

The returned type after indexing.

fn index(&self, index: Handle<T>) -> &<Pool<T, P> as Index<Handle<T>>>::Output

Performs the indexing (container[index]) operation.

impl Index<Handle<UiNode>> for BuildContext<'_>

type Output = UiNode

The returned type after indexing.

fn index( &self, index: Handle<UiNode>, ) -> &<BuildContext<'_> as Index<Handle<UiNode>>>::Output

Performs the indexing (container[index]) operation.

impl Index<Handle<UserInterface>> for UiContainer

type Output = UserInterface

The returned type after indexing.

fn index( &self, index: Handle<UserInterface>, ) -> &<UiContainer as Index<Handle<UserInterface>>>::Output

Performs the indexing (container[index]) operation.

impl<T> IndexMut<Handle<Animation<T>>> for AnimationContainer<T>

where T: EntityId,

fn index_mut( &mut self, index: Handle<Animation<T>>, ) -> &mut <AnimationContainer<T> as Index<Handle<Animation<T>>>>::Output

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

impl<B: Clone + 'static> IndexMut<Handle<BehaviorNode<B>>> for BehaviorTree<B>

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

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

impl IndexMut<Handle<Navmesh>> for NavMeshContainer

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

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

impl IndexMut<Handle<Node>> for Graph

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

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

impl IndexMut<Handle<Scene>> for SceneContainer

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

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

impl<T> IndexMut<Handle<T>> for Graph

where T: NodeTrait,

fn index_mut(&mut self, typed_handle: Handle<T>) -> &mut Self::Output

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

impl<T, P> IndexMut<Handle<T>> for Pool<T, P>

where T: 'static, P: PayloadContainer<Element = T> + 'static,

fn index_mut( &mut self, index: Handle<T>, ) -> &mut <Pool<T, P> as Index<Handle<T>>>::Output

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

impl IndexMut<Handle<UiNode>> for BuildContext<'_>

fn index_mut( &mut self, index: Handle<UiNode>, ) -> &mut <BuildContext<'_> as Index<Handle<UiNode>>>::Output

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

impl IndexMut<Handle<UserInterface>> for UiContainer

fn index_mut( &mut self, index: Handle<UserInterface>, ) -> &mut <UiContainer as Index<Handle<UserInterface>>>::Output

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

impl<T> Ord for Handle<T>

fn cmp(&self, other: &Handle<T>) -> 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> PartialEq for Handle<T>

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

where Handle<T>: 'static, u32: Reflect,

fn source_path() -> &'static str

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_info(&self, func: &mut dyn FnMut(&[FieldInfo<'_, '_>]))

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

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

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

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

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

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

fn fields(&self, func: &mut dyn FnMut(&[&(dyn Reflect + 'static)]))

fn fields_mut( &mut self, func: &mut dyn FnMut(&mut [&mut (dyn Reflect + 'static)]), )

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

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

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

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

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

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

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

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

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

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

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

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

impl<T> Serialize for Handle<T>

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::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) -> Result<(), VisitError>

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

impl<T> Copy for Handle<T>

impl<T> EntityId for Handle<T>

where T: 'static,

impl<T> Eq for Handle<T>

impl<T> Send for Handle<T>

impl<T> Sync for Handle<T>