Struct Pretty

pub struct Pretty { /* private fields */ }

Available on crate features fmt and std and ansi only.

An excessively pretty, human-readable event formatter.

Unlike the Full, Compact, and Json formatters, this is a multi-line output format. Each individual event may output multiple lines of text.

Example Output

:; cargo run --example fmt-pretty
    Finished dev [unoptimized + debuginfo] target(s) in 0.08s
     Running `target/debug/examples/fmt-pretty`
  2022-02-15T18:44:24.535324Z  INFO fmt_pretty: preparing to shave yaks, number_of_yaks: 3
    at examples/examples/fmt-pretty.rs:16 on main

  2022-02-15T18:44:24.535403Z  INFO fmt_pretty::yak_shave: shaving yaks
    at examples/examples/fmt/yak_shave.rs:41 on main
    in fmt_pretty::yak_shave::shaving_yaks with yaks: 3

  2022-02-15T18:44:24.535442Z TRACE fmt_pretty::yak_shave: hello! I'm gonna shave a yak, excitement: "yay!"
    at examples/examples/fmt/yak_shave.rs:16 on main
    in fmt_pretty::yak_shave::shave with yak: 1
    in fmt_pretty::yak_shave::shaving_yaks with yaks: 3

  2022-02-15T18:44:24.535469Z TRACE fmt_pretty::yak_shave: yak shaved successfully
    at examples/examples/fmt/yak_shave.rs:25 on main
    in fmt_pretty::yak_shave::shave with yak: 1
    in fmt_pretty::yak_shave::shaving_yaks with yaks: 3

  2022-02-15T18:44:24.535502Z DEBUG yak_events: yak: 1, shaved: true
    at examples/examples/fmt/yak_shave.rs:46 on main
    in fmt_pretty::yak_shave::shaving_yaks with yaks: 3

  2022-02-15T18:44:24.535524Z TRACE fmt_pretty::yak_shave: yaks_shaved: 1
    at examples/examples/fmt/yak_shave.rs:55 on main
    in fmt_pretty::yak_shave::shaving_yaks with yaks: 3

  2022-02-15T18:44:24.535551Z TRACE fmt_pretty::yak_shave: hello! I'm gonna shave a yak, excitement: "yay!"
    at examples/examples/fmt/yak_shave.rs:16 on main
    in fmt_pretty::yak_shave::shave with yak: 2
    in fmt_pretty::yak_shave::shaving_yaks with yaks: 3

  2022-02-15T18:44:24.535573Z TRACE fmt_pretty::yak_shave: yak shaved successfully
    at examples/examples/fmt/yak_shave.rs:25 on main
    in fmt_pretty::yak_shave::shave with yak: 2
    in fmt_pretty::yak_shave::shaving_yaks with yaks: 3

  2022-02-15T18:44:24.535600Z DEBUG yak_events: yak: 2, shaved: true
    at examples/examples/fmt/yak_shave.rs:46 on main
    in fmt_pretty::yak_shave::shaving_yaks with yaks: 3

  2022-02-15T18:44:24.535618Z TRACE fmt_pretty::yak_shave: yaks_shaved: 2
    at examples/examples/fmt/yak_shave.rs:55 on main
    in fmt_pretty::yak_shave::shaving_yaks with yaks: 3

  2022-02-15T18:44:24.535644Z TRACE fmt_pretty::yak_shave: hello! I'm gonna shave a yak, excitement: "yay!"
    at examples/examples/fmt/yak_shave.rs:16 on main
    in fmt_pretty::yak_shave::shave with yak: 3
    in fmt_pretty::yak_shave::shaving_yaks with yaks: 3

  2022-02-15T18:44:24.535670Z  WARN fmt_pretty::yak_shave: could not locate yak
    at examples/examples/fmt/yak_shave.rs:18 on main
    in fmt_pretty::yak_shave::shave with yak: 3
    in fmt_pretty::yak_shave::shaving_yaks with yaks: 3

  2022-02-15T18:44:24.535698Z DEBUG yak_events: yak: 3, shaved: false
    at examples/examples/fmt/yak_shave.rs:46 on main
    in fmt_pretty::yak_shave::shaving_yaks with yaks: 3

  2022-02-15T18:44:24.535720Z ERROR fmt_pretty::yak_shave: failed to shave yak, yak: 3, error: missing yak, error.sources: [out of space, out of cash]
    at examples/examples/fmt/yak_shave.rs:51 on main
    in fmt_pretty::yak_shave::shaving_yaks with yaks: 3

  2022-02-15T18:44:24.535742Z TRACE fmt_pretty::yak_shave: yaks_shaved: 2
    at examples/examples/fmt/yak_shave.rs:55 on main
    in fmt_pretty::yak_shave::shaving_yaks with yaks: 3

  2022-02-15T18:44:24.535765Z  INFO fmt_pretty: yak shaving completed, all_yaks_shaved: false
    at examples/examples/fmt-pretty.rs:19 on main

Implementations

impl Pretty

pub fn with_source_location(self, display_location: bool) -> Self

👎Deprecated since 0.3.6: all formatters now support configurable source locations. Use Format::with_source_location instead.

Sets whether the event’s source code location is displayed.

This defaults to true.

Trait Implementations

impl Clone for Pretty

fn clone(&self) -> Pretty

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Pretty

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

Formats the value using the given formatter.

impl Default for Pretty

fn default() -> Self

Returns the “default value” for a type.

impl<'writer> FormatFields<'writer> for Pretty

fn format_fields<R: RecordFields>( &self, writer: Writer<'writer>, fields: R, ) -> Result

Format the provided fields to the provided Writer, returning a result.

fn add_fields( &self, current: &'writer mut FormattedFields<Self>, fields: &Record<'_>, ) -> Result

Record additional field(s) on an existing span.

impl PartialEq for Pretty

fn eq(&self, other: &Pretty) -> 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 Eq for Pretty

impl StructuralPartialEq for Pretty