Struct FormatterConfig

pub struct FormatterConfig<'a> {
    pub format: FormatterFormat<'a>,
    pub is_timestamp_available: bool,
}

Settings that control how defmt frames should be formatted.

Fields

format: FormatterFormat<'a>

The format to use

is_timestamp_available: bool

If true, then the logs should include a timestamp.

Not all targets can supply a timestamp, and if not, it should be omitted.

Implementations

impl<'a> FormatterConfig<'a>

pub fn custom(format: &'a str) -> Self

Create a new custom formatter config.

This allows the user to supply a custom log-format string. See the “Custom Log Output” section of the defmt book for details of the format.

pub fn with_timestamp(self) -> Self

Modify a formatter configuration, setting the ‘timestamp available’ flag to true.

pub fn with_location(self) -> Self

Modify a formatter configuration, setting the ‘with_location’ flag to true.

Do not use this with a custom log formatter.

Trait Implementations

impl<'a> Debug for FormatterConfig<'a>

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

Formats the value using the given formatter.

impl<'a> Default for FormatterConfig<'a>

fn default() -> FormatterConfig<'a>

Returns the “default value” for a type.