Struct TaggedCaptures 

pub struct TaggedCaptures<'h, H>
where
    H: Sliceable + ?Sized,
{
    pub captures: Captures<'h, H>,
    pub action: Option<Action>,
}

Represents a tagged capture group for a single match position located by a Structex.

If an action was specified at the match point in the original Structex then action will contain that action, otherwise it will be None.

Fields

captures: Captures<'h, H>

The match and any captures extracted from it.

action: Option<Action>

An optional Action assigned by the match if one was specified in the Structex expression.

Implementations

impl<'h, H> TaggedCaptures<'h, H>

where H: Sliceable + ?Sized,

pub fn as_slice(&self) -> H::Slice<'_>

Returns the slice of the haystack that matched.

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

Returns the action id that was associated with the match if one was specified.

pub fn tag(&self) -> Option<char>

Returns the action tag that was associated with the match if one was specified.

pub fn arg(&self) -> Option<&str>

Returns the argument following the action tag that was associated with the match if one was specified.

pub fn has_action(&self) -> bool

Whether or not this match has an assigned Action.

Methods from Deref<Target = Captures<'h, H>>

pub fn from(&self) -> usize

The byte offset that this match starts at.

pub fn to(&self) -> usize

The byte offset that this match ends at.

pub fn get_match(&self) -> (usize, usize)

The start and end byte offsets of this match.

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

The start and end byte offsets of the given submatch.

Submatch 0 is guaranteed to be Some, with get_match available as a convenience method to directly access it. All other submatches may return None if they were not present in the matched pattern.

pub fn len(&self) -> usize

The length of the full match in bytes.

pub fn is_empty(&self) -> bool

Whether or not this match is equal to the empty string.

pub fn match_text(&self) -> H::Slice<'_>

The full text of the match in the original haystack.

pub fn submatch_text(&self, n: usize) -> Option<H::Slice<'_>>

The full text of the submatch, if present, in the original haystack.

pub fn iter_submatches(&self) -> impl Iterator<Item = Option<H::Slice<'_>>>

Iterate over all submatches starting with the full match.

Trait Implementations

impl<'h, H> Debug for TaggedCaptures<'h, H>

where H: Sliceable + ?Sized + Debug,

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

Formats the value using the given formatter.

impl<'h, H> Deref for TaggedCaptures<'h, H>

where H: Sliceable + ?Sized,

type Target = Captures<'h, H>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'h, H> PartialEq for TaggedCaptures<'h, H>

where H: Sliceable + ?Sized + PartialEq,

fn eq(&self, other: &TaggedCaptures<'h, H>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'h, H> Eq for TaggedCaptures<'h, H>

where H: Sliceable + ?Sized + Eq,

impl<'h, H> StructuralPartialEq for TaggedCaptures<'h, H>

where H: Sliceable + ?Sized,