Struct Client 

pub struct Client { /* private fields */ }

Reusable caller-side SDK client for an aion-server deployment.

Examples

use aion_client::{ClientAuth, ClientBuilder};

let client = ClientBuilder::new("https://aion.example.com")
    .with_auth(ClientAuth::bearer("secret-token"))
    .with_namespace("tenant-a")
    .build()
    .await?;

let shared = client.clone();

Implementations

impl Client

pub fn builder(endpoint: impl Into<String>) -> ClientBuilder

Creates a builder for an aion-server endpoint.

impl Client

pub async fn start( &self, workflow_type: impl Into<String>, input: Payload, opts: StartOptions, ) -> Result<WorkflowHandle, ClientError>

Starts a workflow and returns the assigned workflow and run identifiers.

Errors

Returns ClientError when transport, server, or response conversion fails.

pub async fn start_typed<T>( &self, workflow_type: impl Into<String>, input: &T, opts: StartOptions, ) -> Result<WorkflowHandle, ClientError>

where T: Serialize + ?Sized,

Starts a workflow after serializing input as JSON.

Errors

Returns ClientError::InvalidArgument when serialization fails, or the delegated start error otherwise.

pub async fn signal( &self, workflow_id: &WorkflowId, run_id: Option<&RunId>, name: impl Into<String>, payload: Payload, ) -> Result<(), ClientError>

Sends a signal to the latest run, or to run_id when supplied.

Errors

Returns ClientError when transport, server, or request conversion fails.

pub async fn signal_typed<T>( &self, workflow_id: &WorkflowId, run_id: Option<&RunId>, name: impl Into<String>, value: &T, ) -> Result<(), ClientError>

where T: Serialize + ?Sized,

Serializes value as JSON and sends it as a signal payload.

Errors

Returns ClientError::InvalidArgument when serialization fails, or the delegated signal error otherwise.

pub async fn query( &self, workflow_id: &WorkflowId, run_id: Option<&RunId>, name: impl Into<String>, args: Payload, deadline: Duration, ) -> Result<Payload, ClientError>

Queries the latest run, or run_id when supplied, with a local deadline.

The current AW protobuf does not yet carry query argument payloads, so a non-empty args payload returns ClientError::InvalidArgument instead of being silently dropped.

Errors

Returns ClientError::QueryTimeout when deadline elapses.

pub async fn query_typed<A, R>( &self, workflow_id: &WorkflowId, run_id: Option<&RunId>, name: impl Into<String>, args: &A, deadline: Duration, ) -> Result<R, ClientError>

where A: Serialize + ?Sized, R: DeserializeOwned,

Serializes args as JSON, queries a workflow, and deserializes the JSON result.

Errors

Returns ClientError::InvalidArgument when serialization or result decoding fails, or the delegated query error otherwise.

pub async fn cancel( &self, workflow_id: &WorkflowId, run_id: Option<&RunId>, reason: impl Into<String>, ) -> Result<(), ClientError>

Requests cancellation of the latest run, or run_id when supplied.

Success means the server accepted the cancellation request; it is not a confirmation that the workflow has reached a terminal cancelled state.

Errors

Returns ClientError when transport, server, or request conversion fails.

pub async fn list( &self, filter: &WorkflowFilter, page: ListPage, ) -> Result<Vec<WorkflowSummary>, ClientError>

Lists workflows matching a filter.

Errors

Returns ClientError when transport, server, or response conversion fails.

pub async fn describe( &self, workflow_id: &WorkflowId, run_id: Option<&RunId>, ) -> Result<WorkflowDescription, ClientError>

Describes the latest run, or run_id when supplied.

Errors

Returns ClientError when transport, server, or response conversion fails.

pub fn subscribe_workflow(&self, workflow_id: &WorkflowId) -> EventStream

Subscribes to events for a workflow.

pub fn subscribe_workflow_from( &self, workflow_id: &WorkflowId, resume_from: NonZeroU64, ) -> EventStream

Subscribes to events for a workflow, attaching from an explicit per-workflow sequence cursor.

resume_from is the first sequence number wanted (resume_from_seq on the wire); 1 replays the workflow’s full recorded history before splicing into the live stream, gap-free and duplicate-free.

pub fn subscribe(&self, filter: WorkflowFilter) -> EventStream

Subscribes to events selected by the supplied workflow filter.

pub fn subscribe_firehose(&self) -> EventStream

Subscribes to every event visible to this client namespace.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.