chore: add readme examples and tests for reading single event types

Signed-off-by: Raphael Höser <[email protected]>

Author: Snapstromegon

README.md

@@ -412,6 +412,20 @@ match result {
   Err(err) => // ...
 }
 ```
+
+### Listing a Specific Event Types
+
+To list a specific event type, call the `read_event_type` function. The function returns the detailed event type, which includes the schema:
+
+```rust
+let event_type_name = "io.eventsourcingdb.library.book-acquired";
+let result := client.read_event_type(event_type_name).await;
+match result {
+  Ok(event_type) => // ...
+  Err(err) => // ...
+}
+```
+
 ### Using Testcontainers
 
 Call the `Container::start_default()` function, get a client, and run your test code:

examples/event_types.rs

@@ -3,7 +3,7 @@ use futures::StreamExt;
 
 #[tokio::main]
 async fn main() {
-    let db = Container::start_default().await.unwrap();
+    let db = Container::start_preview().await.unwrap();
     let base_url = db.get_base_url().await.unwrap();
     let api_token = db.get_api_token();
     let client = Client::new(base_url, api_token);
@@ -14,7 +14,7 @@ async fn main() {
         Err(err) => panic!("{}", err),
         Ok(mut event_types) => {
             while let Some(Ok(event_type)) = event_types.next().await {
-                println!("{:?}", event_type)
+                println!("{event_type:?}")
             }
         }
     }

examples/listing_subjects.rs

@@ -3,7 +3,7 @@ use futures::StreamExt;
 
 #[tokio::main]
 async fn main() {
-    let db = Container::start_default().await.unwrap();
+    let db = Container::start_preview().await.unwrap();
     let base_url = db.get_base_url().await.unwrap();
     let api_token = db.get_api_token();
     let client = Client::new(base_url, api_token);
@@ -14,7 +14,7 @@ async fn main() {
         Err(err) => panic!("{}", err),
         Ok(mut subjects) => {
             while let Some(Ok(subject)) = subjects.next().await {
-                println!("{:?}", subject)
+                println!("{subject:?}")
             }
         }
     }

examples/observing_events.rs

@@ -6,7 +6,7 @@ use futures::StreamExt;
 
 #[tokio::main]
 async fn main() {
-    let db = Container::start_default().await.unwrap();
+    let db = Container::start_preview().await.unwrap();
     let base_url = db.get_base_url().await.unwrap();
     let api_token = db.get_api_token();
     let client = Client::new(base_url, api_token);
@@ -26,7 +26,7 @@ async fn main() {
         Err(err) => panic!("{}", err),
         Ok(mut stream) => {
             while let Some(Ok(event)) = stream.next().await {
-                println!("{:?}", event)
+                println!("{event:?}")
             }
         }
     }

examples/ping.rs

@@ -2,7 +2,7 @@ use eventsourcingdb::{client::Client, container::Container};
 
 #[tokio::main]
 async fn main() {
-    let db = Container::start_default().await.unwrap();
+    let db = Container::start_preview().await.unwrap();
     let base_url = db.get_base_url().await.unwrap();
     let api_token = db.get_api_token();
     let client = Client::new(base_url, api_token);

examples/reading_events.rs

@@ -6,7 +6,7 @@ use futures::StreamExt;
 
 #[tokio::main]
 async fn main() {
-    let db = Container::start_default().await.unwrap();
+    let db = Container::start_preview().await.unwrap();
     let base_url = db.get_base_url().await.unwrap();
     let api_token = db.get_api_token();
     let client = Client::new(base_url, api_token);
@@ -28,7 +28,7 @@ async fn main() {
         Err(err) => panic!("{}", err),
         Ok(mut stream) => {
             while let Some(Ok(event)) = stream.next().await {
-                println!("{:?}", event)
+                println!("{event:?}")
             }
         }
     }

examples/registering_event_schema.rs

@@ -3,7 +3,7 @@ use serde_json::json;
 
 #[tokio::main]
 async fn main() {
-    let db = Container::start_default().await.unwrap();
+    let db = Container::start_preview().await.unwrap();
     let base_url = db.get_base_url().await.unwrap();
     let api_token = db.get_api_token();
     let client = Client::new(base_url, api_token);

examples/running_eventql.rs

@@ -3,7 +3,7 @@ use futures::StreamExt;
 
 #[tokio::main]
 async fn main() {
-    let db = Container::start_default().await.unwrap();
+    let db = Container::start_preview().await.unwrap();
     let base_url = db.get_base_url().await.unwrap();
     let api_token = db.get_api_token();
     let client = Client::new(base_url, api_token);
@@ -16,7 +16,7 @@ async fn main() {
         Err(err) => panic!("{}", err),
         Ok(mut stream) => {
             while let Some(Ok(row)) = stream.next().await {
-                println!("{:?}", row)
+                println!("{row:?}")
             }
         }
     }

examples/verify_api_token.rs

@@ -2,7 +2,7 @@ use eventsourcingdb::{client::Client, container::Container};
 
 #[tokio::main]
 async fn main() {
-    let db = Container::start_default().await.unwrap();
+    let db = Container::start_preview().await.unwrap();
     let base_url = db.get_base_url().await.unwrap();
     let api_token = db.get_api_token();
     let client = Client::new(base_url, api_token);

examples/write_events.rs

@@ -3,7 +3,7 @@ use serde_json::json;
 
 #[tokio::main]
 async fn main() {
-    let db = Container::start_default().await.unwrap();
+    let db = Container::start_preview().await.unwrap();
     let base_url = db.get_base_url().await.unwrap();
     let api_token = db.get_api_token();
     let client = Client::new(base_url, api_token);
@@ -21,7 +21,7 @@ async fn main() {
 
     let result = client.write_events(vec![event.clone()], vec![]).await;
     match result {
-        Ok(written_events) => println!("{:?}", written_events),
+        Ok(written_events) => println!("{written_events:?}"),
         Err(err) => panic!("{}", err),
     }
 }