Skip to main content

TreeFormatter

Struct TreeFormatter 

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

Formats inspected values as tree structures.

Implementations§

Source§

impl TreeFormatter

Source

pub fn new() -> Self

Create a new tree formatter with default configuration.

Source

pub fn with_config(config: TreeConfig) -> Self

Create a tree formatter with specific configuration.

Source

pub fn format(&mut self, value: &ValueRef<'_>) -> String

Format an inspected value to a String, automatically resolving color choice based on stdout TTY and environment variables.

Source

pub fn format_colored(&mut self, value: &ValueRef<'_>) -> String

Format an inspected value with ANSI colors explicitly enabled.

Source

pub fn format_plain(&mut self, value: &ValueRef<'_>) -> String

Format an inspected value with ANSI colors explicitly disabled.

Source

pub fn format_to<W: Write>( &mut self, value: &ValueRef<'_>, writer: &mut W, ) -> Result

Format an inspected value directly to a std::fmt::Write destination.

Source

pub fn format_to_styled<W: Write>( &mut self, value: &ValueRef<'_>, writer: &mut W, color_enabled: bool, ) -> Result

Format an inspected value to a std::fmt::Write destination with explicit color flag.

Source

pub fn format_io<W: Write>( &mut self, value: &ValueRef<'_>, writer: W, ) -> Result<()>

Format an inspected value directly to a std::io::Write destination.

Trait Implementations§

Source§

impl Default for TreeFormatter

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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.