Struct grep_regex::RegexMatcher

pub struct RegexMatcher { /* fields omitted */ }

An implementation of the Matcher trait using Rust’s standard regex library.

Implementations

impl RegexMatcher

pub fn new(pattern: &str) -> Result<RegexMatcher, Error>

Create a new matcher from the given pattern using the default configuration.

pub fn new_line_matcher(pattern: &str) -> Result<RegexMatcher, Error>

Create a new matcher from the given pattern using the default configuration, but matches lines terminated by \n.

This is meant to be a convenience constructor for using a RegexMatcherBuilder and setting its line_terminator to \n. The purpose of using this constructor is to permit special optimizations that help speed up line oriented search. These types of optimizations are only appropriate when matches span no more than one line. For this reason, this constructor will return an error if the given pattern contains a literal \n. Other uses of \n (such as in \s) are removed transparently.

Trait Implementations

impl Clone for RegexMatcher

fn clone(&self) -> RegexMatcher

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RegexMatcher

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

Formats the value using the given formatter.

impl Matcher for RegexMatcher

type Captures = RegexCaptures

The concrete type of capturing groups used for this matcher.

type Error = NoError

The error type used by this matcher.

fn find_at(&self, haystack: &[u8], at: usize) -> Result<Option<Match>, NoError>

Returns the start and end byte range of the first match in haystack after at, where the byte offsets are relative to that start of haystack (and not at). If no match exists, then None is returned.

fn new_captures(&self) -> Result<RegexCaptures, NoError>

Creates an empty group of captures suitable for use with the capturing APIs of this trait.

fn capture_count(&self) -> usize

Returns the total number of capturing groups in this matcher.

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

Maps the given capture group name to its corresponding capture group index, if one exists. If one does not exist, then None is returned.

fn find(&self, haystack: &[u8]) -> Result<Option<Match>, NoError>

Returns the start and end byte range of the first match in haystack. If no match exists, then None is returned.

fn find_iter<F>(&self, haystack: &[u8], matched: F) -> Result<(), NoError> where
    F: FnMut(Match) -> bool, 

Executes the given function over successive non-overlapping matches in haystack. If no match exists, then the given function is never called. If the function returns false, then iteration stops.

fn try_find_iter<F, E>(
    &self,
    haystack: &[u8],
    matched: F
) -> Result<Result<(), E>, NoError> where
    F: FnMut(Match) -> Result<bool, E>, 

Executes the given function over successive non-overlapping matches in haystack. If no match exists, then the given function is never called. If the function returns false, then iteration stops. Similarly, if the function returns an error then iteration stops and the error is yielded. If an error occurs while executing the search, then it is converted to E.

fn captures(
    &self,
    haystack: &[u8],
    caps: &mut RegexCaptures
) -> Result<bool, NoError>

Populates the first set of capture group matches from haystack into caps. If no match exists, then false is returned.

fn captures_iter<F>(
    &self,
    haystack: &[u8],
    caps: &mut RegexCaptures,
    matched: F
) -> Result<(), NoError> where
    F: FnMut(&RegexCaptures) -> bool, 

Executes the given function over successive non-overlapping matches in haystack with capture groups extracted from each match. If no match exists, then the given function is never called. If the function returns false, then iteration stops.

fn try_captures_iter<F, E>(
    &self,
    haystack: &[u8],
    caps: &mut RegexCaptures,
    matched: F
) -> Result<Result<(), E>, NoError> where
    F: FnMut(&RegexCaptures) -> Result<bool, E>, 

Executes the given function over successive non-overlapping matches in haystack with capture groups extracted from each match. If no match exists, then the given function is never called. If the function returns false, then iteration stops. Similarly, if the function returns an error then iteration stops and the error is yielded. If an error occurs while executing the search, then it is converted to E.

fn captures_at(
    &self,
    haystack: &[u8],
    at: usize,
    caps: &mut RegexCaptures
) -> Result<bool, NoError>

Populates the first set of capture group matches from haystack into matches after at, where the byte offsets in each capturing group are relative to the start of haystack (and not at). If no match exists, then false is returned and the contents of the given capturing groups are unspecified.

fn replace<F>(
    &self,
    haystack: &[u8],
    dst: &mut Vec<u8>,
    append: F
) -> Result<(), NoError> where
    F: FnMut(Match, &mut Vec<u8>) -> bool, 

Replaces every match in the given haystack with the result of calling append. append is given the start and end of a match, along with a handle to the dst buffer provided.

fn replace_with_captures<F>(
    &self,
    haystack: &[u8],
    caps: &mut RegexCaptures,
    dst: &mut Vec<u8>,
    append: F
) -> Result<(), NoError> where
    F: FnMut(&Self::Captures, &mut Vec<u8>) -> bool, 

Replaces every match in the given haystack with the result of calling append with the matching capture groups.

fn is_match(&self, haystack: &[u8]) -> Result<bool, NoError>

Returns true if and only if the matcher matches the given haystack.

fn is_match_at(&self, haystack: &[u8], at: usize) -> Result<bool, NoError>

Returns true if and only if the matcher matches the given haystack starting at the given position.

fn shortest_match(&self, haystack: &[u8]) -> Result<Option<usize>, NoError>

Returns an end location of the first match in haystack. If no match exists, then None is returned.

fn shortest_match_at(
    &self,
    haystack: &[u8],
    at: usize
) -> Result<Option<usize>, NoError>

Returns an end location of the first match in haystack starting at the given position. If no match exists, then None is returned.

fn non_matching_bytes(&self) -> Option<&ByteSet>

If available, return a set of bytes that will never appear in a match produced by an implementation.

fn line_terminator(&self) -> Option<LineTerminator>

If this matcher was compiled as a line oriented matcher, then this method returns the line terminator if and only if the line terminator never appears in any match produced by this matcher. If this wasn’t compiled as a line oriented matcher, or if the aforementioned guarantee cannot be made, then this must return None, which is the default. It is never wrong to return None, but returning a line terminator when it can appear in a match results in unspecified behavior.

fn find_candidate_line(
    &self,
    haystack: &[u8]
) -> Result<Option<LineMatchKind>, NoError>

Return one of the following: a confirmed line match, a candidate line match (which may be a false positive) or no match at all (which must not be a false negative). When reporting a confirmed or candidate match, the position returned can be any position in the line.

fn find_iter_at<F>(
    &self,
    haystack: &[u8],
    at: usize,
    matched: F
) -> Result<(), Self::Error> where
    F: FnMut(Match) -> bool, 

Executes the given function over successive non-overlapping matches in haystack. If no match exists, then the given function is never called. If the function returns false, then iteration stops.

fn try_find_iter_at<F, E>(
    &self,
    haystack: &[u8],
    at: usize,
    matched: F
) -> Result<Result<(), E>, Self::Error> where
    F: FnMut(Match) -> Result<bool, E>, 

Executes the given function over successive non-overlapping matches in haystack. If no match exists, then the given function is never called. If the function returns false, then iteration stops. Similarly, if the function returns an error then iteration stops and the error is yielded. If an error occurs while executing the search, then it is converted to E.

fn captures_iter_at<F>(
    &self,
    haystack: &[u8],
    at: usize,
    caps: &mut Self::Captures,
    matched: F
) -> Result<(), Self::Error> where
    F: FnMut(&Self::Captures) -> bool, 

Executes the given function over successive non-overlapping matches in haystack with capture groups extracted from each match. If no match exists, then the given function is never called. If the function returns false, then iteration stops.

fn try_captures_iter_at<F, E>(
    &self,
    haystack: &[u8],
    at: usize,
    caps: &mut Self::Captures,
    matched: F
) -> Result<Result<(), E>, Self::Error> where
    F: FnMut(&Self::Captures) -> Result<bool, E>, 

Executes the given function over successive non-overlapping matches in haystack with capture groups extracted from each match. If no match exists, then the given function is never called. If the function returns false, then iteration stops. Similarly, if the function returns an error then iteration stops and the error is yielded. If an error occurs while executing the search, then it is converted to E.

fn replace_with_captures_at<F>(
    &self,
    haystack: &[u8],
    at: usize,
    caps: &mut Self::Captures,
    dst: &mut Vec<u8, Global>,
    append: F
) -> Result<(), Self::Error> where
    F: FnMut(&Self::Captures, &mut Vec<u8, Global>) -> bool, 

Replaces every match in the given haystack with the result of calling append with the matching capture groups.