Struct CodexConfig 

pub struct CodexConfig { /* private fields */ }

Selects how an agent connects to a Codex app server.

Examples

use std::time::Duration;
use agents_kit::{
    config::{BackendConfig, CodexConfig},
    KitError,
};

let spawned_codex = || -> Result<BackendConfig, KitError> {
    let codex = CodexConfig::spawn(
        Duration::from_secs(15),
        Duration::from_secs(60),
    )?;
    Ok(codex.into())
};
let backend = spawned_codex()?;
assert!(matches!(backend, BackendConfig::Codex(_)));

Implementations

impl CodexConfig

pub fn spawn( startup_timeout: Duration, request_timeout: Duration, ) -> Result<Self, KitError>

Configures a Kit-owned Codex child process.

Configuration is passive; the child starts during Agent build.

Errors

Returns crate::error::ErrorKind::InvalidConfig when: Either timeout is zero.

use agents_kit::config::CodexConfig;
use std::time::Duration;
let config = CodexConfig::spawn(Duration::from_secs(15), Duration::from_secs(60))?;
assert!(CodexConfig::spawn(Duration::ZERO, Duration::from_secs(60)).is_err());

pub fn tcp( address: SocketAddr, connect_timeout: Duration, request_timeout: Duration, ) -> Result<Self, KitError>

Configures exclusive attachment to a caller-managed TCP app server.

Constructing this value does not open a socket.

Errors

Returns crate::error::ErrorKind::InvalidConfig when: The port or either timeout is zero.

use agents_kit::config::CodexConfig;
use std::time::Duration;
let config = CodexConfig::tcp("127.0.0.1:4500".parse().unwrap(),
    Duration::from_secs(10), Duration::from_secs(60))?;
assert!(CodexConfig::tcp("127.0.0.1:0".parse().unwrap(),
    Duration::from_secs(10), Duration::from_secs(60)).is_err());

pub fn unix( path: PathBuf, connect_timeout: Duration, request_timeout: Duration, ) -> Result<Self, KitError>

Configures exclusive attachment through a Unix-domain socket.

The path is not opened until Agent build. Availability of Unix sockets depends on the host.

Errors

Returns crate::error::ErrorKind::InvalidConfig when: The path is empty or either timeout is zero.

use agents_kit::config::CodexConfig;
use std::time::Duration;
let config = CodexConfig::unix("codex.sock".into(), Duration::from_secs(10), Duration::from_secs(60))?;
assert!(CodexConfig::unix("".into(), Duration::from_secs(10), Duration::from_secs(60)).is_err());

Trait Implementations

impl Clone for CodexConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CodexConfig

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

Formats the value using the given formatter.

impl From<CodexConfig> for BackendConfig

fn from(config: CodexConfig) -> Self

Converts to this type from the input type.