Struct avocado::literal::RegexOpts

pub struct RegexOpts { /* fields omitted */ }

Options for matching text against a regular expression. Useful with the $regex operator. E.g.:

let query = doc!{
    "name": {
        "$regex": "^Foo",
        "$options": RegexOpts::LINE_ANCHOR | RegexOpts::IGNORE_CASE,
    },
    "address": {
        "$regex": ".* street$",
        "$options": RegexOpts::default(),
    },
};
assert_eq!(query, doc!{
    "name": {
        "$regex": "^Foo",
        "$options": "im",
    },
    "address": {
        "$regex": ".* street$",
        "$options": "",
    },
});

Methods

impl RegexOpts

pub const IGNORE_CASE: RegexOpts

Case insensitive matching.

pub const LINE_ANCHOR: RegexOpts

^ and $ match the beginning and the end of lines, not the whole string.

pub const EXTENDED: RegexOpts

"extended" syntax, allows embedded whitespace and #-comments

pub const DOT_NEWLINE: RegexOpts

The . character matches newlines too.

pub const fn empty() -> RegexOpts

Returns an empty set of flags

pub const fn all() -> RegexOpts

Returns the set containing all flags.

pub const fn bits(&self) -> u8

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u8) -> Option<RegexOpts>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u8) -> RegexOpts

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: RegexOpts) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: RegexOpts) -> bool

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: RegexOpts)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: RegexOpts)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: RegexOpts)

Toggles the specified flags in-place.

pub fn set(&mut self, other: RegexOpts, value: bool)

Inserts or removes the specified flags depending on the passed value.

Trait Implementations

impl PartialOrd<RegexOpts> for RegexOpts

fn partial_cmp(&self, other: &RegexOpts) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &RegexOpts) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &RegexOpts) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &RegexOpts) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &RegexOpts) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialEq<RegexOpts> for RegexOpts

fn eq(&self, other: &RegexOpts) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &RegexOpts) -> bool

This method tests for !=.

impl Copy for RegexOpts

impl Ord for RegexOpts

fn cmp(&self, other: &RegexOpts) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl Eq for RegexOpts

impl Extend<RegexOpts> for RegexOpts

fn extend<T: IntoIterator<Item = RegexOpts>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

impl Default for RegexOpts

fn default() -> RegexOpts

Returns the "default value" for a type.

impl From<RegexOpts> for Bson

See the explanation for BsonType as to why this impl is possible.

fn from(options: RegexOpts) -> Self

Performs the conversion.

impl Clone for RegexOpts

fn clone(&self) -> RegexOpts

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Hash for RegexOpts

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Sub<RegexOpts> for RegexOpts

type Output = RegexOpts

The resulting type after applying the - operator.

fn sub(self, other: RegexOpts) -> RegexOpts

Returns the set difference of the two sets of flags.

impl SubAssign<RegexOpts> for RegexOpts

fn sub_assign(&mut self, other: RegexOpts)

Disables all flags enabled in the set.

impl Not for RegexOpts

type Output = RegexOpts

The resulting type after applying the ! operator.

fn not(self) -> RegexOpts

Returns the complement of this set of flags.

impl BitAnd<RegexOpts> for RegexOpts

type Output = RegexOpts

The resulting type after applying the & operator.

fn bitand(self, other: RegexOpts) -> RegexOpts

Returns the intersection between the two sets of flags.

impl BitOr<RegexOpts> for RegexOpts

type Output = RegexOpts

The resulting type after applying the | operator.

fn bitor(self, other: RegexOpts) -> RegexOpts

Returns the union of the two sets of flags.

impl BitXor<RegexOpts> for RegexOpts

type Output = RegexOpts

The resulting type after applying the ^ operator.

fn bitxor(self, other: RegexOpts) -> RegexOpts

Returns the left flags, but with all the right flags toggled.

impl BitAndAssign<RegexOpts> for RegexOpts

fn bitand_assign(&mut self, other: RegexOpts)

Disables all flags disabled in the set.

impl BitOrAssign<RegexOpts> for RegexOpts

fn bitor_assign(&mut self, other: RegexOpts)

Adds the set of flags.

impl BitXorAssign<RegexOpts> for RegexOpts

fn bitxor_assign(&mut self, other: RegexOpts)

Toggles the set of flags.

impl Debug for RegexOpts

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl FromIterator<RegexOpts> for RegexOpts

fn from_iter<T: IntoIterator<Item = RegexOpts>>(iterator: T) -> RegexOpts

Creates a value from an iterator.

impl Octal for RegexOpts

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Binary for RegexOpts

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl LowerHex for RegexOpts

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl UpperHex for RegexOpts

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<'a> Deserialize<'a> for RegexOpts

fn deserialize<D: Deserializer<'a>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Serialize for RegexOpts

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.