nils-common 0.7.3

Library crate for nils-common in the nils-cli workspace.
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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93

use thiserror::Error;

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum CoreErrorCategory {
    Config,
    Auth,
    Exec,
    Dependency,
    Validation,
    Internal,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum ProviderCategoryHint {
    Auth,
    Dependency,
    Validation,
    Internal,
}

#[derive(Debug, Clone, PartialEq, Eq, Error)]
#[error("{message}")]
pub struct CoreError {
    pub category: CoreErrorCategory,
    pub code: &'static str,
    pub message: String,
    pub retryable: bool,
}

impl CoreError {
    pub fn new(
        category: CoreErrorCategory,
        code: &'static str,
        message: impl Into<String>,
    ) -> Self {
        Self {
            category,
            code,
            message: message.into(),
            retryable: false,
        }
    }

    pub fn with_retryable(mut self, retryable: bool) -> Self {
        self.retryable = retryable;
        self
    }

    pub fn config(code: &'static str, message: impl Into<String>) -> Self {
        Self::new(CoreErrorCategory::Config, code, message)
    }

    pub fn auth(code: &'static str, message: impl Into<String>) -> Self {
        Self::new(CoreErrorCategory::Auth, code, message)
    }

    pub fn exec(code: &'static str, message: impl Into<String>) -> Self {
        Self::new(CoreErrorCategory::Exec, code, message)
    }

    pub fn dependency(code: &'static str, message: impl Into<String>) -> Self {
        Self::new(CoreErrorCategory::Dependency, code, message)
    }

    pub fn validation(code: &'static str, message: impl Into<String>) -> Self {
        Self::new(CoreErrorCategory::Validation, code, message)
    }

    pub fn internal(code: &'static str, message: impl Into<String>) -> Self {
        Self::new(CoreErrorCategory::Internal, code, message)
    }

    pub fn exit_code_hint(&self) -> i32 {
        match self.category {
            CoreErrorCategory::Validation | CoreErrorCategory::Config => 64,
            CoreErrorCategory::Auth
            | CoreErrorCategory::Exec
            | CoreErrorCategory::Dependency
            | CoreErrorCategory::Internal => 1,
        }
    }

    pub fn provider_category_hint(&self) -> ProviderCategoryHint {
        match self.category {
            CoreErrorCategory::Auth => ProviderCategoryHint::Auth,
            CoreErrorCategory::Dependency => ProviderCategoryHint::Dependency,
            CoreErrorCategory::Validation | CoreErrorCategory::Config => {
                ProviderCategoryHint::Validation
            }
            CoreErrorCategory::Exec | CoreErrorCategory::Internal => ProviderCategoryHint::Internal,
        }
    }
}