Struct grep_matcher::Match

pub struct Match { /* fields omitted */ }

The type of a match.

The type of a match is a possibly empty range pointing to a contiguous block of addressable memory.

Every Match is guaranteed to satisfy the invariant that start <= end.

Indexing

This type is structurally identical to std::ops::Range<usize>, but is a bit more ergonomic for dealing with match indices. In particular, this type implements Copy and provides methods for building new Match values based on old Match values. Finally, the invariant that start is always less than or equal to end is enforced.

A Match can be used to slice a &[u8], &mut [u8] or &str using range notation. e.g.,

use grep_matcher::Match;

let m = Match::new(2, 5);
let bytes = b"abcdefghi";
assert_eq!(b"cde", &bytes[m]);

Methods

impl Match

pub fn new(start: usize, end: usize) -> Match

Create a new match.

Panics

This function panics if start > end.

pub fn zero(offset: usize) -> Match

Creates a zero width match at the given offset.

pub fn start(&self) -> usize

Return the start offset of this match.

pub fn end(&self) -> usize

Return the end offset of this match.

pub fn with_start(&self, start: usize) -> Match

Return a new match with the start offset replaced with the given value.

Panics

This method panics if start > self.end.

pub fn with_end(&self, end: usize) -> Match

Return a new match with the end offset replaced with the given value.

Panics

This method panics if self.start > end.

pub fn offset(&self, amount: usize) -> Match

Offset this match by the given amount and return a new match.

This adds the given offset to the start and end of this match, and returns the resulting match.

Panics

This panics if adding the given amount to either the start or end offset would result in an overflow.

pub fn len(&self) -> usize

Returns the number of bytes in this match.

pub fn is_empty(&self) -> bool

Returns true if and only if this match is empty.

Trait Implementations

impl Clone for Match

fn clone(&self) -> Match

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Match

impl Debug for Match

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

Formats the value using the given formatter.

impl Eq for Match

impl Hash for Match

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where     H: Hasher,

Feeds a slice of this type into the given [Hasher].

impl PartialEq for Match

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

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

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

This method tests for !=.

impl Index<Match> for [u8]

type Output = [u8]

The returned type after indexing.

fn index(&self, index: Match) -> &[u8]

Performs the indexing (container[index]) operation.

impl IndexMut<Match> for [u8]

fn index_mut(&mut self, index: Match) -> &mut [u8]

Performs the mutable indexing (container[index]) operation.

impl Index<Match> for str

type Output = str

The returned type after indexing.

fn index(&self, index: Match) -> &str

Performs the indexing (container[index]) operation.