Enum TemplateFormatter 

pub enum TemplateFormatter {
    Display {
        spec: Option<Box<str>>,
    },
    Debug {
        alternate: bool,
    },
    LowerHex {
        alternate: bool,
    },
    UpperHex {
        alternate: bool,
    },
    Pointer {
        alternate: bool,
    },
    Binary {
        alternate: bool,
    },
    Octal {
        alternate: bool,
    },
    LowerExp {
        alternate: bool,
    },
    UpperExp {
        alternate: bool,
    },
}

Formatting mode requested by the placeholder.

Variants

Display

Default Display formatting ({value}) with an optional format spec.

Fields

spec: Option<Box<str>>

Raw display format specifier (for example ">8" or “.3”).

Debug

Debug formatting ({value:?} or {value:#?}).

Fields

alternate: bool

Whether {value:#?} (alternate debug) was requested.

LowerHex

Lower-hexadecimal formatting ({value:x} / {value:#x}).

Fields

alternate: bool

Whether alternate formatting ({value:#x}) was requested.

UpperHex

Upper-hexadecimal formatting ({value:X} / {value:#X}).

Fields

alternate: bool

Whether alternate formatting ({value:#X}) was requested.

Pointer

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

Fields

alternate: bool

Whether alternate formatting ({value:#p}) was requested.

Binary

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

Fields

alternate: bool

Whether alternate formatting ({value:#b}) was requested.

Octal

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

Fields

alternate: bool

Whether alternate formatting ({value:#o}) was requested.

LowerExp

Lower exponential formatting ({value:e} / {value:#e}).

Fields

alternate: bool

Whether alternate formatting ({value:#e}) was requested.

UpperExp

Upper exponential formatting ({value:E} / {value:#E}).

Fields

alternate: bool

Whether alternate formatting ({value:#E}) was requested.

Implementations

impl TemplateFormatter

pub const fn from_kind(kind: TemplateFormatterKind, alternate: bool) -> Self

Constructs a formatter from a TemplateFormatterKind and alternate flag.

The alternate flag is ignored for TemplateFormatterKind::Display.

Examples

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

let formatter = TemplateFormatter::from_kind(TemplateFormatterKind::Binary, true);

assert!(matches!(
    formatter,
    TemplateFormatter::Binary {
        alternate: true
    }
));

pub const fn kind(&self) -> TemplateFormatterKind

Returns the underlying formatter kind.

Examples

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

let formatter = TemplateFormatter::Pointer {
    alternate: false
};

assert_eq!(formatter.kind(), TemplateFormatterKind::Pointer);

pub fn from_format_spec(spec: &str) -> Option<Self>

Parses a formatting specifier (the portion after :) into a formatter.

pub fn display_spec(&self) -> Option<&str>

Returns the stored display format specifier, if any.

pub fn has_display_spec(&self) -> bool

Indicates whether a display formatter carries additional formatting parameters.

pub fn format_fragment(&self) -> Option<Cow<'_, str>>

Returns the formatter fragment that should follow the : in a format string.

pub const fn is_alternate(&self) -> bool

Returns true when alternate formatting (#) was requested.

Trait Implementations

impl Clone for TemplateFormatter

fn clone(&self) -> TemplateFormatter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TemplateFormatter

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

Formats the value using the given formatter.

impl PartialEq for TemplateFormatter

fn eq(&self, other: &TemplateFormatter) -> 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 Eq for TemplateFormatter

impl StructuralPartialEq for TemplateFormatter