facet-cbor 0.3.3

CBOR serialization for Facet types
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
433
434
435
436
437
438
439
440
441
442
443
444
use facet::Facet;
use facet_core::{Def, ScalarType, StructKind, Type, UserType};
use facet_reflect::Peek;

use crate::encode;
use crate::error::CborError;

/// Serialize any `Facet` type to CBOR bytes.
pub fn to_vec<'a, T: Facet<'a>>(value: &T) -> Result<Vec<u8>, CborError> {
    let peek = Peek::new(value);
    let mut out = Vec::new();
    serialize_peek(peek, &mut out)?;
    Ok(out)
}

/// Serialize a `Peek` value to CBOR, appending to `out`.
pub fn serialize_peek(peek: Peek<'_, '_>, out: &mut Vec<u8>) -> Result<(), CborError> {
    // Unwrap transparent wrappers (NonZero, newtypes, smart pointers, etc.)
    let peek = peek.innermost_peek();

    // Try scalar first
    if let Some(scalar_type) = peek.scalar_type() {
        return serialize_scalar(peek, scalar_type, out);
    }

    // Check def-based types first (Option, List, Map, etc.) before user types,
    // because Option<T> is both Def::Option and UserType::Enum.
    match peek.shape().def {
        Def::Option(_) => {
            let opt = peek
                .into_option()
                .map_err(|e| CborError::ReflectError(e.to_string()))?;
            return match opt.value() {
                Some(inner) => serialize_peek(inner, out),
                None => {
                    encode::write_null(out);
                    Ok(())
                }
            };
        }
        Def::List(list_def) => {
            // Special case: Vec<u8> → byte string
            if list_def.t().is_type::<u8>() {
                let list = peek
                    .into_list()
                    .map_err(|e| CborError::ReflectError(e.to_string()))?;
                let len = list.len();
                let mut bytes = Vec::with_capacity(len);
                for i in 0..len {
                    let elem = list.get(i).ok_or_else(|| {
                        CborError::ReflectError("list index out of bounds".into())
                    })?;
                    let byte = elem
                        .get::<u8>()
                        .map_err(|e| CborError::ReflectError(e.to_string()))?;
                    bytes.push(*byte);
                }
                encode::write_bytes(out, &bytes);
            } else {
                let list = peek
                    .into_list()
                    .map_err(|e| CborError::ReflectError(e.to_string()))?;
                let len = list.len();
                encode::write_array_header(out, len as u64);
                for elem in list.iter() {
                    serialize_peek(elem, out)?;
                }
            }
            return Ok(());
        }
        Def::Array(_) | Def::Slice(_) => {
            let list_like = peek
                .into_list_like()
                .map_err(|e| CborError::ReflectError(e.to_string()))?;
            let len = list_like.len();
            encode::write_array_header(out, len as u64);
            for elem in list_like.iter() {
                serialize_peek(elem, out)?;
            }
            return Ok(());
        }
        Def::Map(_) => {
            let map = peek
                .into_map()
                .map_err(|e| CborError::ReflectError(e.to_string()))?;
            encode::write_map_header(out, map.len() as u64);
            for (key, value) in map.iter() {
                serialize_peek(key, out)?;
                serialize_peek(value, out)?;
            }
            return Ok(());
        }
        Def::Set(_) => {
            let set = peek
                .into_set()
                .map_err(|e| CborError::ReflectError(e.to_string()))?;
            encode::write_array_header(out, set.len() as u64);
            for elem in set.iter() {
                serialize_peek(elem, out)?;
            }
            return Ok(());
        }
        Def::Pointer(_) => {
            let ptr = peek
                .into_pointer()
                .map_err(|e| CborError::ReflectError(e.to_string()))?;
            return match ptr.borrow_inner() {
                Some(inner) => serialize_peek(inner, out),
                None => {
                    encode::write_null(out);
                    Ok(())
                }
            };
        }
        _ => {}
    }

    // Try struct/enum (user types)
    match peek.shape().ty {
        Type::User(UserType::Struct(struct_type)) => match struct_type.kind {
            StructKind::Struct => {
                let ps = peek
                    .into_struct()
                    .map_err(|e| CborError::ReflectError(e.to_string()))?;
                encode::write_map_header(out, ps.field_count() as u64);
                for i in 0..ps.field_count() {
                    let field = &struct_type.fields[i];
                    encode::write_text(out, field.name);
                    let field_peek = ps
                        .field(i)
                        .map_err(|e| CborError::ReflectError(e.to_string()))?;
                    serialize_peek(field_peek, out)?;
                }
                return Ok(());
            }
            StructKind::TupleStruct | StructKind::Tuple => {
                let ps = peek
                    .into_struct()
                    .map_err(|e| CborError::ReflectError(e.to_string()))?;
                encode::write_array_header(out, ps.field_count() as u64);
                for i in 0..ps.field_count() {
                    let field_peek = ps
                        .field(i)
                        .map_err(|e| CborError::ReflectError(e.to_string()))?;
                    serialize_peek(field_peek, out)?;
                }
                return Ok(());
            }
            StructKind::Unit => {
                encode::write_null(out);
                return Ok(());
            }
        },
        Type::User(UserType::Enum(_)) => {
            let pe = peek
                .into_enum()
                .map_err(|e| CborError::ReflectError(e.to_string()))?;
            let variant = pe
                .active_variant()
                .map_err(|e| CborError::ReflectError(e.to_string()))?;

            let effective_name = variant.rename.unwrap_or(variant.name);

            if let Some(tag_key) = peek.shape().tag {
                // Internally-tagged enum: tag is merged into the payload
                return serialize_enum_internally_tagged(pe, variant, effective_name, tag_key, out);
            }

            // Externally-tagged enum: map with one entry: variant_name → payload
            encode::write_map_header(out, 1);
            encode::write_text(out, effective_name);

            match variant.data.kind {
                StructKind::Unit => {
                    encode::write_null(out);
                }
                StructKind::TupleStruct => {
                    // Newtype variant if exactly one field, otherwise tuple
                    if variant.data.fields.len() == 1 {
                        let field_peek = pe
                            .field(0)
                            .map_err(|e| CborError::ReflectError(e.to_string()))?
                            .ok_or_else(|| {
                                CborError::ReflectError("missing newtype variant field".into())
                            })?;
                        serialize_peek(field_peek, out)?;
                    } else {
                        encode::write_array_header(out, variant.data.fields.len() as u64);
                        for i in 0..variant.data.fields.len() {
                            let field_peek = pe
                                .field(i)
                                .map_err(|e| CborError::ReflectError(e.to_string()))?
                                .ok_or_else(|| {
                                    CborError::ReflectError("missing tuple variant field".into())
                                })?;
                            serialize_peek(field_peek, out)?;
                        }
                    }
                }
                StructKind::Tuple => {
                    encode::write_array_header(out, variant.data.fields.len() as u64);
                    for i in 0..variant.data.fields.len() {
                        let field_peek = pe
                            .field(i)
                            .map_err(|e| CborError::ReflectError(e.to_string()))?
                            .ok_or_else(|| {
                                CborError::ReflectError("missing tuple variant field".into())
                            })?;
                        serialize_peek(field_peek, out)?;
                    }
                }
                StructKind::Struct => {
                    encode::write_map_header(out, variant.data.fields.len() as u64);
                    for i in 0..variant.data.fields.len() {
                        let field = &variant.data.fields[i];
                        encode::write_text(out, field.name);
                        let field_peek = pe
                            .field(i)
                            .map_err(|e| CborError::ReflectError(e.to_string()))?
                            .ok_or_else(|| {
                                CborError::ReflectError("missing struct variant field".into())
                            })?;
                        serialize_peek(field_peek, out)?;
                    }
                }
            }
            return Ok(());
        }
        _ => {}
    }

    Err(CborError::UnsupportedType(format!("{}", peek.shape())))
}

fn serialize_scalar(
    peek: Peek<'_, '_>,
    scalar_type: ScalarType,
    out: &mut Vec<u8>,
) -> Result<(), CborError> {
    match scalar_type {
        ScalarType::Unit => {
            encode::write_null(out);
        }
        ScalarType::Bool => {
            let v = peek
                .get::<bool>()
                .map_err(|e| CborError::ReflectError(e.to_string()))?;
            encode::write_bool(out, *v);
        }
        ScalarType::Char => {
            let v = peek
                .get::<char>()
                .map_err(|e| CborError::ReflectError(e.to_string()))?;
            let mut buf = [0u8; 4];
            let s = v.encode_utf8(&mut buf);
            encode::write_text(out, s);
        }
        ScalarType::U8 => {
            let v = peek
                .get::<u8>()
                .map_err(|e| CborError::ReflectError(e.to_string()))?;
            encode::write_uint(out, *v as u64);
        }
        ScalarType::U16 => {
            let v = peek
                .get::<u16>()
                .map_err(|e| CborError::ReflectError(e.to_string()))?;
            encode::write_uint(out, *v as u64);
        }
        ScalarType::U32 => {
            let v = peek
                .get::<u32>()
                .map_err(|e| CborError::ReflectError(e.to_string()))?;
            encode::write_uint(out, *v as u64);
        }
        ScalarType::U64 => {
            let v = peek
                .get::<u64>()
                .map_err(|e| CborError::ReflectError(e.to_string()))?;
            encode::write_uint(out, *v);
        }
        ScalarType::U128 => {
            let v = peek
                .get::<u128>()
                .map_err(|e| CborError::ReflectError(e.to_string()))?;
            // CBOR only supports up to u64; encode as byte string for u128
            if *v <= u64::MAX as u128 {
                encode::write_uint(out, *v as u64);
            } else {
                // Tag 2 (positive bignum) + 16-byte big-endian
                out.push(0xc2);
                let bytes = v.to_be_bytes();
                // Strip leading zeros
                let start = bytes.iter().position(|&b| b != 0).unwrap_or(15);
                encode::write_bytes(out, &bytes[start..]);
            }
        }
        ScalarType::USize => {
            let v = peek
                .get::<usize>()
                .map_err(|e| CborError::ReflectError(e.to_string()))?;
            encode::write_uint(out, *v as u64);
        }
        ScalarType::I8 => {
            let v = peek
                .get::<i8>()
                .map_err(|e| CborError::ReflectError(e.to_string()))?;
            write_signed(out, *v as i64);
        }
        ScalarType::I16 => {
            let v = peek
                .get::<i16>()
                .map_err(|e| CborError::ReflectError(e.to_string()))?;
            write_signed(out, *v as i64);
        }
        ScalarType::I32 => {
            let v = peek
                .get::<i32>()
                .map_err(|e| CborError::ReflectError(e.to_string()))?;
            write_signed(out, *v as i64);
        }
        ScalarType::I64 => {
            let v = peek
                .get::<i64>()
                .map_err(|e| CborError::ReflectError(e.to_string()))?;
            write_signed(out, *v);
        }
        ScalarType::I128 => {
            let v = peek
                .get::<i128>()
                .map_err(|e| CborError::ReflectError(e.to_string()))?;
            if *v >= 0 {
                if *v <= u64::MAX as i128 {
                    encode::write_uint(out, *v as u64);
                } else {
                    // Tag 2 (positive bignum)
                    out.push(0xc2);
                    let bytes = (*v as u128).to_be_bytes();
                    let start = bytes.iter().position(|&b| b != 0).unwrap_or(15);
                    encode::write_bytes(out, &bytes[start..]);
                }
            } else {
                // For negative: CBOR major 1 encodes -1-n, so n = -1 - v
                let abs_minus_one = (-1i128 - *v) as u128;
                if abs_minus_one <= u64::MAX as u128 {
                    encode::write_neg(out, abs_minus_one as u64);
                } else {
                    // Tag 3 (negative bignum)
                    out.push(0xc3);
                    let bytes = abs_minus_one.to_be_bytes();
                    let start = bytes.iter().position(|&b| b != 0).unwrap_or(15);
                    encode::write_bytes(out, &bytes[start..]);
                }
            }
        }
        ScalarType::ISize => {
            let v = peek
                .get::<isize>()
                .map_err(|e| CborError::ReflectError(e.to_string()))?;
            write_signed(out, *v as i64);
        }
        ScalarType::F32 => {
            let v = peek
                .get::<f32>()
                .map_err(|e| CborError::ReflectError(e.to_string()))?;
            encode::write_f32(out, *v);
        }
        ScalarType::F64 => {
            let v = peek
                .get::<f64>()
                .map_err(|e| CborError::ReflectError(e.to_string()))?;
            encode::write_f64(out, *v);
        }
        ScalarType::Str | ScalarType::String | ScalarType::CowStr => {
            let s = peek
                .as_str()
                .ok_or_else(|| CborError::ReflectError("failed to extract string value".into()))?;
            encode::write_text(out, s);
        }
        _ => {
            return Err(CborError::UnsupportedType(format!(
                "scalar type {scalar_type:?}"
            )));
        }
    }
    Ok(())
}

/// Serialize an internally-tagged enum.
///
/// When `#[facet(tag = "tag")]` is set on an enum:
/// - Unit variants → just the tag value as a CBOR text string: `"variant_name"`
/// - Struct variants → CBOR map with tag field merged: `{ "tag": "variant_name", field1: ..., ... }`
/// - Newtype/tuple variants → not supported (returns error)
fn serialize_enum_internally_tagged(
    pe: facet_reflect::PeekEnum<'_, '_>,
    variant: &facet_core::Variant,
    effective_name: &str,
    tag_key: &str,
    out: &mut Vec<u8>,
) -> Result<(), CborError> {
    match variant.data.kind {
        StructKind::Unit => {
            // Unit variant: just the tag value as a string
            encode::write_text(out, effective_name);
        }
        StructKind::Struct => {
            // Struct variant: map with tag field + all struct fields
            let field_count = variant.data.fields.len();
            encode::write_map_header(out, (field_count + 1) as u64);
            // Write tag entry first
            encode::write_text(out, tag_key);
            encode::write_text(out, effective_name);
            // Write struct fields
            for i in 0..field_count {
                let field = &variant.data.fields[i];
                encode::write_text(out, field.name);
                let field_peek = pe
                    .field(i)
                    .map_err(|e| CborError::ReflectError(e.to_string()))?
                    .ok_or_else(|| {
                        CborError::ReflectError("missing struct variant field".into())
                    })?;
                serialize_peek(field_peek, out)?;
            }
        }
        StructKind::TupleStruct | StructKind::Tuple => {
            return Err(CborError::UnsupportedType(format!(
                "internally-tagged enum cannot have tuple variant '{}'",
                variant.name
            )));
        }
    }
    Ok(())
}

fn write_signed(out: &mut Vec<u8>, v: i64) {
    if v >= 0 {
        encode::write_uint(out, v as u64);
    } else {
        // CBOR major 1: encode -1-n, so for value v, n = -1 - v
        encode::write_neg(out, (-1i64 - v) as u64);
    }
}