Struct Tree 

pub struct Tree { /* private fields */ }

A node in a hierarchy. Mirrors rich.tree.Tree.

Implementations

impl Tree

pub fn new(label: impl Into<Cell>) -> Self

A new tree/subtree with the given label. A string label is console markup, as upstream’s Tree("[b]root") is; pass a Text for a literal one.

pub fn highlight(self, highlight: bool) -> Self

Highlight string labels (upstream Tree(highlight=…), default off). Upstream renders every label with the root’s setting.

pub fn style(self, style: impl Into<StyleType>) -> Self

The style of this node’s label and, stacked, its descendants’ (upstream Tree(style=…), default "tree").

pub fn guide_style(self, style: impl Into<StyleType>) -> Self

The style of the guide lines below this node (upstream Tree(guide_style=…), default "tree.line"). Bold selects the heavy guides and underline2 the double ones.

pub fn expanded(self, expanded: bool) -> Self

Whether this node’s children are shown (upstream expanded, default on).

pub fn hide_root(self, hide_root: bool) -> Self

Hide the root node, rendering its children as the top level (upstream hide_root, default off; read from the root only).

pub fn set_style(&mut self, style: impl Into<StyleType>) -> &mut Self

Set style in place.

pub fn set_guide_style(&mut self, style: impl Into<StyleType>) -> &mut Self

Set guide_style in place.

pub fn set_expanded(&mut self, expanded: bool) -> &mut Self

Set expanded in place (upstream assigns tree.expanded).

pub fn set_hide_root(&mut self, hide_root: bool) -> &mut Self

Set hide_root in place.

pub fn set_highlight(&mut self, highlight: bool) -> &mut Self

Set highlight in place.

pub fn set_label(&mut self, label: impl Into<Cell>) -> &mut Self

Replace the label in place.

pub fn label(&self) -> &Cell

The label.

pub fn get_style(&self) -> &StyleType

The node’s style (see style).

pub fn get_guide_style(&self) -> &StyleType

The node’s guide style (see guide_style).

pub fn is_expanded(&self) -> bool

Whether children are shown.

pub fn is_root_hidden(&self) -> bool

Whether the root is hidden.

pub fn is_highlighted(&self) -> bool

Whether string labels are highlighted.

pub fn children(&self) -> &[Tree]

The child nodes.

pub fn children_mut(&mut self) -> &mut Vec<Tree>

The child nodes, mutably.

pub fn add(&mut self, label: impl Into<Cell>) -> &mut Tree

Add a child with label, returning a mutable reference to it so further descendants can be attached. Mirrors Tree.add with its defaults: the child inherits this node’s style and guide_style and is expanded.

pub fn add_tree(&mut self, child: Tree) -> &mut Tree

Attach an already built subtree as the last child, returning it. Use it for upstream’s Tree.add(label, style=…, guide_style=…, expanded=…).

Trait Implementations

impl Drop for Tree

fn drop(&mut self)

Drop descendants from an explicit stack: the derived drop recurses once per level and overflows the stack on a very deep tree.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Renderable for Tree

fn measure(&self, console: &Console, options: &ConsoleOptions) -> Measurement

Port of Tree.__rich_measure__: the widest label plus its indent of four cells per level, for both bounds.

fn rich_render( &self, console: &Console, options: &ConsoleOptions, ) -> Vec<Segment>

fn fit_to_measurement(&self) -> bool

Whether a top-level Console::print shrinks this renderable to its measured width. Upstream renders every top-level renderable at the full console width, so the default is false; an extension may opt in.

fn vertical(&self) -> Option<VerticalAlign>

The vertical alignment a Table cell holding this renderable uses in place of its column’s. Upstream reads getattr(renderable, "vertical", None); Align sets it.