Struct PrettyPrinter 

pub struct PrettyPrinter { /* private fields */ }

A formatter for pretty-printing Facet types

Implementations

impl PrettyPrinter

pub const fn new() -> Self

Create a new PrettyPrinter with default settings

pub const fn with_indent_size(self, size: usize) -> Self

Set the indentation size

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

Set the maximum depth for recursive printing

pub const fn with_color_generator(self, generator: ColorGenerator) -> Self

Set the color generator

pub const fn with_colors(self, enable_colors: ColorMode) -> Self

Enable or disable colors. Use None to automatically detect color support based on the NO_COLOR environment variable.

pub const fn with_minimal_option_names(self, minimal: bool) -> Self

Use minimal names for Options (show Some(x) instead of Option<T>::Some(x))

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

Enable or disable doc comments in output

pub const fn with_max_content_len(self, max_len: usize) -> Self

Set the maximum length for strings and byte arrays before truncating

When set, strings and byte arrays longer than this limit will be truncated in the middle, showing the beginning and end with ... between.

pub fn format<'a, T: ?Sized + Facet<'a>>(&self, value: &T) -> String

Format a value to a string

pub fn format_to<'a, T: ?Sized + Facet<'a>>( &self, value: &T, f: &mut Formatter<'_>, ) -> Result

Format a value to a formatter

pub fn format_peek(&self, value: Peek<'_, '_>) -> String

Format a value to a string

pub fn format_peek_with_spans(&self, value: Peek<'_, '_>) -> FormattedValue

Format a value with span tracking for each path.

Returns a FormattedValue containing the plain text output and a map from paths to their byte spans in the output.

This is useful for creating rich diagnostics that can highlight specific parts of a pretty-printed value.

Trait Implementations

impl Clone for PrettyPrinter

fn clone(&self) -> PrettyPrinter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for PrettyPrinter

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for PrettyPrinter

fn eq(&self, other: &PrettyPrinter) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for PrettyPrinter