Struct dendron::tree::HierarchyEditGrant

pub struct HierarchyEditGrant<T>(_);

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

A grant can be created by Tree::grant_hierarchy_edit or HotNode::extract_hierarchy_edit_grant.

A grant can be created by Tree::grant_hierarchy_edit or HotNode::extract_hierarchy_edit_grant.

Implementations

impl<T> HierarchyEditGrant<T>

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

Clones the tree hierarchy edit grant.

Failures

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

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

Returns true if the grant 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 grant1 = node1.tree()
    .grant_hierarchy_edit()
    .expect("hierarchy edit should not yet be prohibited");

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

Trait Implementations

impl<T> Clone for HierarchyEditGrant<T>

fn clone(&self) -> Self

Clones the tree hierarchy edit grant.

If you want to avoid the risk of panic (even if it is very unlikely), use try_clone method.

Panics

Panics if the number of active edit grants for the tree will exceed isize::MAX.

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

Performs copy-assignment from source.

impl<T> Drop for HierarchyEditGrant<T>

fn drop(&mut self)

Executes the destructor for this type.