Skip to main content

CodexExecArgs

Struct CodexExecArgs 

Source
pub struct CodexExecArgs {
Show 17 fields pub input: String, pub base_url: Option<String>, pub api_key: Option<String>, pub thread_id: Option<String>, pub images: Vec<String>, pub model: Option<String>, pub sandbox_mode: Option<SandboxMode>, pub working_directory: Option<String>, pub additional_directories: Vec<String>, pub skip_git_repo_check: bool, pub output_schema_file: Option<String>, pub model_reasoning_effort: Option<ModelReasoningEffort>, pub network_access_enabled: Option<bool>, pub web_search_mode: Option<WebSearchMode>, pub web_search_enabled: Option<bool>, pub approval_policy: Option<ApprovalMode>, pub cancellation_token: Option<CancellationToken>,
}
Expand description

Arguments used by CodexExec::run.

Fields§

§input: String

Prompt text passed to Codex via stdin.

§base_url: Option<String>

Optional OPENAI_BASE_URL override.

§api_key: Option<String>

Optional CODEX_API_KEY override.

§thread_id: Option<String>

Existing thread id to resume. When set, resume <thread_id> is added.

§images: Vec<String>

Local image paths passed via repeated --image flags.

§model: Option<String>

Model override passed as --model.

§sandbox_mode: Option<SandboxMode>

Sandbox mode passed as --sandbox.

§working_directory: Option<String>

Working directory passed as --cd.

§additional_directories: Vec<String>

Additional directories passed as repeated --add-dir flags.

§skip_git_repo_check: bool

Whether to append --skip-git-repo-check.

§output_schema_file: Option<String>

Path passed to --output-schema.

§model_reasoning_effort: Option<ModelReasoningEffort>

Model reasoning effort translated to a --config override.

§network_access_enabled: Option<bool>

Network access override translated to a --config entry.

§web_search_mode: Option<WebSearchMode>

Explicit web search mode translated to a --config entry.

§web_search_enabled: Option<bool>

Legacy boolean web search toggle used when web_search_mode is absent.

§approval_policy: Option<ApprovalMode>

Approval policy translated to a --config entry.

§cancellation_token: Option<CancellationToken>

Optional cancellation token that aborts the running subprocess.

Trait Implementations§

Source§

impl Clone for CodexExecArgs

Source§

fn clone(&self) -> CodexExecArgs

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 CodexExecArgs

Source§

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

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

impl Default for CodexExecArgs

Source§

fn default() -> CodexExecArgs

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