okr 0.1.7

Reproducible R source context for coding agents
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

//! Reproducible, vendored R source context for coding agents.

pub mod cli;
pub mod config;
pub mod digest;
pub mod fetch;
pub mod hosttools;
pub mod lock;
pub mod manifest;
mod progress;
pub mod resolve;
pub mod rlib;
pub mod spec;
pub mod vendor;

/// Errors surfaced by the library and their stable CLI exit classes.
#[derive(Debug, thiserror::Error)]
pub enum Error {
    #[error("{0}")]
    Config(String),
    #[error("{0}")]
    Spec(String),
    #[error("{0}")]
    Fetch(String),
    #[error("{0}")]
    Verification(String),
    #[error(transparent)]
    Io(#[from] std::io::Error),
}

impl Error {
    /// Map an error to the public exit-code contract in SPEC.md section 6.
    #[must_use]
    pub const fn exit_code(&self) -> u8 {
        match self {
            Self::Config(_) | Self::Spec(_) => 2,
            Self::Fetch(_) => 3,
            Self::Verification(_) => 4,
            Self::Io(_) => 1,
        }
    }
}

pub type Result<T> = std::result::Result<T, Error>;

#[cfg(test)]
mod tests {
    use super::Error;

    #[test]
    fn exit_codes_follow_the_cli_contract() {
        assert_eq!(Error::Config(String::new()).exit_code(), 2);
        assert_eq!(Error::Spec(String::new()).exit_code(), 2);
        assert_eq!(Error::Fetch(String::new()).exit_code(), 3);
        assert_eq!(Error::Verification(String::new()).exit_code(), 4);
    }
}