TextLayout

Struct TextLayout 

Source
pub struct TextLayout { /* private fields */ }
Expand description

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 by setting the colors field with a LevelColor instance.

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§

Source§

impl TextLayout

Source

pub fn colors(self, colors: LevelColor) -> Self

Customize the color of each log level.

No effect if no_color is set to true.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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.

Source

pub fn no_color(self) -> Self

Disable colored output.

Source

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

Set the timezone for timestamps.

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

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

Trait Implementations§

Source§

impl Clone for TextLayout

Source§

fn clone(&self) -> TextLayout

Returns a duplicate 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 TextLayout

Source§

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

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

impl Default for TextLayout

Source§

fn default() -> TextLayout

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

impl Layout for TextLayout

Source§

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

Format a log record with optional diagnostics.

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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,

Source§

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>,

Source§

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>,

Source§

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.