docs: add examples

this is to show how we can use closures in the mad component context. It isn't super pretty because of the async closure, so we need to show the slighly complicated syntax

Signed-off-by: kjuulh <contact@kjuulh.io>

CHANGELOG.md

@@ -6,6 +6,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.4.0] - 2024-08-07
+
+### Added
+- add correction
+- add small docs
+
 ## [0.3.0] - 2024-08-07
 
 ### Added

Cargo.lock

@@ -236,7 +236,7 @@ checksum = "a7a70ba024b9dc04c27ea2f0c0548feb474ec5c54bba33a7f72f873a39d07b24"
 
 [[package]]
 name = "mad"
-version = "0.2.0"
+version = "0.3.0"
 dependencies = [
  "anyhow",
  "async-trait",

Cargo.toml

@@ -3,7 +3,7 @@ members = ["crates/*"]
 resolver = "2"
 
 [workspace.package]
-version = "0.3.0"
+version = "0.4.0"
 
 [workspace.dependencies]
 mad = { path = "crates/mad" }

README.md

@@ -41,3 +41,11 @@ async fn main() -> anyhow::Result<()> {
 }
 ```
 
+## Examples
+
+Can be found (here)[crates/mad/examples]
+
+- basic
+- fn
+- signals
+- error_log

crates/mad/examples/fn/main.rs

@@ -10,7 +10,7 @@ impl mad::Component for WaitServer {
         Some("WaitServer".into())
     }
 
-    async fn run(&self, cancellation: CancellationToken) -> Result<(), mad::MadError> {
+    async fn run(&self, _cancellation: CancellationToken) -> Result<(), mad::MadError> {
         let millis_wait = rand::thread_rng().gen_range(500..3000);
 
         tracing::debug!("waiting: {}ms", millis_wait);
@@ -28,9 +28,11 @@ async fn main() -> anyhow::Result<()> {
         .with_max_level(Level::TRACE)
         .init();
 
+    let item = "some item".to_string();
+
     mad::Mad::builder()
         .add(WaitServer {})
-        .add_fn(|cancel| async move {
+        .add_fn(|_cancel| async move {
             let millis_wait = 50;
 
             tracing::debug!("waiting: {}ms", millis_wait);
@@ -40,6 +42,24 @@ async fn main() -> anyhow::Result<()> {
 
             Ok(())
         })
+        .add_fn(move |_cancel| {
+            // I am an actual closure
+
+            let item = item.clone();
+
+            async move {
+                let _item = item;
+
+                let millis_wait = 50;
+
+                tracing::debug!("waiting: {}ms", millis_wait);
+
+                // Simulates a server running for some time. Is normally supposed to be futures blocking indefinitely
+                tokio::time::sleep(std::time::Duration::from_millis(millis_wait)).await;
+
+                Ok(())
+            }
+        })
         .run()
         .await?;
 

crates/mad/src/lib.rs

@@ -94,6 +94,7 @@ impl Mad {
 
         let close_result = self.close_components().await;
 
+        tracing::info!("mad is closed down");
         match (run_result, close_result) {
             (Err(run), Err(close)) => {
                 return Err(MadError::AggregateError(AggregateError {