Struct AuthSessionHelper 

pub struct AuthSessionHelper { /* private fields */ }

Helper for checking Codex auth state and triggering login flows with an app-scoped CODEX_HOME.

All commands run with per-process env overrides; the parent process env is never mutated.

Implementations

impl AuthSessionHelper

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

Creates a helper that pins CODEX_HOME to app_codex_home for every login call.

pub fn with_client(client: CodexClient) -> Self

Wraps an existing CodexClient (useful when you already configured the binary path).

pub fn client(&self) -> CodexClient

Returns the underlying CodexClient.

pub async fn status(&self) -> Result<CodexAuthStatus, CodexError>

Reports the current login status under the configured CODEX_HOME.

pub async fn ensure_api_key_login( &self, api_key: impl AsRef<str>, ) -> Result<CodexAuthStatus, CodexError>

Logs in with an API key when logged out; otherwise returns the current status.

pub async fn ensure_chatgpt_login(&self) -> Result<Option<Child>, CodexError>

Starts the ChatGPT OAuth login flow when no credentials are present.

Returns Ok(None) when already logged in; otherwise returns the spawned login child so the caller can surface output/URLs. Dropping the child kills the login helper.

pub fn spawn_chatgpt_login(&self) -> Result<Child, CodexError>

Directly spawns the ChatGPT login process.

pub async fn login_with_api_key( &self, api_key: impl AsRef<str>, ) -> Result<CodexAuthStatus, CodexError>

Directly logs in with an API key without checking prior state.

Trait Implementations

impl Clone for AuthSessionHelper

fn clone(&self) -> AuthSessionHelper

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthSessionHelper

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

Formats the value using the given formatter.