Struct SnapshotBuilder

pub struct SnapshotBuilder<'a> { /* private fields */ }

A snapshot builder that can extract entities, resources, and rollback Checkpoints from a World.

Implementations

impl<'a> SnapshotBuilder<'a>

pub fn snapshot(world: &'a World) -> Self

Create a new SnapshotBuilder from the World.

You must call at least one of the extract methods or the built snapshot will be empty.

Example

SnapshotBuilder::snapshot(world)
    // Extract all matching entities and resources
    .extract_all()

    // Clear all extracted entities without any components
    .clear_empty()

    // Build the `Snapshot`
    .build();

pub fn checkpoint(world: &'a World) -> Self

Create a new SnapshotBuilder from the World.

Types extracted by this builder will respect the CheckpointRegistry.

You must call at least one of the extract methods or the built snapshot will be empty.

Example

SnapshotBuilder::checkpoint(world)
    // Extract all matching entities and resources
    .extract_all()

    // Clear all extracted entities without any components
    .clear_empty()

    // Build the `Snapshot`
    .build();

impl<'a> SnapshotBuilder<'a>

pub fn world<'w>(&self) -> &'w World

where 'a: 'w,

Retrieve the builder’s reference to the World.

pub fn type_registry(self, type_registry: &'a TypeRegistry) -> Self

Set the TypeRegistry to be used for reflection.

If this is not provided, the AppTypeRegistry resource is used as a default.

impl SnapshotBuilder<'_>

pub fn filter(self, filter: SceneFilter) -> Self

Specify a custom SceneFilter to be used with this builder.

This filter is applied to both components and resources.

pub fn allow<T: Any>(self) -> Self

Allows the given type, T, to be included in the generated snapshot.

This method may be called multiple times for any number of types.

This is the inverse of deny. If T has already been denied, then it will be removed from the blacklist.

pub fn deny<T: Any>(self) -> Self

Denies the given type, T, from being included in the generated snapshot.

This method may be called multiple times for any number of types.

This is the inverse of allow. If T has already been allowed, then it will be removed from the whitelist.

pub fn allow_all(self) -> Self

Updates the filter to allow all types.

This is useful for resetting the filter so that types may be selectively denied.

pub fn deny_all(self) -> Self

Updates the filter to deny all types.

This is useful for resetting the filter so that types may be selectively allowed.

impl SnapshotBuilder<'_>

pub fn extract_entity(self, entity: Entity) -> Self

Extract a single entity from the builder’s World.

pub fn extract_entities(self, entities: impl Iterator<Item = Entity>) -> Self

Extract the given entities from the builder’s World.

Panics

If type_registry is not set or the AppTypeRegistry resource does not exist.

pub fn extract_entities_matching<F: Fn(&EntityRef<'_>) -> bool>( self, filter: F, ) -> Self

Extract the entities matching the given filter from the builder’s World.

pub fn extract_all_entities(self) -> Self

Extract all entities from the builder’s World.

pub fn extract_entities_manual<F, B>(self, func: F) -> Self

where F: Fn(&EntityRef<'_>) -> Option<Vec<Box<dyn PartialReflect>>>,

Extract all entities with a custom extraction function.

pub fn extract_prefab<F, P>(self, func: F) -> Self

where F: Fn(&EntityRef<'_>) -> Option<P>, P: Prefab + PartialReflect,

Extract all Prefab entities with a custom extraction function.

pub fn extract_all_prefabs<P: Prefab>(self) -> Self

Extract all spawned instances of Prefab from the builder’s World.

pub fn extract_resource<T: Resource>(self) -> Self

Extract a single resource from the builder’s World.

pub fn extract_resource_by_path<T: AsRef<str>>(self, type_path: T) -> Self

Extract a single resource with the given type path from the builder’s World.

pub fn extract_resources_by_path<T: AsRef<str>>( self, type_paths: impl Iterator<Item = T>, ) -> Self

Extract resources with the given type paths from the builder’s World.

Panics

If type_registry is not set or the AppTypeRegistry resource does not exist.

pub fn extract_resources_by_type_id( self, type_ids: impl Iterator<Item = TypeId>, ) -> Self

Extract resources with the given TypeId’s from the builder’s World.

Panics

If type_registry is not set or the AppTypeRegistry resource does not exist.

pub fn extract_all_resources(self) -> Self

Extract all resources from the builder’s World.

pub fn extract_checkpoints(self) -> Self

Extract Checkpoints from the builder’s World.

Panics

If type_registry is not set or the AppTypeRegistry resource does not exist.

pub fn extract_all(self) -> Self

Extract all entities, and resources from the builder’s World.

pub fn extract_all_with_checkpoints(self) -> Self

Extract all entities, resources, and Checkpoints from the builder’s World.

impl SnapshotBuilder<'_>

pub fn clear_entities(self) -> Self

Clear all extracted entities.

pub fn clear_resources(self) -> Self

Clear all extracted resources.

pub fn clear_empty(self) -> Self

Clear all extracted entities without any components.

pub fn clear_checkpoints(self) -> Self

Clear Checkpoints from the snapshot.

pub fn clear(self) -> Self

Clear all extracted entities and resources.

impl SnapshotBuilder<'_>

pub fn build(self) -> Snapshot

Build the extracted entities and resources into a Snapshot.