Struct Region

pub struct Region { /* private fields */ }

Represents a set of capture groups found in a search or match.

Implementations

impl Region

pub fn new() -> Region

Create a new empty Region

pub fn with_capacity(capacity: usize) -> Region

Create a new region with a given capacity. This function allocates a new region object as in Region::new and resizes it to contain at least capacity regions.

Arguments

• capacity - the number of captures this region should be capable of storing without allocation.

pub unsafe fn clone_from_raw(ptr: *mut OnigRegion) -> Self

Clone From Raw

Construct a new region based on an existing raw *onig_sys::OnigRegion pointer by copying.

pub fn clear(&mut self)

This can be used to clear out a region so it can be used again. See onig_sys::onig_region_clear

pub fn capacity(&self) -> usize

Get the current capacity of the region.

pub fn reserve(&mut self, new_capacity: usize)

Updates the region to contain new_capacity slots. See onig_sys::onig_region_resize for mor information.

Arguments

• new_capacity - The new number of groups in the region.

pub fn len(&self) -> usize

Get the size of the region.

Returns the number of registers in the region.

pub fn is_empty(&self) -> bool

Check if the region is empty.

Returns true if there are no registers in the region.

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

Returns the start and end positions of the Nth capture group.

Returns None if pos 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.

pub fn tree(&self) -> Option<&CaptureTreeNode>

Get Capture Tree

Returns the capture tree for this region, if there is one.

pub fn iter(&self) -> RegionIter<'_>

Get an iterator over the captures in the region.

pub fn tree_traverse<F>(&self, callback: F) -> i32

where F: Fn(u32, (usize, usize), u32) -> bool,

Walk the Tree of Captures

The given callback is invoked for each node in the capture tree. Each node is passed to the callback before any children.

pub fn tree_traverse_at<F>(&self, at: TraverseCallbackAt, callback: F) -> i32

where F: Fn(u32, (usize, usize), u32) -> bool,

Walk the Tree of Captures in a Given Order

The given callback is invoked for each node in the capture tree. The order in which the callback is invoked can be chosen.

Trait Implementations

impl Clone for Region

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Region

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

Formats the value using the given formatter.

impl Default for Region

fn default() -> Self

Returns the “default value” for a type.

impl Drop for Region

fn drop(&mut self)

Executes the destructor for this type.

impl<'a> IntoIterator for &'a Region

type Item = (usize, usize)

The type of the elements being iterated over.

type IntoIter = RegionIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for Region

fn eq(&self, other: &Region) -> 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 Eq for Region

impl StructuralPartialEq for Region