bevy_reflect::serde

Struct TypedReflectSerializer

Source
pub struct TypedReflectSerializer<'a, P = ()> { /* private fields */ }
Expand description

A serializer for reflected types whose type will be known during deserialization.

This is the serializer counterpart to TypedReflectDeserializer.

See ReflectSerializer for a serializer that serializes an unknown type.

§Output

Since the type is expected to be known during deserialization, this serializer will not output any additional type information, such as the type path.

Instead, it will output just the serialized data.

If you want to override serialization for specific values, you can pass in a reference to a ReflectSerializerProcessor which will take priority over all other serialization methods - see with_processor.

§Example

#[derive(Reflect, PartialEq, Debug)]
#[type_path = "my_crate"]
struct MyStruct {
  value: i32
}

let mut registry = TypeRegistry::default();
registry.register::<MyStruct>();

let input = MyStruct { value: 123 };

let reflect_serializer = TypedReflectSerializer::new(&input, &registry);
let output = ron::to_string(&reflect_serializer).unwrap();

assert_eq!(output, r#"(value:123)"#);

Implementations§

Source§

impl<'a> TypedReflectSerializer<'a, ()>

Source

pub fn new(value: &'a dyn PartialReflect, registry: &'a TypeRegistry) -> Self

Creates a serializer with no processor.

If you want to add custom logic for serializing certain values, use with_processor.

Source§

impl<'a, P> TypedReflectSerializer<'a, P>

Source

pub fn with_processor( value: &'a dyn PartialReflect, registry: &'a TypeRegistry, processor: &'a P, ) -> Self

Creates a serializer with a processor.

If you do not need any custom logic for handling certain values, use new.

Trait Implementations§

Source§

impl<P: ReflectSerializerProcessor> Serialize for TypedReflectSerializer<'_, P>

Source§

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl<'a, P> Freeze for TypedReflectSerializer<'a, P>

§

impl<'a, P = ()> !RefUnwindSafe for TypedReflectSerializer<'a, P>

§

impl<'a, P> Send for TypedReflectSerializer<'a, P>
where P: Sync,

§

impl<'a, P> Sync for TypedReflectSerializer<'a, P>
where P: Sync,

§

impl<'a, P> Unpin for TypedReflectSerializer<'a, P>

§

impl<'a, P = ()> !UnwindSafe for TypedReflectSerializer<'a, P>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Serialize for T
where T: Serialize + ?Sized,

Source§

fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<(), Error>

Source§

fn do_erased_serialize( &self, serializer: &mut dyn Serializer, ) -> Result<(), ErrorImpl>

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ConditionalSend for T
where T: Send,