Struct bevy_reflect::serde::SerializationData

source ·
pub struct SerializationData { /* private fields */ }
Expand description

Contains data relevant to the automatic reflect powered (de)serialization of a type.

Implementations§

source§

impl SerializationData

source

pub fn new<I: Iterator<Item = (usize, SkippedField)>>(skipped_iter: I) -> Self

Creates a new SerializationData instance with the given skipped fields.

§Arguments
  • skipped_iter: The iterator of field indices to be skipped during (de)serialization. Indices are assigned only to reflected fields. Ignored fields (i.e. those marked #[reflect(ignore)]) are implicitly skipped and do not need to be included in this iterator.
source

pub fn is_field_skipped(&self, index: usize) -> bool

Returns true if the given index corresponds to a field meant to be skipped during (de)serialization.

§Example
#[derive(Reflect)]
struct MyStruct {
  serialize_me: i32,
  #[reflect(skip_serializing)]
  skip_me: i32
}

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

let my_struct = MyStruct {
  serialize_me: 123,
  skip_me: 321,
};

let serialization_data = registry.get_type_data::<SerializationData>(TypeId::of::<MyStruct>()).unwrap();

for (idx, field) in my_struct.iter_fields().enumerate(){
  if serialization_data.is_field_skipped(idx) {
    // Skipped!
    assert_eq!(1, idx);
  } else {
    // Not Skipped!
    assert_eq!(0, idx);
  }
}
source

pub fn generate_default(&self, index: usize) -> Option<Box<dyn Reflect>>

Generates a default instance of the skipped field at the given index.

Returns None if the field is not skipped.

§Example
#[derive(Reflect)]
struct MyStruct {
  serialize_me: i32,
  #[reflect(skip_serializing)]
  #[reflect(default = "skip_me_default")]
  skip_me: i32
}

fn skip_me_default() -> i32 {
  789
}

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

let serialization_data = registry.get_type_data::<SerializationData>(TypeId::of::<MyStruct>()).unwrap();
assert_eq!(789, serialization_data.generate_default(1).unwrap().take::<i32>().unwrap());
source

pub fn len(&self) -> usize

Returns the number of skipped fields.

source

pub fn is_empty(&self) -> bool

Returns true if there are no skipped fields.

source

pub fn iter_skipped(&self) -> Iter<'_, usize, SkippedField>

Returns an iterator over the skipped fields.

Each item in the iterator is a tuple containing:

  1. The reflected index of the field
  2. The (de)serialization metadata of the field

Trait Implementations§

source§

impl Clone for SerializationData

source§

fn clone(&self) -> SerializationData

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for SerializationData

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

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

§

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>,

§

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<T> TypeData for T
where T: 'static + Send + Sync + Clone,

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,