mant-protocol 0.11.0

Transport-neutral query contracts and projections for ManT
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
94
95
96
97
98
99
100
101
102

#![doc = include_str!("../README.md")]
#![warn(missing_docs)]

mod catalog;
mod content_selector;
mod doctor;
mod document;
mod explanation;
mod kind_labels;
mod labels;
mod navigation;
mod outline;
mod query;
mod references;
mod schema;
mod scope;
mod search;
mod selector;
mod update;

pub use catalog::*;
pub use content_selector::*;
pub use doctor::*;
pub use document::*;
pub use explanation::*;
pub use kind_labels::entry_kind_label;
pub use labels::{EntryLabelMode, entry_label};
pub use navigation::DocumentOpenTarget;
pub use outline::*;
pub use query::*;
pub use references::*;
pub use schema::*;
pub use scope::*;
pub use search::*;
pub use selector::*;
pub use update::*;

/// Pre-stable native API release line shared by the query protocol family.
pub const NATIVE_API_VERSION: &str = "0.11";

/// Exact process protocol reported by the native CLI boundary.
pub const CLI_PROTOCOL_VERSION: &str = "mant.cli/v0.11";

#[cfg(test)]
mod tests {
    use super::{
        CLI_PROTOCOL_VERSION, CatalogSchema, DocumentSchema, ExcerptSchema, NATIVE_API_VERSION,
        OutlineSchema, QuerySchema, RequestSchema, ScopeQuerySchema, ScopeRequestSchema,
        SearchSchema, TldrCacheUpdateSchema,
    };

    #[test]
    fn native_api_version_is_explicit() {
        assert_eq!(NATIVE_API_VERSION, "0.11");
        assert_eq!(CLI_PROTOCOL_VERSION, "mant.cli/v0.11");
    }

    #[test]
    fn advertised_schema_ids_match_their_serialized_markers() {
        for (value, expected) in [
            (
                serde_json::to_value(RequestSchema::V0Dot11),
                RequestSchema::ID,
            ),
            (serde_json::to_value(QuerySchema::V0Dot11), QuerySchema::ID),
            (
                serde_json::to_value(DocumentSchema::V0Dot11),
                DocumentSchema::ID,
            ),
            (
                serde_json::to_value(OutlineSchema::V0Dot11),
                OutlineSchema::ID,
            ),
            (
                serde_json::to_value(ExcerptSchema::V0Dot11),
                ExcerptSchema::ID,
            ),
            (
                serde_json::to_value(SearchSchema::V0Dot11),
                SearchSchema::ID,
            ),
            (
                serde_json::to_value(ScopeRequestSchema::V0Dot11),
                ScopeRequestSchema::ID,
            ),
            (
                serde_json::to_value(ScopeQuerySchema::V0Dot11),
                ScopeQuerySchema::ID,
            ),
            (
                serde_json::to_value(CatalogSchema::V0Dot11),
                CatalogSchema::ID,
            ),
            (
                serde_json::to_value(TldrCacheUpdateSchema::V1),
                TldrCacheUpdateSchema::ID,
            ),
        ] {
            assert_eq!(value.expect("serialize schema marker"), expected);
        }
    }
}