Struct dogear::Node

pub struct Node<'t>(_, _);

A node in a bookmark tree that knows its parent and children, and dereferences to its item.

Methods

impl<'t> Node<'t>

pub fn content(&self) -> Option<&'t Content>

Returns content info for deduping this item, if available.

pub fn children<'n>(&'n self) -> impl Iterator<Item = Node<'t>> + 'n

Returns an iterator for all children of this node.

pub fn child(&self, index: usize) -> Option<Node>

Returns the child at the given index, or None if the index is out of bounds.

pub fn has_matching_children<'u>(&self, other: Node<'u>) -> bool

Returns true if this and other have the same child GUIDs.

pub fn parent(&self) -> Option<Node>

Returns the resolved parent of this node, or None if this is the root node.

pub fn level(&self) -> i64

Returns the level of this node in the tree.

pub fn is_syncable(&self) -> bool

Indicates if this node is for a syncable item.

Syncable items descend from the four user content roots. For historical reasons, the Desktop tags root and its descendants are also marked as syncable, even though they are not part of the synced tree structure. Any other roots and their descendants, like the left pane root, left pane queries, and custom roots, are non-syncable.

Newer Desktops should never reupload non-syncable items (bug 1274496), and should have removed them in Places migrations (bug 1310295). However, these items may be reparented locally to unfiled, in which case they're seen as syncable. If the remote tree has the missing parents and roots, we'll determine that the items are non-syncable when merging, remove them locally, and mark them for deletion remotely.

pub fn diverged(&self) -> bool

Indicates if this node's structure diverged because it existed in multiple parents, or was reparented.

pub fn to_ascii_string(&self) -> String

Returns an ASCII art (with emoji!) representation of this node and all its descendants. Handy for logging.

pub fn is_root(&self) -> bool

Indicates if this node is the root node.

pub fn is_built_in_root(&self) -> bool

Indicates if this node is a Places built-in root. Any other roots except these are non-syncable.

Methods from Deref<Target = Item>

pub fn is_folder(&self) -> bool

Indicates if the item is a folder. Only folders are allowed to have children.

pub fn has_compatible_kind(&self, remote_node: &Item) -> bool

Indicates if the item can be merged with another item. Only items with compatible kinds can be merged.

Trait Implementations

impl<'t> Clone for Node<'t>

fn clone(&self) -> Node<'t>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'t> Copy for Node<'t>

impl<'t> Deref for Node<'t>

type Target = Item

The resulting type after dereferencing.

fn deref(&self) -> &Item

Dereferences the value.

impl<'t> Debug for Node<'t>

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

Formats the value using the given formatter.

impl<'t> Display for Node<'t>

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

Formats the value using the given formatter.