truc 0.4.0

Rust code generator for safe, fixed size, evolving records.
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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
//! Serialization features.

use codegen::{Function, Scope};
use itertools::Itertools;

use super::{FragmentGenerator, FragmentGeneratorSpecs, RecordSpec};
use crate::generator::{CAP, CAP_GENERIC};

/// Use this generator in [GeneratorConfig](crate::generator::config::GeneratorConfig) in order to
/// enable serialization features on generated structures.
pub struct SerdeImplGenerator;

impl SerdeImplGenerator {
    fn generate_serialize_impl(record_spec: &RecordSpec, scope: &mut Scope) {
        let serialize_impl = scope
            .new_impl(&record_spec.capped_record_name)
            .generic(CAP_GENERIC)
            .target_generic(CAP)
            .impl_trait("serde::Serialize");

        let serialize_fn = serialize_impl
            .new_fn("serialize")
            .generic("S")
            .arg_ref_self()
            .arg("serializer", "S")
            .ret("Result<S::Ok, S::Error>")
            .bound("S", "serde::Serializer");

        if !record_spec.data.is_empty() {
            serialize_fn.line(format!(
                "let mut tuple = serializer.serialize_tuple({})?;",
                record_spec.data.len()
            ));
        } else {
            serialize_fn.line("let tuple = serializer.serialize_tuple(0)?;");
        }
        for datum in &record_spec.data {
            serialize_fn.line(format!(
                "tuple.serialize_element(self.{}())?;",
                datum.name()
            ));
        }
        serialize_fn.line("tuple.end()");
    }

    fn generate_visitor(record_spec: &RecordSpec, deserialize_fn: &mut Function) {
        let mut sub_scope = Scope::new();

        sub_scope.new_struct("RecordVisitor").generic(CAP_GENERIC);

        let visitor_impl = sub_scope
            .new_impl(&format!("RecordVisitor<{}>", CAP))
            .generic(&format!("'de, {}", CAP_GENERIC))
            .impl_trait("serde::de::Visitor<'de>");

        visitor_impl.associate_type(
            "Value",
            format!("{}<{{ {} }}>", &record_spec.capped_record_name, CAP),
        );

        visitor_impl
            .new_fn("expecting")
            .arg_ref_self()
            .arg("formatter", "&mut std::fmt::Formatter")
            .ret("std::fmt::Result")
            .line(format!(
                "formatter.write_str(\"a {}\")",
                record_spec.capped_record_name
            ));

        let visit_seq_fn = visitor_impl
            .new_fn("visit_seq")
            .generic("A")
            .arg_self()
            .arg(
                if !record_spec.data.is_empty() {
                    "mut seq"
                } else {
                    "seq"
                },
                "A",
            )
            .ret("Result<Self::Value, A::Error>")
            .bound("A", "serde::de::SeqAccess<'de>");

        visit_seq_fn.line("if let Some(size) = seq.size_hint() {");
        visit_seq_fn.line(format!(
            "    if size != {} {{ return Err(A::Error::invalid_length(size, &\"{}\")); }}",
            record_spec.data.len(),
            record_spec.data.len(),
        ));
        visit_seq_fn.line("}");

        for datum in &record_spec.data {
            visit_seq_fn.line(format!(
                "let {} = seq.next_element::<{}>()?.ok_or_else(|| A::Error::missing_field(\"{}\"))?;",
                datum.name(),
                datum.details().type_name(),
                datum.name(),
            ));
        }

        visit_seq_fn.line("if let Some(size) = seq.size_hint() {");
        visit_seq_fn.line("    assert_eq!(size, 0);");
        visit_seq_fn.line("}");

        visit_seq_fn.line(format!(
            "Ok({}::new({} {{ {} }}))",
            record_spec.capped_record_name,
            record_spec.unpacked_record_name,
            record_spec.data.iter().map(|datum| datum.name()).join(", "),
        ));

        deserialize_fn.line(sub_scope.to_string());
        deserialize_fn.line("");
    }

    fn generate_deserialize_impl(record_spec: &RecordSpec, scope: &mut Scope) {
        let deserialize_impl = scope
            .new_impl(&record_spec.capped_record_name)
            .generic(&format!("'de, {}", CAP_GENERIC))
            .target_generic(CAP)
            .impl_trait("serde::Deserialize<'de>");

        let deserialize_fn = deserialize_impl
            .new_fn("deserialize")
            .generic("D")
            .arg("deserializer", "D")
            .ret("Result<Self, D::Error>")
            .bound("D", "serde::Deserializer<'de>");

        Self::generate_visitor(record_spec, deserialize_fn);

        deserialize_fn.line(format!(
            "deserializer.deserialize_tuple({}, RecordVisitor::<{}>)",
            record_spec.data.len(),
            CAP
        ));
    }
}

impl FragmentGenerator for SerdeImplGenerator {
    fn imports(&self, scope: &mut Scope) {
        scope.import("serde::ser", "SerializeTuple");
        scope.import("serde::de", "Error");
    }

    fn generate(&self, specs: &FragmentGeneratorSpecs, scope: &mut Scope) {
        let record_spec = specs.record;

        Self::generate_serialize_impl(record_spec, scope);

        Self::generate_deserialize_impl(record_spec, scope);
    }
}

#[cfg(test)]
#[cfg_attr(coverage_nightly, coverage(off))]
mod tests {
    use std::collections::BTreeSet;

    use maplit::btreeset;
    use pretty_assertions::assert_eq;

    use super::*;
    use crate::{
        generator::{config::GeneratorConfig, generate_variant, tests::assert_fragment_eq},
        record::{
            definition::builder::native::NativeRecordDefinitionBuilder,
            type_resolver::HostTypeResolver,
        },
    };

    #[test]
    fn should_generate_empty_serde_impl() {
        let mut builder = NativeRecordDefinitionBuilder::new(HostTypeResolver);
        builder.close_record_variant();
        let definition = builder.build();

        let config =
            GeneratorConfig::new([Box::new(SerdeImplGenerator) as Box<dyn FragmentGenerator>]);

        let mut scope = Scope::new();
        let mut type_size_assertions = BTreeSet::new();

        generate_variant(
            &definition,
            definition.max_type_align(),
            definition.variants().next().expect("variant"),
            None,
            &config,
            &mut scope,
            &mut type_size_assertions,
        );

        assert_fragment_eq(
            r#"
use serde::ser::SerializeTuple;
use serde::de::Error;

impl<const CAP: usize> serde::Serialize for CappedRecord0<CAP> {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where S: serde::Serializer,
    {
        let tuple = serializer.serialize_tuple(0)?;
        tuple.end()
    }
}

impl<'de, const CAP: usize> serde::Deserialize<'de> for CappedRecord0<CAP> {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where D: serde::Deserializer<'de>,
    {
        struct RecordVisitor<const CAP: usize>;

        impl<'de, const CAP: usize> serde::de::Visitor<'de> for RecordVisitor<CAP> {
            type Value = CappedRecord0<{ CAP }>;

            fn expecting(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result {
                formatter.write_str("a CappedRecord0")
            }

            fn visit_seq<A>(self, seq: A) -> Result<Self::Value, A::Error>
            where A: serde::de::SeqAccess<'de>,
            {
                if let Some(size) = seq.size_hint() {
                    if size != 0 { return Err(A::Error::invalid_length(size, &"0")); }
                }
                if let Some(size) = seq.size_hint() {
                    assert_eq!(size, 0);
                }
                Ok(CappedRecord0::new(UnpackedRecord0 {  }))
            }
        }

        deserializer.deserialize_tuple(0, RecordVisitor::<CAP>)
    }
}
"#,
            &scope.to_string(),
        );

        assert_eq!(btreeset![], type_size_assertions);
    }

    #[test]
    fn should_generate_serde_impl_with_data() {
        let mut builder = NativeRecordDefinitionBuilder::new(HostTypeResolver);
        builder.add_datum_allow_uninit::<u32, _>("integer").unwrap();
        builder.add_datum::<u32, _>("not_copy_integer").unwrap();
        builder.close_record_variant();
        let definition = builder.build();

        let config =
            GeneratorConfig::new([Box::new(SerdeImplGenerator) as Box<dyn FragmentGenerator>]);

        let mut scope = Scope::new();
        let mut type_size_assertions = BTreeSet::new();

        generate_variant(
            &definition,
            definition.max_type_align(),
            definition.variants().next().expect("variant"),
            None,
            &config,
            &mut scope,
            &mut type_size_assertions,
        );

        assert_fragment_eq(
            r#"
use serde::ser::SerializeTuple;
use serde::de::Error;

impl<const CAP: usize> serde::Serialize for CappedRecord0<CAP> {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where S: serde::Serializer,
    {
        let mut tuple = serializer.serialize_tuple(2)?;
        tuple.serialize_element(self.integer())?;
        tuple.serialize_element(self.not_copy_integer())?;
        tuple.end()
    }
}

impl<'de, const CAP: usize> serde::Deserialize<'de> for CappedRecord0<CAP> {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where D: serde::Deserializer<'de>,
    {
        struct RecordVisitor<const CAP: usize>;

        impl<'de, const CAP: usize> serde::de::Visitor<'de> for RecordVisitor<CAP> {
            type Value = CappedRecord0<{ CAP }>;

            fn expecting(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result {
                formatter.write_str("a CappedRecord0")
            }

            fn visit_seq<A>(self, mut seq: A) -> Result<Self::Value, A::Error>
            where A: serde::de::SeqAccess<'de>,
            {
                if let Some(size) = seq.size_hint() {
                    if size != 2 { return Err(A::Error::invalid_length(size, &"2")); }
                }
                let integer = seq.next_element::<u32>()?.ok_or_else(|| A::Error::missing_field("integer"))?;
                let not_copy_integer = seq.next_element::<u32>()?.ok_or_else(|| A::Error::missing_field("not_copy_integer"))?;
                if let Some(size) = seq.size_hint() {
                    assert_eq!(size, 0);
                }
                Ok(CappedRecord0::new(UnpackedRecord0 { integer, not_copy_integer }))
            }
        }

        deserializer.deserialize_tuple(2, RecordVisitor::<CAP>)
    }
}
"#,
            &scope.to_string(),
        );

        assert_eq!(
            btreeset![("u32", std::mem::size_of::<u32>())],
            type_size_assertions
        );
    }

    #[test]
    fn should_generate_next_serde_impl_with_data() {
        let mut builder = NativeRecordDefinitionBuilder::new(HostTypeResolver);
        let i0 = builder
            .add_datum_allow_uninit::<u32, _>("integer0")
            .unwrap();
        let nci0 = builder.add_datum::<u32, _>("not_copy_integer0").unwrap();
        builder
            .add_datum_allow_uninit::<bool, _>("boolean1")
            .unwrap();
        builder.close_record_variant();
        builder.remove_datum(i0).unwrap();
        builder.remove_datum(nci0).unwrap();
        builder
            .add_datum_allow_uninit::<u32, _>("integer1")
            .unwrap();
        builder.add_datum::<u32, _>("not_copy_integer1").unwrap();
        builder.close_record_variant();
        let definition = builder.build();

        let config =
            GeneratorConfig::new([Box::new(SerdeImplGenerator) as Box<dyn FragmentGenerator>]);

        let mut scope = Scope::new();
        let mut type_size_assertions = BTreeSet::new();

        let record0_spec = generate_variant(
            &definition,
            definition.max_type_align(),
            definition.variants().next().expect("variant"),
            None,
            &config,
            &mut scope,
            &mut type_size_assertions,
        );
        let mut scope = Scope::new();
        type_size_assertions.clear();
        generate_variant(
            &definition,
            definition.max_type_align(),
            definition.variants().nth(1).expect("variant"),
            Some(&record0_spec),
            &config,
            &mut scope,
            &mut type_size_assertions,
        );

        assert_fragment_eq(
            r#"
use serde::ser::SerializeTuple;
use serde::de::Error;

impl<const CAP: usize> serde::Serialize for CappedRecord1<CAP> {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where S: serde::Serializer,
    {
        let mut tuple = serializer.serialize_tuple(3)?;
        tuple.serialize_element(self.boolean1())?;
        tuple.serialize_element(self.integer1())?;
        tuple.serialize_element(self.not_copy_integer1())?;
        tuple.end()
    }
}

impl<'de, const CAP: usize> serde::Deserialize<'de> for CappedRecord1<CAP> {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where D: serde::Deserializer<'de>,
    {
        struct RecordVisitor<const CAP: usize>;

        impl<'de, const CAP: usize> serde::de::Visitor<'de> for RecordVisitor<CAP> {
            type Value = CappedRecord1<{ CAP }>;

            fn expecting(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result {
                formatter.write_str("a CappedRecord1")
            }

            fn visit_seq<A>(self, mut seq: A) -> Result<Self::Value, A::Error>
            where A: serde::de::SeqAccess<'de>,
            {
                if let Some(size) = seq.size_hint() {
                    if size != 3 { return Err(A::Error::invalid_length(size, &"3")); }
                }
                let boolean1 = seq.next_element::<bool>()?.ok_or_else(|| A::Error::missing_field("boolean1"))?;
                let integer1 = seq.next_element::<u32>()?.ok_or_else(|| A::Error::missing_field("integer1"))?;
                let not_copy_integer1 = seq.next_element::<u32>()?.ok_or_else(|| A::Error::missing_field("not_copy_integer1"))?;
                if let Some(size) = seq.size_hint() {
                    assert_eq!(size, 0);
                }
                Ok(CappedRecord1::new(UnpackedRecord1 { boolean1, integer1, not_copy_integer1 }))
            }
        }

        deserializer.deserialize_tuple(3, RecordVisitor::<CAP>)
    }
}
"#,
            &scope.to_string(),
        );

        assert_eq!(
            btreeset![("u32", std::mem::size_of::<u32>())],
            type_size_assertions
        );
    }
}