Struct bevy::ecs::ComponentFlags

pub struct ComponentFlags { /* fields omitted */ }

Implementations

impl ComponentFlags

pub const ADDED: ComponentFlags

pub const MUTATED: ComponentFlags

pub const fn empty() -> ComponentFlags

Returns an empty set of flags

pub const fn all() -> ComponentFlags

Returns the set containing all flags.

pub const fn bits(&self) -> u8

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u8) -> Option<ComponentFlags>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u8) -> ComponentFlags

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u8) -> ComponentFlags

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: ComponentFlags) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: ComponentFlags) -> bool

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: ComponentFlags)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: ComponentFlags)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: ComponentFlags)

Toggles the specified flags in-place.

pub fn set(&mut self, other: ComponentFlags, value: bool)

Inserts or removes the specified flags depending on the passed value.

Trait Implementations

impl Binary for ComponentFlags

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

Formats the value using the given formatter.

impl BitAnd<ComponentFlags> for ComponentFlags

type Output = ComponentFlags

The resulting type after applying the & operator.

pub fn bitand(self, other: ComponentFlags) -> ComponentFlags

Returns the intersection between the two sets of flags.

impl BitAndAssign<ComponentFlags> for ComponentFlags

pub fn bitand_assign(&mut self, other: ComponentFlags)

Disables all flags disabled in the set.

impl BitOr<ComponentFlags> for ComponentFlags

type Output = ComponentFlags

The resulting type after applying the | operator.

pub fn bitor(self, other: ComponentFlags) -> ComponentFlags

Returns the union of the two sets of flags.

impl BitOrAssign<ComponentFlags> for ComponentFlags

pub fn bitor_assign(&mut self, other: ComponentFlags)

Adds the set of flags.

impl BitXor<ComponentFlags> for ComponentFlags

type Output = ComponentFlags

The resulting type after applying the ^ operator.

pub fn bitxor(self, other: ComponentFlags) -> ComponentFlags

Returns the left flags, but with all the right flags toggled.

impl BitXorAssign<ComponentFlags> for ComponentFlags

pub fn bitxor_assign(&mut self, other: ComponentFlags)

Toggles the set of flags.

impl Clone for ComponentFlags

pub fn clone(&self) -> ComponentFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ComponentFlags

impl Debug for ComponentFlags

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

Formats the value using the given formatter.

impl Eq for ComponentFlags

impl Extend<ComponentFlags> for ComponentFlags

pub fn extend<T>(&mut self, iterator: T) where
    T: IntoIterator<Item = ComponentFlags>, 

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

pub fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<ComponentFlags> for ComponentFlags

pub fn from_iter<T>(iterator: T) -> ComponentFlags where
    T: IntoIterator<Item = ComponentFlags>, 

Creates a value from an iterator.

impl Hash for ComponentFlags

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl LowerHex for ComponentFlags

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

Formats the value using the given formatter.

impl Not for ComponentFlags

type Output = ComponentFlags

The resulting type after applying the ! operator.

pub fn not(self) -> ComponentFlags

Returns the complement of this set of flags.

impl Octal for ComponentFlags

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

Formats the value using the given formatter.

impl Ord for ComponentFlags

pub fn cmp(&self, other: &ComponentFlags) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<ComponentFlags> for ComponentFlags

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

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

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

This method tests for !=.

impl PartialOrd<ComponentFlags> for ComponentFlags

pub fn partial_cmp(&self, other: &ComponentFlags) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

pub fn lt(&self, other: &ComponentFlags) -> bool

This method tests less than (for self and other) and is used by the < operator.

pub fn le(&self, other: &ComponentFlags) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

pub fn gt(&self, other: &ComponentFlags) -> bool

This method tests greater than (for self and other) and is used by the > operator.

pub fn ge(&self, other: &ComponentFlags) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for ComponentFlags

impl StructuralPartialEq for ComponentFlags

impl Sub<ComponentFlags> for ComponentFlags

type Output = ComponentFlags

The resulting type after applying the - operator.

pub fn sub(self, other: ComponentFlags) -> ComponentFlags

Returns the set difference of the two sets of flags.

impl SubAssign<ComponentFlags> for ComponentFlags

pub fn sub_assign(&mut self, other: ComponentFlags)

Disables all flags enabled in the set.

impl UpperHex for ComponentFlags

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

Formats the value using the given formatter.