Struct kas::text::EffectFlags [−]
pub struct EffectFlags { /* fields omitted */ }
Expand description
Text effects
Implementations
impl EffectFlags
impl EffectFlags
pub const UNDERLINE: EffectFlags
pub const UNDERLINE: EffectFlags
Glyph is underlined
pub const STRIKETHROUGH: EffectFlags
pub const STRIKETHROUGH: EffectFlags
Glyph is crossed through by a centre-line
pub const fn empty() -> EffectFlags
pub const fn empty() -> EffectFlags
Returns an empty set of flags.
pub const fn all() -> EffectFlags
pub const fn all() -> EffectFlags
Returns the set containing all flags.
pub const fn from_bits(bits: u32) -> Option<EffectFlags>
pub const fn from_bits(bits: u32) -> Option<EffectFlags>
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) -> EffectFlags
pub const fn from_bits_truncate(bits: u32) -> EffectFlags
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
pub const unsafe fn from_bits_unchecked(bits: u32) -> EffectFlags
pub const unsafe fn from_bits_unchecked(bits: u32) -> EffectFlags
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
Safety
The caller of the bitflags!
macro can chose to allow or
disallow extra bits for their bitflags type.
The caller of from_bits_unchecked()
has to ensure that
all bits correspond to a defined flag or that extra bits
are valid for this bitflags type.
pub const fn intersects(&self, other: EffectFlags) -> bool
pub const fn intersects(&self, other: EffectFlags) -> bool
Returns true
if there are flags common to both self
and other
.
pub const fn contains(&self, other: EffectFlags) -> bool
pub const fn contains(&self, other: EffectFlags) -> bool
Returns true
if all of the flags in other
are contained within self
.
pub fn insert(&mut self, other: EffectFlags)
pub fn insert(&mut self, other: EffectFlags)
Inserts the specified flags in-place.
pub fn remove(&mut self, other: EffectFlags)
pub fn remove(&mut self, other: EffectFlags)
Removes the specified flags in-place.
pub fn toggle(&mut self, other: EffectFlags)
pub fn toggle(&mut self, other: EffectFlags)
Toggles the specified flags in-place.
pub fn set(&mut self, other: EffectFlags, value: bool)
pub fn set(&mut self, other: EffectFlags, value: bool)
Inserts or removes the specified flags depending on the passed value.
pub const fn intersection(self, other: EffectFlags) -> EffectFlags
pub const fn intersection(self, other: EffectFlags) -> EffectFlags
Returns the intersection between the flags in self
and
other
.
Specifically, the returned set contains only the flags which are
present in both self
and other
.
This is equivalent to using the &
operator (e.g.
ops::BitAnd
), as in flags & other
.
pub const fn union(self, other: EffectFlags) -> EffectFlags
pub const fn union(self, other: EffectFlags) -> EffectFlags
Returns the union of between the flags in self
and other
.
Specifically, the returned set contains all flags which are
present in either self
or other
, including any which are
present in both (see Self::symmetric_difference
if that
is undesirable).
This is equivalent to using the |
operator (e.g.
ops::BitOr
), as in flags | other
.
pub const fn difference(self, other: EffectFlags) -> EffectFlags
pub const fn difference(self, other: EffectFlags) -> EffectFlags
Returns the difference between the flags in self
and other
.
Specifically, the returned set contains all flags present in
self
, except for the ones present in other
.
It is also conceptually equivalent to the “bit-clear” operation:
flags & !other
(and this syntax is also supported).
This is equivalent to using the -
operator (e.g.
ops::Sub
), as in flags - other
.
pub const fn symmetric_difference(self, other: EffectFlags) -> EffectFlags
pub const fn symmetric_difference(self, other: EffectFlags) -> EffectFlags
Returns the symmetric difference between the flags
in self
and other
.
Specifically, the returned set contains the flags present which
are present in self
or other
, but that are not present in
both. Equivalently, it contains the flags present in exactly
one of the sets self
and other
.
This is equivalent to using the ^
operator (e.g.
ops::BitXor
), as in flags ^ other
.
pub const fn complement(self) -> EffectFlags
pub const fn complement(self) -> EffectFlags
Returns the complement of this set of flags.
Specifically, the returned set contains all the flags which are
not set in self
, but which are allowed for this type.
Alternatively, it can be thought of as the set difference
between Self::all()
and self
(e.g. Self::all() - self
)
This is equivalent to using the !
operator (e.g.
ops::Not
), as in !flags
.
Trait Implementations
impl Binary for EffectFlags
impl Binary for EffectFlags
impl BitAnd<EffectFlags> for EffectFlags
impl BitAnd<EffectFlags> for EffectFlags
pub fn bitand(self, other: EffectFlags) -> EffectFlags
pub fn bitand(self, other: EffectFlags) -> EffectFlags
Returns the intersection between the two sets of flags.
type Output = EffectFlags
type Output = EffectFlags
The resulting type after applying the &
operator.
impl BitAndAssign<EffectFlags> for EffectFlags
impl BitAndAssign<EffectFlags> for EffectFlags
pub fn bitand_assign(&mut self, other: EffectFlags)
pub fn bitand_assign(&mut self, other: EffectFlags)
Disables all flags disabled in the set.
impl BitOr<EffectFlags> for EffectFlags
impl BitOr<EffectFlags> for EffectFlags
pub fn bitor(self, other: EffectFlags) -> EffectFlags
pub fn bitor(self, other: EffectFlags) -> EffectFlags
Returns the union of the two sets of flags.
type Output = EffectFlags
type Output = EffectFlags
The resulting type after applying the |
operator.
impl BitOrAssign<EffectFlags> for EffectFlags
impl BitOrAssign<EffectFlags> for EffectFlags
pub fn bitor_assign(&mut self, other: EffectFlags)
pub fn bitor_assign(&mut self, other: EffectFlags)
Adds the set of flags.
impl BitXor<EffectFlags> for EffectFlags
impl BitXor<EffectFlags> for EffectFlags
pub fn bitxor(self, other: EffectFlags) -> EffectFlags
pub fn bitxor(self, other: EffectFlags) -> EffectFlags
Returns the left flags, but with all the right flags toggled.
type Output = EffectFlags
type Output = EffectFlags
The resulting type after applying the ^
operator.
impl BitXorAssign<EffectFlags> for EffectFlags
impl BitXorAssign<EffectFlags> for EffectFlags
pub fn bitxor_assign(&mut self, other: EffectFlags)
pub fn bitxor_assign(&mut self, other: EffectFlags)
Toggles the set of flags.
impl Clone for EffectFlags
impl Clone for EffectFlags
pub fn clone(&self) -> EffectFlags
pub fn clone(&self) -> EffectFlags
Returns a copy of the value. Read more
Performs copy-assignment from source
. Read more
impl Debug for EffectFlags
impl Debug for EffectFlags
impl Default for EffectFlags
impl Default for EffectFlags
pub fn default() -> EffectFlags
pub fn default() -> EffectFlags
Returns the “default value” for a type. Read more
impl<'de> Deserialize<'de> for EffectFlags
impl<'de> Deserialize<'de> for EffectFlags
pub fn deserialize<__D>(
__deserializer: __D
) -> Result<EffectFlags, <__D as Deserializer<'de>>::Error> where
__D: Deserializer<'de>,
pub fn deserialize<__D>(
__deserializer: __D
) -> Result<EffectFlags, <__D as Deserializer<'de>>::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
impl Extend<EffectFlags> for EffectFlags
impl Extend<EffectFlags> for EffectFlags
pub fn extend<T>(&mut self, iterator: T) where
T: IntoIterator<Item = EffectFlags>,
pub fn extend<T>(&mut self, iterator: T) where
T: IntoIterator<Item = EffectFlags>,
Extends a collection with the contents of an iterator. Read more
extend_one
)Extends a collection with exactly one element.
extend_one
)Reserves capacity in a collection for the given number of additional elements. Read more
impl FromIterator<EffectFlags> for EffectFlags
impl FromIterator<EffectFlags> for EffectFlags
pub fn from_iter<T>(iterator: T) -> EffectFlags where
T: IntoIterator<Item = EffectFlags>,
pub fn from_iter<T>(iterator: T) -> EffectFlags where
T: IntoIterator<Item = EffectFlags>,
Creates a value from an iterator. Read more
impl Hash for EffectFlags
impl Hash for EffectFlags
impl LowerHex for EffectFlags
impl LowerHex for EffectFlags
impl Not for EffectFlags
impl Not for EffectFlags
pub fn not(self) -> EffectFlags
pub fn not(self) -> EffectFlags
Returns the complement of this set of flags.
type Output = EffectFlags
type Output = EffectFlags
The resulting type after applying the !
operator.
impl Octal for EffectFlags
impl Octal for EffectFlags
impl Ord for EffectFlags
impl Ord for EffectFlags
pub fn cmp(&self, other: &EffectFlags) -> Ordering
pub fn cmp(&self, other: &EffectFlags) -> Ordering
Compares and returns the maximum of two values. Read more
Compares and returns the minimum of two values. Read more
impl PartialEq<EffectFlags> for EffectFlags
impl PartialEq<EffectFlags> for EffectFlags
pub fn eq(&self, other: &EffectFlags) -> bool
pub fn eq(&self, other: &EffectFlags) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
pub fn ne(&self, other: &EffectFlags) -> bool
pub fn ne(&self, other: &EffectFlags) -> bool
This method tests for !=
.
impl PartialOrd<EffectFlags> for EffectFlags
impl PartialOrd<EffectFlags> for EffectFlags
pub fn partial_cmp(&self, other: &EffectFlags) -> Option<Ordering>
pub fn partial_cmp(&self, other: &EffectFlags) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
This method tests less than (for self
and other
) and is used by the <
operator. Read more
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
impl Serialize for EffectFlags
impl Serialize for EffectFlags
pub fn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
__S: Serializer,
pub fn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
__S: Serializer,
Serialize this value into the given Serde serializer. Read more
impl Sub<EffectFlags> for EffectFlags
impl Sub<EffectFlags> for EffectFlags
pub fn sub(self, other: EffectFlags) -> EffectFlags
pub fn sub(self, other: EffectFlags) -> EffectFlags
Returns the set difference of the two sets of flags.
type Output = EffectFlags
type Output = EffectFlags
The resulting type after applying the -
operator.
impl SubAssign<EffectFlags> for EffectFlags
impl SubAssign<EffectFlags> for EffectFlags
pub fn sub_assign(&mut self, other: EffectFlags)
pub fn sub_assign(&mut self, other: EffectFlags)
Disables all flags enabled in the set.
impl UpperHex for EffectFlags
impl UpperHex for EffectFlags
impl Copy for EffectFlags
impl Eq for EffectFlags
impl StructuralEq for EffectFlags
impl StructuralPartialEq for EffectFlags
Auto Trait Implementations
impl RefUnwindSafe for EffectFlags
impl Send for EffectFlags
impl Sync for EffectFlags
impl Unpin for EffectFlags
impl UnwindSafe for EffectFlags
Blanket Implementations
Mutably borrows from an owned value. Read more
impl<T> CallHasher for T where
T: Hash,
impl<T> CallHasher for T where
T: Hash,
pub fn cast_trunc(self) -> T
pub fn cast_trunc(self) -> T
Cast to integer, truncating Read more
pub fn cast_nearest(self) -> T
pub fn cast_nearest(self) -> T
Cast to the nearest integer Read more
pub fn cast_floor(self) -> T
pub fn cast_floor(self) -> T
Cast the floor to an integer Read more
pub fn try_cast_trunc(self) -> Result<T, Error>
pub fn try_cast_trunc(self) -> Result<T, Error>
Try converting to integer with truncation Read more
pub fn try_cast_nearest(self) -> Result<T, Error>
pub fn try_cast_nearest(self) -> Result<T, Error>
Try converting to the nearest integer Read more
pub fn try_cast_floor(self) -> Result<T, Error>
pub fn try_cast_floor(self) -> Result<T, Error>
Try converting the floor to an integer Read more
pub fn try_cast_ceil(self) -> Result<T, Error>
pub fn try_cast_ceil(self) -> Result<T, Error>
Try convert the ceiling to an integer Read more
Compare self to key
and return true
if they are equal.
Checks that type has a default value.