codama_nodes/
defined_type_node.rs

1use crate::{CamelCaseString, Docs, TypeNode};
2use codama_nodes_derive::node;
3
4#[node]
5pub struct DefinedTypeNode {
6    // Data.
7    pub name: CamelCaseString,
8    #[serde(default)]
9    #[serde(skip_serializing_if = "Docs::is_empty")]
10    pub docs: Docs,
11
12    // Children.
13    pub r#type: TypeNode,
14}
15
16impl DefinedTypeNode {
17    pub fn new<T, U>(name: T, r#type: U) -> Self
18    where
19        T: Into<CamelCaseString>,
20        U: Into<TypeNode>,
21    {
22        Self {
23            name: name.into(),
24            docs: Docs::default(),
25            r#type: r#type.into(),
26        }
27    }
28}
29
30#[cfg(test)]
31mod tests {
32    use super::*;
33    use crate::{NumberTypeNode, U8};
34
35    #[test]
36    fn new() {
37        let node = DefinedTypeNode::new("myType", NumberTypeNode::le(U8));
38        assert_eq!(node.name, CamelCaseString::new("myType"));
39        assert_eq!(node.docs, Docs::default());
40        assert_eq!(node.r#type, TypeNode::Number(NumberTypeNode::le(U8)));
41    }
42
43    #[test]
44    fn direct_instantiation() {
45        let node = DefinedTypeNode {
46            name: "myType".into(),
47            docs: Docs::default(),
48            r#type: NumberTypeNode::le(U8).into(),
49        };
50        assert_eq!(node.name, CamelCaseString::new("myType"));
51        assert_eq!(node.docs, Docs::default());
52        assert_eq!(node.r#type, TypeNode::Number(NumberTypeNode::le(U8)));
53    }
54
55    #[test]
56    fn to_json() {
57        let node = DefinedTypeNode::new("myType", NumberTypeNode::le(U8));
58        let json = serde_json::to_string(&node).unwrap();
59        assert_eq!(
60            json,
61            r#"{"kind":"definedTypeNode","name":"myType","type":{"kind":"numberTypeNode","format":"u8","endian":"le"}}"#
62        );
63    }
64
65    #[test]
66    fn from_json() {
67        let json = r#"{"kind":"definedTypeNode","name":"myType","type":{"kind":"numberTypeNode","format":"u8","endian":"le"}}"#;
68        let node: DefinedTypeNode = serde_json::from_str(json).unwrap();
69        assert_eq!(node, DefinedTypeNode::new("myType", NumberTypeNode::le(U8)));
70    }
71}