Struct Interned 

pub struct Interned<T>(pub &'static T)
where
    T: Internable + 'static + ?Sized;

An interned value. Will stay valid until the end of the program and will not drop.

For details on interning, see the module level docs.

Comparisons

Interned values use reference equality, meaning they implement Eq and Hash regardless of whether T implements these traits. Two interned values are only guaranteed to compare equal if they were interned using the same Interner instance.

#[derive(PartialEq, Eq, Hash, Debug)]
struct Value(i32);
impl Internable for Value {
    // ...
}
let interner_1 = Interner::new();
let interner_2 = Interner::new();
// Even though both values are identical, their interned forms do not
// compare equal as they use different interner instances.
assert_ne!(interner_1.intern(&Value(42)), interner_2.intern(&Value(42)));

Tuple Fields

0: &'static T

Trait Implementations

impl AppLabel for Interned<dyn AppLabel>

fn dyn_clone(&self) -> Box<dyn AppLabel>

Clones this AppLabel.

fn intern(&self) -> Interned<dyn AppLabel>

Returns an Interned value corresponding to self.

impl<T> Clone for Interned<T>

where T: Internable + ?Sized,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Interned<T>

where T: Internable + Debug + ?Sized,

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

Formats the value using the given formatter.

impl<T> Deref for Interned<T>

where T: Internable + ?Sized,

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &<Interned<T> as Deref>::Target

Dereferences the value.

impl<T> From<&Interned<T>> for Interned<T>

where T: Internable + ?Sized,

fn from(value: &Interned<T>) -> Interned<T>

Converts to this type from the input type.

impl<T> FromReflect for Interned<T>

where T: Internable + 'static + TypePath + ?Sized, Interned<T>: Any + Send + Sync, &'static T: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn from_reflect(reflect: &(dyn PartialReflect + 'static)) -> Option<Interned<T>>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn PartialReflect>, ) -> Result<Self, Box<dyn PartialReflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl<T> GetTypeRegistration for Interned<T>

where T: Internable + 'static + TypePath + ?Sized, Interned<T>: Any + Send + Sync, &'static T: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn get_type_registration() -> TypeRegistration

Returns the default [TypeRegistration] for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl<T> Hash for Interned<T>

where T: Internable + ?Sized,

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> PartialEq for Interned<T>

where T: Internable + ?Sized,

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

where T: Internable + 'static + TypePath + ?Sized, Interned<T>: Any + Send + Sync, &'static T: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the [TypeInfo] of the type represented by this value.

fn try_apply( &mut self, value: &(dyn PartialReflect + 'static), ) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Interned<T>>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn try_into_reflect( self: Box<Interned<T>>, ) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>

Attempts to cast this type to a boxed, fully-reflected value.

fn try_as_reflect(&self) -> Option<&(dyn Reflect + 'static)>

Attempts to cast this type to a fully-reflected value.

fn try_as_reflect_mut(&mut self) -> Option<&mut (dyn Reflect + 'static)>

Attempts to cast this type to a mutable, fully-reflected value.

fn into_partial_reflect(self: Box<Interned<T>>) -> Box<dyn PartialReflect>

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &(dyn PartialReflect + 'static)

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut (dyn PartialReflect + 'static)

Casts this type to a mutable, reflected value.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

fn reflect_partial_eq( &self, value: &(dyn PartialReflect + 'static), ) -> Option<bool>

Returns a “partial equality” comparison result.

fn reflect_partial_cmp( &self, value: &(dyn PartialReflect + 'static), ) -> Option<Ordering>

Returns a “partial comparison” result.

fn reflect_clone(&self) -> Result<Box<dyn Reflect>, ReflectCloneError>

Attempts to clone Self using reflection.

fn apply(&mut self, value: &(dyn PartialReflect + 'static))

Applies a reflected value to this value.

fn to_dynamic(&self) -> Box<dyn PartialReflect>

Converts this reflected value into its dynamic representation based on its kind.

fn reflect_clone_and_take<T>(&self) -> Result<T, ReflectCloneError>

where T: 'static, Self: Sized + TypePath,

For a type implementing [PartialReflect], combines reflect_clone and take in a useful fashion, automatically constructing an appropriate [ReflectCloneError] if the downcast fails.

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

Debug formatter for the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl<T> Reflect for Interned<T>

where T: Internable + 'static + TypePath + ?Sized, Interned<T>: Any + Send + Sync, &'static T: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &(dyn Any + 'static)

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Interned<T>>) -> Box<dyn Reflect>

Casts this type to a boxed, fully-reflected value.

fn as_reflect(&self) -> &(dyn Reflect + 'static)

Casts this type to a fully-reflected value.

fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)

Casts this type to a mutable, fully-reflected value.

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

Performs a type-checked assignment of a reflected value to this value.

impl Schedulable for Interned<dyn SystemSet>

type Metadata = GraphInfo

Additional data used to configure independent scheduling. Stored in ScheduleConfig.

type GroupMetadata = Chain

Additional data used to configure a schedulable group. Stored in ScheduleConfigs.

fn into_config(self) -> ScheduleConfig<Interned<dyn SystemSet>>

Initializes a configuration from this node.

impl ScheduleLabel for Interned<dyn ScheduleLabel>

fn dyn_clone(&self) -> Box<dyn ScheduleLabel>

Clones this ScheduleLabel.

fn intern(&self) -> Interned<dyn ScheduleLabel>

Returns an Interned value corresponding to self.

impl SystemSet for Interned<dyn SystemSet>

fn system_type(&self) -> Option<TypeId>

Returns Some if this system set is a SystemTypeSet.

fn is_anonymous(&self) -> bool

Returns true if this system set is an AnonymousSet.

fn dyn_clone(&self) -> Box<dyn SystemSet>

Clones this SystemSet.

fn intern(&self) -> Interned<dyn SystemSet>

Returns an Interned value corresponding to self.

impl<T> TupleStruct for Interned<T>

where T: Internable + 'static + TypePath + ?Sized, Interned<T>: Any + Send + Sync, &'static T: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn field(&self, index: usize) -> Option<&(dyn PartialReflect + 'static)>

Returns a reference to the value of the field with index index as a &dyn Reflect.

fn field_mut( &mut self, index: usize, ) -> Option<&mut (dyn PartialReflect + 'static)>

Returns a mutable reference to the value of the field with index index as a &mut dyn Reflect.

fn field_len(&self) -> usize

Returns the number of fields in the tuple struct.

fn iter_fields(&self) -> TupleStructFieldIter<'_>

Returns an iterator over the values of the tuple struct’s fields.

fn to_dynamic_tuple_struct(&self) -> DynamicTupleStruct

Creates a new [DynamicTupleStruct] from this tuple struct.

fn get_represented_tuple_struct_info(&self) -> Option<&'static TupleStructInfo>

Will return None if [TypeInfo] is not available.

impl<T> TypePath for Interned<T>

where T: Internable + 'static + TypePath + ?Sized, Interned<T>: Any + Send + Sync,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl<T> Typed for Interned<T>

where T: Internable + 'static + TypePath + ?Sized, Interned<T>: Any + Send + Sync, &'static T: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl<T> Copy for Interned<T>

where T: Internable + ?Sized,

impl<T> Eq for Interned<T>

where T: Internable + ?Sized,