Struct R1NStore

pub struct R1NStore<T, U>
where
    T: Storable,
    U: Storable,
{
    pub parents: XvcStore<T>,
    pub children: XvcStore<U>,
    pub child_parents: XvcStore<ChildEntity<U, T>>,
}

RNStore is 1-N RelationStore, where we store one-to-many relationships between two entities. It doesn’t have any semantics except binding two entities together.

Fields

parents: XvcStore<T>

Keeps the parent type

children: XvcStore<U>

Keeps the child type

child_parents: XvcStore<ChildEntity<U, T>>

Keeps the relationships between child entities and parent entities The key for the child_parents is the child entity, as there are many children for a parent.

Implementations

impl<T, U> R1NStore<T, U>

where T: Storable, U: Storable,

pub fn insert( &mut self, parent_entity: XvcEntity, parent_component: T, child_entity: XvcEntity, child_component: U, ) -> Option<XvcEntity>

Insert a child component to a parent parent_component. It checks whether the parent is equal to the given, and updates if there is a change.

pub fn children_of(&self, parent_entity: &XvcEntity) -> Result<HStore<U>>

get the store of related entities.

pub fn parent_of( &self, child_entity: &XvcEntity, ) -> Result<(&ChildEntity<U, T>, &T)>

Get left entity that’s related with thethe right child_entity.

pub fn remove_child(&mut self, child_entity: XvcEntity) -> Result<()>

Remove the child entity from child-parent store and children store

impl<T, U> R1NStore<T, U>

where T: Storable, U: Storable,

pub fn load_r1nstore(store_root: &Path) -> Result<R1NStore<T, U>>

Loads the stores from store root and directory named after type names

pub fn save_r1nstore(store: &Self, store_root: &Path) -> Result<()>

Records the stores to store root and directories created from type names

Trait Implementations

impl<T, U> Clone for R1NStore<T, U>

where T: Storable + Clone, U: Storable + Clone,

fn clone(&self) -> R1NStore<T, U>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, U> Debug for R1NStore<T, U>

where T: Storable + Debug, U: Storable + Debug,

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

Formats the value using the given formatter.