Struct tracing_subscriber::fmt::format::Format

source ·
pub struct Format<F = Full, T = SystemTime> { /* private fields */ }
Expand description

A pre-configured event formatter.

You will usually want to use this as the FormatEvent for a FmtSubscriber.

The default logging format, Full includes all fields in each event and its containing spans. The Compact logging format is intended to produce shorter log lines; it displays each event’s fields, along with fields from the current span context, but other information is abbreviated. The Pretty logging format is an extra-verbose, multi-line human-readable logging format intended for use in development.

Implementations§

source§

impl<F, T> Format<F, T>

source

pub fn compact(self) -> Format<Compact, T>

Use a less verbose output format.

See Compact.

source

pub fn pretty(self) -> Format<Pretty, T>

Use an excessively pretty, human-readable output format.

See Pretty.

Note that this requires the “ansi” feature to be enabled.

§Options

Format::with_ansi can be used to disable ANSI terminal escape codes (which enable formatting such as colors, bold, italic, etc) in event formatting. However, a field formatter must be manually provided to avoid ANSI in the formatting of parent spans, like so:

tracing_subscriber::fmt()
   .pretty()
   .with_ansi(false)
   .fmt_fields(format::PrettyFields::new().with_ansi(false))
   // ... other settings ...
   .init();
source

pub fn with_timer<T2>(self, timer: T2) -> Format<F, T2>

Use the given timer for log message timestamps.

See time module for the provided timer implementations.

Note that using the "time" feature flag enables the additional time formatters UtcTime and LocalTime, which use the time crate to provide more sophisticated timestamp formatting options.

source

pub fn without_time(self) -> Format<F, ()>

Do not emit timestamps with log messages.

source

pub fn with_ansi(self, ansi: bool) -> Format<F, T>

Enable ANSI terminal colors for formatted output.

source

pub fn with_target(self, display_target: bool) -> Format<F, T>

Sets whether or not an event’s target is displayed.

source

pub fn with_level(self, display_level: bool) -> Format<F, T>

Sets whether or not an event’s level is displayed.

source

pub fn with_thread_ids(self, display_thread_id: bool) -> Format<F, T>

Sets whether or not the thread ID of the current thread is displayed when formatting events.

source

pub fn with_thread_names(self, display_thread_name: bool) -> Format<F, T>

Sets whether or not the name of the current thread is displayed when formatting events.

source

pub fn with_file(self, display_filename: bool) -> Format<F, T>

Sets whether or not an event’s source code file path is displayed.

source

pub fn with_line_number(self, display_line_number: bool) -> Format<F, T>

Sets whether or not an event’s source code line number is displayed.

source

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

Sets whether or not the source code location from which an event originated is displayed.

This is equivalent to calling Format::with_file and Format::with_line_number with the same value.

Trait Implementations§

source§

impl<F: Clone, T: Clone> Clone for Format<F, T>

source§

fn clone(&self) -> Format<F, T>

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<F: Debug, T: Debug> Debug for Format<F, T>

source§

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

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

impl Default for Format<Full, SystemTime>

source§

fn default() -> Self

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

impl<C, N, T> FormatEvent<C, N> for Format<Pretty, T>
where C: Subscriber + for<'a> LookupSpan<'a>, N: for<'a> FormatFields<'a> + 'static, T: FormatTime,

source§

fn format_event( &self, ctx: &FmtContext<'_, C, N>, writer: Writer<'_>, event: &Event<'_>, ) -> Result

Write a log message for Event in Context to the given Writer.
source§

impl<S, N, T> FormatEvent<S, N> for Format<Compact, T>
where S: Subscriber + for<'a> LookupSpan<'a>, N: for<'a> FormatFields<'a> + 'static, T: FormatTime,

source§

fn format_event( &self, ctx: &FmtContext<'_, S, N>, writer: Writer<'_>, event: &Event<'_>, ) -> Result

Write a log message for Event in Context to the given Writer.
source§

impl<S, N, T> FormatEvent<S, N> for Format<Full, T>
where S: Subscriber + for<'a> LookupSpan<'a>, N: for<'a> FormatFields<'a> + 'static, T: FormatTime,

source§

fn format_event( &self, ctx: &FmtContext<'_, S, N>, writer: Writer<'_>, event: &Event<'_>, ) -> Result

Write a log message for Event in Context to the given Writer.

Auto Trait Implementations§

§

impl<F, T> Freeze for Format<F, T>
where F: Freeze, T: Freeze,

§

impl<F, T> RefUnwindSafe for Format<F, T>

§

impl<F, T> Send for Format<F, T>
where F: Send, T: Send,

§

impl<F, T> Sync for Format<F, T>
where F: Sync, T: Sync,

§

impl<F, T> Unpin for Format<F, T>
where F: Unpin, T: Unpin,

§

impl<F, T> UnwindSafe for Format<F, T>
where F: UnwindSafe, T: UnwindSafe,

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> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit #126799)
Performs copy-assignment from self to dst. 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