Enum FormatterFormat

#[non_exhaustive]
pub enum FormatterFormat<'a> {
    Default {
        with_location: bool,
    },
    OneLine {
        with_location: bool,
    },
    Custom(&'a str),
}

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Default

The classic defmt two-line format.

Looks like:

INFO This is a log message
└─ test_lib::hello @ /Users/jonathan/Documents/knurling/test-lib/src/lib.rs:8

Fields

with_location: bool

OneLine

A one-line format.

Looks like:

[INFO ] This is a log message (crate_name test-lib/src/lib.rs:8)

Fields

with_location: bool

Custom(&'a str)

Implementations

impl FormatterFormat<'static>

pub fn from_string( s: &str, with_location: bool, ) -> Option<FormatterFormat<'static>>

Parse a string into a choice of FormatterFormat.

Unknown strings return None.

pub fn get_options() -> impl Iterator<Item = &'static str>

Get a list of valid string names for the various format options.

This will not include an entry for FormatterFormat::Custom because that requires a format string argument.

Trait Implementations

impl<'a> Debug for FormatterFormat<'a>

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

Formats the value using the given formatter.

impl Default for FormatterFormat<'_>

fn default() -> Self

Returns the “default value” for a type.