bob-rs 0.3.6

Unofficial Rust SDK for the bob agent CLI — detection, install, keychain, run. Not affiliated with or endorsed by the bob maintainers.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69

//! Typed errors for the bob SDK.

/// 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.
#[derive(Debug, thiserror::Error)]
#[non_exhaustive]
pub enum BobError {
    /// 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.
    #[error("{context}: {source}")]
    Io {
        /// Which install step failed (e.g. `"spawn install script"`).
        context: &'static str,
        /// The underlying OS error.
        #[source]
        source: std::io::Error,
    },

    /// 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 `unwrap`ped.
    #[error("install child {stream} pipe was not captured")]
    PipeNotCaptured {
        /// Which stream was missing — `"stdout"` or `"stderr"`.
        stream: &'static str,
    },

    /// The OS keychain rejected a read / write / delete of the API key.
    #[error("keychain access failed: {0}")]
    Keychain(#[from] keyring::Error),

    /// Serializing the on-disk auth-state marker failed.
    #[error("auth-state serialization failed: {0}")]
    Serialize(#[from] serde_json::Error),

    /// A caller-supplied argument was invalid (e.g. an empty API key).
    #[error("{0}")]
    Invalid(String),

    /// The Node.js runtime that would execute bob is missing or too old.
    /// bob re-launches itself with flags that need a recent node (e.g.
    /// `--disable-sigusr1`), so an old runtime dies with an opaque
    /// "exited with code 9" — this preflight surfaces the real cause
    /// (and the fix) *before* the spawn instead.
    #[error("bob requires Node.js {minimum}+ — {detail}. Install Node {minimum} or newer (e.g. `nvm install {minimum}`), then reinstall or relaunch.")]
    NodeIncompatible {
        /// The minimum Node major bob supports (`BOB_MIN_NODE_VERSION`).
        minimum: String,
        /// What was actually found — a too-old version + its path, or
        /// "no `node` found on PATH".
        detail: String,
    },

    /// The platform application-data directory couldn't be resolved, so the
    /// auth-state marker has nowhere to live.
    #[error("could not determine the application data directory")]
    NoDataDir,

    /// The subprocess engine failed to spawn or cancel bob.
    #[error(transparent)]
    Stream(#[from] cli_stream::StreamError),
}