Enum TemplateFormatterKind 

pub enum TemplateFormatterKind {
    Display,
    Debug,
    LowerHex,
    UpperHex,
    Pointer,
    Binary,
    Octal,
    LowerExp,
    UpperExp,
}

Formatter traits recognised within placeholders.

Examples

use masterror_template::template::{TemplateFormatter, TemplateFormatterKind};

let formatter = TemplateFormatter::LowerHex {
    alternate: true
};

assert_eq!(formatter.kind(), TemplateFormatterKind::LowerHex);
assert_eq!(TemplateFormatterKind::LowerHex.specifier(), Some('x'));
assert!(TemplateFormatterKind::LowerHex.supports_alternate());

Variants

Display

Default Display trait ({value}).

Debug

Debug trait ({value:?} / {value:#?}).

LowerHex

LowerHex trait ({value:x} / {value:#x}).

UpperHex

UpperHex trait ({value:X} / {value:#X}).

Pointer

Pointer trait ({value:p} / {value:#p}).

Binary

Binary trait ({value:b} / {value:#b}).

Octal

Octal trait ({value:o} / {value:#o}).

LowerExp

LowerExp trait ({value:e} / {value:#e}).

UpperExp

UpperExp trait ({value:E} / {value:#E}).

Implementations

impl TemplateFormatterKind

pub const fn from_specifier(specifier: char) -> Option<Self>

Maps a format specifier character to a formatter kind.

Returns None when the specifier is unsupported.

Examples

use masterror_template::template::TemplateFormatterKind;

assert_eq!(
    TemplateFormatterKind::from_specifier('?'),
    Some(TemplateFormatterKind::Debug)
);
assert_eq!(TemplateFormatterKind::from_specifier('Q'), None);

pub const fn specifier(self) -> Option<char>

Returns the canonical format specifier character, if any.

The default Display kind has no dedicated specifier and therefore returns None.

Examples

use masterror_template::template::TemplateFormatterKind;

assert_eq!(TemplateFormatterKind::LowerHex.specifier(), Some('x'));
assert_eq!(TemplateFormatterKind::Display.specifier(), None);

pub const fn supports_alternate(self) -> bool

Indicates whether the formatter kind supports the alternate (#) flag.

Examples

use masterror_template::template::TemplateFormatterKind;

assert!(TemplateFormatterKind::Binary.supports_alternate());
assert!(!TemplateFormatterKind::Display.supports_alternate());

Trait Implementations

impl Clone for TemplateFormatterKind

fn clone(&self) -> TemplateFormatterKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TemplateFormatterKind

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

Formats the value using the given formatter.

impl PartialEq for TemplateFormatterKind

fn eq(&self, other: &TemplateFormatterKind) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for TemplateFormatterKind

impl Eq for TemplateFormatterKind

impl StructuralPartialEq for TemplateFormatterKind