Struct flow_arena::FlowArena

pub struct FlowArena<Id: Hash + Eq + Clone, FlowNode: Node<Id> + Clone> { /* fields omitted */ }

Implementations

impl<Id, FlowNode> FlowArena<Id, FlowNode> where
    Id: Clone + Hash + Eq + Default + Debug,
    FlowNode: Node<Id> + Default + Debug + Clone, 

pub fn new() -> Self

impl<Id, Entity> FlowArena<Id, FlowNode<Id, Entity>> where
    Id: Clone + Hash + Eq + Default + Debug,
    Entity: Default + Debug + Clone, 

pub fn entities(&self) -> Entities<'_, Id, Entity>

returns an iterator over all entities.

pub fn entities_mut(&mut self) -> EntitiesMut<'_, Id, Entity>

returns an iterator over all entities.

Trait Implementations

impl<Id: Clone + Hash + Eq, FlowNode: Clone + Node<Id>> Clone for FlowArena<Id, FlowNode>

fn clone(&self) -> FlowArena<Id, FlowNode>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Id: Debug + Hash + Eq + Clone, FlowNode: Debug + Node<Id> + Clone> Debug for FlowArena<Id, FlowNode>

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

Formats the value using the given formatter.

impl<Id, FlowNode> Default for FlowArena<Id, FlowNode> where
    Id: Clone + Hash + Eq + Default + Debug,
    FlowNode: Node<Id> + Default + Debug + Clone, 

fn default() -> Self

Returns the “default value” for a type.

impl<'de, Id, Entity> Deserialize<'de> for FlowArena<Id, FlowNode<Id, Entity>> where
    Id: Deserialize<'de> + Clone + Hash + Eq,
    Entity: Deserialize<'de> + Clone, 

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl<Id, FlowNode> Flow for FlowArena<Id, FlowNode> where
    Id: Clone + Hash + Eq + Default + Debug,
    FlowNode: Node<Id> + Default + Debug + Clone, 

impl<Id, FlowNode> FlowBase for FlowArena<Id, FlowNode> where
    Id: Clone + Hash + Eq + Default + Debug,
    FlowNode: Node<Id> + Default + Debug + Clone, 

type Id = Id

type Node = FlowNode

fn orphan(&self) -> Vec<Self::Id>

ensures root and returns it

fn contains_node(&self, obj: &Self::Id) -> bool

fn node(&self, obj: &Self::Id) -> Option<&Self::Node>

fn node_mut(&mut self, obj: &Self::Id) -> Option<&mut Self::Node>

fn parent(&self, obj: &Self::Id) -> Option<Self::Id>

fn children(&self, obj: &Self::Id) -> Vec<Self::Id>

fn friends(&self, obj: &Self::Id) -> Vec<Self::Id>

returns parent’s children

fn nth_friend(&self, obj: &Self::Id) -> Option<usize>

returns nth position in friends; None if not found in either way

fn children_owned(&self, obj: &Self::Id) -> Vec<Self::Id>

returns owned children

fn is_owned(&self, obj: &Self::Id, owner: &Self::Id) -> bool

judge whether the obj is owned by the owner

fn is_linked(&self, obj: &Self::Id, owner: &Self::Id) -> bool

judge whether the obj is purely linked from the owner

fn node_offspring_set(&self, obj: &Self::Id) -> HashSet<Self::Id>

returns all the offspring of a node, not including itself

fn node_ownership_set(&self, obj: &Self::Id) -> HashSet<Self::Id>

returns all the nodes owned by a node, including itself

impl<Id, FlowNode> FlowCheck for FlowArena<Id, FlowNode> where
    Id: Clone + Hash + Eq + Default + Debug,
    FlowNode: Node<Id> + Default + Debug + Clone, 

fn check(&self) -> Result<(), (FlowError, String)>

fn check_assert(&self)

panics if anything went wrong. Iff in debug state.

impl<Id, FlowNode> FlowDevote for FlowArena<Id, FlowNode> where
    Id: Clone + Hash + Eq + Default + Debug,
    FlowNode: Node<Id> + Default + Debug + Clone, 

fn devote(
    &mut self,
    obj: &Self::Id,
    owner: &Self::Id,
    nth: usize
) -> Result<(), FlowError>

appoints and ensures an owner; also links to owner; won’t do anything if aleady has the node as child

fn devote_push(
    &mut self,
    obj: &Self::Id,
    owner: &Self::Id
) -> Result<(), FlowError>

fn decay(&mut self, obj: &Self::Id) -> Result<(), FlowError>

removes ownership; also detaches

fn devote_loyal(
    &mut self,
    obj: &Self::Id,
    owner: &Self::Id,
    nth: usize
) -> Result<(), FlowError>

decay before devote

fn devote_loyal_push(
    &mut self,
    obj: &Self::Id,
    owner: &Self::Id
) -> Result<(), FlowError>

decay before devote

impl<Id, FlowNode> FlowDock for FlowArena<Id, FlowNode> where
    Id: Clone + Hash + Eq + Default + Debug,
    FlowNode: Node<Id> + Default + Debug + Clone, 

fn dock(
    &mut self,
    owner: &Self::Id,
    vec: Vec<Self::Id>,
    flow: Self
) -> Result<(), FlowError>

fn undock_impl(
    &mut self,
    obj: &Self::Id,
    owned: bool
) -> Result<(Self, Vec<Self::Id>), FlowError>

moves all the nodes under the designated node out of the current flow and unmounts them

fn snap(&self, obj: &Self::Id) -> Result<(Self, Vec<Self::Id>), FlowError>

clones all the nodes linked under the designated node and unmounts the clone

fn snap_owned(&self, obj: &Self::Id) -> Result<(Self, Vec<Self::Id>), FlowError>

clones all the nodes owned under the designated node and unmounts the clone

fn dock_unordered(
    &mut self,
    owner: &Self::Id,
    flow: Self
) -> Result<(), FlowError>

adds all the nodes in another flow to self and mounts all orphan nodes to the designated node

fn undock(&mut self, obj: &Self::Id) -> Result<(Self, Vec<Self::Id>), FlowError>

fn undock_owned(
    &mut self,
    obj: &Self::Id
) -> Result<(Self, Vec<Self::Id>), FlowError>

impl<Id, FlowNode> FlowLink for FlowArena<Id, FlowNode> where
    Id: Clone + Hash + Eq + Default + Debug,
    FlowNode: Node<Id> + Default + Debug + Clone, 

fn link(
    &mut self,
    obj: &Self::Id,
    owner: &Self::Id,
    nth: usize
) -> Result<(), FlowError>

randomly ensures the link of a node to another; won’t change if aleady has the node as child

fn link_push(
    &mut self,
    obj: &Self::Id,
    owner: &Self::Id
) -> Result<(), FlowError>

fn detach(&mut self, obj: &Self::Id, owner: &Self::Id) -> Result<(), FlowError>

detaches a node from a non-owner link

impl<Id, FlowNode> FlowMap for FlowArena<Id, FlowNode> where
    Id: Clone + Hash + Eq + Default + Debug,
    FlowNode: Node<Id> + Default + Debug + Clone, 

fn grow(&mut self, obj: Self::Node) -> Result<Self::Id, FlowError>

inserts a node; returns err if id exists.

fn erase(&mut self, obj: &Self::Id) -> Result<Self::Node, FlowError>

removes a node; returns err if id not found under root

impl<Id, FlowNode> FlowShift for FlowArena<Id, FlowNode> where
    Id: Clone + Hash + Eq + Default + Debug,
    FlowNode: Node<Id> + Default + Debug + Clone, 

fn shuttle(&self, obj: &Self::Id, dir: Direction) -> Result<Self::Id, FlowError>

returns the obj in the corresponding relative position

fn shuttle_iter(
    &self,
    obj: &Self::Id,
    dir: Direction
) -> Result<Self::Id, FlowError>

iteratively shuttles within the flow

fn migrate(&mut self, obj: &Self::Id, dir: Direction) -> Result<(), FlowError>

alters the node position by the corresponding relative position, within a single node

fn migrate_iter(
    &mut self,
    obj: &Self::Id,
    dir: Direction
) -> Result<(), FlowError>

alters the node position by the corresponding relative position, iteratively within the flow

impl<Id: PartialEq + Hash + Eq + Clone, FlowNode: PartialEq + Node<Id> + Clone> PartialEq<FlowArena<Id, FlowNode>> for FlowArena<Id, FlowNode>

fn eq(&self, other: &FlowArena<Id, FlowNode>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &FlowArena<Id, FlowNode>) -> bool

This method tests for !=.

impl<Id, Entity> Serialize for FlowArena<Id, FlowNode<Id, Entity>> where
    Id: Serialize + Hash + Eq + Clone,
    Entity: Serialize + Clone, 

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl<Id: Hash + Eq + Clone, FlowNode: Node<Id> + Clone> StructuralPartialEq for FlowArena<Id, FlowNode>