catchmark(3rheolef)

✨ NAME ✨

okay so bestie, gather round 💖 this is catchmark — the input/output manipulator from rheolef-7.2. yes that's the whole name, she's lowkey humble like that 🎀

---

🦋 DESCRIPTION 🦋

so the catchmark input/output manipulator is literally the girl who labels your stuff 💅 she's used for defining labels associated to field(2) when saving them on files. like, you tag your fields so future-you knows which one is which, no cap.

here's the save moment, bestie:

dout << catchmark('u')   << uh
     << catchmark('w')   << wh
     << catchmark('psi') << psih;

and then reading is done the same way, it's giving symmetry ✨:

din  >> catchmark('u')   >> uh
     >> catchmark('w')   >> wh
     >> catchmark('psi') >> psih;

also go peek at diststream(2) — she's in the same friend group 🫶

---

🌸 IMPLEMENTATION 🌸

okay so this documentation has been generated from file util/lib/catchmark.h — yes, she's that girl, fully sourced 👑

class catchmark {
    public:
        catchmark(const std::string& x);
        const std::string& mark() const { return _mark; }
        friend std::istream& operator >> (std::istream& is, const catchmark& m);
        friend std::ostream& operator << (std::ostream& os, const catchmark& m);

};

---

💜 AUTHOR 💜

Pierre Saramito <Pierre.Saramito@imag.fr> — the icon, the legend, the moment 🌟

---

🎀 COPYRIGHT 🎀

Copyright (C) 2000-2018 Pierre Saramito <Pierre.Saramito@imag.fr>

GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.

This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law.

fr fr read that again: free to change, free to redistribute, and NO WARRANTY — so don't come for her if things go sideways 😭

---

okay that's the whole page bestie, mwah 💋 sending you off with love from the rheolef girlies — this is Version 7.2 and yes she's catchmark(3rheolef) through and through ✨🎀💖