Struct esl::LightFlags
source · pub struct LightFlags(/* private fields */);
Implementations§
source§impl LightFlags
impl LightFlags
pub const DYNAMIC: Self = _
pub const CAN_CARRY: Self = _
pub const NEGATIVE: Self = _
pub const FLICKER: Self = _
pub const FIRE: Self = _
pub const OFF_BY_DEFAULT: Self = _
pub const FLICKER_SLOW: Self = _
pub const PULSE: Self = _
pub const PULSE_SLOW: Self = _
source§impl LightFlags
impl LightFlags
sourcepub const fn bits(&self) -> u32
pub const fn bits(&self) -> u32
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
sourcepub const fn from_bits(bits: u32) -> Option<Self>
pub const fn from_bits(bits: u32) -> Option<Self>
Convert from a bits value.
This method will return None
if any unknown bits are set.
sourcepub const fn from_bits_truncate(bits: u32) -> Self
pub const fn from_bits_truncate(bits: u32) -> Self
Convert from a bits value, unsetting any unknown bits.
sourcepub const fn from_bits_retain(bits: u32) -> Self
pub const fn from_bits_retain(bits: u32) -> Self
Convert from a bits value exactly.
sourcepub fn from_name(name: &str) -> Option<Self>
pub fn from_name(name: &str) -> Option<Self>
Get a flags value with the bits of a flag with the given name set.
This method will return None
if name
is empty or doesn’t
correspond to any named flag.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Whether any set bits in a source flags value are also set in a target flags value.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Whether all set bits in a source flags value are also set in a target flags value.
sourcepub fn remove(&mut self, other: Self)
pub fn remove(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
remove
won’t truncate other
, but the !
operator will.
sourcepub fn toggle(&mut self, other: Self)
pub fn toggle(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Call insert
when value
is true
or remove
when value
is false
.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
The bitwise and (&
) of the bits in two flags values.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
The bitwise or (|
) of the bits in two flags values.
sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
The bitwise negation (!
) of the bits in a flags value, truncating the result.
source§impl LightFlags
impl LightFlags
sourcepub const fn iter(&self) -> Iter<LightFlags>
pub const fn iter(&self) -> Iter<LightFlags>
Yield a set of contained flags values.
Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.
sourcepub const fn iter_names(&self) -> IterNames<LightFlags>
pub const fn iter_names(&self) -> IterNames<LightFlags>
Yield a set of contained named flags values.
This method is like iter
, except only yields bits in contained named flags.
Any unknown bits, or bits not corresponding to a contained flag will not be yielded.
Trait Implementations§
source§impl Binary for LightFlags
impl Binary for LightFlags
source§impl BitAnd for LightFlags
impl BitAnd for LightFlags
source§impl BitAndAssign for LightFlags
impl BitAndAssign for LightFlags
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
The bitwise and (&
) of the bits in two flags values.
source§impl BitOr for LightFlags
impl BitOr for LightFlags
source§fn bitor(self, other: LightFlags) -> Self
fn bitor(self, other: LightFlags) -> Self
The bitwise or (|
) of the bits in two flags values.
§type Output = LightFlags
type Output = LightFlags
|
operator.source§impl BitOrAssign for LightFlags
impl BitOrAssign for LightFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
The bitwise or (|
) of the bits in two flags values.
source§impl BitXor for LightFlags
impl BitXor for LightFlags
source§impl BitXorAssign for LightFlags
impl BitXorAssign for LightFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
source§impl Clone for LightFlags
impl Clone for LightFlags
source§fn clone(&self) -> LightFlags
fn clone(&self) -> LightFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for LightFlags
impl Debug for LightFlags
source§impl Default for LightFlags
impl Default for LightFlags
source§fn default() -> LightFlags
fn default() -> LightFlags
source§impl<'de> Deserialize<'de> for LightFlags
impl<'de> Deserialize<'de> for LightFlags
source§fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
D: Deserializer<'de>,
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where D: Deserializer<'de>,
source§impl Extend<LightFlags> for LightFlags
impl Extend<LightFlags> for LightFlags
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
The bitwise or (|
) of the bits in each flags value.
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl Flags for LightFlags
impl Flags for LightFlags
source§const FLAGS: &'static [Flag<LightFlags>] = _
const FLAGS: &'static [Flag<LightFlags>] = _
source§fn from_bits_retain(bits: u32) -> LightFlags
fn from_bits_retain(bits: u32) -> LightFlags
source§fn from_bits_truncate(bits: Self::Bits) -> Self
fn from_bits_truncate(bits: Self::Bits) -> Self
source§fn from_name(name: &str) -> Option<Self>
fn from_name(name: &str) -> Option<Self>
source§fn iter_names(&self) -> IterNames<Self>
fn iter_names(&self) -> IterNames<Self>
source§fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
fn intersects(&self, other: Self) -> boolwhere Self: Sized,
source§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere Self: Sized,
source§fn insert(&mut self, other: Self)where
Self: Sized,
fn insert(&mut self, other: Self)where Self: Sized,
|
) of the bits in two flags values.source§fn remove(&mut self, other: Self)where
Self: Sized,
fn remove(&mut self, other: Self)where Self: Sized,
&!
). Read moresource§fn toggle(&mut self, other: Self)where
Self: Sized,
fn toggle(&mut self, other: Self)where Self: Sized,
^
) of the bits in two flags values.source§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
&
) of the bits in two flags values.source§fn difference(self, other: Self) -> Self
fn difference(self, other: Self) -> Self
&!
). Read moresource§fn symmetric_difference(self, other: Self) -> Self
fn symmetric_difference(self, other: Self) -> Self
^
) of the bits in two flags values.source§fn complement(self) -> Self
fn complement(self) -> Self
!
) of the bits in a flags value, truncating the result.source§impl FromIterator<LightFlags> for LightFlags
impl FromIterator<LightFlags> for LightFlags
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
The bitwise or (|
) of the bits in each flags value.
source§impl Hash for LightFlags
impl Hash for LightFlags
source§impl IntoIterator for LightFlags
impl IntoIterator for LightFlags
source§impl LowerHex for LightFlags
impl LowerHex for LightFlags
source§impl Not for LightFlags
impl Not for LightFlags
source§impl Octal for LightFlags
impl Octal for LightFlags
source§impl Ord for LightFlags
impl Ord for LightFlags
source§fn cmp(&self, other: &LightFlags) -> Ordering
fn cmp(&self, other: &LightFlags) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere Self: Sized,
source§impl PartialEq for LightFlags
impl PartialEq for LightFlags
source§fn eq(&self, other: &LightFlags) -> bool
fn eq(&self, other: &LightFlags) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd for LightFlags
impl PartialOrd for LightFlags
source§fn partial_cmp(&self, other: &LightFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &LightFlags) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl PublicFlags for LightFlags
impl PublicFlags for LightFlags
source§impl Serialize for LightFlags
impl Serialize for LightFlags
source§impl Sub for LightFlags
impl Sub for LightFlags
source§fn sub(self, other: Self) -> Self
fn sub(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.
§type Output = LightFlags
type Output = LightFlags
-
operator.source§impl SubAssign for LightFlags
impl SubAssign for LightFlags
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.