Struct TextLayout 

pub struct TextLayout { /* private fields */ }

A layout that formats log record as optionally colored text.

Output format:

2024-08-11T22:44:57.172105+08:00 ERROR file: examples/file.rs:51 Hello error!
2024-08-11T22:44:57.172219+08:00  WARN file: examples/file.rs:52 Hello warn!
2024-08-11T22:44:57.172276+08:00  INFO file: examples/file.rs:53 Hello info!
2024-08-11T22:44:57.172329+08:00 DEBUG file: examples/file.rs:54 Hello debug!
2024-08-11T22:44:57.172382+08:00 TRACE file: examples/file.rs:55 Hello trace!

By default, log levels are colored. You can set the no_color field to true to disable coloring.

You can also customize the color of each log level with error_color and so on.

You can customize the timezone of the timestamp by setting the tz field with a TimeZone instance. Otherwise, the system timezone is used.

Examples

use logforth_layout_text::TextLayout;

let layout = TextLayout::default();

Implementations

impl TextLayout

pub fn fatal_color(self, color: Color) -> Self

Customize the color of the error log level. Default to bright red.

No effect if no_color is set to true.

pub fn error_color(self, color: Color) -> Self

Customize the color of the error log level. Default to red.

No effect if no_color is set to true.

pub fn warn_color(self, color: Color) -> Self

Customize the color of the warn log level. Default to yellow.

No effect if no_color is set to true.

pub fn info_color(self, color: Color) -> Self

Customize the color of the info log level/ Default to green.

No effect if no_color is set to true.

pub fn debug_color(self, color: Color) -> Self

Customize the color of the debug log level. Default to blue.

No effect if no_color is set to true.

pub fn trace_color(self, color: Color) -> Self

Customize the color of the trace log level. Default to magenta.

No effect if no_color is set to true.

pub fn no_color(self) -> Self

Disable colored output.

pub fn timezone(self, tz: TimeZone) -> Self

Set the timezone for timestamps.

Defaults to the system timezone if not set.

Examples

use jiff::tz::TimeZone;
use logforth_layout_text::TextLayout;

let layout = TextLayout::default().timezone(TimeZone::UTC);

pub fn timestamp_format( self, format: fn(Timestamp, &TimeZone) -> String, ) -> Self

Set a user-defined timestamp format function.

Default to formatting the timestamp with offset as ISO 8601. See the example below.

For other formatting options, refer to the jiff::fmt::strtime documentation.

Examples

use jiff::Timestamp;
use jiff::tz::TimeZone;
use logforth_layout_text::TextLayout;

// This is equivalent to the default timestamp format.
let layout = TextLayout::default()
    .timestamp_format(|ts, tz| format!("{:.6}", ts.display_with_offset(tz.to_offset(ts))));

Trait Implementations

impl Clone for TextLayout

fn clone(&self) -> TextLayout

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TextLayout

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

Formats the value using the given formatter.

impl Default for TextLayout

fn default() -> Self

Returns the “default value” for a type.

impl Layout for TextLayout

fn format( &self, record: &Record<'_>, diags: &[Box<dyn Diagnostic>], ) -> Result<Vec<u8>, Error>

Format a log record with optional diagnostics.