Struct onig::Captures

pub struct Captures<'t> { /* fields omitted */ }

Captures represents a group of captured strings for a single match.

The 0th capture always corresponds to the entire match. Each subsequent index corresponds to the next capture group in the regex. Positions returned from a capture group are always byte indices.

't is the lifetime of the matched text.

Methods

impl<'t> Captures<'t>

fn pos(&self, pos: usize) -> Option<(usize, usize)>

Returns the start and end positions of the Nth capture group. Returns None if i is not a valid capture group or if the capture group did not match anything. The positions returned are always byte indices with respect to the original string matched.

fn at(&self, pos: usize) -> Option<&'t str>

Returns the matched string for the capture group i. If i isn't a valid capture group or didn't match anything, then None is returned.

fn len(&self) -> usize

Returns the number of captured groups.

fn is_empty(&self) -> bool

Returns true if and only if there are no captured groups.

fn iter(&'t self) -> SubCaptures<'t>

Creates an iterator of all the capture groups in order of appearance in the regular expression.

fn iter_pos(&'t self) -> SubCapturesPos<'t>

Creates an iterator of all the capture group positions in order of appearance in the regular expression. Positions are byte indices in terms of the original string matched.

fn offset(&self) -> usize

Offset of the captures within the given string slice.

Trait Implementations

impl<'t> Debug for Captures<'t>

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

Formats the value using the given formatter.