Skip to main content

Tree

Struct Tree 

Source
pub struct Tree { /* private fields */ }
Expand description

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

Implementations§

Source§

impl Tree

Source

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.

Source

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

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

Source

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.

Trait Implementations§

Source§

impl Drop for Tree

Source§

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.

Source§

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. Read more
Source§

impl Renderable for Tree

Source§

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.

Source§

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

Source§

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.

Auto Trait Implementations§

§

impl !RefUnwindSafe for Tree

§

impl !UnwindSafe for Tree

§

impl Freeze for Tree

§

impl Send for Tree

§

impl Sync for Tree

§

impl Unpin for Tree

§

impl UnsafeUnpin for Tree

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.