Struct WorkflowAgent 

pub struct WorkflowAgent { /* private fields */ }

An SupportsAgentRun that wraps a Workflow and exposes it through the agent interface. Rust analogue of WorkflowAgent.

Implementations

impl WorkflowAgent

pub fn new(workflow: Workflow, name: impl Into<String>) -> WorkflowAgent

Wrap workflow as an agent named name.

pub fn with_id(self, id: impl Into<String>) -> WorkflowAgent

Set an explicit id.

pub fn with_description(self, description: impl Into<String>) -> WorkflowAgent

Set a description.

pub fn workflow(&self) -> &Workflow

The wrapped workflow.

pub fn description(&self) -> Option<&str>

The agent description, if any.

pub fn run_stream_with_thread( &self, messages: Vec<Message>, session: Option<AgentSession>, ) -> Pin<Box<dyn Stream<Item = Result<AgentResponseUpdate, Error>> + Send>>

Stream the workflow’s agent activity and, once the stream completes, fire session‘s context providers’ after_run hook the way Agent::run_stream does: messages and the response messages reconstructed from the emitted updates are passed through. An infallible inherent convenience; the object-safe SupportsAgentRun::run_stream trait method wraps this in Ok(..).

Mirrors Python’s WorkflowAgent.run_stream, which likewise only notifies the thread of new messages after the stream is exhausted — it does not feed the session’s prior history back into the workflow’s own input (see SupportsAgentRun::run on this type for the same convention on the non-streaming path).

Because a history provider’s storage is shared via Arc, the write-back is observable on the original session through any clone of it once the returned stream is fully consumed (same pattern as Agent’s).

pub fn as_tool(&self) -> ToolDefinition

Wrap this workflow-agent as a ToolDefinition callable by another agent (mirrors Agent::as_tool). The tool takes a single task string and returns the response text.

Trait Implementations

impl Clone for WorkflowAgent

fn clone(&self) -> WorkflowAgent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl SupportsAgentRun for WorkflowAgent

fn run_stream<'life0, 'async_trait>( &'life0 self, messages: Vec<Message>, session: Option<AgentSession>, options: Option<AgentRunOptions>, ) -> Pin<Box<dyn Future<Output = Result<Pin<Box<dyn Stream<Item = Result<AgentResponseUpdate, Error>> + Send>>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, WorkflowAgent: 'async_trait,

Real streaming override: maps the workflow’s live events to agent updates as they happen, with the session’s context providers notified on completion. Per-run AgentRunOptions are not supported (the wrapped workflow’s executors carry their own options); non-empty options are ignored with a warning.

fn run<'life0, 'life1, 'async_trait>( &'life0 self, messages: Vec<Message>, session: Option<&'life1 mut AgentSession>, ) -> Pin<Box<dyn Future<Output = Result<AgentResponse, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, WorkflowAgent: 'async_trait,

Run the agent to completion.

fn id(&self) -> &str

A stable identifier for this agent.

fn name(&self) -> Option<&str>

The optional human-readable name.

fn create_session(&self) -> AgentSession

A fresh session for a new conversation.

fn run_with_options<'life0, 'life1, 'async_trait>( &'life0 self, messages: Vec<Message>, session: Option<&'life1 mut AgentSession>, options: AgentRunOptions, ) -> Pin<Box<dyn Future<Output = Result<AgentResponse, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

Run the agent to completion, applying per-run AgentRunOptions over the agent’s build-time defaults.

fn display_name(&self) -> String

The display name: name if set, else id.