armour-typ 0.1.0

Shared schema/type descriptors (Typ, ScalarTyp, GetType) for the armour ecosystem
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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140

use crate::scalar::ScalarTyp;
use crate::typ::{Fields, Typ};

/// Owned runtime mirror of `Typ`. Reuses `ScalarTyp`. Deserializable
/// (`impl Rapira` — in the rapira crate, Plan 2).
#[derive(PartialEq, Eq, Clone, Debug)]
pub enum SchemaTyp {
    Scalar(ScalarTyp),
    Array(u32, Box<SchemaTyp>),
    Vec(Box<SchemaTyp>),
    Optional(Box<SchemaTyp>),
    SimpleEnum {
        name: String,
        variants: Vec<(u8, String)>,
    },
    Struct {
        name: String,
        fields: SchemaFields,
    },
    Enum {
        name: String,
        variants: Vec<(u8, String, SchemaTyp)>,
    },
    Custom(String, Vec<SchemaTyp>),
}

#[derive(PartialEq, Eq, Clone, Debug)]
pub enum SchemaFields {
    Named(Vec<(String, SchemaTyp)>),
    Unnamed(Vec<SchemaTyp>),
}

impl From<&Typ> for SchemaTyp {
    fn from(t: &Typ) -> Self {
        match t {
            Typ::Scalar(s) => SchemaTyp::Scalar(*s),
            Typ::Array(n, inner) => SchemaTyp::Array(*n, Box::new(SchemaTyp::from(*inner))),
            Typ::Vec(inner) => SchemaTyp::Vec(Box::new(SchemaTyp::from(*inner))),
            Typ::Optional(inner) => SchemaTyp::Optional(Box::new(SchemaTyp::from(*inner))),
            Typ::SimpleEnum(e) => SchemaTyp::SimpleEnum {
                name: e.name.to_string(),
                variants: e
                    .variants
                    .iter()
                    .map(|(i, n)| (*i, n.to_string()))
                    .collect(),
            },
            Typ::Struct(s) => SchemaTyp::Struct {
                name: s.name.to_string(),
                fields: match s.fields {
                    Fields::Named(fs) => SchemaFields::Named(
                        fs.iter()
                            .map(|(n, ty)| (n.to_string(), SchemaTyp::from(ty)))
                            .collect(),
                    ),
                    Fields::Unnamed(fs) => {
                        SchemaFields::Unnamed(fs.iter().map(SchemaTyp::from).collect())
                    }
                },
            },
            Typ::Enum(e) => SchemaTyp::Enum {
                name: e.name.to_string(),
                variants: e
                    .variants
                    .iter()
                    .map(|(i, (n, ty))| (*i, n.to_string(), SchemaTyp::from(ty)))
                    .collect(),
            },
            Typ::Custom(name, items) => SchemaTyp::Custom(
                name.to_string(),
                items.iter().map(SchemaTyp::from).collect(),
            ),
        }
    }
}

/// Exhaustiveness guard (spec §11): a new composite variant in `Typ` must be
/// mirrored here in `SchemaTyp`, otherwise this match fails to compile. Pairs
/// with the compiler-enforced `From<&Typ>` match above (which guards the
/// `Typ → SchemaTyp` direction) to keep both enums in lockstep.
#[cfg(test)]
#[allow(dead_code)]
fn _schema_guard(s: &SchemaTyp) {
    match s {
        SchemaTyp::Scalar(_) => {}
        SchemaTyp::Array(_, _) => {}
        SchemaTyp::Vec(_) => {}
        SchemaTyp::Optional(_) => {}
        SchemaTyp::SimpleEnum { .. } => {}
        SchemaTyp::Struct { .. } => {}
        SchemaTyp::Enum { .. } => {}
        SchemaTyp::Custom(_, _) => {}
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::scalar::ScalarTyp;
    use crate::typ::{Fields, StructType, Typ};

    #[test]
    fn from_typ_struct_roundtrips_shape() {
        static T: Typ = Typ::Struct(StructType {
            name: "S",
            fields: Fields::Named(&[
                ("a", Typ::Scalar(ScalarTyp::U64)),
                ("b", Typ::Vec(&Typ::Scalar(ScalarTyp::Str))),
            ]),
        });
        let s = SchemaTyp::from(&T);
        let expected = SchemaTyp::Struct {
            name: "S".to_string(),
            fields: SchemaFields::Named(vec![
                ("a".to_string(), SchemaTyp::Scalar(ScalarTyp::U64)),
                (
                    "b".to_string(),
                    SchemaTyp::Vec(Box::new(SchemaTyp::Scalar(ScalarTyp::Str))),
                ),
            ]),
        };
        assert_eq!(s, expected);
    }

    #[test]
    fn from_typ_covers_scalars_and_composites() {
        assert_eq!(
            SchemaTyp::from(&Typ::Scalar(ScalarTyp::Fuid)),
            SchemaTyp::Scalar(ScalarTyp::Fuid)
        );
        assert_eq!(
            SchemaTyp::from(&Typ::Optional(&Typ::Scalar(ScalarTyp::Id64))),
            SchemaTyp::Optional(Box::new(SchemaTyp::Scalar(ScalarTyp::Id64)))
        );
        assert_eq!(
            SchemaTyp::from(&Typ::Custom("c", &[Typ::Scalar(ScalarTyp::U8)])),
            SchemaTyp::Custom("c".to_string(), vec![SchemaTyp::Scalar(ScalarTyp::U8)])
        );
    }
}