Struct regex::bytes::CaptureLocations

source ·
pub struct CaptureLocations(/* private fields */);
Expand description

A low level representation of the byte offsets of each capture group.

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 haystack that these offsets were matched on.

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

In order to build a value of this type, you’ll need to call the Regex::capture_locations method. The value returned can then be reused in subsequent searches for that regex. Using it for other regexes may result in a panic or otherwise incorrect results.

§Example

This example shows how to create and use CaptureLocations in a search.

use regex::bytes::Regex;

let re = Regex::new(r"(?<first>\w+)\s+(?<last>\w+)").unwrap();
let mut locs = re.capture_locations();
let m = re.captures_read(&mut locs, b"Bruce Springsteen").unwrap();
assert_eq!(0..17, m.range());
assert_eq!(Some((0, 17)), locs.get(0));
assert_eq!(Some((0, 5)), locs.get(1));
assert_eq!(Some((6, 17)), locs.get(2));

// Asking for an invalid capture group always returns None.
assert_eq!(None, locs.get(3));
assert_eq!(None, locs.get(34973498648));
assert_eq!(None, locs.get(9944060567225171988));

Implementations§

source§

impl CaptureLocations

source

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

Returns the start and end byte offsets of the capture group at index i. This returns None if i is not a valid capture group or if the capture group did not match.

§Example
use regex::bytes::Regex;

let re = Regex::new(r"(?<first>\w+)\s+(?<last>\w+)").unwrap();
let mut locs = re.capture_locations();
re.captures_read(&mut locs, b"Bruce Springsteen").unwrap();
assert_eq!(Some((0, 17)), locs.get(0));
assert_eq!(Some((0, 5)), locs.get(1));
assert_eq!(Some((6, 17)), locs.get(2));
source

pub fn len(&self) -> usize

Returns the total number of capture groups (even if they didn’t match). That is, the length returned is unaffected by the result of a search.

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

§Example
use regex::bytes::Regex;

let re = Regex::new(r"(?<first>\w+)\s+(?<last>\w+)").unwrap();
let mut locs = re.capture_locations();
assert_eq!(3, locs.len());
re.captures_read(&mut locs, b"Bruce Springsteen").unwrap();
assert_eq!(3, locs.len());

Notice that the length is always at least 1, regardless of the regex:

use regex::bytes::Regex;

let re = Regex::new(r"").unwrap();
let locs = re.capture_locations();
assert_eq!(1, locs.len());

// [a&&b] is a regex that never matches anything.
let re = Regex::new(r"[a&&b]").unwrap();
let locs = re.capture_locations();
assert_eq!(1, locs.len());

Trait Implementations§

source§

impl Clone for CaptureLocations

source§

fn clone(&self) -> CaptureLocations

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for CaptureLocations

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

source§

fn into(self) -> U

Calls U::from(self).

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

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

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.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.