pub struct FindOptions { /* private fields */ }
Implementations§
Source§impl FindOptions
impl FindOptions
pub const NONE: Self
pub const CASE_INSENSITIVE: Self
pub const AT_WORD_STARTS: Self
pub const TREAT_MEDIAL_CAPITAL_AS_WORD_START: Self
pub const BACKWARDS: Self
pub const WRAP_AROUND: Self
Sourcepub const fn from_bits(bits: u32) -> Option<Self>
pub const fn from_bits(bits: u32) -> 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: u32) -> Self
pub const fn from_bits_truncate(bits: u32) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
Sourcepub const unsafe fn from_bits_unchecked(bits: u32) -> Self
pub const unsafe fn from_bits_unchecked(bits: u32) -> 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 FindOptions
impl Binary for FindOptions
Source§impl BitAnd for FindOptions
impl BitAnd for FindOptions
Source§impl BitAndAssign for FindOptions
impl BitAndAssign for FindOptions
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 FindOptions
impl BitOr for FindOptions
Source§fn bitor(self, other: FindOptions) -> Self
fn bitor(self, other: FindOptions) -> Self
Returns the union of the two sets of flags.
Source§type Output = FindOptions
type Output = FindOptions
|
operator.Source§impl BitOrAssign for FindOptions
impl BitOrAssign for FindOptions
Source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
Source§impl BitXor for FindOptions
impl BitXor for FindOptions
Source§impl BitXorAssign for FindOptions
impl BitXorAssign for FindOptions
Source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
Source§impl Clone for FindOptions
impl Clone for FindOptions
Source§fn clone(&self) -> FindOptions
fn clone(&self) -> FindOptions
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for FindOptions
impl Debug for FindOptions
Source§impl Display for FindOptions
impl Display for FindOptions
Source§impl Extend<FindOptions> for FindOptions
impl Extend<FindOptions> for FindOptions
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<FindOptions> for FindOptions
impl FromIterator<FindOptions> for FindOptions
Source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
Source§impl<'a> FromValue<'a> for FindOptions
impl<'a> FromValue<'a> for FindOptions
Source§type Checker = GenericValueTypeChecker<FindOptions>
type Checker = GenericValueTypeChecker<FindOptions>
Source§unsafe fn from_value(value: &'a Value) -> Self
unsafe fn from_value(value: &'a Value) -> Self
Value
. Read moreSource§impl Hash for FindOptions
impl Hash for FindOptions
Source§impl LowerHex for FindOptions
impl LowerHex for FindOptions
Source§impl Not for FindOptions
impl Not for FindOptions
Source§impl Octal for FindOptions
impl Octal for FindOptions
Source§impl Ord for FindOptions
impl Ord for FindOptions
Source§fn cmp(&self, other: &FindOptions) -> Ordering
fn cmp(&self, other: &FindOptions) -> 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 FindOptions
impl PartialEq for FindOptions
Source§impl PartialOrd for FindOptions
impl PartialOrd for FindOptions
Source§impl StaticType for FindOptions
impl StaticType for FindOptions
Source§fn static_type() -> Type
fn static_type() -> Type
Self
.Source§impl Sub for FindOptions
impl Sub for FindOptions
Source§impl SubAssign for FindOptions
impl SubAssign for FindOptions
Source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
Source§impl ToValue for FindOptions
impl ToValue for FindOptions
Source§impl UpperHex for FindOptions
impl UpperHex for FindOptions
Source§impl ValueType for FindOptions
impl ValueType for FindOptions
Source§type Type = FindOptions
type Type = FindOptions
Type
from. Read moreimpl Copy for FindOptions
impl Eq for FindOptions
impl StructuralPartialEq for FindOptions
Auto Trait Implementations§
impl Freeze for FindOptions
impl RefUnwindSafe for FindOptions
impl Send for FindOptions
impl Sync for FindOptions
impl Unpin for FindOptions
impl UnwindSafe for FindOptions
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§impl<T> ToSendValue for T
impl<T> ToSendValue for T
Source§fn to_send_value(&self) -> SendValue
fn to_send_value(&self) -> SendValue
SendValue
clone of self
.