Struct Pretty 

pub struct Pretty { /* private fields */ }

A renderable that pretty prints a value. Mirrors rich.pretty.Pretty.

Implementations

impl Pretty

pub fn new(value: &impl Debug) -> Self

Pretty-print value ({:#?}, multi-line and indented) and highlight it. Not upstream’s layout; see Pretty::from_value.

pub fn compact(value: &impl Debug) -> Self

Format value compactly on one line ({:?}) and highlight it.

pub fn from_value(value: PrettyValue) -> Self

Pretty-print a Python value as upstream’s Pretty(obj) does.

pub fn highlighter( self, highlighter: impl Highlighter + Send + Sync + 'static, ) -> Self

The highlighter applied to the repr (upstream highlighter, default ReprHighlighter).

pub fn indent_size(self, indent_size: usize) -> Self

Spaces per indent level (upstream indent_size, default 4).

pub fn justify(self, justify: Option<Justify>) -> Self

Justify method, or None for the console’s (upstream justify).

pub fn overflow(self, overflow: Option<Overflow>) -> Self

Overflow method, or None for the console’s (upstream overflow).

pub fn no_wrap(self, no_wrap: Option<bool>) -> Self

Disable wrapping, or None for the console’s (upstream no_wrap, default False).

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

Draw indent guides (upstream indent_guides).

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

Abbreviate containers longer than this (upstream max_length).

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

Truncate strings longer than this (upstream max_string).

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

Stop at this depth of nesting (upstream max_depth).

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

Expand every container (upstream expand_all).

pub fn margin(self, margin: usize) -> Self

Cells taken off the width, so containers expand sooner (upstream margin).

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

Start with a blank line when the output has several lines (upstream insert_line).

Trait Implementations

impl Renderable for Pretty

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.