Struct Formatter

pub(super) struct Formatter<'c, 'f, 't, 'w, W, L> {
    pub(super) config: &'c Config<L>,
    pub(super) fmt: &'f [u8],
    pub(super) tm: &'t BrokenDownTime,
    pub(super) wtr: &'w mut W,
}

Fields

config: &'c Config<L>

fmt: &'f [u8]

tm: &'t BrokenDownTime

wtr: &'w mut W

Implementations

impl<'c, 'f, 't, 'w, W: Write, L: Custom> Formatter<'c, 'f, 't, 'w, W, L>

pub(super) fn format(&mut self) -> Result<(), Error>

fn format_one(&mut self) -> Result<(), Error>

fn f(&self) -> u8

Returns the byte at the current position of the format string.

Panics

This panics when the entire format string has been consumed.

fn bump_fmt(&mut self) -> bool

Bumps the position of the format string.

This returns true in precisely the cases where self.f() will not panic. i.e., When the end of the format string hasn’t been reached yet.

fn utf8_decode_and_bump(&mut self) -> Result<char, Error>

Decodes a Unicode scalar value from the beginning of fmt and advances the parser accordingly.

If a Unicode scalar value could not be decoded, then an error is returned.

It would be nice to just pass through bytes as-is instead of doing actual UTF-8 decoding, but since the Write trait only represents Unicode-accepting buffers, we need to actually do decoding here.

Panics

When self.fmt is empty. i.e., Only call this when you know there is some remaining bytes to parse.

fn parse_extension(&mut self) -> Result<Extension, Error>

Parses optional extensions before a specifier directive. That is, right after the %. If any extensions are parsed, the parser is bumped to the next byte. (If no next byte exists, then an error is returned.)

fn parse_flag(&mut self) -> Result<Option<Flag>, Error>

Parses an optional flag. And if one is parsed, the parser is bumped to the next byte. (If no next byte exists, then an error is returned.)

fn parse_width(&mut self) -> Result<Option<u8>, Error>

Parses an optional width that comes after a (possibly absent) flag and before the specifier directive itself. And if a width is parsed, the parser is bumped to the next byte. (If no next byte exists, then an error is returned.)

Note that this is also used to parse precision settings for %f and %.f. In the former case, the width is just re-interpreted as a precision setting. In the latter case, something like %5.9f is technically valid, but the 5 is ignored.

fn parse_colons(&mut self) -> u8

Parses an optional number of colons (up to 3) immediately before a conversion specifier.

fn fmt_ampm_lower(&mut self, ext: &Extension) -> Result<(), Error>

%P

fn fmt_ampm_upper(&mut self, ext: &Extension) -> Result<(), Error>

%p

fn fmt_american_date(&mut self, ext: &Extension) -> Result<(), Error>

%D

fn fmt_clock_nosecs(&mut self, ext: &Extension) -> Result<(), Error>

%R

fn fmt_clock_secs(&mut self, ext: &Extension) -> Result<(), Error>

%T

fn fmt_day_zero(&mut self, ext: &Extension) -> Result<(), Error>

%d

fn fmt_day_space(&mut self, ext: &Extension) -> Result<(), Error>

%e

fn fmt_hour12_zero(&mut self, ext: &Extension) -> Result<(), Error>

%I

fn fmt_hour24_zero(&mut self, ext: &Extension) -> Result<(), Error>

%H

fn fmt_hour12_space(&mut self, ext: &Extension) -> Result<(), Error>

%l

fn fmt_hour24_space(&mut self, ext: &Extension) -> Result<(), Error>

%k

fn fmt_iso_date(&mut self, ext: &Extension) -> Result<(), Error>

%F

fn fmt_minute(&mut self, ext: &Extension) -> Result<(), Error>

%M

fn fmt_month(&mut self, ext: &Extension) -> Result<(), Error>

%m

fn fmt_month_full(&mut self, ext: &Extension) -> Result<(), Error>

%B

fn fmt_month_abbrev(&mut self, ext: &Extension) -> Result<(), Error>

%b, %h

fn fmt_iana_nocolon(&mut self) -> Result<(), Error>

%Q

fn fmt_iana_colon(&mut self) -> Result<(), Error>

%:Q

fn fmt_offset_nocolon(&mut self) -> Result<(), Error>

%z

fn fmt_offset_colon(&mut self) -> Result<(), Error>

%:z

fn fmt_offset_colon2(&mut self) -> Result<(), Error>

%::z

fn fmt_offset_colon3(&mut self) -> Result<(), Error>

%:::z

fn fmt_second(&mut self, ext: &Extension) -> Result<(), Error>

%S

fn fmt_timestamp(&mut self, ext: &Extension) -> Result<(), Error>

%s

fn fmt_fractional(&mut self, ext: &Extension) -> Result<(), Error>

%f

fn fmt_dot_fractional(&mut self, ext: &Extension) -> Result<(), Error>

%.f

fn fmt_nanoseconds(&mut self, ext: &Extension) -> Result<(), Error>

%N

fn fmt_tzabbrev(&mut self, ext: &Extension) -> Result<(), Error>

%Z

fn fmt_weekday_full(&mut self, ext: &Extension) -> Result<(), Error>

%A

fn fmt_weekday_abbrev(&mut self, ext: &Extension) -> Result<(), Error>

%a

fn fmt_weekday_mon(&mut self, ext: &Extension) -> Result<(), Error>

%u

fn fmt_weekday_sun(&mut self, ext: &Extension) -> Result<(), Error>

%w

fn fmt_week_sun(&mut self, ext: &Extension) -> Result<(), Error>

%U

fn fmt_week_iso(&mut self, ext: &Extension) -> Result<(), Error>

%V

fn fmt_week_mon(&mut self, ext: &Extension) -> Result<(), Error>

%W

fn fmt_year(&mut self, ext: &Extension) -> Result<(), Error>

%Y

fn fmt_year2(&mut self, ext: &Extension) -> Result<(), Error>

%y

fn fmt_century(&mut self, ext: &Extension) -> Result<(), Error>

%C

fn fmt_iso_week_year(&mut self, ext: &Extension) -> Result<(), Error>

%G

fn fmt_iso_week_year2(&mut self, ext: &Extension) -> Result<(), Error>

%g

fn fmt_quarter(&mut self, ext: &Extension) -> Result<(), Error>

%q

fn fmt_day_of_year(&mut self, ext: &Extension) -> Result<(), Error>

%j

fn fmt_literal(&mut self, literal: &str) -> Result<(), Error>

%n, %t

fn fmt_datetime(&mut self, ext: &Extension) -> Result<(), Error>

%c

fn fmt_date(&mut self, ext: &Extension) -> Result<(), Error>

%x

fn fmt_time(&mut self, ext: &Extension) -> Result<(), Error>

%X

fn fmt_12hour_time(&mut self, ext: &Extension) -> Result<(), Error>

%r