Struct SessionOptions 

pub struct SessionOptions {
    pub client_info: ClientInfo,
    pub capabilities: Option<InitializeCapabilities>,
    pub command: String,
    pub extra_args: Vec<String>,
    pub call_timeout: Option<Duration>,
    pub events_capacity: Option<usize>,
}

Options used when creating a high-level CodexSession.

This wraps the generated initialize params plus process-spawn knobs so a caller can connect, handshake, and start using the app-server in one call.

Fields

client_info: ClientInfo

capabilities: Option<InitializeCapabilities>

command: String

extra_args: Vec<String>

call_timeout: Option<Duration>

events_capacity: Option<usize>

Implementations

impl SessionOptions

pub fn new(name: impl Into<String>, version: impl Into<String>) -> Self

Creates default session options for a client name and version.

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

Adds a human-readable title to the initialize client info.

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

Uses a different binary than codex when spawning the app-server.

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

Appends one extra argument after app-server when spawning Codex.

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

Appends a Codex -c key=value config override.

pub fn with_capabilities(self, capabilities: InitializeCapabilities) -> Self

Supplies explicit initialize capabilities.

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

Overrides the request/response timeout used by generated client calls.

pub fn with_events_capacity(self, events_capacity: usize) -> Self

Overrides the capacity of the session’s internal event channel instead of crate::DEFAULT_EVENTS_CHANNEL_CAPACITY. See crate::CodexAppServerClient::spawn_with_events_capacity for what this bounds and the drop policy once it fills up. A 0 capacity is rejected (not silently clamped) by the underlying client constructor when the session is created.

Trait Implementations

impl Clone for SessionOptions

fn clone(&self) -> SessionOptions

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SessionOptions

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

Formats the value using the given formatter.