std::format..._time_format(3)

📦 version 2024.07.05, in nixpkgs unstable, opensuse-leap 16.0

✨ std::format..._time_format(3) ✨

okay so bestie, this is the C++ Standard Libary manual, section 3, and it’s part 1 of 2 — yes, the manual really spells it “Libary,” and we are not fixing the lore 💅. Today’s main characters are std::formatter and std::chrono::local_time_format, and they’re sharing a page, which is lowkey iconic because formatting a std::chrono::local_time should not be a whole villain arc.

🎀 NAME 🎀

std::formatter,std::chrono::local_time_format — std::formatter,std::chrono::local_time_format

🦋 Synopsis 🦋

okay, deep breath, here’s the whole declaration vibe:

Defined in header <chrono>
template< class Duration, class CharT >                       (1)
struct formatter<std::chrono::local_time<Duration>, CharT>;
template< class Duration >

struct /*local-time-format-t*/ {
    std::chrono::local_time<Duration> time; // exposition
only
    const std::string* abbrev;              // exposition     (2)
(exposition only*)
only
    const std::chrono::seconds* offset;     // exposition
only

};
template< class Duration >

/*local-time-format-t*/<Duration>
    local_time_format( const
std::chrono::local_time<Duration>& tp,                        (3)
                       const std::string* abbrev = nullptr,

                       const std::chrono::seconds* offset_sec
= nullptr );
template< class Duration, class CharT >                       (4)
struct formatter</*local-time-format-t*/<Duration>, CharT>;

so what is this? It’s the specialization of std::formatter that defines the formatting rules for a std::chrono::local_time. periodt.

  • 1) — if %Z, %z or a modified variant of %z is used, a std::format_error is thrown. like, instant drama 😭
  • 2-4) — the local_time_format function returns a value of unspecified type that holds the local time, offset, and time zone abbreviation. When an object f of this unspecified type is formatted, if %Z is used, it is replaced with *f.abbrev widened to CharT if f.abbrev is not null; otherwise a std::format_error is thrown. If %z or a modified variant thereof is used, an offset of *f.offset_sec will be formatted if f.offset_sec is not null; otherwise a std::format_error is thrown.

and std::formatter is usually not directly accessed, but is used through formatting functions — behind-the-scenes main character energy, fr fr.

🌈 Format specification 🌈

The format specification has the form

fill-and-align (optional) width (optional) precision (optional) L(optional) chrono-spec (optional)

fill-and-align, width, and precision have the same meaning as in standard format specification. precision is valid only for std::chrono::duration types where the representation type Rep is a floating-point type, otherwise std::format_error is thrown.

The locale used for formatting is determined as follows:

  • the default "C" locale if L is not present in the format specification,
  • otherwise, the locale denoted by the std::locale passed to the formatting function, if any,
  • otherwise (L is present but no std::locale is passed to the formatting function), the global locale.

The chrono-spec consists of one or more conversion specifiers and ordinary characters (other than {, }, and %). A chrono-spec must start with a conversion specifier. All ordinary characters are written to the output without modification. Each unmodified conversion specifier begins with a % character followed by a character that determines the behavior of the specifier. Some conversion specifiers have a modified form in which an E or O modifier character is inserted after the % character. Each conversion specifier is replaced by appropriate characters in the output as described below.

If the chrono-spec is empty, the chrono object is formatted as if by streaming it to an object os of type std::basic_ostringstream<CharT> with the formatting locale (one of std::locale::classic(), the passed std::locale object, and std::locale::global()) imbued and copying os.str() to the output buffer with additional padding and adjustments as per format specifiers.

🌸 The following format specifiers are available 🌸

✨ General ✨

  • %% — writes a literal % character.
  • %n — writes a newline character.
  • %t — writes a horizontal tab character.

🌸 Year 🌸

  • %C — writes the year divided by 100 using floored division. If the result is a single decimal digit, it is prefixed with 0.
  • %EC — the modified command %EC writes the locale’s alternative representation of the century.
  • %y — writes the last two decimal digits of the year. If the result is a single digit it is prefixed by 0.
  • %Oy — the modified command %Oy writes the locale’s alternative representation.
  • %Ey — the modified command %Ey writes the locale’s alternative representation of offset from %EC (year only).
  • %Y — writes the year as a decimal number. If the result is less than four digits it is left-padded with 0 to four digits.
  • %EY — the modified command %EY writes the locale’s alternative full year representation.

🌸 Month 🌸

  • %b, %h — writes the locale’s abbreviated month name.
  • %B — writes the locale’s full month name.
  • %m — writes the month as a decimal number (January is 01). If the result is a single digit, it is prefixed with 0.
  • %Om — the modified command %Om writes the locale’s alternative representation.

🌸 Day 🌸

  • %d — writes the day of month as a decimal number. If the result is a single decimal digit, it is prefixed with 0.
  • %Od — the modified command %Od writes the locale’s alternative representation.
  • %e — writes the day of month as a decimal number. If the result is a single decimal digit, it is prefixed with a space.
  • %Oe — the modified command %Oe writes the locale’s alternative representation.

🌸 Day of the week 🌸

  • %a — writes the locale’s abbreviated weekday name.
  • %A — writes the locale’s full weekday name.
  • %u — writes the ISO weekday as a decimal number (1-7), where Monday is 1.
  • %Ou — the modified command %Ou writes the locale’s alternative representation.
  • %w — writes the weekday as a decimal number (0-6), where Sunday is 0.
  • %Ow — the modified command %Ow writes the locale’s alternative representation.

🌸 ISO 8601 week-based year 🌸

In ISO 8601 weeks begin with Monday and the first week of the year must satisfy the following requirements:

  • Includes January 4
  • Includes first Thursday of the year
  • %g — writes the last two decimal digits of the ISO 8601 week-based year. If the result is a single digit it is prefixed by 0.
  • %G — writes the ISO 8601 week-based year as a decimal number. If the result is less than four digits it is left-padded with 0 to four digits.
  • %V — writes the ISO 8601 week of the year as a decimal number. If the result is a single digit, it is prefixed with 0.
  • %OV — the modified command %OV writes the locale’s alternative representation.

🌸 Week/day of the year 🌸

  • %j — writes the day of the year as a decimal number (January 1 is 001). If the result is less than three digits, it is left-padded with 0 to three digits.
  • %U — writes the week number of the year as a decimal number. The first Sunday of the year is the first day of week 01. Days of the same year prior to that are in week 00. If the result is a single digit, it is prefixed with 0.
  • %OU — the modified command %OU writes the locale’s alternative representation.
  • %W — writes the week number of the year as a decimal number. The first Monday of the year is the first day of week 01. Days of the same year prior to that are in week 00. If the result is a single digit, it is prefixed with 0.
  • %OW — the modified command %OW writes the locale’s alternative representation.

🌸 Date 🌸

  • %D — equivalent to "%m/%d/%y".
  • %F — equivalent to "%Y-%m-%d".
  • %x — writes the locale’s date representation.
  • %Ex — the modified command %Ex produces the locale’s alternate date representation.

🌸 Time of day 🌸

  • %H — writes the hour (24-hour clock) as a decimal number. If the result is a single digit, it is prefixed with 0.
  • %OH — the modified command %OH writes the locale’s alternative representation.
  • %I — writes the hour (12-hour clock) as a decimal number. If the result is a single digit, it is prefixed with 0.
  • %OI — the modified command %OI writes the locale’s alternative representation.
  • %M — writes the minute as a decimal number. If the result is a single digit, it is prefixed with 0.
  • %OM — the modified command %OM writes the locale’s alternative representation.
  • %S, %OS — writes the second as a decimal number. If the number of seconds is less than 10, the result is prefixed with 0. If the precision of the input cannot be exactly represented with seconds, then the format is a decimal floating-point number with a fixed format and a precision matching that of the precision of the input (or to a microseconds precision if the conversion to floating-point decimal seconds cannot be made within 18 fractional digits). The character for the decimal point is localized according to the locale.
  • %OS — the modified command %OS writes out the locale's alternative representation. slay 💅
  • %p — drops the locale's equivalent of the AM/PM designations that go with a 12-hour clock. iconic.
  • %R — literally the same energy as "%H:%M".
  • %T — and this one's just "%H:%M:%S", no cap.
  • %r — writes the locale's 12-hour clock time. cute.
  • %X — writes the locale's time representation.
  • %EX — the modified command %EX writes the locale's alternate time representation. fancy ✨

🌍 Time zone 🌍

  • %z — writes the offset from UTC in the ISO 8601 format. for example, -0430 refers to 4 hours 30 minutes behind UTC. and if the offset is zero, +0000 is what gets used. periodt.
  • %Ez, %Oz — the modified commands %Ez and %Oz slip a : in between the hours and minutes (e.g., -04:30). the way that little colon ate 🫶
  • %Z — writes the time zone abbreviation.

🎀 Miscellaneous 🎀

  • %c — writes the locale's date and time representation.
  • %Ec — the modified command %Ec writes the locale's alternative date and time representation. bestie behaviour honestly.
heads up: the following specifiers are recognized, but they will cause std::format_error to be thrown. not a drill 💀

Conversion specifier — Duration count

  • %Q — writes the count of ticks of the duration, i.e. the value obtained via count().
  • %q — writes the unit suffix of the duration, as specified in operator<<().

🌈 Example 🌈

This section is incomplete
Reason: no example
ngl this section is giving "todo: me" 😭 no example yet, we move.

👑 See also 👑

  • format — stores formatted representation of the arguments in a new string — (C++20) (function template)

Category:

  • Todo no example

okay that's the whole vibe check, you're officially a time-formatting main character now 💖 this page came straight from cppreference.com, dated 2024.06.10, and it's the manual page for std::format..._time_format(3) — go forth and format, bestie 🌸🦋

📦 where this page comes from