pub struct MetaCharType { /* private fields */ }
Expand description
Syntax meta character types
Implementations§
Source§impl MetaCharType
impl MetaCharType
Sourcepub const META_CHAR_ESCAPE: Self = _
pub const META_CHAR_ESCAPE: Self = _
The escape charater for this syntax
Sourcepub const META_CHAR_ANYCHAR: Self = _
pub const META_CHAR_ANYCHAR: Self = _
The any (.) character for this syntax.
Sourcepub const META_CHAR_ANYTIME: Self = _
pub const META_CHAR_ANYTIME: Self = _
The any number of repeats (*) character for this syntax.
Sourcepub const META_CHAR_ZERO_OR_ONE_TIME: Self = _
pub const META_CHAR_ZERO_OR_ONE_TIME: Self = _
The optinoal (?) chracter for this syntax
Sourcepub const META_CHAR_ONE_OR_MORE_TIME: Self = _
pub const META_CHAR_ONE_OR_MORE_TIME: Self = _
The at least once (+) character for this syntax
Sourcepub const META_CHAR_ANYCHAR_ANYTIME: Self = _
pub const META_CHAR_ANYCHAR_ANYTIME: Self = _
The glob character for this syntax (.*)
Sourcepub const fn from_bits(bits: c_uint) -> Option<Self>
pub const fn from_bits(bits: c_uint) -> 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: c_uint) -> Self
pub const fn from_bits_truncate(bits: c_uint) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
Sourcepub const unsafe fn from_bits_unchecked(bits: c_uint) -> Self
pub const unsafe fn from_bits_unchecked(bits: c_uint) -> 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
.
Trait Implementations§
Source§impl Binary for MetaCharType
impl Binary for MetaCharType
Source§impl BitAnd for MetaCharType
impl BitAnd for MetaCharType
Source§impl BitAndAssign for MetaCharType
impl BitAndAssign for MetaCharType
Source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
Source§impl BitOr for MetaCharType
impl BitOr for MetaCharType
Source§fn bitor(self, other: MetaCharType) -> Self
fn bitor(self, other: MetaCharType) -> Self
Returns the union of the two sets of flags.
Source§type Output = MetaCharType
type Output = MetaCharType
|
operator.Source§impl BitOrAssign for MetaCharType
impl BitOrAssign for MetaCharType
Source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
Source§impl BitXor for MetaCharType
impl BitXor for MetaCharType
Source§impl BitXorAssign for MetaCharType
impl BitXorAssign for MetaCharType
Source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
Source§impl Clone for MetaCharType
impl Clone for MetaCharType
Source§fn clone(&self) -> MetaCharType
fn clone(&self) -> MetaCharType
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for MetaCharType
impl Debug for MetaCharType
Source§impl Extend<MetaCharType> for MetaCharType
impl Extend<MetaCharType> for MetaCharType
Source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
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 FromIterator<MetaCharType> for MetaCharType
impl FromIterator<MetaCharType> for MetaCharType
Source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
Source§impl Hash for MetaCharType
impl Hash for MetaCharType
Source§impl LowerHex for MetaCharType
impl LowerHex for MetaCharType
Source§impl Not for MetaCharType
impl Not for MetaCharType
Source§impl Octal for MetaCharType
impl Octal for MetaCharType
Source§impl Ord for MetaCharType
impl Ord for MetaCharType
Source§fn cmp(&self, other: &MetaCharType) -> Ordering
fn cmp(&self, other: &MetaCharType) -> 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 MetaCharType
impl PartialEq for MetaCharType
Source§impl PartialOrd for MetaCharType
impl PartialOrd for MetaCharType
Source§impl Sub for MetaCharType
impl Sub for MetaCharType
Source§impl SubAssign for MetaCharType
impl SubAssign for MetaCharType
Source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
Source§impl UpperHex for MetaCharType
impl UpperHex for MetaCharType
impl Copy for MetaCharType
impl Eq for MetaCharType
impl StructuralPartialEq for MetaCharType
Auto Trait Implementations§
impl Freeze for MetaCharType
impl RefUnwindSafe for MetaCharType
impl Send for MetaCharType
impl Sync for MetaCharType
impl Unpin for MetaCharType
impl UnwindSafe for MetaCharType
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
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)