Struct State

pub struct State { /* private fields */ }

Container for Ruby VM-level Regexp engine state.

Using Regexps in Ruby code can set regexp global variables:

• $~ is equivalent to Regexp.last_match.
• $& contains the complete matched text.
• $` contains string before match.
• $' contains string after match.
• $1, $2 and so on contain text matching first, second, etc capture group.
• $+ contains last capture group.

This struct is used by the implementation of Regexp in Artichoke’s Ruby Core to track this global state.

Implementations

impl State

pub const fn new() -> Self

Constructs a new, empty Regexp state.

Examples

use spinoso_regexp::State;
let state = State::new();

pub fn clear(&mut self)

Reset the state to empty.

Examples

use spinoso_regexp::State;
let mut state = State::new();
state.clear();

pub const fn capture_group_globals(&self) -> usize

Retrieve the count of currently active Regexp capture group globals.

This count is used to track how many $1, $2, etc. variables are set to non-nil values.

Examples

use spinoso_regexp::State;

let mut state = State::new();
assert_eq!(state.capture_group_globals(), 0);

state.set_capture_group_globals(7);
assert_eq!(state.capture_group_globals(), 7);

pub fn set_capture_group_globals(&mut self, count: usize)

Set the count of currently active Regexp capture group globals.

This count is used to track how many $1, $2, etc. variables are set to non-nil values.

Examples

use spinoso_regexp::State;

let mut state = State::new();
assert_eq!(state.capture_group_globals(), 0);

state.set_capture_group_globals(7);
assert_eq!(state.capture_group_globals(), 7);

Trait Implementations

impl Clone for State

fn clone(&self) -> State

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for State

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

Formats the value using the given formatter.

impl Default for State

fn default() -> State

Returns the “default value” for a type.

impl Hash for State

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 State

fn cmp(&self, other: &State) -> 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 State

fn eq(&self, other: &State) -> 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 State

fn partial_cmp(&self, other: &State) -> 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 Eq for State

impl StructuralPartialEq for State