Struct esl::LightFlags

pub struct LightFlags { /* fields omitted */ }

Methods

impl LightFlags

pub const DYNAMIC: LightFlags

pub const CAN_CARRY: LightFlags

pub const NEGATIVE: LightFlags

pub const FLICKER: LightFlags

pub const FIRE: LightFlags

pub const OFF_BY_DEFAULT: LightFlags

pub const FLICKER_SLOW: LightFlags

pub const PULSE: LightFlags

pub const PULSE_SLOW: LightFlags

pub const fn empty() -> LightFlags

Returns an empty set of flags

pub const fn all() -> LightFlags

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u32) -> Option<LightFlags>

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

pub const fn from_bits_truncate(bits: u32) -> LightFlags

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

pub const unsafe fn from_bits_unchecked(bits: u32) -> LightFlags

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: LightFlags) -> bool

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for LightFlags

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

Formats the value using the given formatter.

impl BitAnd<LightFlags> for LightFlags

type Output = LightFlags

The resulting type after applying the & operator.

fn bitand(self, other: LightFlags) -> LightFlags

Returns the intersection between the two sets of flags.

impl BitAndAssign<LightFlags> for LightFlags

fn bitand_assign(&mut self, other: LightFlags)

Disables all flags disabled in the set.

impl BitOr<LightFlags> for LightFlags

type Output = LightFlags

The resulting type after applying the | operator.

fn bitor(self, other: LightFlags) -> LightFlags

Returns the union of the two sets of flags.

impl BitOrAssign<LightFlags> for LightFlags

fn bitor_assign(&mut self, other: LightFlags)

Adds the set of flags.

impl BitXor<LightFlags> for LightFlags

type Output = LightFlags

The resulting type after applying the ^ operator.

fn bitxor(self, other: LightFlags) -> LightFlags

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

impl BitXorAssign<LightFlags> for LightFlags

fn bitxor_assign(&mut self, other: LightFlags)

Toggles the set of flags.

impl Clone for LightFlags

fn clone(&self) -> LightFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for LightFlags

impl Debug for LightFlags

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

Formats the value using the given formatter.

impl Default for LightFlags

fn default() -> LightFlags

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for LightFlags

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for LightFlags

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

Formats the value using the given formatter.

impl Eq for LightFlags

impl Extend<LightFlags> for LightFlags

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

Extends a collection with the contents of an iterator.

impl FromIterator<LightFlags> for LightFlags

fn from_iter<T: IntoIterator<Item = LightFlags>>(iterator: T) -> LightFlags

Creates a value from an iterator.

impl FromStr for LightFlags

type Err = ()

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<LightFlags, Self::Err>

Parses a string s to return a value of this type.

impl Hash for LightFlags

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, 

Feeds a slice of this type into the given [Hasher].

impl LowerHex for LightFlags

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

Formats the value using the given formatter.

impl Not for LightFlags

type Output = LightFlags

The resulting type after applying the ! operator.

fn not(self) -> LightFlags

Returns the complement of this set of flags.

impl Octal for LightFlags

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

Formats the value using the given formatter.

impl Ord for LightFlags

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

This method returns an [Ordering] between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

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

Restrict a value to a certain interval.

impl PartialEq<LightFlags> for LightFlags

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

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

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

This method tests for !=.

impl PartialOrd<LightFlags> for LightFlags

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

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

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

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

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

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

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

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

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

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

impl Serialize for LightFlags

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralEq for LightFlags

impl StructuralPartialEq for LightFlags

impl Sub<LightFlags> for LightFlags

type Output = LightFlags

The resulting type after applying the - operator.

fn sub(self, other: LightFlags) -> LightFlags

Returns the set difference of the two sets of flags.

impl SubAssign<LightFlags> for LightFlags

fn sub_assign(&mut self, other: LightFlags)

Disables all flags enabled in the set.

impl UpperHex for LightFlags

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

Formats the value using the given formatter.