std::encoding_state(3)

💖 std::encoding_state — a whole vibe for encoding glow-ups

okay bestie, listen. this is std::encoding_state(3) from the Library Functions Manual, and she's the friend who speaks every language and translates flawlessly between all of them. basically: an extension so you can use iconv to deal with character encodings. iconic behavior honestly. 💅

---

🌸 NAME 🌸

std::encoding_state — Extension to use iconv for dealing with character encodings.

like. that's the whole point of her. she's the encoding middle-manager. 🎀

---

✨ SYNOPSIS ✨

#include <codecvt_specializations.h>

🫶 Public Types

• typedef iconv_t descriptor_type — the descriptor type. yes bestie, iconv_t is her whole thing. 💖

🌈 Public Member Functions

• encoding_state (const char *__int, const char *__ext, int __ibom=0, int __ebom=0, int __bytes=1) — the constructor that takes an internal encoding, an external encoding, and optionally an internal BOM defaulting to 0, an external BOM defaulting to 0, and a byte count defaulting to 1. defaults are slaying, as always. ✨
• encoding_state (const encoding_state &__obj) — copy constructor. she copies her whole vibe onto __obj. 🦋
• int character_ratio () const — gives you the character ratio. lowkey useful.
• int external_bom () const — the external BOM. yes it's a number. 💜
• const std::string external_encoding () const — hands you back the external encoding as a std::string. no cap.
• bool good () const throw () — vibe check!! returns whether she's good. it's a bool, it doesn't throw, she would never. 🌸
• const descriptor_type & in_descriptor () const — the input descriptor, by const reference, obviously.
• int internal_bom () const — the internal BOM. the inside one. 🎀
• const std::string internal_encoding () const — the internal encoding, as a std::string.
• encoding_state & operator= (const encoding_state &__obj) — assignment operator, returns a reference to herself like the main character she is. 👑
• const descriptor_type & out_descriptor () const — the output descriptor, const reference, periodt.

🧚 Protected Member Functions

• void construct (const encoding_state &__obj) — constructs from __obj. protected, so don't get any ideas unless you're a subclass. 🙈
• void destroy () throw () — tears it all down. it does not throw. she's too composed for that. 💀
• void init () — sets things up. protected. 🤫

🍓 Protected Attributes

• int _M_bytes — the byte count she's holding. 💖
• int _M_ext_bom — the external BOM member. ✨
• std::string _M_ext_enc — the external encoding member. 🦋
• descriptor_type _M_in_desc — the input descriptor member. 🌸
• int _M_int_bom — the internal BOM member. 💅
• std::string _M_int_enc — the internal encoding member. 🫶
• descriptor_type _M_out_desc — the output descriptor member. 😭

ngl bestie, those _M_ names are protected, which means they're for the family only. don't touch unless you were born into the inheritance hierarchy. 🔥

---

👑 Detailed Description 👑

Extension to use iconv for dealing with character encodings.

like that's it, that's the whole summary, and she ate. it's giving "I convert your encodings and I look good doing it." 🌈

---

🌟 Author 🌟

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

---

🎀 so that's the whole page, bestie!! this diva is documented by libstdc++ and stamped with std::encoding_state(3) — go convert some encodings, you absolute legend. 💖✨🦋💅