Struct safe_regex::Matcher5

pub struct Matcher5<F> where
    F: for<'d> Fn(&'d [u8]) -> Option<(&'d [u8], &'d [u8], &'d [u8], &'d [u8], &'d [u8])>,  { /* fields omitted */ }

A compiled regular expression with 5 capturing groups.

This is a zero-length type. The regex! macro generates a Rust type that implements the regular expression. This struct holds that type.

Implementations

impl<F> Matcher5<F> where
    F: for<'d> Fn(&'d [u8]) -> Option<(&'d [u8], &'d [u8], &'d [u8], &'d [u8], &'d [u8])>, 

#[must_use]pub fn match_all<'d>(
    &self,
    data: &'d [u8]
) -> Option<(&'d [u8], &'d [u8], &'d [u8], &'d [u8], &'d [u8])>

Executes the regular expression against the byte string data.

Returns Some(T) if the expression matched all of the bytes in data. The value T is a tuple of captured group slices.

This is a whole-string match. For sub-string search, put .* at the beginning and end of the regex.

Returns None if the expression did not match data.

Example

use safe_regex::{regex, Matcher3};
let matcher: Matcher3<_> = regex!(br"([abc])([0-9]*)(suffix)?");
let (prefix, digits, suffix) = matcher.match_all(b"a42").unwrap();
assert_eq!(b"a", prefix);
assert_eq!(b"42", digits);
assert!(suffix.is_empty());

#[must_use]pub fn new(f: F) -> Self

This is used internally by the regex! macro.

Trait Implementations

impl<F> IsMatch for Matcher5<F> where
    F: for<'d> Fn(&'d [u8]) -> Option<(&'d [u8], &'d [u8], &'d [u8], &'d [u8], &'d [u8])>, 

#[must_use]fn is_match(&self, data: &[u8]) -> bool

Returns true if data matches the regular expression, otherwise returns false.