Struct regex_syntax::ast::Group

pub struct Group {
    pub span: Span,
    pub kind: GroupKind,
    pub ast: Box<Ast>,
}

A grouped regular expression.

This includes both capturing and non-capturing groups. This does not include flag-only groups like (?is), but does contain any group that contains a sub-expression, e.g., (a), (?P<name>a), (?:a) and (?is:a).

Fields

span: Span

The span of this group.

kind: GroupKind

The kind of this group.

ast: Box<Ast>

The regular expression in this group.

Implementations

impl Group

pub fn flags(&self) -> Option<&Flags>

If this group is non-capturing, then this returns the (possibly empty) set of flags. Otherwise, None is returned.

pub fn is_capturing(&self) -> bool

Returns true if and only if this group is capturing.

pub fn capture_index(&self) -> Option<u32>

Returns the capture index of this group, if this is a capturing group.

This returns a capture index precisely when is_capturing is true.

Trait Implementations

impl Clone for Group

fn clone(&self) -> Group

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Group

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

Formats the value using the given formatter.

impl PartialEq for Group

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for Group

impl StructuralPartialEq for Group