Struct Client 

pub struct Client { /* private fields */ }

Contains an instance of a namespace-bound client for interacting with the Temporal server. Cheap to clone.

Implementations

impl Client

pub fn new( connection: Connection, options: ClientOptions, ) -> Result<Self, ClientNewError>

Create a new client from a connection and options.

Currently infallible, but returns a Result for future extensibility (e.g., interceptor or plugin validation).

pub fn options(&self) -> &ClientOptions

Return the options this client was initialized with

pub fn options_mut(&mut self) -> &mut ClientOptions

Return this client’s options mutably.

Note: If this client has been cloned, this will copy-on-write to avoid affecting other clones.

pub fn connection(&self) -> &Connection

Returns a reference to the underlying connection

pub fn connection_mut(&mut self) -> &mut Connection

Returns a mutable reference to the underlying connection

impl Client

pub async fn start_workflow<W>( &self, workflow: W, input: W::Input, options: WorkflowStartOptions, ) -> Result<WorkflowHandle<Self, W>, WorkflowStartError>

where W: WorkflowDefinition, W::Input: Send,

Start a workflow execution.

Returns a WorkflowHandle that can be used to interact with the workflow (e.g., get its result, send signals, query, etc.).

pub fn get_workflow_handle<W: WorkflowDefinition>( &self, workflow_id: impl Into<String>, ) -> WorkflowHandle<Self, W>

Get a handle to an existing workflow.

For untyped access, use get_workflow_handle::<UntypedWorkflow>(...).

pub fn list_workflows( &self, query: impl Into<String>, opts: WorkflowListOptions, ) -> ListWorkflowsStream

List workflows matching a query.

Returns a stream that lazily paginates through results. Use limit in options to cap the number of results returned.

pub async fn count_workflows( &self, query: impl Into<String>, opts: WorkflowCountOptions, ) -> Result<WorkflowExecutionCount, ClientError>

Count workflows matching a query.

pub fn get_async_activity_handle( &self, identifier: ActivityIdentifier, ) -> AsyncActivityHandle<Self>

Get a handle to complete an activity asynchronously.

An activity returning ActivityError::WillCompleteAsync can be completed with this handle.

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.

impl NamespacedClient for Client

fn namespace(&self) -> String

Returns the namespace this client is bound to

fn identity(&self) -> String

Returns the client identity

fn data_converter(&self) -> &DataConverter

Returns the data converter for serializing/deserializing payloads. Default implementation returns a static default converter.