STD::TIME_GET(3)

💖 NAME 💖

std::time_get< _CharT, _InIter > — Primary class template time_get.

okay so real talk, bestie — this one lives in the Library Functions Manual, section 3, and it's a whole ✨mood✨. Let's get into it. 🦋

---

✨ SYNOPSIS ✨

#include <locale>

Inherits std::locale::facet, and std::time_base.

Inherited by std::time_get_byname< _CharT, _InIter >.

---

🌸 Public Types 🌸

• enum dateorder { no_order, dmy, mdy, ymd, ydm } — the lil menu of date orderings, we love her.
• typedef _CharT char_type — Public typedefs.
• typedef _InIter iter_type — Public typedefs.

---

🎀 Public Member Functions 🎀

• time_get — Constructor performs initialization.

time_get (size_t __refs=0)

• date_order — Return preferred order of month, day, and year.

dateorder date_order () const

• get — Parse input string according to format.

iter_type get (iter_type __s, iter_type __end, ios_base &__io,
    ios_base::iostate &__err, tm *__tm, char __format, char
    __modifier=0) const

• get — Parse input string according to format. (yes bestie there's a second one, she's overloaded 💅)

iter_type get (iter_type __s, iter_type __end, ios_base &__io,
    ios_base::iostate &__err, tm *__tm, const char_type *__fmt, const
    char_type *__fmtend) const

• get_date — Parse input date string.

iter_type get_date (iter_type __beg, iter_type __end, ios_base &__io,
    ios_base::iostate &__err, tm *__tm) const

• get_monthname — Parse input month string.

iter_type get_monthname (iter_type __beg, iter_type __end, ios_base
    &__io, ios_base::iostate &__err, tm *__tm) const

• get_time — Parse input time string.

iter_type get_time (iter_type __beg, iter_type __end, ios_base &__io,
    ios_base::iostate &__err, tm *__tm) const

• get_weekday — Parse input weekday string.

iter_type get_weekday (iter_type __beg, iter_type __end, ios_base &__io,
    ios_base::iostate &__err, tm *__tm) const

• get_year — Parse input year string.

iter_type get_year (iter_type __beg, iter_type __end, ios_base &__io,
    ios_base::iostate &__err, tm *__tm) const

---

🦋 Static Public Attributes 🦋

• static locale::id id — Numpunct facet id.

---

💜 Protected Member Functions 💜

• virtual ~time_get () — Destructor.
• _M_extract_name

iter_type _M_extract_name (iter_type __beg, iter_type __end, int
    &__member, const _CharT **__names, size_t __indexlen, ios_base
    &__io, ios_base::iostate &__err) const

• _M_extract_num

iter_type _M_extract_num (iter_type __beg, iter_type __end, int
    &__member, int __min, int __max, size_t __len, ios_base &__io,
    ios_base::iostate &__err) const

• _M_extract_via_format

iter_type _M_extract_via_format (iter_type __beg, iter_type __end,
    ios_base &__io, ios_base::iostate &__err, tm *__tm, const _CharT
    *__format) const

• _M_extract_via_format (the sequel, now with ✨state✨)

iter_type _M_extract_via_format (iter_type __beg, iter_type __end,
    ios_base &__io, ios_base::iostate &__err, tm *__tm, const _CharT
    *__format, __time_get_state &__state) const

• _M_extract_wday_or_month

iter_type _M_extract_wday_or_month (iter_type __beg, iter_type __end,
    int &__member, const _CharT **__names, size_t __indexlen, ios_base
    &__io, ios_base::iostate &__err) const

• virtual dateorder do_date_order () const — Return preferred order of month, day, and year.
• do_get — Parse input string according to format.

iter_type do_get (iter_type __s, iter_type __end, ios_base &__f,
    ios_base::iostate &__err, tm *__tm, char __format, char __modifier)
    const

• virtual iter_type do_get_date (...) const — Parse input date string.

virtual iter_type do_get_date (iter_type __beg, iter_type __end,
    ios_base &__io, ios_base::iostate &__err, tm *__tm) const

• virtual iter_type do_get_monthname (...) const — Parse input month string.

virtual iter_type do_get_monthname (iter_type __beg, iter_type __end,
    ios_base &, ios_base::iostate &__err, tm *__tm) const

• virtual iter_type do_get_time (...) const — Parse input time string.

virtual iter_type do_get_time (iter_type __beg, iter_type __end,
    ios_base &__io, ios_base::iostate &__err, tm *__tm) const

• virtual iter_type do_get_weekday (...) const — Parse input weekday string.

virtual iter_type do_get_weekday (iter_type __beg, iter_type __end,
    ios_base &, ios_base::iostate &__err, tm *__tm) const

• virtual iter_type do_get_year (...) const — Parse input year string.

virtual iter_type do_get_year (iter_type __beg, iter_type __end,
    ios_base &__io, ios_base::iostate &__err, tm *__tm) const

---

🧚 Static Protected Member Functions 🧚

• static __c_locale _S_clone_c_locale (__c_locale &__cloc) throw ()
• static void _S_create_c_locale (__c_locale &__cloc, const char *__s, __c_locale __old=0)
• static void _S_destroy_c_locale (__c_locale &__cloc)
• static __c_locale _S_get_c_locale ()
• static const char * _S_get_c_name () throw ()
• static __c_locale _S_lc_ctype_c_locale (__c_locale __cloc, const char *__s)

---

👑 Detailed Description 👑

template<typename _CharT, typename _InIter>
    class std::time_get< _CharT, _InIter >"Primary class template time_get.

This facet encapsulates the code to parse and return a date or time from a string. It is used by the istream numeric extraction operators.

The time_get template uses protected virtual functions to provide the actual results. The public accessors forward the call to the virtual functions. These virtual functions are hooks for developers to implement the behavior they require from the time_get facet.

so basically: public ones are the ✨front desk✨ and the do_* ones are the back office where you actually get stuff done. iykyk. 💅

---

🌈 Member Typedef Documentation 🌈

• template<typename _CharT, typename _InIter> typedef _CharT std::time_get< _CharT, _InIter >::char_type — Public typedefs.
• template<typename _CharT, typename _InIter> typedef _InIter std::time_get< _CharT, _InIter >::iter_type — Public typedefs.

---

🎀 Constructor & Destructor Documentation 🎀

time_get

template<typename _CharT, typename _InIter> std::time_get< _CharT, _InIter
    >::time_get (size_t __refs = 0) [inline],  [explicit]

Constructor performs initialization. This is the constructor provided by the standard.

Parameters

• __refs — Passed to the base facet class.

References std::locale::facet::facet().

---

~time_get

template<typename _CharT, typename _InIter> virtual std::time_get< _CharT,
    _InIter >::~time_get () [inline],  [protected],  [virtual]

Destructor.

---

⭐ Member Function Documentation ⭐

date_order

template<typename _CharT, typename _InIter> dateorder std::time_get< _CharT,
    _InIter >::date_order () const [inline]

Return preferred order of month, day, and year. This function returns an enum from time_base::dateorder giving the preferred ordering if the format x given to time_put::put() only uses month, day, and year. If the format x for the associated locale uses other fields, this function returns time_base::dateorder::noorder.

NOTE: The library always returns noorder at the moment. 💀 yeah. always. no cap.

Returns

• A member of time_base::dateorder.

References do_date_order().

---

do_date_order

template<typename _CharT, typename _InIter>
    _GLIBCXX_END_NAMESPACE_LDBL_OR_CXX11 time_base::dateorder std::time_get<
    _CharT, _InIter >::do_date_order () const [protected],  [virtual]

Return preferred order of month, day, and year. This function returns an enum from time_base::dateorder giving the preferred ordering if the format x given to time_put::put() only uses month, day, and year. This function is a hook for derived classes to change the value returned.

Returns

• A member of time_base::dateorder.

Referenced by date_order().

---

do_get

template<typename _CharT, typename _InIter> _InIter std::time_get< _CharT,
    _InIter >::do_get (iter_type __s, iter_type __end, ios_base & __f,
    ios_base::iostate & __err, tm * __tm, char __format, char __modifier)
    const [inline],  [protected]

Parse input string according to format. This function parses the string according to the provided format and optional modifier. This function is a hook for derived classes to change the value returned.

See also get() for more details.

Parameters

• __s — Start of string to parse.
• __end — End of string to parse.
• __f — Source of the locale.
• __err — Error flags to set.
• __tm — Pointer to struct tm to fill in.
• __format — Format specifier.
• __modifier — Format modifier.

Returns

• Iterator to first char not parsed.

References std::ios_base::_M_getloc(), std::ios_base::eofbit, std::ios_base::goodbit, std::use_facet(), and std::__ctype_abstract_base< _CharT >::widen().

Referenced by get(), and get().

---

do_get_date

template<typename _CharT, typename _InIter> _InIter std::time_get< _CharT,
    _InIter >::do_get_date (iter_type __beg, iter_type __end, ios_base &
    __io, ios_base::iostate & __err, tm * __tm) const [protected],
    [virtual]

Parse input date string. This function parses a date according to the format X and puts the results into a user-supplied struct tm. This function is a hook for derived classes to change the value returned.

See also get_date() for details.

Parameters

• __beg — Start of string to parse.
• __end — End of string to parse.
• __io — Source of the locale.
• __err — Error flags to set.
• __tm — Pointer to struct tm to fill in.

Returns

• Iterator to first char beyond date string.

References std::ios_base::_M_getloc(), std::ios_base::eofbit, and std::use_facet().

Referenced by get_date().

---

do_get_monthname

template<typename _CharT, typename _InIter> _InIter std::time_get< _CharT,
    _InIter >::do_get_monthname (iter_type __beg, iter_type __end, ios_base
    & __io, ios_base::iostate & __err, tm * __tm) const [protected],
    [virtual]

Parse input month string. This function parses a month name and puts the results into a user-supplied struct tm. This function is a hook for derived classes to change the value returned.

See also get_monthname() for details.

Parameters

• __beg — Start of string to parse.
• __end — End of string to parse.
• __io — Source of the locale.
• __err — Error flags to set.
• __tm — Pointer to struct tm to fill in.

Returns

• Iterator to first char beyond month name.

References std::ios_base::_M_getloc(), std::ios_base::eofbit, std::ios_base::failbit, std::ios_base::goodbit, and std::use_facet().

Referenced by get_monthname().

---

do_get_time

template<typename _CharT, typename _InIter> _InIter std::time_get< _CharT,
    _InIter >::do_get_time (iter_type __beg, iter_type __end, ios_base &
    __io, ios_base::iostate & __err, tm * __tm) const [protected],
    [virtual]

Parse input time string. This function parses a time according to the format x and puts the results into a user-supplied struct tm. This function is a hook for derived classes to change the value returned.

See also get_time() for details.

Parameters

• __beg — Start of string to parse.
• __end — End of string to parse.
• __io — Source of the locale.
• __err — Error flags to set.
• __tm — Pointer to struct tm to fill in.

Returns

• Iterator to first char beyond time string.

References std::ios_base::_M_getloc(), std::ios_base::eofbit, and std::use_facet().

Referenced by get_time().

do_get_weekday() — protected, virtual, the hook bestie 🦋

template<typename _CharT, typename _InIter> _InIter std::time_get< _CharT,
    _InIter >::do_get_weekday (iter_type __beg, iter_type __end, ios_base &
    __io, ios_base::iostate & __err, tm * __tm) const [protected],
    [virtual]

Okay so this one parses an input weekday string. It parses a weekday name and puts the results into a user-supplied struct tm. It’s a hook for derived classes to change the value returned. periodt 💅

See also: get_weekday() for details.

Parameters:

• __beg — start of string to parse.
• __end — end of string to parse.
• __io — source of the locale.
• __err — error flags to set.
• __tm — pointer to struct tm to fill in.

Returns: iterator to first char beyond weekday name.

References: std::ios_base::_M_getloc(), std::ios_base::eofbit, std::ios_base::failbit, std::ios_base::goodbit, and std::use_facet().

Referenced by get_weekday().

---

do_get_year() — protected, virtual, year parser energy ⭐

template<typename _CharT, typename _InIter> _InIter std::time_get< _CharT,
    _InIter >::do_get_year (iter_type __beg, iter_type __end, ios_base &
    __io, ios_base::iostate & __err, tm * __tm) const [protected],
    [virtual]

This one parses an input year string. It reads up to 4 characters to parse a year string and puts the results into a user-supplied struct tm. It’s a hook for derived classes to change the value returned. no cap ✨

See also: get_year() for details.

Parameters:

• __beg — start of string to parse.
• __end — end of string to parse.
• __io — source of the locale.
• __err — error flags to set.
• __tm — pointer to struct tm to fill in.

Returns: iterator to first char beyond year.

References: std::ios_base::_M_getloc(), std::ios_base::eofbit, std::ios_base::failbit, std::ios_base::goodbit, std::__ctype_abstract_base< _CharT >::narrow(), and std::use_facet().

Referenced by get_year().

---

get() — the char __format overload 🎀

template<typename _CharT, typename _InIter> iter_type std::time_get< _CharT,
    _InIter >::get (iter_type __s, iter_type __end, ios_base & __io,
    ios_base::iostate & __err, tm * __tm, char __format, char __modifier =
    0) const [inline]

Parse input string according to format. This function calls time_get::do_get with the provided parameters. lowkey the middleman 💜

See also: do_get() and get().

Parameters:

• __s — start of string to parse.
• __end — end of string to parse.
• __io — source of the locale.
• __err — error flags to set.
• __tm — pointer to struct tm to fill in.
• __format — format specifier.
• __modifier — format modifier.

Returns: iterator to first char not parsed.

References: do_get().

---

get() — the format-string overload 🌈

template<typename _CharT, typename _InIter> iter_type std::time_get< _CharT,
    _InIter >::get (iter_type __s, iter_type __end, ios_base & __io,
    ios_base::iostate & __err, tm * __tm, const char_type * __fmt, const
    char_type * __fmtend) const [inline]

Parse input string according to format. This function parses the input string according to a provided format string. It does the inverse of time_put::put. The format string follows the format specified for strftime(3)/strptime(3). The actual parsing is done by time_get::do_get. it’s giving reverse uno card 🃏

Parameters:

• __s — start of string to parse.
• __end — end of string to parse.
• __io — source of the locale.
• __err — error flags to set.
• __tm — pointer to struct tm to fill in.
• __fmt — start of the format string.
• __fmtend — end of the format string.

Returns: iterator to first char not parsed.

References: std::ios_base::_M_getloc(), do_get(), std::ios_base::eofbit, std::ios_base::failbit, std::ios_base::goodbit, std::__ctype_abstract_base< _CharT >::is(), std::__ctype_abstract_base< _CharT >::narrow(), std::__ctype_abstract_base< _CharT >::tolower(), std::__ctype_abstract_base< _CharT >::toupper(), and std::use_facet().

---

get_date() — inline date parser 📅

template<typename _CharT, typename _InIter> iter_type std::time_get< _CharT,
    _InIter >::get_date (iter_type __beg, iter_type __end, ios_base & __io,
    ios_base::iostate & __err, tm * __tm) const [inline]

Parse input date string. This function parses a date according to the format x and puts the results into a user-supplied struct tm. The result is returned by calling time_get::do_get_date().

If there is a valid date string according to format x, tm will be filled in accordingly and the returned iterator will point to the first character beyond the date string. If an error occurs before the end, err |= ios_base::failbit. If parsing reads all the characters, err |= ios_base::eofbit. the way that it handles errors is so real 😭

Parameters:

• __beg — start of string to parse.
• __end — end of string to parse.
• __io — source of the locale.
• __err — error flags to set.
• __tm — pointer to struct tm to fill in.

Returns: iterator to first char beyond date string.

References: do_get_date().

---

get_monthname() — inline month-name parser 🌸

template<typename _CharT, typename _InIter> iter_type std::time_get< _CharT,
    _InIter >::get_monthname (iter_type __beg, iter_type __end, ios_base &
    __io, ios_base::iostate & __err, tm * __tm) const [inline]

Parse input month string. This function parses a month name and puts the results into a user-supplied struct tm. The result is returned by calling time_get::do_get_monthname().

Parsing starts by parsing an abbreviated month name. If a valid abbreviation is followed by a character that would lead to the full month name, parsing continues until the full name is found or an error occurs. Otherwise parsing finishes at the end of the abbreviated name.

If an error occurs before the end, err |= ios_base::failbit. If parsing reads all the characters, err |= ios_base::eofbit. abbreviation to full name pipeline? obsessed 💖

Parameters:

• __beg — start of string to parse.
• __end — end of string to parse.
• __io — source of the locale.
• __err — error flags to set.
• __tm — pointer to struct tm to fill in.

Returns: iterator to first char beyond month name.

References: do_get_monthname().

---

get_time() — inline time parser ⏰

template<typename _CharT, typename _InIter> iter_type std::time_get< _CharT,
    _InIter >::get_time (iter_type __beg, iter_type __end, ios_base & __io,
    ios_base::iostate & __err, tm * __tm) const [inline]

Parse input time string. This function parses a time according to the format X and puts the results into a user-supplied struct tm. The result is returned by calling time_get::do_get_time().

If there is a valid time string according to format X, tm will be filled in accordingly and the returned iterator will point to the first character beyond the time string. If an error occurs before the end, err |= ios_base::failbit. If parsing reads all the characters, err |= ios_base::eofbit. format X said trust me bestie ✨

Parameters:

• __beg — start of string to parse.
• __end — end of string to parse.
• __io — source of the locale.
• __err — error flags to set.
• __tm — pointer to struct tm to fill in.

Returns: iterator to first char beyond time string.

References: do_get_time().

---

get_weekday() — inline weekday parser 🗓️

template<typename _CharT, typename _InIter> iter_type std::time_get< _CharT,
    _InIter >::get_weekday (iter_type __beg, iter_type __end, ios_base &
    __io, ios_base::iostate & __err, tm * __tm) const [inline]

Parse input weekday string. This function parses a weekday name and puts the results into a user-supplied struct tm. The result is returned by calling time_get::do_get_weekday().

Parsing starts by parsing an abbreviated weekday name. If a valid abbreviation is followed by a character that would lead to the full weekday name, parsing continues until the full name is found or an error occurs. Otherwise parsing finishes at the end of the abbreviated name.

If an error occurs before the end, err |= ios_base::failbit. If parsing reads all the characters, err |= ios_base::eofbit. Mon → Monday pipeline slay 💅

Parameters:

• __beg — start of string to parse.
• __end — end of string to parse.
• __io — source of the locale.
• __err — error flags to set.
• __tm — pointer to struct tm to fill in.

Returns: iterator to first char beyond weekday name.

References: do_get_weekday().

---

get_year() — inline year parser 🎆

template<typename _CharT, typename _InIter> iter_type std::time_get< _CharT,
    _InIter >::get_year (iter_type __beg, iter_type __end, ios_base & __io,
    ios_base::iostate & __err, tm * __tm) const [inline]

Parse input year string. This function reads up to 4 characters to parse a year string and puts the results into a user-supplied struct tm. The result is returned by calling time_get::do_get_year().

4 consecutive digits are interpreted as a full year. If there are exactly 2 consecutive digits, the library interprets this as the number of years since 1900.

If an error occurs before the end, err |= ios_base::failbit. If parsing reads all the characters, err |= ios_base::eofbit. two digits? since 1900? iconic behavior 👑

Parameters:

• __beg — start of string to parse.
• __end — end of string to parse.
• __io — source of the locale.
• __err — error flags to set.
• __tm — pointer to struct tm to fill in.

Returns: iterator to first char beyond year.

References: do_get_year().

---

Member Data Documentation 🗂️

id — static, and yes it says “Numpunct facet id.” 💀

template<typename _CharT, typename _InIter> locale::id std::time_get<
    _CharT, _InIter >::id [static]

Numpunct facet id.

---

Author ✍️

Generated automatically by Doxygen for libstdc++ from the source code.

---

okay bestie, that’s the whole page 💖 this one is auto-generated by Doxygen for libstdc++ from the source code, and the footer is literally libstdc++ + std::time_... _InIter >(3). no date in the footer, just vibes and C++ locale lore. bye bestie 🫶✨