Struct bevy_utils::intern::Interned

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

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<T: ?Sized> Clone for Interned<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: ?Sized + Debug> Debug for Interned<T>

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

Formats the value using the given formatter.

impl<T: ?Sized> Deref for Interned<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

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

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

Converts to this type from the input type.

impl<T: ?Sized + Internable> Hash for Interned<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: ?Sized + Internable> PartialEq for Interned<T>

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<T: ?Sized> Copy for Interned<T>

impl<T: ?Sized + Internable> Eq for Interned<T>