Struct Matches

pub struct Matches<'a> { /* private fields */ }

The Matches represent matched results from a Pattern against a provided text.

Implementations

impl<'a> Matches<'a>

pub fn get(&self, name_or_alias: &str) -> Option<&str>

Gets the value for the name (or) alias if found, None otherwise.

Examples found in repository

examples/simple.rs (line 17)

fn main() {
    // Instantiate Grok
    let mut grok = Grok::default();

    // Add a pattern which might be a regex or an alias
    grok.add_pattern("USERNAME", r"[a-zA-Z0-9._-]+");

    // Compile the definitions into the pattern you want
    let pattern = grok
        .compile("%{USERNAME}", false)
        .expect("Error while compiling!");

    //  Match the compiled pattern against a string
    match pattern.match_against("root") {
        Some(m) => println!("Found username {:?}", m.get("USERNAME")),
        None => println!("No matches found!"),
    }
}

pub fn len(&self) -> usize

Returns the number of matches.

pub fn is_empty(&self) -> bool

Returns true if there are no matches, false otherwise.

pub fn iter(&'a self) -> MatchesIter<'a>

Returns a tuple of key/value with all the matches found.

Note that if no match is found, the value is empty.

Trait Implementations

impl<'a> Debug for Matches<'a>

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

Formats the value using the given formatter.

impl<'a> IntoIterator for &'a Matches<'a>

type Item = (&'a str, &'a str)

The type of the elements being iterated over.

type IntoIter = MatchesIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.