bevy::ecs::intern

Struct Interned

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

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§

source§

impl AppLabel for Interned<dyn AppLabel>

source§

fn as_dyn_eq(&self) -> &(dyn DynEq + 'static)

Casts this value to a form where it can be compared with other type-erased values.

source§

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

Clones this AppLabel.
source§

fn dyn_hash(&self, state: &mut dyn Hasher)

Feeds this value into the given [Hasher].
source§

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

Returns an Interned value corresponding to self.
source§

impl<T> Clone for Interned<T>
where T: ?Sized,

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<T> Debug for Interned<T>
where T: Debug + ?Sized,

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

type Target = T

The resulting type after dereferencing.
source§

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

Dereferences the value.
source§

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

source§

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

Converts to this type from the input type.
source§

impl<T> Hash for Interned<T>
where T: Internable + ?Sized,

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl<T> PartialEq for Interned<T>
where T: Internable + ?Sized,

source§

fn eq(&self, other: &Interned<T>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl ScheduleLabel for Interned<dyn ScheduleLabel>

source§

fn as_dyn_eq(&self) -> &(dyn DynEq + 'static)

Casts this value to a form where it can be compared with other type-erased values.

source§

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

Clones this ScheduleLabel.
source§

fn dyn_hash(&self, state: &mut dyn Hasher)

Feeds this value into the given Hasher.
source§

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

Returns an Interned value corresponding to self.
source§

impl SystemSet for Interned<dyn SystemSet>

source§

fn as_dyn_eq(&self) -> &(dyn DynEq + 'static)

Casts this value to a form where it can be compared with other type-erased values.

source§

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

Returns Some if this system set is a SystemTypeSet.
source§

fn is_anonymous(&self) -> bool

Returns true if this system set is an AnonymousSet.
source§

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

Clones this SystemSet.
source§

fn dyn_hash(&self, state: &mut dyn Hasher)

Feeds this value into the given Hasher.
source§

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

Returns an Interned value corresponding to self.
source§

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

source§

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

Auto Trait Implementations§

§

impl<T> Freeze for Interned<T>
where T: ?Sized,

§

impl<T> RefUnwindSafe for Interned<T>
where T: RefUnwindSafe + ?Sized,

§

impl<T> Send for Interned<T>
where T: Sync + ?Sized,

§

impl<T> Sync for Interned<T>
where T: Sync + ?Sized,

§

impl<T> Unpin for Interned<T>
where T: ?Sized,

§

impl<T> UnwindSafe for Interned<T>
where T: RefUnwindSafe + ?Sized,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T, C, D> Curve<T> for D
where C: Curve<T> + ?Sized, D: Deref<Target = C>,

source§

fn domain(&self) -> Interval

The interval over which this curve is parametrized. Read more
source§

fn sample_unchecked(&self, t: f32) -> T

Sample a point on this curve at the parameter value t, extracting the associated value. This is the unchecked version of sampling, which should only be used if the sample time t is already known to lie within the curve’s domain. Read more
source§

fn sample(&self, t: f32) -> Option<T>

Sample a point on this curve at the parameter value t, returning None if the point is outside of the curve’s domain.
source§

fn sample_clamped(&self, t: f32) -> T

Sample a point on this curve at the parameter value t, clamping t to lie inside the domain of the curve.
source§

fn sample_iter( &self, iter: impl IntoIterator<Item = f32>, ) -> impl Iterator<Item = Option<T>>
where Self: Sized,

Sample a collection of n >= 0 points on this curve at the parameter values t_n, returning None if the point is outside of the curve’s domain. Read more
source§

fn sample_iter_unchecked( &self, iter: impl IntoIterator<Item = f32>, ) -> impl Iterator<Item = T>
where Self: Sized,

Sample a collection of n >= 0 points on this curve at the parameter values t_n, extracting the associated values. This is the unchecked version of sampling, which should only be used if the sample times t_n are already known to lie within the curve’s domain. Read more
source§

fn sample_iter_clamped( &self, iter: impl IntoIterator<Item = f32>, ) -> impl Iterator<Item = T>
where Self: Sized,

Sample a collection of n >= 0 points on this curve at the parameter values t_n, clamping t_n to lie inside the domain of the curve. Read more
source§

fn map<S, F>(self, f: F) -> MapCurve<T, S, Self, F>
where Self: Sized, F: Fn(T) -> S,

Create a new curve by mapping the values of this curve via a function f; i.e., if the sample at time t for this curve is x, the value at time t on the new curve will be f(x).
source§

fn reparametrize<F>(self, domain: Interval, f: F) -> ReparamCurve<T, Self, F>
where Self: Sized, F: Fn(f32) -> f32,

Create a new Curve whose parameter space is related to the parameter space of this curve by f. For each time t, the sample from the new curve at time t is the sample from this curve at time f(t). The given domain will be the domain of the new curve. The function f is expected to take domain into self.domain(). Read more
source§

fn reparametrize_linear( self, domain: Interval, ) -> Result<LinearReparamCurve<T, Self>, LinearReparamError>
where Self: Sized,

Linearly reparametrize this Curve, producing a new curve whose domain is the given domain instead of the current one. This operation is only valid for curves with bounded domains; if either this curve’s domain or the given domain is unbounded, an error is returned.
source§

fn reparametrize_by_curve<C>(self, other: C) -> CurveReparamCurve<T, Self, C>
where Self: Sized, C: Curve<f32>,

Reparametrize this Curve by sampling from another curve. Read more
source§

fn graph(self) -> GraphCurve<T, Self>
where Self: Sized,

Create a new Curve which is the graph of this one; that is, its output echoes the sample time as part of a tuple. Read more
source§

fn zip<S, C>( self, other: C, ) -> Result<ZipCurve<T, S, Self, C>, InvalidIntervalError>
where Self: Sized, C: Curve<S>,

Create a new Curve by zipping this curve together with another. Read more
source§

fn chain<C>(self, other: C) -> Result<ChainCurve<T, Self, C>, ChainError>
where Self: Sized, C: Curve<T>,

Create a new Curve by composing this curve end-to-start with another, producing another curve with outputs of the same type. The domain of the other curve is translated so that its start coincides with where this curve ends. Read more
source§

fn reverse(self) -> Result<ReverseCurve<T, Self>, ReverseError>
where Self: Sized,

Create a new Curve inverting this curve on the x-axis, producing another curve with outputs of the same type, effectively playing backwards starting at self.domain().end() and transitioning over to self.domain().start(). The domain of the new curve is still the same. Read more
source§

fn repeat(self, count: usize) -> Result<RepeatCurve<T, Self>, RepeatError>
where Self: Sized,

Create a new Curve repeating this curve N times, producing another curve with outputs of the same type. The domain of the new curve will be bigger by a factor of n + 1. Read more
source§

fn forever(self) -> Result<ForeverCurve<T, Self>, RepeatError>
where Self: Sized,

Create a new Curve repeating this curve forever, producing another curve with outputs of the same type. The domain of the new curve will be unbounded. Read more
source§

fn ping_pong(self) -> Result<PingPongCurve<T, Self>, PingPongError>
where Self: Sized,

Create a new Curve chaining the original curve with its inverse, producing another curve with outputs of the same type. The domain of the new curve will be twice as long. The transition point is guaranteed to not make any jumps. Read more
source§

fn chain_continue<C>( self, other: C, ) -> Result<ContinuationCurve<T, Self, C>, ChainError>
where Self: Sized, T: VectorSpace, C: Curve<T>,

Create a new Curve by composing this curve end-to-start with another, producing another curve with outputs of the same type. The domain of the other curve is translated so that its start coincides with where this curve ends. Read more
source§

fn resample<I>( &self, segments: usize, interpolation: I, ) -> Result<SampleCurve<T, I>, ResamplingError>
where Self: Sized, I: Fn(&T, &T, f32) -> T,

Resample this Curve to produce a new one that is defined by interpolation over equally spaced sample values, using the provided interpolation to interpolate between adjacent samples. The curve is interpolated on segments segments between samples. For example, if segments is 1, only the start and end points of the curve are used as samples; if segments is 2, a sample at the midpoint is taken as well, and so on. If segments is zero, or if this curve has an unbounded domain, then a ResamplingError is returned. Read more
source§

fn resample_auto( &self, segments: usize, ) -> Result<SampleAutoCurve<T>, ResamplingError>
where Self: Sized, T: StableInterpolate,

Resample this Curve to produce a new one that is defined by interpolation over equally spaced sample values, using automatic interpolation to interpolate between adjacent samples. The curve is interpolated on segments segments between samples. For example, if segments is 1, only the start and end points of the curve are used as samples; if segments is 2, a sample at the midpoint is taken as well, and so on. If segments is zero, or if this curve has an unbounded domain, then a ResamplingError is returned.
source§

fn samples( &self, samples: usize, ) -> Result<impl Iterator<Item = T>, ResamplingError>
where Self: Sized,

Extract an iterator over evenly-spaced samples from this curve. If samples is less than 2 or if this curve has unbounded domain, then an error is returned instead.
source§

fn resample_uneven<I>( &self, sample_times: impl IntoIterator<Item = f32>, interpolation: I, ) -> Result<UnevenSampleCurve<T, I>, ResamplingError>
where Self: Sized, I: Fn(&T, &T, f32) -> T,

Resample this Curve to produce a new one that is defined by interpolation over samples taken at a given set of times. The given interpolation is used to interpolate adjacent samples, and the sample_times are expected to contain at least two valid times within the curve’s domain interval. Read more
source§

fn resample_uneven_auto( &self, sample_times: impl IntoIterator<Item = f32>, ) -> Result<UnevenSampleAutoCurve<T>, ResamplingError>
where Self: Sized, T: StableInterpolate,

Resample this Curve to produce a new one that is defined by automatic interpolation over samples taken at the given set of times. The given sample_times are expected to contain at least two valid times within the curve’s domain interval. Read more
source§

fn by_ref(&self) -> &Self
where Self: Sized,

Borrow this curve rather than taking ownership of it. This is essentially an alias for a prefix &; the point is that intermediate operations can be performed while retaining access to the original curve. Read more
source§

fn flip<U, V>(self) -> impl Curve<(V, U)>
where Self: Sized + Curve<(U, V)>,

Flip this curve so that its tuple output is arranged the other way.
source§

impl<T> Downcast for T
where T: Any,

source§

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

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
source§

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

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
source§

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

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
source§

impl<T> DynEq for T
where T: Any + Eq,

source§

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

Casts the type to dyn Any.
source§

fn dyn_eq(&self, other: &(dyn DynEq + 'static)) -> bool

This method tests for self and other values to be equal. Read more
source§

impl<T> DynHash for T
where T: DynEq + Hash,

source§

fn as_dyn_eq(&self) -> &(dyn DynEq + 'static)

Casts the type to dyn Any.
source§

fn dyn_hash(&self, state: &mut dyn Hasher)

Feeds this value into the given Hasher.
source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<S> IntoSystemSet<()> for S
where S: SystemSet,

source§

type Set = S

The type of SystemSet this instance converts into.
source§

fn into_system_set(self) -> <S as IntoSystemSet<()>>::Set

Converts this instance to its associated SystemSet type.
source§

impl<S> IntoSystemSetConfigs for S
where S: SystemSet,

source§

fn into_configs(self) -> NodeConfigs<Interned<dyn SystemSet>>

source§

fn in_set(self, set: impl SystemSet) -> NodeConfigs<Interned<dyn SystemSet>>

Add these system sets to the provided set.
source§

fn before<M>( self, set: impl IntoSystemSet<M>, ) -> NodeConfigs<Interned<dyn SystemSet>>

Runs before all systems in set. If self has any systems that produce Commands or other Deferred operations, all systems in set will see their effect. Read more
source§

fn after<M>( self, set: impl IntoSystemSet<M>, ) -> NodeConfigs<Interned<dyn SystemSet>>

Runs before all systems in set. If set has any systems that produce Commands or other Deferred operations, all systems in self will see their effect. Read more
source§

fn before_ignore_deferred<M>( self, set: impl IntoSystemSet<M>, ) -> NodeConfigs<Interned<dyn SystemSet>>

Run before all systems in set. Read more
source§

fn after_ignore_deferred<M>( self, set: impl IntoSystemSet<M>, ) -> NodeConfigs<Interned<dyn SystemSet>>

Run after all systems in set. Read more
source§

fn run_if<M>( self, condition: impl Condition<M>, ) -> NodeConfigs<Interned<dyn SystemSet>>

Run the systems in this set(s) only if the Condition is true. Read more
source§

fn ambiguous_with<M>( self, set: impl IntoSystemSet<M>, ) -> NodeConfigs<Interned<dyn SystemSet>>

Suppress warnings and errors that would result from systems in these sets having ambiguities (conflicting access but indeterminate order) with systems in set.
source§

fn ambiguous_with_all(self) -> NodeConfigs<Interned<dyn SystemSet>>

Suppress warnings and errors that would result from systems in these sets having ambiguities (conflicting access but indeterminate order) with any other system.
source§

fn chain(self) -> NodeConfigs<Interned<dyn SystemSet>>

Treat this collection as a sequence of system sets. Read more
source§

fn chain_ignore_deferred(self) -> NodeConfigs<Interned<dyn SystemSet>>

Treat this collection as a sequence of systems. Read more
source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> TypeData for T
where T: 'static + Send + Sync + Clone,

source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<T> ConditionalSend for T
where T: Send,