Struct Pattern

Source

pub struct Pattern { /* private fields */ }

Implementations§

Source §

impl Pattern

Source

pub fn parse(&self, s: &str) -> Result<HashMap<String, Value>, String>

parse the input string based on the pattern, and rename the captured group based on alias.

if type is specified, then the value will be converted to the specified type.
if the type is not supported, then the value will be kept as string.
if the value can’t be converted to the specified type, then an error will be returned.
if the value can’t be captured, then an empty map will be returned.

§Example

use std::collections::HashMap;
use grok_rs::{Grok, Value};

let grok = Grok::default();
let pattern = grok.compile("%{USERNAME}", false).unwrap();
let result = pattern.parse("admin admin@example.com").unwrap();
let expected = HashMap::from([("USERNAME".to_string(), Value::String("admin".into()))]);
assert_eq!(expected, result);

Examples found in repository ?

examples/add_pattern.rs (line 7)

3fn main() {
4    let mut grok = Grok::default();
5    grok.add_pattern("NAME", r"[A-z0-9._-]+");
6    let pattern = grok.compile("%{NAME}", false).unwrap();
7    let result = pattern.parse("admin").unwrap();
8    println!("{:#?}", result);
9}

More examples

Hide additional examples

examples/named_capture_only.rs (line 8)

3fn main() {
4    let grok = Grok::default();
5    let pattern = grok
6        .compile("%{USERNAME} %{EMAILADDRESS:email}", true)
7        .unwrap();
8    let result = pattern.parse("admin admin@example.com").unwrap();
9    println!("{:#?}", result);
10}

examples/type.rs (line 8)

3fn main() {
4    let mut grok = Grok::default();
5    grok.add_pattern("NUMBER", r"\d+");
6
7    let pattern = grok.compile("%{NUMBER:digit:int}", false).unwrap();
8    let result = pattern.parse("hello 123").unwrap();
9    println!("{:#?}", result);
10}

examples/default_patterns.rs (line 10)

3fn main() {
4    let grok = Grok::default();
5    let pattern = grok
6        // USERNAME and EMAILADDRESS are defined in grok-patterns
7        .compile("%{USERNAME}", false)
8        .unwrap();
9
10    let result = pattern.parse("admin admin@example.com").unwrap();
11    println!("{:#?}", result);
12}