Skip to main content

ReadOnlyTransport

Struct ReadOnlyTransport 

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

Read-only NDJSON transport wrapping a codex subprocess.

Each line read from stdout is a single JSON object. There is no stdin writing — the prompt is passed as a CLI argument.

Implementations§

Source§

impl ReadOnlyTransport

Source

pub fn spawn( cli_path: &str, subcommand: &str, extra_args: &[String], prompt: Option<&str>, working_dir: Option<&Path>, env_vars: &[(String, String)], ) -> Result<Self>

Spawn a new codex process.

The process is launched as <cli_path> <subcommand> --json [extra_args...] [prompt]. Stdin is /dev/null — there is no send method.

§Errors

Returns SdkError::ProcessSpawn if the process cannot be started.

Source

pub async fn recv(&mut self) -> Result<Option<Value>>

Read the next NDJSON line from stdout and parse it as a JSON value.

Returns Ok(None) when stdout reaches EOF (process exited).

§Errors

Returns SdkError::InvalidJson if a line is not valid JSON. Returns SdkError::Io on read failure.

Source

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

Send an interrupt signal (SIGINT on Unix) to the subprocess.

Source

pub async fn kill(&mut self) -> Result<()>

Kill the subprocess immediately (SIGKILL on Unix).

Source

pub async fn wait_with_stderr( &mut self, ) -> Result<(Option<i32>, Option<String>)>

Wait for the subprocess to exit and return the exit code and captured stderr.

Source

pub fn try_wait(&mut self) -> Result<Option<ExitStatus>>

Check whether the child process has exited without blocking.

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, 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