Skip to content

Commit 0265436

Browse files
authored
bevy_reflect: Rename UntypedReflectDeserializer to ReflectDeserializer (#12721)
# Objective We have `ReflectSerializer` and `TypedReflectSerializer`. The former is the one users will most often use since the latter takes a bit more effort to deserialize. However, our deserializers are named `UntypedReflectDeserializer` and `TypedReflectDeserializer`. There is no obvious indication that `UntypedReflectDeserializer` must be used with `ReflectSerializer` since the names don't quite match up. ## Solution Rename `UntypedReflectDeserializer` back to `ReflectDeserializer` (initially changed as part of #5723). Also update the docs for both deserializers (as they were pretty out of date) and include doc examples. I also updated the docs for the serializers, too, just so that everything is consistent. --- ## Changelog - Renamed `UntypedReflectDeserializer` to `ReflectDeserializer` - Updated docs for `ReflectDeserializer`, `TypedReflectDeserializer`, `ReflectSerializer`, and `TypedReflectSerializer` ## Migration Guide `UntypedReflectDeserializer` has been renamed to `ReflectDeserializer`. Usages will need to be updated accordingly. ```diff - let reflect_deserializer = UntypedReflectDeserializer::new(&registry); + let reflect_deserializer = ReflectDeserializer::new(&registry); ```
1 parent e6b5f05 commit 0265436

File tree

7 files changed

+291
-109
lines changed

7 files changed

+291
-109
lines changed

crates/bevy_reflect/src/lib.rs

+9-9
Original file line numberDiff line numberDiff line change
@@ -334,7 +334,7 @@
334334
//! The way it works is by moving the serialization logic into common serializers and deserializers:
335335
//! * [`ReflectSerializer`]
336336
//! * [`TypedReflectSerializer`]
337-
//! * [`UntypedReflectDeserializer`]
337+
//! * [`ReflectDeserializer`]
338338
//! * [`TypedReflectDeserializer`]
339339
//!
340340
//! All of these structs require a reference to the [registry] so that [type information] can be retrieved,
@@ -347,7 +347,7 @@
347347
//! and the value is the serialized data.
348348
//! The `TypedReflectSerializer` will simply output the serialized data.
349349
//!
350-
//! The `UntypedReflectDeserializer` can be used to deserialize this map and return a `Box<dyn Reflect>`,
350+
//! The `ReflectDeserializer` can be used to deserialize this map and return a `Box<dyn Reflect>`,
351351
//! where the underlying type will be a dynamic type representing some concrete type (except for value types).
352352
//!
353353
//! Again, it's important to remember that dynamic types may need to be converted to their concrete counterparts
@@ -357,7 +357,7 @@
357357
//! ```
358358
//! # use serde::de::DeserializeSeed;
359359
//! # use bevy_reflect::{
360-
//! # serde::{ReflectSerializer, UntypedReflectDeserializer},
360+
//! # serde::{ReflectSerializer, ReflectDeserializer},
361361
//! # Reflect, FromReflect, TypeRegistry
362362
//! # };
363363
//! #[derive(Reflect, PartialEq, Debug)]
@@ -378,7 +378,7 @@
378378
//! let serialized_value: String = ron::to_string(&reflect_serializer).unwrap();
379379
//!
380380
//! // Deserialize
381-
//! let reflect_deserializer = UntypedReflectDeserializer::new(&registry);
381+
//! let reflect_deserializer = ReflectDeserializer::new(&registry);
382382
//! let deserialized_value: Box<dyn Reflect> = reflect_deserializer.deserialize(
383383
//! &mut ron::Deserializer::from_str(&serialized_value).unwrap()
384384
//! ).unwrap();
@@ -460,7 +460,7 @@
460460
//! [`serde`]: ::serde
461461
//! [`ReflectSerializer`]: serde::ReflectSerializer
462462
//! [`TypedReflectSerializer`]: serde::TypedReflectSerializer
463-
//! [`UntypedReflectDeserializer`]: serde::UntypedReflectDeserializer
463+
//! [`ReflectDeserializer`]: serde::ReflectDeserializer
464464
//! [`TypedReflectDeserializer`]: serde::TypedReflectDeserializer
465465
//! [registry]: TypeRegistry
466466
//! [type information]: TypeInfo
@@ -610,7 +610,7 @@ mod tests {
610610
use super::prelude::*;
611611
use super::*;
612612
use crate as bevy_reflect;
613-
use crate::serde::{ReflectSerializer, UntypedReflectDeserializer};
613+
use crate::serde::{ReflectDeserializer, ReflectSerializer};
614614
use crate::utility::GenericTypePathCell;
615615

616616
#[test]
@@ -1223,7 +1223,7 @@ mod tests {
12231223
let serialized = to_string_pretty(&serializer, PrettyConfig::default()).unwrap();
12241224

12251225
let mut deserializer = Deserializer::from_str(&serialized).unwrap();
1226-
let reflect_deserializer = UntypedReflectDeserializer::new(&registry);
1226+
let reflect_deserializer = ReflectDeserializer::new(&registry);
12271227
let value = reflect_deserializer.deserialize(&mut deserializer).unwrap();
12281228
let dynamic_struct = value.take::<DynamicStruct>().unwrap();
12291229

@@ -2383,7 +2383,7 @@ bevy_reflect::tests::Test {
23832383
registry.register::<Quat>();
23842384
registry.register::<f32>();
23852385

2386-
let de = UntypedReflectDeserializer::new(&registry);
2386+
let de = ReflectDeserializer::new(&registry);
23872387

23882388
let mut deserializer =
23892389
Deserializer::from_str(data).expect("Failed to acquire deserializer");
@@ -2440,7 +2440,7 @@ bevy_reflect::tests::Test {
24402440
registry.add_registration(Vec3::get_type_registration());
24412441
registry.add_registration(f32::get_type_registration());
24422442

2443-
let de = UntypedReflectDeserializer::new(&registry);
2443+
let de = ReflectDeserializer::new(&registry);
24442444

24452445
let mut deserializer =
24462446
Deserializer::from_str(data).expect("Failed to acquire deserializer");

0 commit comments

Comments
 (0)