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
//! Serde (de)serialization of worlds.
//!
//! As component types are not known at compile time, the world must be provided with the
//! means to serialize each component. This is provided by the [`WorldSerializer`] implementation.
//! This implementation also describes how [`ComponentTypeId`](super::storage::ComponentTypeId)s
//! (which are not stable between compiles) are mapped to stable type identifiers. Components
//! that are not known to the serializer will be omitted from the serialized output.
//!
//! The [`Registry`] provides a [`WorldSerializer`] implementation suitable for most situations.
//!
//! Serializing all entities with a `Position` component to JSON.
//! ```
//! # use legion::*;
//! # use legion::serialize::Canon;
//! # let world = World::default();
//! # #[derive(serde::Serialize, serde::Deserialize)]
//! # struct Position;
//! // create a registry which uses strings as the external type ID
//! let mut registry = Registry::<String>::default();
//! registry.register::<Position>("position".to_string());
//! registry.register::<f32>("f32".to_string());
//! registry.register::<bool>("bool".to_string());
//!
//! // serialize entities with the `Position` component
//! let entity_serializer = Canon::default();
//! let json = serde_json::to_value(&world.as_serializable(
//! component::<Position>(),
//! ®istry,
//! &entity_serializer,
//! ))
//! .unwrap();
//! println!("{:#}", json);
//!
//! // registries are also serde deserializers
//! use serde::de::DeserializeSeed;
//! let world: World = registry
//! .as_deserialize(&entity_serializer)
//! .deserialize(json)
//! .unwrap();
//! ```
#[cfg(feature = "type-uuid")]
pub use crate::internals::serialize::SerializableTypeUuid;
pub use crate::internals::serialize::{
de::WorldDeserializer,
id::{set_entity_serializer, Canon, CustomEntitySerializer, EntityName, EntitySerializer},
ser::{SerializableWorld, WorldSerializer},
AutoTypeKey, DeserializeIntoWorld, DeserializeNewWorld, Registry, TypeKey, UnknownType,
};