Struct Codex

Source

pub struct Codex { /* private fields */ }

Expand description

Entry point for the Codex SDK.

Creates Thread instances for running prompts against the Codex CLI.

Implementations§

Source §

impl Codex

Source

pub fn new(config: CodexConfig) -> Result<Self>

Create a new Codex instance.

Discovers the CLI binary (or uses config.cli_path if set).

Source

pub fn start_thread(&self, options: ThreadOptions) -> Thread

Start a new thread (conversation).

Source

pub fn resume_thread( &self, thread_id: impl Into<String>, options: ThreadOptions, ) -> Thread

Resume a previous thread by ID.

Source

pub fn cli_path(&self) -> &Path

Get the resolved CLI path.

Source

pub async fn version(&self) -> Result<String>

Check the CLI version.

Auto Trait Implementations§

§

impl !UnwindSafe for Codex

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