Skip to main content

Codex

Struct Codex 

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

Entry point for interacting with the Codex agent.

Implementations§

Source§

impl Codex

Source

pub fn new(options: Option<CodexOptions>) -> Result<Self>

Creates a new Codex client.

When options is None, default options are used and the SDK attempts to discover the codex executable automatically.

§Example
use codex::Codex;

let _codex = Codex::new(None)?;
Source

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

Starts a new thread.

§Example
use codex::Codex;

let codex = Codex::new(None)?;
let _thread = codex.start_thread(None);
Source

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

Resumes an existing thread by id.

§Example
use codex::Codex;

let codex = Codex::new(None)?;
let _thread = codex.resume_thread("thread_123", None);

Trait Implementations§

Source§

impl Clone for Codex

Source§

fn clone(&self) -> Codex

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

impl Debug for Codex

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Codex

§

impl RefUnwindSafe for Codex

§

impl Send for Codex

§

impl Sync for Codex

§

impl Unpin for Codex

§

impl UnsafeUnpin for Codex

§

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