std::encoding_state(3cxx)

💖 NAME 💖

okay so bestie, welcome to std::encoding_state(3cxx) — this is the page for std::encoding_state, and it's an extension to use iconv for dealing with character encodings. that's the whole vibe. no cap. 🦋

---

✨ SYNOPSIS ✨

first things first, you gotta pull in the header:

#include <codecvt_specializations.h>

---

🎀 Public Types 🎀

• typedef iconv_t descriptor_type — yeah so descriptor_type is literally just iconv_t wearing a cute nickname. 💅

---

🌸 Public Member Functions 🌸

• encoding_state (const char *__int, const char *__ext, int __ibom=0, int __ebom=0, int __bytes=1) — the main constructor, she takes an internal encoding (__int), an external encoding (__ext), and then optionally __ibom, __ebom and __bytes (which default to 0, 0 and 1 respectively). slay.
• encoding_state (const encoding_state &__obj) — copy constructor, for when you want a whole other one of these that's just like __obj. 🫶
• int character_ratio () const — hands you back the character ratio as an int.
• int external_bom () const — gives you the external BOM as an int.
• const std::string external_encoding () const — returns the external encoding as a const std::string.
• bool good () const throw () — the vibe check function, fr fr. returns a bool and it's declared throw ().
• const descriptor_type & in_descriptor () const — returns a const reference to the in-descriptor.
• int internal_bom () const — returns the internal BOM, as an int.
• const std::string internal_encoding () const — returns the internal encoding as a const std::string.
• encoding_state & operator= (const encoding_state &__obj) — assignment operator, takes another encoding_state called __obj and gives you back a reference to one. iconic.
• const descriptor_type & out_descriptor () const — returns a const reference to the out-descriptor. 👑

---

🧚 Protected Member Functions 🧚

• void construct (const encoding_state &__obj) — the construction helper, takes __obj.
• void destroy () throw () — the teardown helper, and yeah it's declared throw ().
• void init () — the init helper, no arguments, no notes.

---

🍓 Protected Attributes 🍓

• int _M_bytes — the bytes count, chillin' here as an int.
• int _M_ext_bom — the external BOM, as an int.
• std::string _M_ext_enc — the external encoding, as a std::string.
• descriptor_type _M_in_desc — the in-descriptor, of type descriptor_type.
• int _M_int_bom — the internal BOM, as an int.
• std::string _M_int_enc — the internal encoding, as a std::string.
• descriptor_type _M_out_desc — the out-descriptor, of type descriptor_type.

---

💜 Detailed Description 💜

so the entire point of this thing: it's an extension to use iconv for dealing with character encodings. that's the tea, that's the whole thing, main character energy from start to finish. 🌈

---

🦋 Author 🦋

not a human author bestie — this was generated automatically by Doxygen for libstdc++ from the source code. the robots ate, honestly. 💀✨

---

and that's a wrap on std::encoding_state(3cxx) 💖 — this whole page comes to you courtesy of libstdc++, so go forth and handle your character encodings, bestie. periodt. 👑🎀