chore: Add examples for API

examples/consumer.rs

@@ -0,0 +1,32 @@
+use futures::StreamExt;
+use streamstore::{
+    client::{ClientConfig, StreamClient},
+    types::{BasinName, ReadSessionRequest},
+};
+use tokio::select;
+
+#[tokio::main]
+async fn main() -> Result<(), Box<dyn std::error::Error>> {
+    let token = std::env::var("S2_AUTH_TOKEN")?;
+    let config = ClientConfig::new(token);
+    let basin: BasinName = "my-basin".parse()?;
+    let stream = "my-basin";
+    let stream_client = StreamClient::new(config, basin, stream);
+
+    let start_seq_num = 0;
+    let read_session_request = ReadSessionRequest::new(start_seq_num);
+    let mut read_stream = stream_client.read_session(read_session_request).await?;
+
+    loop {
+        select! {
+            next_batch = read_stream.next() => {
+                let Some(next_batch) = next_batch else { break };
+                let next_batch = next_batch?;
+                println!("{next_batch:?}");
+            }
+            _ = tokio::signal::ctrl_c() => break,
+        }
+    }
+
+    Ok(())
+}

examples/get_latest_record.rs

@@ -0,0 +1,24 @@
+use streamstore::{
+    client::{ClientConfig, StreamClient},
+    types::{BasinName, ReadLimit, ReadRequest},
+};
+
+#[tokio::main]
+async fn main() -> Result<(), Box<dyn std::error::Error>> {
+    let token = std::env::var("S2_AUTH_TOKEN")?;
+    let config = ClientConfig::new(token);
+    let basin: BasinName = "my-basin".parse()?;
+    let stream = "my-basin";
+    let stream_client = StreamClient::new(config, basin, stream);
+
+    let tail = stream_client.check_tail().await?;
+    let latest_seq_num = tail - 1;
+
+    let read_limit = ReadLimit { count: 1, bytes: 0 };
+    let read_request = ReadRequest::new(latest_seq_num).with_limit(read_limit);
+    let latest_record = stream_client.read(read_request).await?;
+
+    println!("{latest_record:#?}");
+
+    Ok(())
+}