Struct allsorts::gsub::FeatureMask
source · [−]pub struct FeatureMask { /* private fields */ }
Implementations
sourceimpl FeatureMask
impl FeatureMask
pub const ABVF: Self = _
pub const ABVS: Self = _
pub const AFRC: Self = _
pub const AKHN: Self = _
pub const BLWF: Self = _
pub const BLWS: Self = _
pub const C2SC: Self = _
pub const CALT: Self = _
pub const CCMP: Self = _
pub const CFAR: Self = _
pub const CJCT: Self = _
pub const CLIG: Self = _
pub const DLIG: Self = _
pub const FINA: Self = _
pub const FIN2: Self = _
pub const FIN3: Self = _
pub const FRAC: Self = _
pub const HALF: Self = _
pub const HALN: Self = _
pub const HLIG: Self = _
pub const INIT: Self = _
pub const ISOL: Self = _
pub const LIGA: Self = _
pub const LNUM: Self = _
pub const LOCL: Self = _
pub const MEDI: Self = _
pub const MED2: Self = _
pub const MSET: Self = _
pub const NUKT: Self = _
pub const ONUM: Self = _
pub const ORDN: Self = _
pub const PNUM: Self = _
pub const PREF: Self = _
pub const PRES: Self = _
pub const PSTF: Self = _
pub const PSTS: Self = _
pub const RCLT: Self = _
pub const RKRF: Self = _
pub const RLIG: Self = _
pub const RPHF: Self = _
pub const SMCP: Self = _
pub const TNUM: Self = _
pub const VATU: Self = _
pub const VRT2_OR_VERT: Self = _
pub const ZERO: Self = _
sourcepub const fn from_bits(bits: u64) -> Option<Self>
pub const fn from_bits(bits: u64) -> Option<Self>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
sourcepub const fn from_bits_truncate(bits: u64) -> Self
pub const fn from_bits_truncate(bits: u64) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u64) -> Self
pub const unsafe fn from_bits_unchecked(bits: u64) -> Self
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.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
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
.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
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
.
sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
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
.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
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
.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
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
.
sourceimpl FeatureMask
impl FeatureMask
pub fn from_tag(tag: u32) -> FeatureMask
pub fn iter<'a>(&'a self) -> impl Iterator<Item = FeatureInfo> + 'a
Trait Implementations
sourceimpl Binary for FeatureMask
impl Binary for FeatureMask
sourceimpl BitAnd<FeatureMask> for FeatureMask
impl BitAnd<FeatureMask> for FeatureMask
type Output = FeatureMask
type Output = FeatureMask
The resulting type after applying the &
operator.
sourceimpl BitAndAssign<FeatureMask> for FeatureMask
impl BitAndAssign<FeatureMask> for FeatureMask
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<FeatureMask> for FeatureMask
impl BitOr<FeatureMask> for FeatureMask
sourcefn bitor(self, other: FeatureMask) -> Self
fn bitor(self, other: FeatureMask) -> Self
Returns the union of the two sets of flags.
type Output = FeatureMask
type Output = FeatureMask
The resulting type after applying the |
operator.
sourceimpl BitOrAssign<FeatureMask> for FeatureMask
impl BitOrAssign<FeatureMask> for FeatureMask
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<FeatureMask> for FeatureMask
impl BitXor<FeatureMask> for FeatureMask
sourcefn bitxor(self, other: Self) -> Self
fn bitxor(self, other: Self) -> Self
Returns the left flags, but with all the right flags toggled.
type Output = FeatureMask
type Output = FeatureMask
The resulting type after applying the ^
operator.
sourceimpl BitXorAssign<FeatureMask> for FeatureMask
impl BitXorAssign<FeatureMask> for FeatureMask
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for FeatureMask
impl Clone for FeatureMask
sourcefn clone(&self) -> FeatureMask
fn clone(&self) -> FeatureMask
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for FeatureMask
impl Debug for FeatureMask
sourceimpl Default for FeatureMask
impl Default for FeatureMask
sourceimpl Extend<FeatureMask> for FeatureMask
impl Extend<FeatureMask> for FeatureMask
sourcefn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
Extends a collection with the contents of an iterator. Read more
sourcefn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)Extends a collection with exactly one element.
sourcefn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)Reserves capacity in a collection for the given number of additional elements. Read more
sourceimpl FromIterator<FeatureMask> for FeatureMask
impl FromIterator<FeatureMask> for FeatureMask
sourcefn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
Creates a value from an iterator. Read more
sourceimpl Hash for FeatureMask
impl Hash for FeatureMask
sourceimpl LowerHex for FeatureMask
impl LowerHex for FeatureMask
sourceimpl Not for FeatureMask
impl Not for FeatureMask
type Output = FeatureMask
type Output = FeatureMask
The resulting type after applying the !
operator.
sourceimpl Octal for FeatureMask
impl Octal for FeatureMask
sourceimpl Ord for FeatureMask
impl Ord for FeatureMask
sourcefn cmp(&self, other: &FeatureMask) -> Ordering
fn cmp(&self, other: &FeatureMask) -> Ordering
1.21.0 · sourcefn max(self, other: Self) -> Self
fn max(self, other: Self) -> Self
Compares and returns the maximum of two values. Read more
1.21.0 · sourcefn min(self, other: Self) -> Self
fn min(self, other: Self) -> Self
Compares and returns the minimum of two values. Read more
1.50.0 · sourcefn clamp(self, min: Self, max: Self) -> Self where
Self: PartialOrd<Self>,
fn clamp(self, min: Self, max: Self) -> Self where
Self: PartialOrd<Self>,
Restrict a value to a certain interval. Read more
sourceimpl PartialEq<FeatureMask> for FeatureMask
impl PartialEq<FeatureMask> for FeatureMask
sourcefn eq(&self, other: &FeatureMask) -> bool
fn eq(&self, other: &FeatureMask) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &FeatureMask) -> bool
fn ne(&self, other: &FeatureMask) -> bool
This method tests for !=
.
sourceimpl PartialOrd<FeatureMask> for FeatureMask
impl PartialOrd<FeatureMask> for FeatureMask
sourcefn partial_cmp(&self, other: &FeatureMask) -> Option<Ordering>
fn partial_cmp(&self, other: &FeatureMask) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
sourceimpl Sub<FeatureMask> for FeatureMask
impl Sub<FeatureMask> for FeatureMask
type Output = FeatureMask
type Output = FeatureMask
The resulting type after applying the -
operator.
sourceimpl SubAssign<FeatureMask> for FeatureMask
impl SubAssign<FeatureMask> for FeatureMask
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
sourceimpl UpperHex for FeatureMask
impl UpperHex for FeatureMask
impl Copy for FeatureMask
impl Eq for FeatureMask
impl StructuralEq for FeatureMask
impl StructuralPartialEq for FeatureMask
Auto Trait Implementations
impl RefUnwindSafe for FeatureMask
impl Send for FeatureMask
impl Sync for FeatureMask
impl Unpin for FeatureMask
impl UnwindSafe for FeatureMask
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more