classifier-implementation 0.1.0

Compatibility classifier contract implementation
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

boxology::contract! {
    pub enum CompatibilityClass {
        Unchanged,
        Documentation,
        Deprecation,
        Additive,
        CompatibleWithConditions,
        Incompatible,
    }

    pub struct ClassifyRequest {
        pub base: Option<Vec<u8>>,
        pub submitted: Vec<u8>,
    }

    pub struct ClassifyFinding {
        pub code: String,
        pub path: String,
        pub kind: String,
        pub class: CompatibilityClass,
        pub base_excerpt: Option<String>,
        pub submitted_excerpt: Option<String>,
        pub condition: Option<String>,
    }

    pub struct ClassifyReport {
        pub verdict: CompatibilityClass,
        pub findings: Vec<ClassifyFinding>,
        pub rendered_text: String,
    }

    pub enum ClassifyFailureStage {
        Base,
        Submitted,
        Pairing,
    }

    pub struct ClassifyFailure {
        pub stage: ClassifyFailureStage,
        pub diagnostics: String,
    }

    pub struct ClassifyOutcome {
        pub report: Option<ClassifyReport>,
        pub failure: Option<ClassifyFailure>,
    }

    #[error]
    pub enum ClassifierError { Internal }

    #[capability]
    pub async fn classify(request: ClassifyRequest) -> Result<ClassifyOutcome, ClassifierError>;
}