serde_avro_fast 2.1.0

An idiomatic implementation of serde/avro (de)serialization
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
445
446
447
448
449
450
451
mod allowed_depth;
mod types;
mod unit_variant_enum_access;

use {types::*, unit_variant_enum_access::UnitVariantEnumAccess};

pub(crate) use allowed_depth::AllowedDepth;

use super::*;

/// Can't be instantiated directly - has to be constructed from a
/// [`DeserializerState`]
pub struct DatumDeserializer<'r, 's, R> {
	pub(super) state: &'r mut DeserializerState<'s, R>,
	pub(super) schema_node: &'s SchemaNode<'s>,
	pub(super) allowed_depth: AllowedDepth,
}

impl<'de, R: ReadSlice<'de>> Deserializer<'de> for DatumDeserializer<'_, '_, R> {
	type Error = DeError;

	fn deserialize_any<V>(self, visitor: V) -> Result<V::Value, Self::Error>
	where
		V: Visitor<'de>,
	{
		match *self.schema_node {
			SchemaNode::Null => visitor.visit_unit(),
			SchemaNode::Boolean => read_bool(self.state, visitor),
			SchemaNode::Int => visitor.visit_i32(self.state.read_varint()?),
			SchemaNode::Long => visitor.visit_i64(self.state.read_varint()?),
			SchemaNode::Float => {
				visitor.visit_f32(f32::from_le_bytes(self.state.read_const_size_buf()?))
			}
			SchemaNode::Double => {
				visitor.visit_f64(f64::from_le_bytes(self.state.read_const_size_buf()?))
			}
			SchemaNode::Bytes => read_length_delimited(self.state, BytesVisitor(visitor)),
			SchemaNode::String => read_length_delimited(self.state, StringVisitor(visitor)),
			SchemaNode::Array(elements_schema) => visitor.visit_seq(ArraySeqAccess {
				elements_schema: elements_schema.as_ref(),
				block_reader: BlockReader::new(self.state, false, self.allowed_depth.dec()?),
			}),
			SchemaNode::Map(elements_schema) => visitor.visit_map(MapMapAccess {
				elements_schema: elements_schema.as_ref(),
				block_reader: BlockReader::new(self.state, false, self.allowed_depth.dec()?),
			}),
			SchemaNode::Union(ref union) => Self {
				schema_node: read_union_discriminant(self.state, union)?,
				state: self.state,
				allowed_depth: self.allowed_depth.dec()?,
			}
			.deserialize_any(visitor),
			SchemaNode::Record(ref record) => {
				// NB: infinite recursion is prevented here by the fact we prevent constructing
				// a schema that contains a record that always ends up containing itself
				visitor.visit_map(RecordMapAccess {
					record_fields: record.fields.iter(),
					state: self.state,
					allowed_depth: self.allowed_depth.dec()?,
				})
			}
			SchemaNode::Enum(ref enum_) => read_enum_as_str(self.state, &enum_.symbols, visitor),
			SchemaNode::Fixed(ref fixed) => {
				self.state.read_slice(fixed.size, BytesVisitor(visitor))
			}
			SchemaNode::Decimal(ref decimal) => read_decimal(
				self.state,
				DecimalMode::Regular(decimal),
				VisitorHint::Str,
				visitor,
			),
			SchemaNode::BigDecimal => {
				read_decimal(self.state, DecimalMode::Big, VisitorHint::Str, visitor)
			}
			SchemaNode::Uuid => read_length_delimited(self.state, StringVisitor(visitor)),
			SchemaNode::Date => visitor.visit_i32(self.state.read_varint()?),
			SchemaNode::TimeMillis => visitor.visit_i32(self.state.read_varint()?),
			SchemaNode::TimeMicros => visitor.visit_i64(self.state.read_varint()?),
			SchemaNode::TimestampMillis => visitor.visit_i64(self.state.read_varint()?),
			SchemaNode::TimestampMicros => visitor.visit_i64(self.state.read_varint()?),
			SchemaNode::Duration => visitor.visit_map(DurationMapAndSeqAccess {
				duration_buf: &self.state.read_const_size_buf::<12>()?,
			}),
		}
	}

	serde::forward_to_deserialize_any! {
		bool i8 i16 i32 u8 u16 u32 f32 char
		unit unit_struct newtype_struct
	}

	fn deserialize_u64<V>(self, visitor: V) -> Result<V::Value, Self::Error>
	where
		V: Visitor<'de>,
	{
		// Allow deserializing discriminants without making the string lookup for enums
		match *self.schema_node {
			SchemaNode::Enum(_) => {
				let discriminant: i64 = self.state.read_varint()?;
				visitor.visit_u64(discriminant.try_into().map_err(|e| {
					DeError::custom(format_args!("Got negative enum discriminant: {e}"))
				})?)
			}
			SchemaNode::Decimal(ref decimal) => read_decimal(
				self.state,
				DecimalMode::Regular(decimal),
				VisitorHint::U64,
				visitor,
			),
			SchemaNode::BigDecimal => {
				read_decimal(self.state, DecimalMode::Big, VisitorHint::U64, visitor)
			}
			_ => self.deserialize_any(visitor),
		}
	}

	fn deserialize_i64<V>(self, visitor: V) -> Result<V::Value, Self::Error>
	where
		V: Visitor<'de>,
	{
		match *self.schema_node {
			SchemaNode::Long => visitor.visit_i64(self.state.read_varint()?),
			SchemaNode::Decimal(ref decimal) => read_decimal(
				self.state,
				DecimalMode::Regular(decimal),
				VisitorHint::I64,
				visitor,
			),
			SchemaNode::BigDecimal => {
				read_decimal(self.state, DecimalMode::Big, VisitorHint::I64, visitor)
			}
			_ => self.deserialize_any(visitor),
		}
	}

	fn deserialize_u128<V>(self, visitor: V) -> Result<V::Value, Self::Error>
	where
		V: Visitor<'de>,
	{
		match *self.schema_node {
			SchemaNode::Decimal(ref decimal) => read_decimal(
				self.state,
				DecimalMode::Regular(decimal),
				VisitorHint::U128,
				visitor,
			),
			SchemaNode::BigDecimal => {
				read_decimal(self.state, DecimalMode::Big, VisitorHint::U128, visitor)
			}
			_ => self.deserialize_any(visitor),
		}
	}

	fn deserialize_i128<V>(self, visitor: V) -> Result<V::Value, Self::Error>
	where
		V: Visitor<'de>,
	{
		match *self.schema_node {
			SchemaNode::Decimal(ref decimal) => read_decimal(
				self.state,
				DecimalMode::Regular(decimal),
				VisitorHint::I128,
				visitor,
			),
			SchemaNode::BigDecimal => {
				read_decimal(self.state, DecimalMode::Big, VisitorHint::I128, visitor)
			}
			_ => self.deserialize_any(visitor),
		}
	}

	fn deserialize_f64<V>(self, visitor: V) -> Result<V::Value, Self::Error>
	where
		V: Visitor<'de>,
	{
		match *self.schema_node {
			SchemaNode::Double => {
				visitor.visit_f64(f64::from_le_bytes(self.state.read_const_size_buf()?))
			}
			SchemaNode::Decimal(ref decimal) => read_decimal(
				self.state,
				DecimalMode::Regular(decimal),
				VisitorHint::F64,
				visitor,
			),
			SchemaNode::BigDecimal => {
				read_decimal(self.state, DecimalMode::Big, VisitorHint::F64, visitor)
			}
			_ => self.deserialize_any(visitor),
		}
	}

	fn deserialize_str<V>(self, visitor: V) -> Result<V::Value, Self::Error>
	where
		V: Visitor<'de>,
	{
		// If we get hinted on str, we may attempt to deserialize byte arrays as utf-8
		// encoded strings
		match *self.schema_node {
			SchemaNode::String => read_length_delimited(self.state, StringVisitor(visitor)),
			SchemaNode::Bytes => read_length_delimited(self.state, StringVisitor(visitor)),
			SchemaNode::Fixed(ref fixed) => {
				self.state.read_slice(fixed.size, StringVisitor(visitor))
			}
			_ => self.deserialize_any(visitor),
		}
	}

	fn deserialize_string<V>(self, visitor: V) -> Result<V::Value, Self::Error>
	where
		V: Visitor<'de>,
	{
		self.deserialize_str(visitor)
	}

	fn deserialize_bytes<V>(self, visitor: V) -> Result<V::Value, Self::Error>
	where
		V: Visitor<'de>,
	{
		match *self.schema_node {
			SchemaNode::Bytes => read_length_delimited(self.state, BytesVisitor(visitor)),
			SchemaNode::Duration => self.state.read_slice(12, BytesVisitor(visitor)),
			_ => self.deserialize_any(visitor),
		}
	}

	fn deserialize_byte_buf<V>(self, visitor: V) -> Result<V::Value, Self::Error>
	where
		V: Visitor<'de>,
	{
		self.deserialize_bytes(visitor)
	}

	fn deserialize_option<V>(self, visitor: V) -> Result<V::Value, Self::Error>
	where
		V: Visitor<'de>,
	{
		match self.schema_node {
			SchemaNode::Null => visitor.visit_none(),
			SchemaNode::Union(union) => {
				let union_discriminant: usize = read_discriminant(self.state)?;
				match union
					.variants
					.get(union_discriminant)
					.map(|&schema_key| schema_key.as_ref())
				{
					None => Err(DeError::new("Could not find union discriminant in schema")),
					Some(SchemaNode::Null) => visitor.visit_none(),
					Some(variant_schema)
						if union.variants.len() == 2
							&& matches!(
								*union.variants[1 - union_discriminant],
								SchemaNode::Null
							) =>
					{
						visitor.visit_some(DatumDeserializer {
							state: self.state,
							schema_node: variant_schema,
							allowed_depth: self.allowed_depth.dec()?,
						})
					}
					Some(variant_schema) => {
						visitor.visit_some(FavorSchemaTypeNameIfEnumHintDatumDeserializer {
							inner: DatumDeserializer {
								state: self.state,
								schema_node: variant_schema,
								allowed_depth: self.allowed_depth.dec()?,
							},
						})
					}
				}
			}
			_ => visitor.visit_some(self),
		}
	}

	fn deserialize_seq<V>(self, visitor: V) -> Result<V::Value, Self::Error>
	where
		V: Visitor<'de>,
	{
		// TODO deserialize map as [(key,value)]
		// Until then, this can be worked around using the `serde-tuple-vec-map` crate
		match *self.schema_node {
			SchemaNode::Array(elements_schema) => visitor.visit_seq(ArraySeqAccess {
				elements_schema: elements_schema.as_ref(),
				block_reader: BlockReader::new(self.state, false, self.allowed_depth.dec()?),
			}),
			SchemaNode::Duration => visitor.visit_seq(DurationMapAndSeqAccess {
				duration_buf: &self.state.read_const_size_buf::<12>()?,
			}),
			_ => self.deserialize_any(visitor),
		}
	}

	fn deserialize_tuple<V>(self, len: usize, visitor: V) -> Result<V::Value, Self::Error>
	where
		V: Visitor<'de>,
	{
		// Allows deserializing Duration as (u32, u32, u32)
		match *self.schema_node {
			SchemaNode::Array(elements_schema) => visitor.visit_seq(ArraySeqAccess {
				elements_schema: elements_schema.as_ref(),
				block_reader: BlockReader::new(self.state, false, self.allowed_depth.dec()?),
			}),
			SchemaNode::Duration if len == 3 => visitor.visit_seq(DurationMapAndSeqAccess {
				duration_buf: &self.state.read_const_size_buf::<12>()?,
			}),
			_ => self.deserialize_any(visitor),
		}
	}

	fn deserialize_tuple_struct<V>(
		self,
		_: &'static str,
		len: usize,
		visitor: V,
	) -> Result<V::Value, Self::Error>
	where
		V: Visitor<'de>,
	{
		self.deserialize_tuple(len, visitor)
	}

	fn deserialize_map<V>(self, visitor: V) -> Result<V::Value, Self::Error>
	where
		V: Visitor<'de>,
	{
		// TODO [{key, value}] could be deserialized into a map
		self.deserialize_any(visitor)
	}

	fn deserialize_struct<V>(
		self,
		_: &'static str,
		_: &'static [&'static str],
		visitor: V,
	) -> Result<V::Value, Self::Error>
	where
		V: Visitor<'de>,
	{
		self.deserialize_map(visitor)
	}

	fn deserialize_enum<V>(
		self,
		_: &'static str,
		_: &'static [&'static str],
		visitor: V,
	) -> Result<V::Value, Self::Error>
	where
		V: Visitor<'de>,
	{
		// Depending on the schema node type, it may represent the identifier of the
		// enum variant directly (e.g. String type may be used to represent the enum
		// variant name) If that's the case then we need to propose it as variant name
		// when deserializing, otherwise we should propose the type as variant name and
		// propagate deserialization of the current node to the variant's inner value
		match *self.schema_node {
			SchemaNode::Union(ref union) => visitor.visit_enum(SchemaTypeNameEnumAccess {
				variant_schema: read_union_discriminant(self.state, union)?,
				state: self.state,
				allowed_depth: self.allowed_depth.dec()?,
			}),
			ref possible_unit_variant_identifier @ (SchemaNode::Int
			| SchemaNode::Long
			| SchemaNode::Bytes
			| SchemaNode::String
			| SchemaNode::Enum(_)
			| SchemaNode::Fixed(_)) => visitor.visit_enum(UnitVariantEnumAccess {
				state: self.state,
				schema_node: possible_unit_variant_identifier,
				allowed_depth: self.allowed_depth.dec()?,
			}),
			ref not_unit_variant_identifier @ (SchemaNode::Null
			| SchemaNode::Boolean
			| SchemaNode::Float
			| SchemaNode::Double
			| SchemaNode::Array(_)
			| SchemaNode::Map(_)
			| SchemaNode::Record(_)
			| SchemaNode::Decimal(_)
			| SchemaNode::BigDecimal
			| SchemaNode::Uuid
			| SchemaNode::Date
			| SchemaNode::TimeMillis
			| SchemaNode::TimeMicros
			| SchemaNode::TimestampMillis
			| SchemaNode::TimestampMicros
			| SchemaNode::Duration) => visitor.visit_enum(SchemaTypeNameEnumAccess {
				state: self.state,
				variant_schema: not_unit_variant_identifier,
				allowed_depth: self.allowed_depth.dec()?,
			}),
		}
	}

	fn deserialize_identifier<V>(self, visitor: V) -> Result<V::Value, Self::Error>
	where
		V: Visitor<'de>,
	{
		match *self.schema_node {
			SchemaNode::Int => visitor.visit_u64({
				let val: i32 = self.state.read_varint()?;
				val.try_into()
					.map_err(|_| DeError::new("Failed to convert i32 to u64 for enum identifier"))?
			}),
			SchemaNode::Long => visitor.visit_u64({
				let val: i64 = self.state.read_varint()?;
				val.try_into()
					.map_err(|_| DeError::new("Failed to convert i64 to u64 for enum identifier"))?
			}),
			_ => self.deserialize_any(visitor),
		}
	}

	fn deserialize_ignored_any<V>(self, visitor: V) -> Result<V::Value, Self::Error>
	where
		V: Visitor<'de>,
	{
		// We can skip here for performance:
		// - utf8 decoding of strings
		// - block reads when serialized data provides serialized block size in bytes

		match *self.schema_node {
			SchemaNode::String => read_length_delimited(self.state, BytesVisitor(visitor)),
			SchemaNode::Array(elements_schema) => visitor.visit_seq(ArraySeqAccess {
				elements_schema: elements_schema.as_ref(),
				block_reader: BlockReader::new(self.state, true, self.allowed_depth.dec()?),
			}),
			SchemaNode::Map(elements_schema) => visitor.visit_map(MapMapAccess {
				elements_schema: elements_schema.as_ref(),
				block_reader: BlockReader::new(self.state, true, self.allowed_depth.dec()?),
			}),
			SchemaNode::Int => {
				// Skip zigzag decoding
				let _: u32 = self.state.read_varint()?;
				visitor.visit_unit()
			}
			SchemaNode::Long | SchemaNode::Enum(_) => {
				// Skip zigzag decoding
				let _: u64 = self.state.read_varint()?;
				visitor.visit_unit()
			}
			SchemaNode::Duration => {
				self.state.read_const_size_buf::<12>()?;
				visitor.visit_unit()
			}
			_ => self.deserialize_any(visitor),
		}
	}
}