type_reg 0.9.0

Serializable map of any type.
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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173

#![cfg_attr(coverage_nightly, feature(coverage_attribute))]

//! Serializable map of any type.
//!
//! This library provides a map that can store any serializable type, and
//! retrieve it as the strong type. Serialization and deserialization is also
//! done without requiring the consumer to implement custom serde logic.
//!
//! ## Usage
//!
//! Add the following to `Cargo.toml`
//!
//! ```toml
//! type_reg = { version = "0.9.0", features = ["tagged"] }
//! type_reg = { version = "0.9.0", features = ["untagged"] }
//!
//! # Values must impl Debug, and TypeMap's Debug impl will
//! # print the debug string of each value.
//! type_reg = { version = "0.9.0", features = ["debug"] }
//!
//! # Use insertion order for TypeMap and TypeReg iteration order.
//! type_reg = { version = "0.9.0", features = ["ordered"] }
//! ```
//!
//! ### Untagged Type Registry
//!
//! #### Serialization
//!
//! ```rust
//! # #![allow(clippy::needless_doctest_main)]
//! use serde::{Deserialize, Serialize};
//! use type_reg::untagged::TypeMap;
//!
//! #[derive(Clone, Copy, Debug, Deserialize, Serialize)]
//! struct A(u32);
//!
//! fn main() {
//!     let mut type_map = TypeMap::new();
//!     type_map.insert("one", 1u32);
//!     type_map.insert("two", 2u64);
//!     type_map.insert("three", A(3));
//!
//!     println!("{}", serde_yaml_ng::to_string(&type_map).unwrap());
//!
//!     // ---
//!     // two: 2
//!     // one: 1
//!     // three: 3
//! }
//! ```
//!
//! #### Deserialization
//!
//! ```rust
//! # #![allow(clippy::needless_doctest_main)]
//! use serde::{Deserialize, Serialize};
//! use type_reg::untagged::{TypeMap, TypeReg};
//!
//! #[derive(Clone, Copy, Debug, Deserialize, Serialize)]
//! struct A(u32);
//!
//! fn main() {
//!     let mut type_reg = TypeReg::<String>::new();
//!     type_reg.register::<u32>(String::from("one"));
//!     type_reg.register::<u64>(String::from("two"));
//!     type_reg.register::<A>(String::from("three"));
//!
//!     let serialized = "---\n\
//!         one: 1\n\
//!         two: 2\n\
//!         three: 3\n\
//!         ";
//!
//!     let deserializer = serde_yaml_ng::Deserializer::from_str(serialized);
//!     let type_map: TypeMap<String> = type_reg.deserialize_map(deserializer).unwrap();
//!
//!     let data_u32 = type_map.get::<u32, _>("one").copied().unwrap();
//!     let data_u64 = type_map.get::<u64, _>("two").copied().unwrap();
//!     let data_a = type_map.get::<A, _>("three").copied().unwrap();
//!
//!     println!("{data_u32}, {data_u64}, {data_a:?}");
//!
//!     // 1, 2, A(3)
//! }
//! ```
//!
//! ### Tagged Type Registry
//!
//! ⚠️ **Note:** This uses [`std::any::type_name`] internally, which is not
//! stable.
//!
//! #### Serialization
//!
//! ```rust
//! # #![allow(clippy::needless_doctest_main)]
//! use serde::{Deserialize, Serialize};
//! use type_reg::tagged::TypeMap;
//!
//! #[derive(Clone, Copy, Debug, Deserialize, Serialize)]
//! struct A(u32);
//!
//! fn main() {
//!     let mut type_map = TypeMap::new();
//!     type_map.insert("one", 1u32);
//!     type_map.insert("two", 2u64);
//!     type_map.insert("three", A(3));
//!
//!     println!("{}", serde_yaml_ng::to_string(&type_map).unwrap());
//!
//!     // ---
//!     // one:
//!     //   u32: 1
//!     // three:
//!     //   "tagged_serialize::A": 3
//!     // two:
//!     //   u64: 2
//! }
//! ```
//!
//! #### Deserialization
//!
//! ```rust
//! # #![allow(clippy::needless_doctest_main)]
//! use serde::{Deserialize, Serialize};
//! use type_reg::tagged::{TypeMap, TypeReg};
//!
//! #[derive(Clone, Copy, Debug, Deserialize, Serialize)]
//! struct A(u32);
//!
//! fn main() {
//!     let mut type_reg = TypeReg::new();
//!     type_reg.register::<u32>();
//!     type_reg.register::<u64>();
//!     type_reg.register::<A>();
//!
//!     let serialized = "---\n\
//!         one:   { u32: 1 }\n\
//!         two:   { u64: 2 }\n\
//!         three: { 'rust_out::A': 3 }\n\
//!         ";
//!
//!     let deserializer = serde_yaml_ng::Deserializer::from_str(serialized);
//!     let type_map: TypeMap<String> = type_reg.deserialize_map(deserializer).unwrap();
//!
//!     let data_u32 = type_map.get::<u32, _>("one").copied().unwrap();
//!     let data_u64 = type_map.get::<u64, _>("two").copied().unwrap();
//!     let data_a = type_map.get::<A, _>("three").copied().unwrap();
//!
//!     println!("{data_u32}, {data_u64}, {data_a:?}");
//!
//!     // 1, 2, A(3)
//! }
//! ```

#[cfg(any(feature = "tagged", feature = "untagged"))]
pub mod common;
#[cfg(feature = "tagged")]
pub mod tagged;
#[cfg(feature = "untagged")]
pub mod untagged;

pub use crate::type_name_lit::TypeNameLit;

mod type_name_lit;

// This is used in `Debug` impls, but for some reason rustc warns the fields
// are not used.
#[allow(dead_code)]
#[derive(Debug)]
pub(crate) struct TypedValue<'a> {
    r#type: TypeNameLit,
    value: &'a dyn std::fmt::Debug,
}