Struct PrettyPrinter 

pub struct PrettyPrinter { /* private fields */ }

A formatter for pretty-printing Facet types

Implementations

impl PrettyPrinter

pub fn new() -> Self

Create a new PrettyPrinter with default settings

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

Set the indentation size

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

Set the maximum depth for recursive printing

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

Set the color generator

pub fn with_colors(self, use_colors: bool) -> Self

Enable or disable colors

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

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

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

Enable or disable doc comments in output

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 Default for PrettyPrinter

fn default() -> Self

Returns the “default value” for a type.