Skip to main content

CodexBuilder

Struct CodexBuilder 

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

Builder for creating a Codex client.

All options are optional. By default the builder discovers the codex binary via PATH.

Implementations§

Source§

impl CodexBuilder

Source

pub fn binary(self, path: impl Into<PathBuf>) -> Self

Set an explicit path to the codex binary (skips PATH lookup).

Source

pub fn working_dir(self, path: impl Into<PathBuf>) -> Self

Set the working directory for all commands.

Source

pub fn env(self, key: impl Into<String>, value: impl Into<String>) -> Self

Set a single environment variable for child processes.

Source

pub fn envs( self, vars: impl IntoIterator<Item = (impl Into<String>, impl Into<String>)>, ) -> Self

Set multiple environment variables for child processes.

Source

pub fn timeout_secs(self, seconds: u64) -> Self

Set the command timeout in seconds.

Source

pub fn timeout(self, duration: Duration) -> Self

Set the command timeout as a Duration.

Source

pub fn arg(self, arg: impl Into<String>) -> Self

Append a raw global argument passed before any subcommand.

Source

pub fn config(self, key_value: impl Into<String>) -> Self

Add a global config override (-c key=value).

Source

pub fn enable(self, feature: impl Into<String>) -> Self

Enable a feature flag globally (--enable <name>).

Source

pub fn disable(self, feature: impl Into<String>) -> Self

Disable a feature flag globally (--disable <name>).

Source

pub fn retry(self, policy: RetryPolicy) -> Self

Set a default RetryPolicy for all commands.

Source

pub fn build(self) -> Result<Codex>

Build the Codex client.

Returns Error::NotFound if no binary path was set and codex is not found in PATH.

Trait Implementations§

Source§

impl Debug for CodexBuilder

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for CodexBuilder

Source§

fn default() -> CodexBuilder

Returns the “default value” for a type. 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> 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