Struct bevy_reflect::serde::SerializationData

pub struct SerializationData { /* private fields */ }

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

Implementations

impl SerializationData

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.

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);
  }
}

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());

pub fn len(&self) -> usize

Returns the number of skipped fields.

pub fn is_empty(&self) -> bool

Returns true if there are no skipped fields.

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

impl Clone for SerializationData

fn clone(&self) -> SerializationData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SerializationData

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

Formats the value using the given formatter.