Struct dogear::Tree

pub struct Tree { /* private fields */ }

A complete, rooted bookmark tree with tombstones.

The tree stores bookmark items in a vector, and uses indices in the vector to identify parents and children. This makes traversal and lookup very efficient. Retrieving a node’s parent takes one indexing operation, retrieving children takes one indexing operation per child, and retrieving a node by random GUID takes one hash map lookup and one indexing operation.

Implementations

impl Tree

pub fn with_root(root: Item) -> Builder

Returns a builder for a rooted tree.

pub fn size(&self) -> usize

Returns the number of nodes in the tree.

pub fn root(&self) -> Node<'_>

Returns the root node.

pub fn deletions(&self) -> &HashSet<Guid>

Returns the set of all tombstoned GUIDs.

pub fn exists(&self, guid: &Guid) -> bool

Indicates if the GUID exists in the tree.

pub fn is_deleted(&self, guid: &Guid) -> bool

Indicates if the GUID is known to be deleted. If Tree::node_for_guid returns None and Tree::is_deleted returns false, the item doesn’t exist in the tree at all.

pub fn mentions(&self, guid: &Guid) -> bool

Indicates if the GUID is mentioned in the tree, either as a node or a deletion.

pub fn guids(&self) -> impl Iterator<Item = &Guid>

Returns an iterator for all node and tombstone GUIDs.

pub fn node_for_guid(&self, guid: &Guid) -> Option<Node<'_>>

Returns the node for a given guid, or None if a node with the guid doesn’t exist in the tree, or was deleted.

pub fn problems(&self) -> &Problems

Returns the structure divergences found when building the tree.

Trait Implementations

impl Debug for Tree

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

Formats the value using the given formatter.

impl Display for Tree

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

Formats the value using the given formatter.

impl TryFrom<Builder> for Tree

fn try_from(builder: Builder) -> Result<Tree>

Builds a tree from all stored items and parent-child associations, resolving inconsistencies like orphans, multiple parents, and parent-child disagreements.

type Error = Error

The type returned in the event of a conversion error.