Struct pcre2::bytes::CaptureLocations

pub struct CaptureLocations { /* fields omitted */ }

CaptureLocations is a low level representation of the raw offsets of each submatch.

Primarily, this type is useful when using Regex APIs such as captures_read, which permits amortizing the allocation in which capture match locations are stored.

In order to build a value of this type, you'll need to call the capture_locations method on the Regex being used to execute the search. The value returned can then be reused in subsequent searches.

Methods

impl CaptureLocations

pub fn get(&self, i: usize) -> Option<(usize, usize)>

Returns the start and end positions of the Nth capture group.

This 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 subject string matched.

pub fn len(&self) -> usize

Returns the total number of capturing groups.

This is always at least 1 since every regex has at least 1 capturing group that corresponds to the entire match.

Trait Implementations

impl Clone for CaptureLocations

fn clone(&self) -> CaptureLocations

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CaptureLocations

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

Formats the value using the given formatter.