Enum Error 

pub enum Error {
    Env {
        source: VarError,
    },
    CurrentDir {
        source: Error,
    },
    Io {
        action: &'static str,
        path: PathBuf,
        source: Error,
    },
    InvalidIdentityName {
        name: String,
    },
    IdentityNotFound {
        name: IdentityName,
    },
    IdentityAlreadyExists {
        name: IdentityName,
    },
    IdentityBroken {
        name: IdentityName,
    },
    NativeAuthExists,
    NoNativeAuthFile,
    CodexHomeMissing {
        path: PathBuf,
    },
    UnknownAuthState {
        reason: UnknownAuthReason,
    },
}

Error returned by the library API.

Variants

Env

Environment did not contain enough information to resolve Codex home.

Fields

source: VarError

Source environment error.

CurrentDir

Current working directory could not be read while absolutizing a path.

Fields

source: Error

Source filesystem error.

Io

Filesystem operation failed.

Fields

action: &'static str

Action being attempted.

path: PathBuf

Path involved in the failure.

source: Error

Source filesystem error.

InvalidIdentityName

Identity name is invalid.

Fields

name: String

Invalid name.

IdentityNotFound

Identity does not exist.

Fields

name: IdentityName

Missing identity name.

IdentityAlreadyExists

Identity already exists.

Fields

name: IdentityName

Existing identity name.

IdentityBroken

Identity entry exists but is unusable.

Fields

name: IdentityName

Broken identity name.

NativeAuthExists

Native auth file exists and would be discarded.

NoNativeAuthFile

No native auth file exists to capture.

CodexHomeMissing

Codex home does not exist.

Fields

path: PathBuf

Missing Codex home path.

UnknownAuthState

Current auth state is unknown.

Fields

reason: UnknownAuthReason

Reason the auth state is unknown.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.