Struct dendron::HierarchyEditProhibition

pub struct HierarchyEditProhibition<T>(_);

A token to keep the tree hierarchy prohibited to be edited.

A prohibition can be created by Tree::prohibit_hierarchy_edit or FrozenNode::extract_hierarchy_edit_prohibition.

Implementations

impl<T> HierarchyEditProhibition<T>

pub fn try_clone(&self) -> Result<Self, HierarchyEditProhibitionError>

Clones the tree hierarchy edit prohibition.

Failures

Fails if the number of active edit prohibitions for the tree exceeds isize::MAX.

pub fn is_valid_for_node(&self, node: &Node<T>) -> bool

Returns true if the prohibition is valid for the tree the given node belongs to.

Examples

use dendron::Node;

let node1 = Node::new_tree("foo");
let node2 = Node::new_tree("bar");

let prohibition1 = node1.tree()
    .prohibit_hierarchy_edit()
    .expect("hierarchy edit should not yet be granted");

assert!(prohibition1.is_valid_for_node(&node1));
assert!(!prohibition1.is_valid_for_node(&node2));

Trait Implementations

impl<T> Drop for HierarchyEditProhibition<T>

fn drop(&mut self)

Executes the destructor for this type.