Struct Grok

Source

pub struct Grok { /* private fields */ }

Implementations§

Source §

impl Grok

Source

pub fn add_pattern<T: Into<String>>(&mut self, name: T, pattern: T)

add a custom pattern, if the pattern is already defined, then it will be overwritten.

§Example

use grok_rs::Grok;

let mut grok = Grok::default();
grok.add_pattern("NAME", r"[A-z0-9._-]+");

Examples found in repository ?

examples/add_pattern.rs (line 5)

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/type.rs (line 5)

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}

Source

pub fn compile( &self, s: &str, named_capture_only: bool, ) -> Result<Pattern, String>

Compile the pattern, and return a Pattern.

if named_capture_only is true, then the unnamed capture group will be ignored.
if the pattern is invalid or not found , then an error will be returned.

Due to the compile process is heavy, it’s recommended compile the pattern once and reuse it.

§Example

the USERNAME will be ignored because named_capture_only is true.

use grok_rs::Grok;
let grok = Grok::default();
let pattern = grok.compile("%{USERNAME} %{EMAILADDRESS:email}", true).unwrap();

Examples found in repository ?

examples/add_pattern.rs (line 6)

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 6)

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 7)

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 7)

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}