refactor: use more comprehensive api (#69)

Signed-off-by: tison <[email protected]>

.github/workflows/ci.yml

@@ -73,7 +73,7 @@ jobs:
         run: |
           cargo run --example simple_stdio
           cargo run --example fn_layout_filter
-          cargo run --example env_filter
+          cargo run --example default_filter_respect_env
           cargo run --features="no-color" --example simple_stdio
           cargo run --features="json" --example json_stdio
           cargo run --features="json,rolling_file" --example rolling_file

Cargo.toml

@@ -114,5 +114,5 @@ name = "fn_layout_filter"
 path = "examples/fn_layout_filter.rs"
 
 [[example]]
-name = "env_filter"
-path = "examples/env_filter.rs"
+name = "default_filter_respect_env"
+path = "examples/default_filter_respect_env.rs"

README.md

@@ -35,21 +35,20 @@ Then, you can use the logger with the simplest default setup:
 
 ```rust
 fn main() {
-    logforth::stderr().finish();
+    logforth::stderr().apply();
 }
 ```
 
 Or configure the logger in a more fine-grained way:
 
 ```rust
+use log::LevelFilter;
+use logforth::append;
+
 fn main() {
-    logforth::builder()
-        .filter(log::LevelFilter::Debug)
-        .append(logforth::append::Stderr::default())
-        .dispatch()
-        .filter(log::LevelFilter::Info)
-        .append(logforth::append::Stdout::default())
-        .finish();
+    logforth::dispatch(|b| b.filter(LevelFilter::Debug).append(append::Stderr::default()))
+        .and_dispatch(|b| b.filter(LevelFilter::Info).append(append::Stdout::default()))
+        .apply();
 }
 ```
 

examples/env_filter.rs → examples/default_filter_respect_env.rs

@@ -12,14 +12,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-use logforth::append;
-use logforth::filter::EnvFilter;
-
 fn main() {
-    logforth::builder()
-        .filter(EnvFilter::from_default_env())
-        .append(append::Stdout::default())
-        .finish();
+    logforth::stdout().apply();
 
     log::error!("Hello error!");
     log::warn!("Hello warn!");

examples/fn_layout_filter.rs

@@ -19,8 +19,8 @@ use logforth::filter::FilterResult;
 use logforth::layout::CustomLayout;
 
 fn main() {
-    logforth::builder()
-        .filter(CustomFilter::new(|metadata: &log::Metadata| {
+    logforth::dispatch(|b| {
+        b.filter(CustomFilter::new(|metadata: &log::Metadata| {
             if metadata.level() > LevelFilter::Info {
                 FilterResult::Accept
             } else {
@@ -32,7 +32,8 @@ fn main() {
                 Ok(format!("[system alert] {}", record.args()).into_bytes())
             })),
         )
-        .finish();
+    })
+    .apply();
 
     log::error!("Hello error!");
     log::warn!("Hello warn!");

examples/json_stdio.rs

@@ -16,9 +16,8 @@ use logforth::append;
 use logforth::layout::JsonLayout;
 
 fn main() {
-    logforth::builder()
-        .append(append::Stdout::default().with_layout(JsonLayout::default()))
-        .finish();
+    logforth::dispatch(|b| b.append(append::Stdout::default().with_layout(JsonLayout::default())))
+        .apply();
 
     log::error!("Hello error!");
     log::warn!("Hello warn!");

examples/rolling_file.rs

@@ -30,13 +30,12 @@ fn main() {
         .unwrap();
     let (writer, _guard) = NonBlockingBuilder::default().finish(rolling);
 
-    logforth::builder()
-        .filter("trace")
-        .append(RollingFile::new(writer).with_layout(JsonLayout::default()))
-        .dispatch()
-        .filter("info")
-        .append(Stdout::default())
-        .finish();
+    logforth::dispatch(|b| {
+        b.filter("trace")
+            .append(RollingFile::new(writer).with_layout(JsonLayout::default()))
+    })
+    .and_dispatch(|b| b.filter("info").append(Stdout::default()))
+    .apply();
 
     let repeat = 1;
 

examples/simple_stdio.rs

@@ -16,11 +16,12 @@ use log::LevelFilter;
 use logforth::append;
 
 fn main() {
-    logforth::builder()
-        .filter(LevelFilter::Trace)
-        .append(append::Stdout::default())
-        .append(append::Stderr::default())
-        .finish();
+    logforth::dispatch(|b| {
+        b.filter(LevelFilter::Trace)
+            .append(append::Stdout::default())
+            .append(append::Stderr::default())
+    })
+    .apply();
 
     log::error!("Hello error!");
     log::warn!("Hello warn!");

src/lib.rs

@@ -29,19 +29,18 @@ cargo add logforth
 Then, you can use the logger with the simplest default setup:
 
 ```rust
-logforth::stderr().finish();
+logforth::stderr().apply();
 ```
 
 Or configure the logger in a more fine-grained way:
 
 ```rust
-logforth::builder()
-    .filter(log::LevelFilter::Debug)
-    .append(logforth::append::Stderr::default())
-    .dispatch()
-    .filter(log::LevelFilter::Info)
-    .append(logforth::append::Stdout::default())
-    .finish();
+use log::LevelFilter;
+use logforth::append;
+
+logforth::dispatch(|b| b.filter(LevelFilter::Debug).append(append::Stderr::default()))
+    .and_dispatch(|b| b.filter(LevelFilter::Info).append(append::Stdout::default()))
+    .apply();
 ```
 
 Read more demos under the [examples](https://github.com/fast/logforth/tree/main/examples) directory.