Struct CaptureSlots 

pub struct CaptureSlots { /* private fields */ }

Where each register landed in one match, in a buffer sized by the pattern and refilled in place.

Built once with CaptureSlots::of and passed to captures_read or captures_read_at for each match. Slot order is the order the pattern binds its names, which is the order crate::capture_names reports; it is not the order crate::Match::captures uses, which is sorted by name.

A register the match did not bind reads back as None, which is what distinguishes it from one that bound an empty span.

Implementations

impl CaptureSlots

pub fn of(pattern: &Pattern) -> Self

A buffer shaped for pattern: one slot per name it binds.

pub fn len(&self) -> usize

How many registers the buffer holds.

pub fn is_empty(&self) -> bool

Whether the pattern binds nothing.

pub fn names(&self) -> &[String]

The register names, in slot order.

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

The name of slot i.

pub fn index_of(&self, name: &str) -> Option<usize>

The slot name occupies.

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

The byte span slot i bound, or None where it bound nothing.

pub fn by_name(&self, name: &str) -> Option<Span>

The byte span the register called name bound.

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

The significant tokens slot i bound, as a half-open index pair into the token stream.

The engine names a match by the token indices it runs between, so this is what it had before it converted to bytes. A byte matcher reports no such pair, because a byte offset does not say which token it is in.

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

How many significant tokens slot i bound.

pub fn matched(&self) -> Option<Span>

The span of the whole match the buffer was last filled from.

pub fn matched_extent(&self) -> Option<(usize, usize)>

The significant tokens the whole match spanned.

pub fn matched_tokens(&self) -> Option<usize>

How many significant tokens the whole match spanned.

pub fn clear(&mut self)

Forget every position, keeping the names and the allocation.

Trait Implementations

impl Clone for CaptureSlots

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CaptureSlots

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

Formats the value using the given formatter.

impl Default for CaptureSlots

fn default() -> Self

Returns the “default value” for a type.

impl Eq for CaptureSlots

impl PartialEq for CaptureSlots

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for CaptureSlots