std::chrono...hrono::day)(3)

πŸ“¦ version 2024.07.05, in nixpkgs unstable, opensuse-leap 16.0

πŸŽ€ NAME

std::chrono::from_stream(std::chrono::day) β€” std::chrono::from_stream(std::chrono::day) (this is the C++ Standard Libary manual page, section (3), bestie πŸ’…)

okay so this is the from_stream overload that parses a std::chrono::day out of an input stream, and yes the NAME line really says the same thing twice. iconic of her, no notes.

✨ Synopsis

Defined in header <chrono>
template< class CharT, class Traits, class Alloc =
std::allocator<CharT> >

std::basic_istream<CharT, Traits>&
    from_stream( std::basic_istream<CharT, Traits>& is, const CharT* fmt,
(since C++20)
                 std::chrono::day& d,
                 std::basic_string<CharT, Traits, Alloc>* abbrev =
nullptr,

                 std::chrono::minutes* offset = nullptr );

So what does it do? It attempts to parse the input stream is into the std::chrono::day d according to the format string fmt. That's the whole assignment, fr fr.

It behaves as an UnformattedInputFunction, except that it has an unspecified effect on is.gcount(). After constructing and checking the sentry object, it attempts to parse the input stream is into d according to the format string fmt. If the parse fails to decode a valid day, is.setstate(std::ios_base::failbit) is called and d is not modified. 🫢

If the format specifier %Z is used and successfully parsed, the parsed value is assigned to *abbrev if abbrev is not null. If the format specifier %z or a modified variant is used and successfully parsed, the parsed value is assigned to *offset if offset is not null.

🫢 Parameters 🫢

okay so here's who's who in this function's little friend group:

  • is β€” the input stream, aka where we're reading from.
  • fmt β€” a format string (see below).
  • d β€” object to hold the parse result.
  • abbrev β€” if not null, pointer to an object that will hold the time zone abbreviation or name corresponding to the %Z specifier.
  • offset β€” if not null, pointer to an object that will hold the offset from UTC corresponding to the %z specifier.

✨ Format string ✨

The format string is literally zero or more conversion specifiers plus ordinary characters. Here's the vibe:

  • Every ordinary character β€” excluding whitespace characters and the terminating null character β€” matches one identical character from the input stream, or causes the function to fail if the next character on the stream does not compare equal.
  • Every whitespace character matches zero or more whitespace characters in the input stream.

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. Some conversion specifiers have a modified form in which a width parameter given as a positive decimal integer (shown as N below) is inserted after the % character. Each conversion specifier causes the matched characters to be interpreted as parts of date and time types according to the breakdown below.

A character sequence in the format string that begins with a % but does not match one of the conversion specifiers below is interpreted as ordinary characters. iykyk πŸ’…

If from_stream fails to parse everything specified by the format string, or if insufficient information is parsed to specify a complete result, or if parsing discloses contradictory information, is.setstate(std::ios_base::failbit) is called. 😭

The following conversion specifiers are available:

  • %% β€” matches a literal % character.
  • %n β€” matches one whitespace character.
  • %t β€” matches zero or one whitespace character.

🌸 Year 🌸

  • %C, %NC, %EC β€” parses the century as a decimal number. The width N specifies the maximum number of characters to read. The default width is 2. Leading zeroes are permitted but not required. The modified command %EC interprets the locale's alternative representation of the century.
  • %y, %Ny, %Ey, %Oy β€” parses the last two decimal digits of the year. If the century is not otherwise specified (e.g. with %C), values in the range [69, 99] are presumed to refer to the years 1969 to 1999, and values in the range [00, 68] are presumed to refer to the years 2000 to 2068. The width N specifies the maximum number of characters to read. The default width is 2. Leading zeroes are permitted but not required. The modified commands %Ey and %Oy interpret the locale's alternative representation.
  • %Y, %NY, %EY β€” parses the year as a decimal number. The width N specifies the maximum number of characters to read. The default width is 4. Leading zeroes are permitted but not required. The modified command %EY interprets the locale's alternative representation.

πŸŽ€ Month πŸŽ€

  • %b, %B, %h β€” parses the locale's full or abbreviated case-insensitive month name.
  • %m, %Nm, %Om β€” parses the month as a decimal number (January is 1). The width N specifies the maximum number of characters to read. The default width is 2. Leading zeroes are permitted but not required. The modified command %Om interprets the locale's alternative representation.

πŸ¦‹ Day πŸ¦‹

  • %d, %Nd, %Od, %e, %Ne, %Oe β€” the Day crew. %d / %Nd parses the day of month as a decimal number. The width N specifies the maximum number of characters to read. The default width is 2. Leading zeroes are permitted but not required. The modified commands %Od and %Oe interpret the locale's alternative representation.

🌈 Day of the week 🌈

  • %a, %A β€” parses the locale's full or abbreviated case-insensitive weekday name.
  • %u, %Nu β€” parses the ISO weekday as a decimal number (1-7), where Monday is 1. The width N specifies the maximum number of characters to read. The default width is 1. Leading zeroes are permitted but not required.
  • %w, %Nw, %Ow β€” parses the weekday as a decimal number (0-6), where Sunday is 0. The width N specifies the maximum number of characters to read. The default width is 1. Leading zeroes are permitted but not required. The modified command %Ow interprets 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, %Ng β€” parses the last two decimal digits of the ISO 8601 week-based year. The width N specifies the maximum number of characters to read. The default width is 2. Leading zeroes are permitted but not required.
  • %G, %NG β€” parses the ISO 8601 week-based year as a decimal number. The width N specifies the maximum number of characters to read. The default width is 4. Leading zeroes are permitted but not required.
  • %V, %NV β€” parses the ISO 8601 week of the year as a decimal number. The width N specifies the maximum number of characters to read. The default width is 2. Leading zeroes are permitted but not required.

πŸ’œ Week/day of the year πŸ’œ

  • %j, %Nj β€” parses the day of the year as a decimal number (January 1 is 1). The width N specifies the maximum number of characters to read. The default width is 3. Leading zeroes are permitted but not required.
  • %U, %NU, %OU β€” parses 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. The width N specifies the maximum number of characters to read. The default width is 2. Leading zeroes are permitted but not required. The modified command %OU interprets the locale's alternative representation.
  • %W, %NW, %OW β€” parses 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. The width N specifies the maximum number of characters to read. The default width is 2. Leading zeroes are permitted but not required. The modified command %OW interprets the locale's alternative representation.

πŸ“ Date πŸ“

  • %D β€” equivalent to "%m/%d/%y".
  • %F, %NF β€” equivalent to "%Y-%m-%d". If the width is specified, it is only applied to the %Y.
  • %x, %Ex β€” %x parses the locale's date representation. The modified command %Ex interprets the locale's alternate date representation.

🧚 Time of day 🧚

  • %H, %NH, %OH β€” parses the hour (24-hour clock) as a decimal number. The width N specifies the maximum number of characters to read. The default width is 2. Leading zeroes are permitted but not required. The modified command %OH interprets the locale's alternative representation.
  • %I, %NI, %OI β€” parses the hour (12-hour clock) as a decimal number. The width N specifies the maximum number of characters to read. The default width is 2. Leading zeroes are permitted but not required. The modified command %OI interprets the locale's alternative representation.
  • %M, %NM, %OM β€” parses the minute as a decimal number. The width N specifies the maximum number of characters to read. The default width is 2. Leading zeroes are permitted but not required. The modified command %OM interprets the locale's alternative representation.
  • %S, %NS, %OS β€” parses the second as a decimal number. The width N specifies the maximum number of characters to read. The default width is 2. Leading zeroes are permitted but not required. The modified command %OS interprets the locale's alternative representation.
  • %p β€” parses the locale's equivalent of the AM/PM designations associated with a 12-hour clock.
  • %R β€” equivalent to "%H:%M".
  • %T β€” equivalent to "%H:%M:%S".
  • %r β€” parses the locale's 12-hour clock time.
  • %X, %EX β€” %X parses the locale's time representation. The modified command %EX interprets the locale's alternate time representation.

πŸ’… Miscellaneous πŸ’…

Okay bestie, this is the grab-bag corner of the conversion specifiers β€” the leftovers that didn't fit anywhere else. They're still iconic though, don't sleep on them 🫢

  • %c, %Ec β€” Parses the locale's date and time representation ✨. And the modified command %Ec? That one interprets the locale's alternative date and time representation. Two flavours, same vibe πŸ’–
  • %z, %Ez, %Oz β€” Parses the offset from UTC, in the format [+|-]hh[mm]. For example, -0430 refers to 4 hours 30 minutes behind UTC, and 04 refers to 4 hours ahead of UTC 🌈. The modified commands %Ez and %Oz parse the format [+|-]h[h][:mm] β€” that is, they require a : between the hours and minutes, and they make the leading zero for the hour optional. Fancy πŸ’…
  • %Z β€” Parses the time zone abbreviation or name, and it's taken as the longest sequence of characters that only contains the characters A through Z, a through z, 0 through 9, -, +, _, and / πŸ”₯. Greedy little thing, we love that for it.

πŸŽ€ Return value πŸŽ€

No cap, the page literally just says this:

is

That's it. That's the whole return value section 😭 bestie I cannot make it longer than the source gave us, so we're all just gonna sit with is and think about it πŸ™ˆ


πŸ¦‹ See also πŸ¦‹

  • parse β€” parses a chrono object from a stream (C++20) (function template). Your bestie for turning text into actual chrono objects, periodt πŸ‘‘

And that's the whole page, bestie β€” you officially know these conversion specifiers better than half the internet 🧚✨ This one came from http://cppreference.com, dated 2024.06.10, and it's titled std::chrono...hrono::day)(3) 🌸 Go parse something cute for me πŸ’œπŸ“

πŸ“¦ where this page comes from