Skip to main content

Thread

Struct Thread 

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

A conversation thread with the Codex agent.

Each call to run() or run_streamed() spawns a codex exec subprocess.

Implementations§

Source§

impl Thread

Source

pub fn with_approval_callback(self, callback: ApprovalCallback) -> Self

Set an approval callback for handling permission requests.

Source

pub fn with_patch_approval_callback( self, callback: PatchApprovalCallback, ) -> Self

Set a patch approval callback for handling file-patch approval requests.

Source

pub fn with_event_callback(self, callback: EventCallback) -> Self

Set an event callback for observing, transforming, or filtering events.

Source

pub fn with_hooks(self, hooks: Vec<HookMatcher>) -> Self

Add hooks to this thread.

Source

pub fn with_transport(self, transport: Arc<dyn Transport>) -> Self

Override the transport used for this thread (useful for testing).

When set, the provided transport is used instead of spawning a real codex subprocess. The same connect / write / end_input / read_messages / close call sequence is used regardless.

Source

pub fn id(&self) -> Option<String>

Get the thread ID (populated after first successful turn).

Source

pub async fn interrupt(&self) -> Result<()>

Interrupt the currently running turn by sending SIGINT to the CLI subprocess.

Equivalent to pressing Ctrl-C. The CLI has close_timeout seconds to clean up before being force-killed. Returns Ok(()) if no turn is in progress.

Source

pub async fn run( &mut self, input: impl Into<Input>, turn_options: TurnOptions, ) -> Result<Turn>

Run a prompt and collect all events into a Turn.

Source

pub async fn run_streamed( &mut self, input: impl Into<Input>, turn_options: TurnOptions, ) -> Result<StreamedTurn>

Run a prompt and return a streaming StreamedTurn.

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> 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. 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