examples and readme

LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright [2024] [yuanbohan]
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

README.md

@@ -4,7 +4,88 @@ Rust port of Elastic Grok processor, inspired by [grok-go][grok-go] and [grok][g
 
 ## Example
 
+### Only with default patterns
+
+```rust
+let grok = Grok::default();
+let pattern = grok
+    // USERNAME are defined in grok-patterns
+    .compile("%{USERNAME}", false)
+    .unwrap();
+let result = pattern.parse("admin [email protected]").unwrap();
+println!("{:#?}", result);
+```
+
+the output is:
+
+```text
+{
+    "USERNAME": String(
+        "admin",
+    ),
+}
+```
+
+### With user-defined patterns
+
+```rust
+let mut grok = Grok::default();
+grok.add_pattern("NAME", r"[A-z0-9._-]+");
+let pattern = grok.compile("%{NAME}", false).unwrap();
+let result = pattern.parse("admin").unwrap();
+println!("{:#?}", result);
+```
+
+the output is:
+
+```text
+{
+    "NAME": String(
+        "admin",
+    ),
+}
+```
+
+### With `named_capture_only` is true
+
 ```rust
+let grok = Grok::default();
+let pattern = grok
+    .compile("%{USERNAME} %{EMAILADDRESS:email}", true)
+    .unwrap();
+let result = pattern.parse("admin [email protected]").unwrap();
+println!("{:#?}", result);
+```
+
+the output is:
+
+```text
+{
+    "email": String(
+        "[email protected]",
+    ),
+}
+```
+
+### With type
+
+```rust
+let mut grok = Grok::default();
+grok.add_pattern("NUMBER", r"\d+");
+
+let pattern = grok.compile("%{NUMBER:digit:int}", false).unwrap();
+let result = pattern.parse("hello 123").unwrap();
+println!("{:#?}", result);
+```
+
+the output is:
+
+```text
+{
+    "digit": Int(
+        123,
+    ),
+}
 ```
 
 ## Elastic Grok compliance

examples/add_pattern.rs

@@ -0,0 +1,9 @@
+use grok_rs::Grok;
+
+fn main() {
+    let mut grok = Grok::default();
+    grok.add_pattern("NAME", r"[A-z0-9._-]+");
+    let pattern = grok.compile("%{NAME}", false).unwrap();
+    let result = pattern.parse("admin").unwrap();
+    println!("{:#?}", result);
+}

examples/default_patterns.rs

@@ -0,0 +1,12 @@
+use grok_rs::Grok;
+
+fn main() {
+    let grok = Grok::default();
+    let pattern = grok
+        // USERNAME and EMAILADDRESS are defined in grok-patterns
+        .compile("%{USERNAME}", false)
+        .unwrap();
+
+    let result = pattern.parse("admin [email protected]").unwrap();
+    println!("{:#?}", result);
+}

examples/named_capture_only.rs

@@ -0,0 +1,10 @@
+use grok_rs::Grok;
+
+fn main() {
+    let grok = Grok::default();
+    let pattern = grok
+        .compile("%{USERNAME} %{EMAILADDRESS:email}", true)
+        .unwrap();
+    let result = pattern.parse("admin [email protected]").unwrap();
+    println!("{:#?}", result);
+}

examples/type.rs

@@ -0,0 +1,10 @@
+use grok_rs::Grok;
+
+fn main() {
+    let mut grok = Grok::default();
+    grok.add_pattern("NUMBER", r"\d+");
+
+    let pattern = grok.compile("%{NUMBER:digit:int}", false).unwrap();
+    let result = pattern.parse("hello 123").unwrap();
+    println!("{:#?}", result);
+}