Struct CodexHomeLayout 

pub struct CodexHomeLayout { /* private fields */ }

Describes the on-disk layout used by the Codex CLI when CODEX_HOME is set.

Files are rooted next to config.toml, auth.json, .credentials.json, and history.jsonl; conversations/ holds transcript JSONL files and logs/ holds codex-*.log outputs. Call Self::materialize to create the directories when standing up an app-scoped home.

Implementations

impl CodexHomeLayout

pub fn new(root: impl Into<PathBuf>) -> Self

Creates a new layout description rooted at root.

pub fn root(&self) -> &Path

Returns the CODEX_HOME root.

pub fn config_path(&self) -> PathBuf

Path to config.toml under CODEX_HOME.

pub fn auth_path(&self) -> PathBuf

Path to auth.json under CODEX_HOME.

pub fn credentials_path(&self) -> PathBuf

Path to .credentials.json under CODEX_HOME.

pub fn history_path(&self) -> PathBuf

Path to history.jsonl under CODEX_HOME.

pub fn conversations_dir(&self) -> PathBuf

Directory containing conversation transcripts.

pub fn logs_dir(&self) -> PathBuf

Directory containing Codex log files.

pub fn materialize(&self, create_home_dirs: bool) -> Result<(), CodexError>

Creates the CODEX_HOME root and its known subdirectories when create_home_dirs is true. No-op when disabled.

pub fn seed_auth_from( &self, seed_home: impl AsRef<Path>, options: AuthSeedOptions, ) -> Result<AuthSeedOutcome, AuthSeedError>

Copies login artifacts (auth.json and .credentials.json) from a trusted seed home into this layout. History and logs are intentionally excluded.

This is opt-in and leaves defaults untouched. Missing files raise errors only when marked as required in options; otherwise they are skipped. Target directories are created when create_target_dirs is true.

Trait Implementations

impl Clone for CodexHomeLayout

fn clone(&self) -> CodexHomeLayout

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CodexHomeLayout

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

Formats the value using the given formatter.

impl PartialEq for CodexHomeLayout

fn eq(&self, other: &CodexHomeLayout) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for CodexHomeLayout

impl StructuralPartialEq for CodexHomeLayout