Struct kas::text::EffectFlags
pub struct EffectFlags { /* private fields */ }
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 center-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 for EffectFlags
impl BitAnd for EffectFlags
§fn bitand(self, other: EffectFlags) -> EffectFlags
fn bitand(self, other: EffectFlags) -> EffectFlags
Returns the intersection between the two sets of flags.
§type Output = EffectFlags
type Output = EffectFlags
&
operator.§impl BitAndAssign for EffectFlags
impl BitAndAssign for EffectFlags
§fn bitand_assign(&mut self, other: EffectFlags)
fn bitand_assign(&mut self, other: EffectFlags)
Disables all flags disabled in the set.
§impl BitOr for EffectFlags
impl BitOr for EffectFlags
§fn bitor(self, other: EffectFlags) -> EffectFlags
fn bitor(self, other: EffectFlags) -> EffectFlags
Returns the union of the two sets of flags.
§type Output = EffectFlags
type Output = EffectFlags
|
operator.§impl BitOrAssign for EffectFlags
impl BitOrAssign for EffectFlags
§fn bitor_assign(&mut self, other: EffectFlags)
fn bitor_assign(&mut self, other: EffectFlags)
Adds the set of flags.
§impl BitXor for EffectFlags
impl BitXor for EffectFlags
§fn bitxor(self, other: EffectFlags) -> EffectFlags
fn bitxor(self, other: EffectFlags) -> EffectFlags
Returns the left flags, but with all the right flags toggled.
§type Output = EffectFlags
type Output = EffectFlags
^
operator.§impl BitXorAssign for EffectFlags
impl BitXorAssign for EffectFlags
§fn bitxor_assign(&mut self, other: EffectFlags)
fn bitxor_assign(&mut self, other: EffectFlags)
Toggles the set of flags.
§impl Clone for EffectFlags
impl Clone for EffectFlags
§fn clone(&self) -> EffectFlags
fn clone(&self) -> EffectFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more§impl Debug for EffectFlags
impl Debug for EffectFlags
§impl Default for EffectFlags
impl Default for EffectFlags
§fn default() -> EffectFlags
fn default() -> EffectFlags
§impl Extend<EffectFlags> for EffectFlags
impl Extend<EffectFlags> for EffectFlags
§fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = EffectFlags>,
fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = EffectFlags>,
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
)§impl FromIterator<EffectFlags> for EffectFlags
impl FromIterator<EffectFlags> for EffectFlags
§fn from_iter<T>(iterator: T) -> EffectFlagswhere
T: IntoIterator<Item = EffectFlags>,
fn from_iter<T>(iterator: T) -> EffectFlagswhere
T: IntoIterator<Item = EffectFlags>,
§impl Hash for EffectFlags
impl Hash for EffectFlags
§impl LowerHex for EffectFlags
impl LowerHex for EffectFlags
§impl Not for EffectFlags
impl Not for EffectFlags
§fn not(self) -> EffectFlags
fn not(self) -> EffectFlags
Returns the complement of this set of flags.
§type Output = EffectFlags
type Output = EffectFlags
!
operator.§impl Octal for EffectFlags
impl Octal for EffectFlags
§impl Ord for EffectFlags
impl Ord for EffectFlags
§impl PartialEq for EffectFlags
impl PartialEq for EffectFlags
§fn eq(&self, other: &EffectFlags) -> bool
fn eq(&self, other: &EffectFlags) -> bool
self
and other
values to be equal, and is used
by ==
.§impl PartialOrd for EffectFlags
impl PartialOrd for EffectFlags
§fn partial_cmp(&self, other: &EffectFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &EffectFlags) -> 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 more§impl Sub for EffectFlags
impl Sub for EffectFlags
§fn sub(self, other: EffectFlags) -> EffectFlags
fn sub(self, other: EffectFlags) -> EffectFlags
Returns the set difference of the two sets of flags.
§type Output = EffectFlags
type Output = EffectFlags
-
operator.§impl SubAssign for EffectFlags
impl SubAssign for EffectFlags
§fn sub_assign(&mut self, other: EffectFlags)
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§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<S, T> CastApprox<T> for Swhere
T: ConvApprox<S>,
impl<S, T> CastApprox<T> for Swhere
T: ConvApprox<S>,
§fn try_cast_approx(self) -> Result<T, Error>
fn try_cast_approx(self) -> Result<T, Error>
§fn cast_approx(self) -> T
fn cast_approx(self) -> T
§impl<S, T> CastFloat<T> for Swhere
T: ConvFloat<S>,
impl<S, T> CastFloat<T> for Swhere
T: ConvFloat<S>,
§fn cast_trunc(self) -> T
fn cast_trunc(self) -> T
§fn cast_nearest(self) -> T
fn cast_nearest(self) -> T
§fn cast_floor(self) -> T
fn cast_floor(self) -> T
§fn try_cast_trunc(self) -> Result<T, Error>
fn try_cast_trunc(self) -> Result<T, Error>
§fn try_cast_nearest(self) -> Result<T, Error>
fn try_cast_nearest(self) -> Result<T, Error>
§fn try_cast_floor(self) -> Result<T, Error>
fn try_cast_floor(self) -> Result<T, Error>
§fn try_cast_ceil(self) -> Result<T, Error>
fn try_cast_ceil(self) -> Result<T, Error>
§impl<Q, K> Comparable<K> for Q
impl<Q, K> Comparable<K> for Q
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.§impl<T> DowncastSync for T
impl<T> DowncastSync for T
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<R, P> ReadPrimitive<R> for P
impl<R, P> ReadPrimitive<R> for P
source§fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
ReadEndian::read_from_little_endian()
.