Struct kas_core::text::EffectFlags

pub struct EffectFlags { /* private fields */ }

Text effects

Implementations

impl EffectFlags

pub const UNDERLINE: EffectFlags = Self{ bits: 1 << 0,}

Glyph is underlined

pub const STRIKETHROUGH: EffectFlags = Self{ bits: 1 << 1,}

Glyph is crossed through by a center-line

pub const fn empty() -> EffectFlags

Returns an empty set of flags.

pub const fn all() -> EffectFlags

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

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

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

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

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

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)

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

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

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

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

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

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

Formats the value using the given formatter.

impl BitAnd<EffectFlags> for EffectFlags

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

Returns the intersection between the two sets of flags.

type Output = EffectFlags

The resulting type after applying the & operator.

impl BitAndAssign<EffectFlags> for EffectFlags

fn bitand_assign(&mut self, other: EffectFlags)

Disables all flags disabled in the set.

impl BitOr<EffectFlags> for EffectFlags

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

Returns the union of the two sets of flags.

type Output = EffectFlags

The resulting type after applying the | operator.

impl BitOrAssign<EffectFlags> for EffectFlags

fn bitor_assign(&mut self, other: EffectFlags)

Adds the set of flags.

impl BitXor<EffectFlags> for EffectFlags

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

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

type Output = EffectFlags

The resulting type after applying the ^ operator.

impl BitXorAssign<EffectFlags> for EffectFlags

fn bitxor_assign(&mut self, other: EffectFlags)

Toggles the set of flags.

impl Clone for EffectFlags

fn clone(&self) -> EffectFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EffectFlags

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

Formats the value using the given formatter.

impl Default for EffectFlags

fn default() -> EffectFlags

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EffectFlags

fn deserialize<__D>(
    __deserializer: __D
) -> Result<EffectFlags, <__D as Deserializer<'de>>::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Extend<EffectFlags> for EffectFlags

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

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

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<EffectFlags> for EffectFlags

fn from_iter<T>(iterator: T) -> EffectFlagswhere
    T: IntoIterator<Item = EffectFlags>,

Creates a value from an iterator.

impl Hash for EffectFlags

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

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 EffectFlags

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

Formats the value using the given formatter.

impl Not for EffectFlags

fn not(self) -> EffectFlags

Returns the complement of this set of flags.

type Output = EffectFlags

The resulting type after applying the ! operator.

impl Octal for EffectFlags

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

Formats the value using the given formatter.

impl Ord for EffectFlags

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<EffectFlags> for EffectFlags

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<EffectFlags> for EffectFlags

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

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

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

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

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

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

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

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

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

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

impl Serialize for EffectFlags

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.

impl Sub<EffectFlags> for EffectFlags

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

Returns the set difference of the two sets of flags.

type Output = EffectFlags

The resulting type after applying the - operator.

impl SubAssign<EffectFlags> for EffectFlags

fn sub_assign(&mut self, other: EffectFlags)

Disables all flags enabled in the set.

impl UpperHex for EffectFlags

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

Formats the value using the given formatter.

impl Copy for EffectFlags

impl Eq for EffectFlags

impl StructuralEq for EffectFlags

impl StructuralPartialEq for EffectFlags