Struct env_logger::fmt::Style

source ·
pub struct Style { /* private fields */ }
Expand description

A set of styles to apply to the terminal output.

Call Formatter::style to get a Style and use the builder methods to set styling properties, like color and weight. To print a value using the style, wrap it in a call to value when the log record is formatted.

§Examples

Create a bold, red colored style and use it to print the log level:

use std::io::Write;
use env_logger::fmt::Color;

let mut builder = env_logger::Builder::new();

builder.format(|buf, record| {
    let mut level_style = buf.style();

    level_style.set_color(Color::Red).set_bold(true);

    writeln!(buf, "{}: {}",
        level_style.value(record.level()),
        record.args())
});

Styles can be re-used to output multiple values:

use std::io::Write;
use env_logger::fmt::Color;

let mut builder = env_logger::Builder::new();

builder.format(|buf, record| {
    let mut bold = buf.style();

    bold.set_bold(true);

    writeln!(buf, "{}: {} {}",
        bold.value(record.level()),
        bold.value("some bold text"),
        record.args())
});

Implementations§

source§

impl Style

source

pub fn set_color(&mut self, color: Color) -> &mut Style

Set the text color.

§Examples

Create a style with red text:

use std::io::Write;
use env_logger::fmt::Color;

let mut builder = env_logger::Builder::new();

builder.format(|buf, record| {
    let mut style = buf.style();

    style.set_color(Color::Red);

    writeln!(buf, "{}", style.value(record.args()))
});
source

pub fn set_bold(&mut self, yes: bool) -> &mut Style

Set the text weight.

If yes is true then text will be written in bold. If yes is false then text will be written in the default weight.

§Examples

Create a style with bold text:

use std::io::Write;

let mut builder = env_logger::Builder::new();

builder.format(|buf, record| {
    let mut style = buf.style();

    style.set_bold(true);

    writeln!(buf, "{}", style.value(record.args()))
});
source

pub fn set_intense(&mut self, yes: bool) -> &mut Style

Set the text intensity.

If yes is true then text will be written in a brighter color. If yes is false then text will be written in the default color.

§Examples

Create a style with intense text:

use std::io::Write;

let mut builder = env_logger::Builder::new();

builder.format(|buf, record| {
    let mut style = buf.style();

    style.set_intense(true);

    writeln!(buf, "{}", style.value(record.args()))
});
source

pub fn set_dimmed(&mut self, yes: bool) -> &mut Style

Set whether the text is dimmed.

If yes is true then text will be written in a dimmer color. If yes is false then text will be written in the default color.

§Examples

Create a style with dimmed text:

use std::io::Write;

let mut builder = env_logger::Builder::new();

builder.format(|buf, record| {
    let mut style = buf.style();

    style.set_dimmed(true);

    writeln!(buf, "{}", style.value(record.args()))
});
source

pub fn set_bg(&mut self, color: Color) -> &mut Style

Set the background color.

§Examples

Create a style with a yellow background:

use std::io::Write;
use env_logger::fmt::Color;

let mut builder = env_logger::Builder::new();

builder.format(|buf, record| {
    let mut style = buf.style();

    style.set_bg(Color::Yellow);

    writeln!(buf, "{}", style.value(record.args()))
});
source

pub fn value<T>(&self, value: T) -> StyledValue<'_, T>

Wrap a value in the style.

The same Style can be used to print multiple different values.

§Examples

Create a bold, red colored style and use it to print the log level:

use std::io::Write;
use env_logger::fmt::Color;

let mut builder = env_logger::Builder::new();

builder.format(|buf, record| {
    let mut style = buf.style();

    style.set_color(Color::Red).set_bold(true);

    writeln!(buf, "{}: {}",
        style.value(record.level()),
        record.args())
});

Trait Implementations§

source§

impl Clone for Style

source§

fn clone(&self) -> Style

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 Style

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Style

§

impl !RefUnwindSafe for Style

§

impl !Send for Style

§

impl !Sync for Style

§

impl Unpin for Style

§

impl !UnwindSafe for Style

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