Struct NavTree 

pub struct NavTree {
    pub hung: Hung,
    pub nodes: Vec<NavNode>,
    pub path: BlockPath,
    pub selected: Vec<BlockId>,
}

The navigator’s tree: every block the document holds under its top, nested as the document nests them, beside where the canvas is standing and what is selected on it.

Fields

hung: Hung

What the tree hangs from. The top block is never a row of its own — its children are the first rows — so a path from the document root passes through it by name here.

nodes: Vec<NavNode>

path: BlockPath

selected: Vec<BlockId>

Implementations

impl NavTree

pub fn of( document: &IndexedDocument<'_>, path: BlockPath, selected: Vec<BlockId>, ) -> Self

The tree over document, under its top block: every block the document holds, nested as the document nests them.

pub fn path_of(&self, text: &str) -> Option<BlockPath>

Resolve a path string back to a BlockPath, matching names down from the document root — through the top, where one is designated — case-insensitively after trimming; the first sibling that matches wins. None if any name names nothing the tree holds.

pub fn all_blocks(&self) -> Vec<(BlockId, String)>

Every block the tree holds with its display label, depth first — the palette’s search space for find.

pub fn level_blocks(&self) -> Vec<(BlockId, String)>

The blocks on the level the canvas is standing on, with their display labels — the palette’s expand <block> targets, since only a direct child can be descended into.

pub fn walk(&self) -> impl Iterator<Item = (&NavNode, Vec<BlockId>)>

Every node, depth first, each with the ids of its ancestors between the tree’s root and it, outermost first.

pub fn node(&self, id: BlockId) -> Option<&NavNode>

The node for id, wherever it is in the tree.

pub fn children_of(&self, scope: Scope) -> &[NavNode]

The blocks a scope holds: the tree’s own rows for Scope::Root — the root a walk over the tree hangs from — and for the scope the tree hangs from in the document, which names the same rows for a path standing inside the top; a node’s children for a block within.

Trait Implementations

impl Clone for NavTree

fn clone(&self) -> NavTree

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NavTree

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

Formats the value using the given formatter.

impl Default for NavTree

fn default() -> NavTree

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for NavTree

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for NavTree

fn eq(&self, other: &NavTree) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for NavTree

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for NavTree

impl StructuralPartialEq for NavTree