Crate pulse_client 

Official Rust client for StreamFlow Pulse — the AI Agent Platform.

Quick start

use pulse_client::PulseClient;

#[tokio::main]
async fn main() -> Result<(), pulse_client::PulseError> {
    let client = PulseClient::builder()
        .base_url("http://localhost:9090")
        .build()?;

    client.auth().login("alice", "secret").await?;

    for pipeline in client.pipelines().list().await? {
        println!("{}", pipeline["name"]);
    }
    Ok(())
}

Surface

Mirrors the Python (pulse-py), JavaScript (@olsisoft/pulse-client), Java (com.streamflow:pulse-client) and Go (github.com/olsisoft/pulse-go) SDKs 1:1:

• auth() — login, refresh, organisations, switch org
• pipelines() — list, get, create, delete
• agents() — list, get
• templates() — list
• users() — list (admin only)
• events() — Server-Sent Events stream
• iq() — B-106 Interactive Queries on agent state
• streams() — B-107 Kafka-Streams-like DSL
• version() — public, no JWT required

Wire format

Every method corresponds 1:1 to an endpoint in the Pulse OpenAPI 3.1 spec (streamflow-pulse/src/main/resources/openapi/openapi.yaml). Drift caught at PR time by the in-tree spec invariant tests (B-103).

Modules

aggs

Aggregator factory namespace.

windows

Window-spec factory namespace.

Structs

AgentsResource

AuthResource

BranchSpec

One branch of StreamBuilder::branch.

BroadcastJoinOptions

Options for StreamBuilder::broadcast_join.

CdcJoinOptions

Options for StreamBuilder::cdc_join.

CepOptions

Options for StreamBuilder::cep.

EnrichAsyncOptions

Options for StreamBuilder::enrich_async.

EventsResource

client.events() — accessor for the SSE event stream.

EventsStream

Stream<Item = Result<Value, PulseError>> — yields parsed SSE events.

IQQueryOptions

Optional inputs for IQResource::query.

IQResource

client.iq() — accessor for Interactive Queries.

IQScanOptions

Optional range bounds + page size for IQResource::scan and IQResource::list_keys.

MapOptions

Options for StreamBuilder::map.

PipelinesResource

PulseClient

Async HTTP client for the Pulse REST API.

PulseClientBuilder

Fluent builder for PulseClient.

StreamBuilder

Fluent builder for a Pulse streaming pipeline.

StreamsResource

client.streams() — compile + deploy StreamBuilder pipelines.

TemplatesResource

UsersResource

WindowOptions

Options for StreamBuilder::window.

WindowSpec

A window specification. Compiled to the string form the server expects.

Enums

PulseError

The single error type returned by every PulseClient method.

Value

Represents any valid JSON value.

Constants

VERSION

Current SDK version (matches Cargo.toml and the Pulse server it targets).

Functions

iq_and

Builds an AND filter combining all children.

iq_leaf

Builds a leaf filter node: {"field": ..., "op": ..., "value": ...}. Pass an empty op to omit it (e.g. for an exists-style test where the field’s mere presence suffices).

iq_not

Builds a NOT filter negating its child.

iq_or

Builds an OR filter combining all children.