Struct regex::CaptureLocations

source ·
pub struct CaptureLocations(_);
Expand description

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.

Implementations§

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.

Returns the total number of capture groups (even if they didn’t match).

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

Trait Implementations§

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.