Struct Explorer 

pub struct Explorer<'a> { /* private fields */ }

A renderable view of a document tree.

Scalars reuse core’s JSON styles, keys json.key, XML attributes data.attribute; YAML anchors and aliases show as dim &name / *name badges and INI/dotenv comments as a dim # comment. Every line is cut to the available width: long strings shrink first (keeping their quotes), then the line ends in …, so nothing wraps.

use rich::Console;
use rich_ext::data::{parse, Explorer, Format};

let node = parse(Format::Json, r#"{"a": {"b": 1, "c": 2}, "d": [1, 2, 3]}"#).unwrap();
let explorer = Explorer::new(&node).max_depth(1).root_label("doc");
let out = Console::builder().width(40).build().render_export(&explorer);
assert_eq!(out, "doc\n├── a: {…} 2 keys\n└── d: […] 3 items\n");

Implementations

impl<'a> Explorer<'a>

pub fn new(node: impl Into<Cow<'a, Node>>) -> Self

Explore an owned or borrowed node.

pub fn max_depth(self, depth: usize) -> Self

Fold containers this deep (the root is depth 0) to a summary like {…} 3 keys.

pub fn max_length(self, length: usize) -> Self

Show at most this many children per container, then … N more.

pub fn max_string(self, length: usize) -> Self

Cut strings to this many characters (with …). Strings are also cut to the available width regardless.

pub fn show_paths(self, show: bool) -> Self

Append each leaf’s path, dim.

pub fn show_types(self, show: bool) -> Self

Append each node’s type (str, int, map, …), dim.

pub fn fold(self, path: Path) -> Self

Fold the container at path.

pub fn highlight(self, path: Path, style: Style) -> Self

Style the tree line of the node at path, such as the selection of a data::transform::Highlight. The table view ignores it.

pub fn root_label(self, label: impl Into<String>) -> Self

The root line’s label (default: the root’s summary).

pub fn view(self, view: View) -> Self

Tree or table.

pub fn style_rules(self, rules: StyleRules) -> Self

Conditional styles (table::rules) for the table view of records, by header. The tree ignores them.

pub fn node(&self) -> &Node

The node being explored.

Trait Implementations

impl<'a> Clone for Explorer<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Explorer<'a>

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

Formats the value using the given formatter.

impl Renderable for Explorer<'_>

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

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

The (minimum, maximum) cell width this renderable wants. Port of __rich_measure__. The default is what upstream’s Measurement.get returns for a renderable without one: anything from nothing to the whole width, (0, max_width).

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.

fn print_end_line(&self, _options: &ConsoleOptions) -> bool

Whether a top-level print ends this renderable’s last line. This port’s renderables separate lines, where upstream’s end each line with "\n", so a print adds the final line break. A renderable whose upstream output stops without one (Screen, LiveRender, a Rule whose end has no newline) returns false, and the next output continues its last line. options are the print’s options.