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