Struct rustpostal::expand::StringOptions
source · [−]pub struct StringOptions { /* private fields */ }
Expand description
Bit set of active string options.
Implementations
sourceimpl StringOptions
impl StringOptions
pub const TRANSLITERATE: Self
pub const STRIP_ACCENTS: Self
pub const DECOMPOSE: Self
pub const LOWERCASE: Self
pub const TRIM_STRING: Self
pub const DROP_PARENTHETICALS: Self
pub const REPLACE_NUMERIC_HYPHENS: Self
pub const DELETE_NUMERIC_HYPHENS: Self
pub const SPLIT_ALPHA_FROM_NUMERIC: Self
pub const REPLACE_WORD_HYPHENS: Self
pub const DELETE_WORD_HYPHENS: Self
pub const DELETE_FINAL_PERIODS: Self
pub const DELETE_ACRONYM_PERIODS: Self
pub const DROP_ENGLISH_POSSESSIVES: Self
pub const DELETE_APOSTROPHES: Self
pub const EXPAND_NUMEX: Self
pub const ROMAN_NUMERALS: Self
pub const LATIN_ASCII: 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
sourceimpl Binary for StringOptions
impl Binary for StringOptions
sourceimpl BitAnd<StringOptions> for StringOptions
impl BitAnd<StringOptions> for StringOptions
sourceimpl BitAndAssign<StringOptions> for StringOptions
impl BitAndAssign<StringOptions> for StringOptions
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<StringOptions> for StringOptions
impl BitOr<StringOptions> for StringOptions
sourcefn bitor(self, other: StringOptions) -> Self
fn bitor(self, other: StringOptions) -> Self
Returns the union of the two sets of flags.
type Output = Self
type Output = Self
The resulting type after applying the |
operator.
sourceimpl BitOrAssign<StringOptions> for StringOptions
impl BitOrAssign<StringOptions> for StringOptions
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<StringOptions> for StringOptions
impl BitXor<StringOptions> for StringOptions
sourceimpl BitXorAssign<StringOptions> for StringOptions
impl BitXorAssign<StringOptions> for StringOptions
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for StringOptions
impl Clone for StringOptions
sourcefn clone(&self) -> StringOptions
fn clone(&self) -> StringOptions
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 StringOptions
impl Debug for StringOptions
sourceimpl Default for StringOptions
impl Default for StringOptions
sourcefn default() -> StringOptions
fn default() -> StringOptions
Returns the “default value” for a type. Read more
sourceimpl Extend<StringOptions> for StringOptions
impl Extend<StringOptions> for StringOptions
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<StringOptions> for StringOptions
impl FromIterator<StringOptions> for StringOptions
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 StringOptions
impl Hash for StringOptions
sourceimpl LowerHex for StringOptions
impl LowerHex for StringOptions
sourceimpl Not for StringOptions
impl Not for StringOptions
sourceimpl Octal for StringOptions
impl Octal for StringOptions
sourceimpl Ord for StringOptions
impl Ord for StringOptions
sourceimpl PartialEq<StringOptions> for StringOptions
impl PartialEq<StringOptions> for StringOptions
sourcefn eq(&self, other: &StringOptions) -> bool
fn eq(&self, other: &StringOptions) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &StringOptions) -> bool
fn ne(&self, other: &StringOptions) -> bool
This method tests for !=
.
sourceimpl PartialOrd<StringOptions> for StringOptions
impl PartialOrd<StringOptions> for StringOptions
sourcefn partial_cmp(&self, other: &StringOptions) -> Option<Ordering>
fn partial_cmp(&self, other: &StringOptions) -> 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<StringOptions> for StringOptions
impl Sub<StringOptions> for StringOptions
sourceimpl SubAssign<StringOptions> for StringOptions
impl SubAssign<StringOptions> for StringOptions
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
sourceimpl UpperHex for StringOptions
impl UpperHex for StringOptions
impl Copy for StringOptions
impl Eq for StringOptions
impl StructuralEq for StringOptions
impl StructuralPartialEq for StringOptions
Auto Trait Implementations
impl RefUnwindSafe for StringOptions
impl Send for StringOptions
impl Sync for StringOptions
impl Unpin for StringOptions
impl UnwindSafe for StringOptions
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
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more