Enum BobError 

#[non_exhaustive]
pub enum BobError {
    Io {
        context: &'static str,
        source: Error,
    },
    PipeNotCaptured {
        stream: &'static str,
    },
    Keychain(Error),
    Serialize(Error),
    Invalid(String),
    NoDataDir,
    Stream(StreamError),
}

Why a bob-rs operation (install, keychain I/O, spawn) failed.

Each variant carries the real underlying error as a source — an std::io::Error, a keyring::Error, a serde_json::Error, or a cli_stream::StreamError — rather than a pre-formatted string, so a consumer can inspect or downcast it (e.g. branch on io::ErrorKind, or recognise a keyring::Error::NoEntry). #[non_exhaustive] so adding a variant later isn’t a breaking change.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Io

An OS-level I/O failure while running the installer — spooling the embedded script to a tempfile, setting its mode, spawning bash, or waiting on it. context names the step; source is the OS error.

Fields

context: &'static str

Which install step failed (e.g. "spawn install script").

source: Error

The underlying OS error.

PipeNotCaptured

A spawned install child didn’t expose a piped stdout/stderr. Shouldn’t happen given Stdio::piped(), but Child’s accessors return Option, so the case is represented rather than unwrapped.

Fields

stream: &'static str

Which stream was missing — "stdout" or "stderr".

Keychain(Error)

The OS keychain rejected a read / write / delete of the API key.

Serialize(Error)

Serializing the on-disk auth-state marker failed.

Invalid(String)

A caller-supplied argument was invalid (e.g. an empty API key).

NoDataDir

The platform application-data directory couldn’t be resolved, so the auth-state marker has nowhere to live.

Stream(StreamError)

The subprocess engine failed to spawn or cancel bob.

Trait Implementations

impl Debug for BobError

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

Formats the value using the given formatter.

impl Display for BobError

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

Formats the value using the given formatter.

impl Error for BobError

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.

impl From<Error> for BobError

fn from(source: Error) -> BobError

Converts to this type from the input type.

impl From<Error> for BobError

fn from(source: Error) -> BobError

Converts to this type from the input type.

impl From<StreamError> for BobError

fn from(source: StreamError) -> BobError

Converts to this type from the input type.