pub struct Pretty { /* private fields */ }
Expand description

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§

source§

impl Pretty

source

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§

source§

impl Clone for Pretty

source§

fn clone(&self) -> Pretty

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Pretty

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for Pretty

source§

fn default() -> Self

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

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

source§

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

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

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

Record additional field(s) on an existing span. Read more
source§

impl PartialEq for Pretty

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Eq for Pretty

source§

impl StructuralEq for Pretty

source§

impl StructuralPartialEq for Pretty

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> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

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.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more