rscheck-cli 0.1.0-alpha.3

CLI frontend for the rscheck policy engine.
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

use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum SemanticBackendAvailability {
    Available,
    Unavailable,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct SemanticBackendStatus {
    pub availability: SemanticBackendAvailability,
    pub runtime: String,
    pub reason: Option<String>,
}

impl SemanticBackendStatus {
    #[must_use]
    pub fn available(runtime: &str) -> Self {
        Self {
            availability: SemanticBackendAvailability::Available,
            runtime: runtime.to_string(),
            reason: None,
        }
    }

    #[must_use]
    pub fn unavailable(runtime: &str, reason: impl Into<String>) -> Self {
        Self {
            availability: SemanticBackendAvailability::Unavailable,
            runtime: runtime.to_string(),
            reason: Some(reason.into()),
        }
    }

    #[must_use]
    pub fn probe() -> Self {
        Self::probe_for_runtime("current")
    }

    #[must_use]
    pub fn probe_for_runtime(runtime: &str) -> Self {
        Self {
            availability: SemanticBackendAvailability::Unavailable,
            runtime: runtime.to_string(),
            reason: Some(format!(
                "semantic backend unavailable on `{runtime}` because rscheck-cli was built without a nightly semantic implementation"
            )),
        }
    }

    #[must_use]
    pub fn is_available(&self) -> bool {
        self.availability == SemanticBackendAvailability::Available
    }
}