Skip to main content

Workflow

Struct Workflow 

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

One reusable workflow handle:

  • simple path: run(prompt)
  • expert path: profile/config mutation via WorkflowConfig

Implementations§

Source§

impl Workflow

Source

pub async fn connect(config: WorkflowConfig) -> Result<Self, ClientError>

Connect once with one explicit workflow config.

Source

pub async fn connect_default( cwd: impl Into<String>, ) -> Result<Self, ClientError>

Connect with defaults for one cwd.

Source

pub async fn run( &self, prompt: impl Into<String>, ) -> Result<PromptRunResult, PromptRunError>

Run one prompt using workflow defaults.

Source

pub async fn run_with_profile( &self, prompt: impl Into<String>, profile: RunProfile, ) -> Result<PromptRunResult, PromptRunError>

Run one prompt with explicit profile override.

Source

pub async fn setup_session(&self) -> Result<Session, PromptRunError>

Start one session using workflow defaults.

Source

pub async fn setup_session_with_profile( &self, profile: RunProfile, ) -> Result<Session, PromptRunError>

Start one session with explicit profile override.

Source

pub fn config(&self) -> &WorkflowConfig

Source

pub fn client(&self) -> &Client

Source

pub async fn shutdown(self) -> Result<(), RuntimeError>

Explicit shutdown to keep lifecycle obvious.

Trait Implementations§

Source§

impl Clone for Workflow

Source§

fn clone(&self) -> Workflow

Returns a duplicate of the value. Read more
1.0.0 · 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> 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> Same for T

Source§

type Output = T

Should always be Self
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 = Infallible

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