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
sourceimpl CaptureLocations
impl CaptureLocations
sourcepub fn get(&self, i: usize) -> Option<(usize, usize)>
pub fn get(&self, i: 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.
Trait Implementations
sourceimpl Clone for CaptureLocations
impl Clone for CaptureLocations
sourcefn clone(&self) -> CaptureLocations
fn clone(&self) -> CaptureLocations
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
Auto Trait Implementations
impl RefUnwindSafe for CaptureLocations
impl Send for CaptureLocations
impl Sync for CaptureLocations
impl Unpin for CaptureLocations
impl UnwindSafe for CaptureLocations
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more