Kimberlite SDK reference

Rust API Reference

On this page

Native Rust SDK for Kimberlite.

Crate: kimberlite MSRV: 1.88

Installation

[dependencies]
kimberlite = "1.0"
tokio = { version = "1", features = ["full"] }

Client

See docs.rs/kimberlite for complete API documentation.

Quick Reference

use kimberlite::{Client, TenantId, StreamId, Position};

// Connect
let client = Client::connect("localhost:3000").await?;

// Append
let position = client.append(
    TenantId::new(1),
    StreamId::new(1, 100),
    b"event data"
).await?;

// Read
let events = client.read_stream(
    TenantId::new(1),
    StreamId::new(1, 100)
).await?;

// Subscribe
let mut subscription = client.subscribe(
    TenantId::new(1),
    StreamId::new(1, 100)
).await?;

while let Some(event) = subscription.next().await {
    println!("Event: {:?}", event);
}

Examples

See Rust Quickstart for complete examples.

See docs.rs/kimberlite for full API documentation.