Skip to main content

WorkflowContext

Struct WorkflowContext 

Source
pub struct WorkflowContext { /* private fields */ }
Expand description

Collects the effects an executor produces while handling a message: messages to send downstream, workflow outputs, custom events, info requests, and access to run-scoped SharedState.

This is a cheap, cloneable handle (interior mutability) so executor closures may own it and hold it across await points. Rust equivalent of WorkflowContext.

Implementations§

Source§

impl WorkflowContext

Source

pub async fn send_message(&self, data: impl Into<Value>) -> Result<(), Error>

Send a message to all connected downstream executors.

Source

pub async fn send_to( &self, target_id: impl Into<String>, data: impl Into<Value>, ) -> Result<(), Error>

Send a message to a specific downstream executor.

Source

pub async fn yield_output(&self, data: impl Into<Value>) -> Result<(), Error>

Emit a workflow-level output.

Source

pub fn add_event(&self, event: WorkflowEvent)

Add a custom event to the event stream.

Source

pub async fn request_info(&self, data: impl Into<Value>) -> Result<(), Error>

Request external information (human-in-the-loop).

Records a request whose response, once supplied via the run handle, is delivered back to this executor as a message. Mirrors Python’s ctx.request_info.

Source

pub fn shared_state(&self) -> SharedState

Access the run-scoped SharedState shared by all executors.

Source

pub fn executor_id(&self) -> &str

The id of the executor this context belongs to.

Source

pub fn source_executor_ids(&self) -> &[String]

The id(s) of the executor(s) that sent the current message.

Trait Implementations§

Source§

impl Clone for WorkflowContext

Source§

fn clone(&self) -> WorkflowContext

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more