Struct EntityTree 

pub struct EntityTree {
    pub path: EntityPath,
    pub children: BTreeMap<EntityPathPart, Self>,
}

A recursive tree structure that maintains the entity hierarchy.

The tree contains a list of subtrees, and so on recursively.

Fields

path: EntityPath

Full path prefix to the root of this (sub)tree.

children: BTreeMap<EntityPathPart, Self>

Direct descendants of this (sub)tree.

Implementations

impl EntityTree

pub fn root() -> Self

pub fn new(path: EntityPath) -> Self

pub fn is_leaf(&self) -> bool

Has no child entities.

pub fn on_new_entity(&mut self, entity_path: &EntityPath)

pub fn subtree(&self, path: &EntityPath) -> Option<&Self>

pub fn visit_children_recursively(&self, visitor: impl FnMut(&EntityPath))

Invokes visitor for self and all children recursively.

pub fn prune_empty_entities( &mut self, entity_has_data: &impl Fn(&EntityPath) -> bool, )

Removes leaf entities that have no children and for which entity_has_data returns false.

This is called after store deletions to keep the tree in sync with the actual data.

pub fn find_first_child_recursive( &self, predicate: impl FnMut(&EntityPath) -> bool, ) -> Option<&Self>

Invokes the predicate for self and all children recursively, returning the first entity for which the predicate returns true.

Note that this function has early return semantics, meaning if multiple entities would return true, only the first is returned. The entities are yielded in order of their entity paths.

Trait Implementations

impl Clone for EntityTree

fn clone(&self) -> EntityTree

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EntityTree

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

Formats the value using the given formatter.

impl Default for EntityTree

fn default() -> Self

Returns the “default value” for a type.

impl SizeBytes for EntityTree

fn heap_size_bytes(&self) -> u64

Returns how many bytes self uses on the heap.

fn total_size_bytes(&self) -> u64

Returns the total size of self in bytes, accounting for both stack and heap space.

fn stack_size_bytes(&self) -> u64

Returns the total size of self on the stack, in bytes.

fn is_pod() -> bool

Is Self just plain old data?