Struct WorkflowHandle 

pub struct WorkflowHandle { /* private fields */ }

Handle for a concrete workflow run returned by Client::start.

Implementations

impl WorkflowHandle

pub fn from_ids(client: Client, workflow_id: WorkflowId, run_id: RunId) -> Self

Constructs a handle from caller-held workflow and run identifiers.

The client is retained so handle methods can delegate through the same transport, error mapping, payload machinery, and stream implementation as top-level Client operations.

pub const fn workflow_id(&self) -> &WorkflowId

Returns the workflow identifier bundled in this handle.

pub const fn run_id(&self) -> &RunId

Returns the run identifier bundled in this handle.

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

Sends a raw payload signal to this concrete run.

Errors

Returns ClientError when signal delivery fails.

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

where T: Serialize + ?Sized,

Sends a JSON-typed signal to this concrete run.

Errors

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

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

Queries this concrete run and returns a raw payload result.

Errors

Returns ClientError when the query fails or times out.

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

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

Queries this concrete run and deserializes the result to R.

Errors

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

pub async fn cancel(&self, reason: impl Into<String>) -> Result<(), ClientError>

Requests cancellation of this concrete run.

Errors

Returns ClientError when the server rejects the cancellation request.

pub async fn describe(&self) -> Result<WorkflowDescription, ClientError>

Describes this concrete run.

Errors

Returns ClientError when the description cannot be fetched or decoded.

pub fn subscribe(&self) -> EventStream

Subscribes to events for this workflow.

Trait Implementations

impl Clone for WorkflowHandle

fn clone(&self) -> WorkflowHandle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorkflowHandle

fn fmt(&self, formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for WorkflowHandle

impl PartialEq for WorkflowHandle

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.