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
sourceimpl<F, T> Format<F, T>
impl<F, T> Format<F, T>
sourcepub fn pretty(self) -> Format<Pretty, T>
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();
sourcepub fn with_timer<T2>(self, timer: T2) -> Format<F, T2>
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.
sourcepub fn without_time(self) -> Format<F, ()>
pub fn without_time(self) -> Format<F, ()>
Do not emit timestamps with log messages.
sourcepub fn with_ansi(self, ansi: bool) -> Format<F, T>
pub fn with_ansi(self, ansi: bool) -> Format<F, T>
Enable ANSI terminal colors for formatted output.
sourcepub fn with_target(self, display_target: bool) -> Format<F, T>
pub fn with_target(self, display_target: bool) -> Format<F, T>
Sets whether or not an event’s target is displayed.
sourcepub fn with_level(self, display_level: bool) -> Format<F, T>
pub fn with_level(self, display_level: bool) -> Format<F, T>
Sets whether or not an event’s level is displayed.
sourcepub fn with_thread_ids(self, display_thread_id: bool) -> Format<F, T>
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
sourcepub fn with_thread_names(self, display_thread_name: bool) -> Format<F, T>
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
sourcepub fn with_file(self, display_filename: bool) -> Format<F, T>
pub fn with_file(self, display_filename: bool) -> Format<F, T>
Sets whether or not an event’s source code file path is displayed.
sourcepub fn with_line_number(self, display_line_number: bool) -> Format<F, T>
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.
sourcepub fn with_source_location(self, display_location: bool) -> Self
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
sourceimpl Default for Format<Full, SystemTime>
impl Default for Format<Full, SystemTime>
sourceimpl<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,
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,
sourcefn format_event(
&self,
ctx: &FmtContext<'_, C, N>,
writer: Writer<'_>,
event: &Event<'_>
) -> Result
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
.
sourceimpl<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,
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,
sourcefn format_event(
&self,
ctx: &FmtContext<'_, S, N>,
writer: Writer<'_>,
event: &Event<'_>
) -> Result
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
.
sourceimpl<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,
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,
sourcefn format_event(
&self,
ctx: &FmtContext<'_, S, N>,
writer: Writer<'_>,
event: &Event<'_>
) -> Result
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> RefUnwindSafe for Format<F, T> where
F: RefUnwindSafe,
T: RefUnwindSafe,
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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
Uses borrowed data to replace owned data, usually by cloning. Read more