Struct Options

pub struct Options { /* private fields */ }

Configuration options for Ruby Regexps.

Options can be supplied either as an Integer object to Regexp::new or inline in Regexp literals like /artichoke/i.

Implementations

impl Options

pub const fn new() -> Self

Constructs a new, default Options.

pub const fn with_ignore_case() -> Self

An options instance that has only case insensitive mode enabled.

pub fn try_from_int(options: i64) -> Option<Self>

Try to parse an Options from a full-width i64.

If options cannot be converted losslessly to a u8, this function returns None. See From<u8>.

For a conversion from i64 that truncates the given options to u8, see From<i64>.

pub fn flags(self) -> Flags

Convert an Options to its bit flag representation.

Alias for the corresponding Into<Flags> implementation.

pub const fn into_bits(self) -> u8

Convert an Options to its bit representation.

Alias for the corresponding Into<u8> implementation.

pub const fn multiline(self) -> RegexpOption

Whether these Options are configured for multiline mode.

pub const fn ignore_case(self) -> RegexpOption

Whether these Options are configured for case-insensitive mode.

pub const fn extended(self) -> RegexpOption

Whether these Options are configured for extended mode with insignificant whitespace.

pub const fn is_literal(self) -> bool

Whether the Regexp was parsed as a literal, e.g. '/artichoke/i.

This enables Ruby parsers to inject whether a Regexp is a literal to the core library. Literal Regexps have some special behavior regarding capturing groups and report parse failures differently.

pub const fn as_display_modifier(self) -> &'static str

Serialize the option flags to a string suitable for a Regexp display or debug implementation.

See also Regexp#inspect.

pub const fn as_inline_modifier(self) -> &'static str

Serialize the option flags to a string suitable for including in a raw pattern for configuring an underlying Regexp.

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

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

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Options

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

Formats the value using the given formatter.

impl Default for Options

fn default() -> Options

Returns the “default value” for a type.

impl Display for Options

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

Formats the value using the given formatter.

impl From<&[u8]> for Options

fn from(options: &[u8]) -> Self

Converts to this type from the input type.

impl From<&str> for Options

fn from(options: &str) -> Self

Converts to this type from the input type.

impl From<Flags> for Options

fn from(flags: Flags) -> Self

Converts to this type from the input type.

impl From<Option<bool>> for Options

fn from(options: Option<bool>) -> Self

Converts to this type from the input type.

impl From<Options> for Flags

fn from(opts: Options) -> Self

Convert an Options to its bit flag representation.

impl From<Options> for RegexOptions

fn from(opts: Options) -> Self

Converts to this type from the input type.

impl From<Options> for i64

fn from(opts: Options) -> Self

Convert an Options to its widened bit representation.

impl From<Options> for u8

fn from(opts: Options) -> Self

Convert an Options to its bit representation.

impl From<String> for Options

fn from(options: String) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for Options

fn from(options: Vec<u8>) -> Self

Converts to this type from the input type.

impl From<i64> for Options

fn from(flags: i64) -> Self

Truncate the given i64 to one byte and generate flags.

See From<u8>. For a conversion that fails if the given i64 is larger than u8::MAX, see try_from_int.

impl From<u8> for Options

fn from(flags: u8) -> Self

Converts to this type from the input type.

impl Hash for Options

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Options

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Options

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Options

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for Options

impl Eq for Options

impl StructuralPartialEq for Options