Struct AnimationHint 

#[non_exhaustive]
pub struct AnimationHint {
    pub redefinition: AnimationChange,
    pub replacement: AnimationChange,
}

Specifies how a Block might change in the very near future, for the benefit of rendering algorithms. Does not currently describe non-visual aspects of a block.

This should be configured for blocks which either are continuously animated in some fashion, or for which it is especially important that the specified changes are handled efficiently, at the possible cost of spending more resources on those blocks. Blocks which merely might change in response to user action should not set this hint.

The | operator may be used to combine multiple hints into “both of these will happen”.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

redefinition: AnimationChange

Ways in which the block’s definition might change (via modification to a BlockDef or recursive Space) such that many instances of this block will become another simultaneously.

replacement: AnimationChange

If this block is likely to be replaced in a Space by another, this field specifies the replacement’s relation to this.

Implementations

impl AnimationHint

pub const UNCHANGING: Self

There are no expectations that the block is soon going to change.

This is the default value of this type and within BlockAttributes.

pub const fn redefinition(change: AnimationChange) -> Self

Creates a hint that the block definition might be redefined, in the ways specified by change.

pub const fn replacement(change: AnimationChange) -> Self

Creates a hint that the block will be replaced with another block, which differs in the ways specified by change.

Trait Implementations

impl<'arbitrary> Arbitrary<'arbitrary> for AnimationHint

fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl BitOr for AnimationHint

type Output = AnimationHint

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl BitOrAssign for AnimationHint

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl Clone for AnimationHint

fn clone(&self) -> AnimationHint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AnimationHint

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

Formats the value using the given formatter.

impl Default for AnimationHint

fn default() -> Self

Returns the “default value” for a type.

impl Hash for AnimationHint

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 PartialEq for AnimationHint

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

fn visit_handles(&self, _: &mut dyn HandleVisitor)

For each Handle contained within self that is reachable without traversing another Handle, call visitor with a reference to it.

impl Copy for AnimationHint

impl Eq for AnimationHint

impl StructuralPartialEq for AnimationHint