Struct Tree 

pub struct Tree { /* private fields */ }

Implementations

impl Tree

pub fn new() -> Self

pub fn push( &mut self, parent: Option<NodeId>, name: impl Into<String>, is_container: bool, action: ActionValues, ) -> NodeId

pub fn push_with_detail( &mut self, parent: Option<NodeId>, name: impl Into<String>, detail: Option<String>, is_container: bool, action: ActionValues, ) -> NodeId

pub fn fully_indexed(&self) -> bool

True once every node’s children are loaded and every span validated; the jump picker requires this.

pub fn pending(&self) -> usize

Nodes whose children/validation are still pending (progress display).

pub fn errors(&self) -> &[String]

Messages for spans that failed to scan, in discovery order.

pub fn name(&self, id: NodeId) -> String

The node’s display name.

pub fn detail(&self, id: NodeId) -> Option<String>

Optional secondary text rendered after the name.

pub fn parent(&self, id: NodeId) -> Option<NodeId>

pub fn depth(&self, id: NodeId) -> usize

0 for roots.

pub fn is_container(&self, id: NodeId) -> bool

Whether the node represents a container, including an empty one.

pub fn children_of(&self, id: NodeId) -> &[NodeId]

The node’s children, in display order.

pub fn output(&self, id: NodeId) -> OsString

Text written to stdout when the node is accepted.

pub fn alternate_output(&self, id: NodeId) -> OsString

Text written to stdout by the alternate accept action.

pub fn path(&self, id: NodeId) -> OsString

Value exported to shell bindings as $path.

pub fn filesystem_path(&self, id: NodeId) -> Option<OsString>

The node’s location in the host filesystem, when it has one. JSON nodes are addressed by pointer within a document, so nothing outside ite can open them.

pub fn relpath(&self, id: NodeId) -> OsString

Value exported to shell bindings as $relpath: the address within the source’s natural unit — the scan root for directories, the document for JSON, the containing record for JSONL (the record itself is “”).

pub fn jump_key(&self, id: NodeId) -> String

The text the jump picker matches and displays: the node’s document-global address. Coincides with relpath for directory scans and JSON documents; JSONL diverges, since a record-relative relpath repeats across records.

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn root_ids(&self) -> &[NodeId]

pub fn is_leaf(&self, id: NodeId) -> bool

True when the node cannot be expanded. Containers are never leaves: an empty directory is still a directory and {}/[] are still containers — they simply open to nothing.

pub fn branches(&self) -> impl Iterator<Item = (NodeId, Option<NodeId>)> + '_

All expandable nodes as (id, parent) pairs, in tree order.

Trait Implementations

impl Debug for Tree

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

Formats the value using the given formatter.

impl Default for Tree

fn default() -> Tree

Returns the “default value” for a type.

impl TreeModel for Tree

type Id = usize

The node identifier type.

fn roots(&self) -> impl Iterator<Item = NodeId> + '_

Returns forest roots in deterministic order.

fn children(&self, id: NodeId) -> TreeChildren<'_, NodeId>

Returns the node’s child state and loaded children.

fn revision(&self) -> TreeRevision

Returns the revision of the model structure and display data.

fn size_hint(&self) -> usize

Returns an approximate number of available nodes.