Struct onig::RegexOptions
source · [−]pub struct RegexOptions { /* private fields */ }
Expand description
Regex parsing and compilation options.
Implementations
sourceimpl RegexOptions
impl RegexOptions
sourcepub const REGEX_OPTION_NONE: Self = _
pub const REGEX_OPTION_NONE: Self = _
Default options.
sourcepub const REGEX_OPTION_IGNORECASE: Self = _
pub const REGEX_OPTION_IGNORECASE: Self = _
Ambiguity match on.
sourcepub const REGEX_OPTION_EXTEND: Self = _
pub const REGEX_OPTION_EXTEND: Self = _
Extended pattern form.
sourcepub const REGEX_OPTION_MULTILINE: Self = _
pub const REGEX_OPTION_MULTILINE: Self = _
'.'
match with newline.
sourcepub const REGEX_OPTION_SINGLELINE: Self = _
pub const REGEX_OPTION_SINGLELINE: Self = _
'^'
-> '\A'
, '$'
-> '\Z'
.
sourcepub const REGEX_OPTION_FIND_LONGEST: Self = _
pub const REGEX_OPTION_FIND_LONGEST: Self = _
Find longest match.
sourcepub const REGEX_OPTION_FIND_NOT_EMPTY: Self = _
pub const REGEX_OPTION_FIND_NOT_EMPTY: Self = _
Ignore empty match.
sourcepub const REGEX_OPTION_NEGATE_SINGLELINE: Self = _
pub const REGEX_OPTION_NEGATE_SINGLELINE: Self = _
Clear OPTION_SINGLELINE
which is enabled on
SYNTAX_POSIX_BASIC
, SYNTAX_POSIX_EXTENDED
,
SYNTAX_PERL
, SYNTAX_PERL_NG
, SYNTAX_JAVA
.
sourcepub const REGEX_OPTION_DONT_CAPTURE_GROUP: Self = _
pub const REGEX_OPTION_DONT_CAPTURE_GROUP: Self = _
Only named group captured.
sourcepub const REGEX_OPTION_CAPTURE_GROUP: Self = _
pub const REGEX_OPTION_CAPTURE_GROUP: Self = _
Named and no-named group captured.
sourcepub const fn bits(&self) -> OnigOptionType
pub const fn bits(&self) -> OnigOptionType
Returns the raw value of the flags currently stored.
sourcepub const fn from_bits(bits: OnigOptionType) -> Option<Self>
pub const fn from_bits(bits: OnigOptionType) -> 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: OnigOptionType) -> Self
pub const fn from_bits_truncate(bits: OnigOptionType) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: OnigOptionType) -> Self
pub const unsafe fn from_bits_unchecked(bits: OnigOptionType) -> 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 RegexOptions
impl Binary for RegexOptions
sourceimpl BitAnd<RegexOptions> for RegexOptions
impl BitAnd<RegexOptions> for RegexOptions
type Output = RegexOptions
type Output = RegexOptions
The resulting type after applying the &
operator.
sourceimpl BitAndAssign<RegexOptions> for RegexOptions
impl BitAndAssign<RegexOptions> for RegexOptions
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<RegexOptions> for RegexOptions
impl BitOr<RegexOptions> for RegexOptions
sourcefn bitor(self, other: RegexOptions) -> Self
fn bitor(self, other: RegexOptions) -> Self
Returns the union of the two sets of flags.
type Output = RegexOptions
type Output = RegexOptions
The resulting type after applying the |
operator.
sourceimpl BitOrAssign<RegexOptions> for RegexOptions
impl BitOrAssign<RegexOptions> for RegexOptions
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<RegexOptions> for RegexOptions
impl BitXor<RegexOptions> for RegexOptions
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 = RegexOptions
type Output = RegexOptions
The resulting type after applying the ^
operator.
sourceimpl BitXorAssign<RegexOptions> for RegexOptions
impl BitXorAssign<RegexOptions> for RegexOptions
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for RegexOptions
impl Clone for RegexOptions
sourcefn clone(&self) -> RegexOptions
fn clone(&self) -> RegexOptions
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 RegexOptions
impl Debug for RegexOptions
sourceimpl Extend<RegexOptions> for RegexOptions
impl Extend<RegexOptions> for RegexOptions
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<RegexOptions> for RegexOptions
impl FromIterator<RegexOptions> for RegexOptions
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 RegexOptions
impl Hash for RegexOptions
sourceimpl LowerHex for RegexOptions
impl LowerHex for RegexOptions
sourceimpl Not for RegexOptions
impl Not for RegexOptions
type Output = RegexOptions
type Output = RegexOptions
The resulting type after applying the !
operator.
sourceimpl Octal for RegexOptions
impl Octal for RegexOptions
sourceimpl Ord for RegexOptions
impl Ord for RegexOptions
sourcefn cmp(&self, other: &RegexOptions) -> Ordering
fn cmp(&self, other: &RegexOptions) -> 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<RegexOptions> for RegexOptions
impl PartialEq<RegexOptions> for RegexOptions
sourcefn eq(&self, other: &RegexOptions) -> bool
fn eq(&self, other: &RegexOptions) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &RegexOptions) -> bool
fn ne(&self, other: &RegexOptions) -> bool
This method tests for !=
.
sourceimpl PartialOrd<RegexOptions> for RegexOptions
impl PartialOrd<RegexOptions> for RegexOptions
sourcefn partial_cmp(&self, other: &RegexOptions) -> Option<Ordering>
fn partial_cmp(&self, other: &RegexOptions) -> 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<RegexOptions> for RegexOptions
impl Sub<RegexOptions> for RegexOptions
type Output = RegexOptions
type Output = RegexOptions
The resulting type after applying the -
operator.
sourceimpl SubAssign<RegexOptions> for RegexOptions
impl SubAssign<RegexOptions> for RegexOptions
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
sourceimpl UpperHex for RegexOptions
impl UpperHex for RegexOptions
impl Copy for RegexOptions
impl Eq for RegexOptions
impl StructuralEq for RegexOptions
impl StructuralPartialEq for RegexOptions
Auto Trait Implementations
impl RefUnwindSafe for RegexOptions
impl Send for RegexOptions
impl Sync for RegexOptions
impl Unpin for RegexOptions
impl UnwindSafe for RegexOptions
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