codama-nodes 0.9.0

Node specifications and helpers for the Codama standard
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

use crate::{CamelCaseString, Docs, HasName, TypeNode};
use codama_nodes_derive::node;

#[node]
pub struct DefinedTypeNode {
    // Data.
    pub name: CamelCaseString,
    #[serde(default, skip_serializing_if = "crate::is_default")]
    pub docs: Docs,

    // Children.
    pub r#type: TypeNode,
}

impl DefinedTypeNode {
    pub fn new<T, U>(name: T, r#type: U) -> Self
    where
        T: Into<CamelCaseString>,
        U: Into<TypeNode>,
    {
        Self {
            name: name.into(),
            docs: Docs::default(),
            r#type: r#type.into(),
        }
    }
}

impl HasName for DefinedTypeNode {
    fn name(&self) -> &CamelCaseString {
        &self.name
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::{NumberTypeNode, U8};

    #[test]
    fn new() {
        let node = DefinedTypeNode::new("myType", NumberTypeNode::le(U8));
        assert_eq!(node.name, CamelCaseString::new("myType"));
        assert_eq!(node.docs, Docs::default());
        assert_eq!(node.r#type, TypeNode::Number(NumberTypeNode::le(U8)));
    }

    #[test]
    fn direct_instantiation() {
        let node = DefinedTypeNode {
            name: "myType".into(),
            docs: Docs::default(),
            r#type: NumberTypeNode::le(U8).into(),
        };
        assert_eq!(node.name, CamelCaseString::new("myType"));
        assert_eq!(node.docs, Docs::default());
        assert_eq!(node.r#type, TypeNode::Number(NumberTypeNode::le(U8)));
    }

    #[test]
    fn to_json() {
        let node = DefinedTypeNode::new("myType", NumberTypeNode::le(U8));
        let json = serde_json::to_string(&node).unwrap();
        assert_eq!(
            json,
            r#"{"kind":"definedTypeNode","name":"myType","type":{"kind":"numberTypeNode","format":"u8","endian":"le"}}"#
        );
    }

    #[test]
    fn from_json() {
        let json = r#"{"kind":"definedTypeNode","name":"myType","type":{"kind":"numberTypeNode","format":"u8","endian":"le"}}"#;
        let node: DefinedTypeNode = serde_json::from_str(json).unwrap();
        assert_eq!(node, DefinedTypeNode::new("myType", NumberTypeNode::le(U8)));
    }
}