Struct regex::CaptureLocations[][src]

pub struct CaptureLocations(_);

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

You can think of this as a lower level Captures, where this type does not support named capturing groups directly and it does not borrow the text that these offsets were matched on.

Primarily, this type is useful when using the lower level Regex APIs such as read_captures, 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.


impl CaptureLocations[src]

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

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.

pub fn len(&self) -> usize[src]

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[src]

impl Debug for CaptureLocations[src]

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized

impl<T> Borrow<T> for T where
    T: ?Sized

impl<T> BorrowMut<T> for T where
    T: ?Sized

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 

impl<T> ToOwned for T where
    T: Clone

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.