koala-core 1.0.4

Shared types, invariant evaluator, and primitives for the koala framework.
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

//! Invariant evaluator. See ADR-0013.

mod context;
mod outcome;
mod perf;
mod property;
mod registry;
pub mod rules;
mod user_toml;

pub use context::Context;
pub use outcome::Outcome;
pub use perf::{evaluate_against_baseline, Baseline, PerfDecision};
pub use property::{persist_counter_example, persisted_path, PersistError, PropertyResult};
pub use registry::Registry;
pub use user_toml::{
    load_all as load_user_invariants, LoadError as UserLoadError, UserDefinedInvariant,
};

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum Category {
    Arch,
    Deps,
    Docs,
    Security,
    Health,
    Governance,
}

impl Category {
    pub fn as_str(&self) -> &'static str {
        match self {
            Self::Arch => "arch",
            Self::Deps => "deps",
            Self::Docs => "docs",
            Self::Security => "security",
            Self::Health => "health",
            Self::Governance => "governance",
        }
    }
}

pub trait Invariant: Send + Sync {
    fn id(&self) -> &'static str;
    fn category(&self) -> Category;
    fn intent(&self) -> &'static str;
    fn adr(&self) -> Option<&'static str> {
        None
    }
    fn evaluate(&self, ctx: &Context) -> Outcome;
}