STD::TIME_PUT_BYNAME(3)

💖 std::time_put_byname< _CharT, _OutIter > 💖

okay bestie, gather round, because today we're meeting std::time_put_byname< _CharT, _OutIter > — aka class time_put_byname [22.2.5.4]. it lives in the libstdc++ manual (section 3, library functions, you know the vibe ✨) and it is genuinely so good at what it does. let's get into it 🫶

---

🌸 NAME 🌸

std::time_put_byname< _CharT, _OutIter > — that's the class time_put_byname, [22.2.5.4]. periodt. 💅

---

✨ SYNOPSIS ✨

first thing, the include, no notes:

#include <locale>

and it Inherits std::time_put< _CharT, _OutIter > — so all that parent energy is coming with it, fr fr.

🎀 Public Types 🎀

• typedef _CharT char_type
• typedef _OutIter iter_type

💜 Public Member Functions 💜

• time_put_byname (const char *, size_t __refs=0)
• time_put_byname (const string &__s, size_t __refs=0)
• iter_type put (iter_type __s, ios_base &__io, char_type __fill, const tm *__tm, char __format, char __mod=0) const — format and output a time or date 🕰️
• iter_type put (iter_type __s, ios_base &__io, char_type __fill, const tm *__tm, const _CharT *__beg, const _CharT *__end) const — format and output a time or date 🕰️ (yes, again, but with a format string this time, not a single char)

⭐ Static Public Attributes ⭐

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

🦋 Protected Member Functions 🦋

• virtual iter_type do_put (iter_type __s, ios_base &__io, char_type __fill, const tm *__tm, char __format, char __mod) const — format and output a time or date 🕰️

🌈 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 _OutIter>
class std::time_put_byname< _CharT, _OutIter >

and the description of it is literally, verbatim, the name again: class time_put_byname [22.2.5.4]. iconic of it honestly, it knows its own name and it's not gonna elaborate. 💀

---

🔥 Member Function Documentation 🔥

🫶 do_put 🫶

template<typename _CharT, typename _OutIter>
_OutIter std::time_put< _CharT, _OutIter >::do_put
    (iter_type __s, ios_base & __io, char_type __fill, const tm * __tm,
     char __format, char __mod) const

tags on this one: [protected], [virtual], [inherited] — so it's a protected virtual hook that we got from the parent. slay.

Format and output a time or date. this function formats the data in struct tm according to the provided format char and optional modifier. and listen — this function is a hook for derived classes to change the value returned. so it's literally the "hey subclasses, do your thing" door 🚪✨

See also: put() for more details.

Parameters:

• __s — the stream to write to.
• __io — source of locale.
• __fill — char_type to use for padding.
• __tm — Struct tm with date and time info to format.
• __format — format char.
• __mod — optional modifier char.

Returns: iterator after writing.

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

Referenced by put(), and put(). (both of them, bestie, it's popular 💅)

🍓 put (the format-char one) 🍓

template<typename _CharT, typename _OutIter>
iter_type std::time_put< _CharT, _OutIter >::put
    (iter_type __s, ios_base & __io, char_type __fill, const tm * __tm,
     char __format, char __mod = 0) const

tags: [inline], [inherited].

Format and output a time or date. formats the data in struct tm according to the provided format char and optional modifier. the format and modifier are interpreted as by strftime(). and it does so by returning time_put::do_put() — so it's basically the friendly front desk that sends you to do_put in the back office 🫡

Parameters:

• __s — the stream to write to.
• __io — source of locale.
• __fill — char_type to use for padding.
• __tm — Struct tm with date and time info to format.
• __format — format char.
• __mod — optional modifier char.

Returns: iterator after writing.

References do_put().

🧚 put (the format-string one) 🧚

template<typename _CharT, typename _OutIter>
_OutIter std::time_put< _CharT, _OutIter >::put
    (iter_type __s, ios_base & __io, char_type __fill, const tm * __tm,
     const _CharT * __beg, const _CharT * __end) const

tags: [inherited].

Format and output a time or date. this one formats the data in struct tm according to the provided format string (not just one char, we're fancy now). the format string is interpreted as by strftime().

Parameters:

• __s — the stream to write to.
• __io — source of locale.
• __fill — char_type to use for padding.
• __tm — Struct tm with date and time info to format.
• __beg — start of format string.
• __end — end of format string.

Returns: iterator after writing.

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

---

👑 Member Data Documentation 👑

template<typename _CharT, typename _OutIter>
locale::id std::time_put< _CharT, _OutIter >::id

tags: [static], [inherited].

it's the Numpunct facet id. that's the whole description. short and mysterious, main character energy honestly 🌟

---

💌 Author 💌

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

---

no cap, every option, overload, parameter and reference above is straight from the page — nothing dropped, nothing invented, just delivered with the correct amount of sparkle. 💖

and that's the whole thing bestie!! this page is from the libstdc++ manual, it's the std::time_..._OutIter >(3) page (Library Functions Manual, section 3, the one and only), and it was written in the year of our lord whenever libstdc++ felt like it 🎀✨ mwah, go format some timestamps, you ate 💅🦋🌸