ost::Engine(3)

📦 version 1.8.1, in ubuntu jammy

👑 ost::Engine(3) 👑

okay bestie, so this one comes straight out of the Library Functions Manual and it's lowkey iconic. we're talking about ost::Engine — a whole class that eats C++ STL streams for breakfast and turns your persistent classes into bytes. let's get into it. 💅

🌸 NAME 🌸

ost::Engine — it's an Engine. that's the whole vibe. no notes. 💀

✨ SYNOPSIS ✨

#include <persist.h>

🦋 Public Types

  • enum EngineMode { modeRead, modeWrite } — these are the modes the Persistence::Engine can work in. pick your fighter.

🎀 Public Member Functions

  • Engine (std::iostream &stream, EngineMode mode, bool compress=true) — THROWS(PersistException). constructs a Persistence::Engine with the specified stream in the given mode.
  • void sync () — this Flushes the buffers and closes the Persistence::Engine. this must happen before the underlying stream is shut down, fr fr.
  • bool more () — this says there are more objects to deserialize.
  • virtual ~Engine ()
  • void write (const BaseObject &object) — THROWS(PersistException). writes a BaseObject from a reference.
  • void write (const BaseObject *object) — THROWS(PersistException). writes a BaseObject from a pointer.
  • void write (int8 i) — THROWS(PersistException)
  • void write (uint8 i) — THROWS(PersistException)
  • void write (int16 i) — THROWS(PersistException)
  • void write (uint16 i) — THROWS(PersistException)
  • void write (int32 i) — THROWS(PersistException)
  • void write (uint32 i) — THROWS(PersistException)
  • void write (float i) — THROWS(PersistException)
  • void write (double i) — THROWS(PersistException)
  • void write (const String &str) — THROWS(PersistException)
  • void write (const std::string &str) — THROWS(PersistException)
  • void writeBinary (const uint8 *data, const uint32 size) — THROWS(PersistException)
  • void read (BaseObject &object) — THROWS(PersistException). reads a BaseObject into a reference, overwriting the object.
  • void read (BaseObject *&object) — THROWS(PersistException). reads a BaseObject into a pointer, allocating memory for the object if necessary.
  • void read (int8 &i) — THROWS(PersistException)
  • void read (uint8 &i) — THROWS(PersistException)
  • void read (int16 &i) — THROWS(PersistException)
  • void read (uint16 &i) — THROWS(PersistException)
  • void read (int32 &i) — THROWS(PersistException)
  • void read (uint32 &i) — THROWS(PersistException)
  • void read (float &i) — THROWS(PersistException)
  • void read (double &i) — THROWS(PersistException)
  • void read (String &str) — THROWS(PersistException)
  • void read (std::string &str) — THROWS(PersistException)
  • void readBinary (uint8 *data, uint32 size) — THROWS(PersistException)
bestie listen — these are not member functions. they're just vibing nearby. don't get it twisted. 💖
  • __EXPORT Engine & operator>> (Engine &ar, BaseObject &ob) — THROWS(PersistException)
  • __EXPORT Engine & operator>> (Engine &ar, BaseObject *&ob) — THROWS(PersistException)
  • __EXPORT Engine & operator<< (Engine &ar, BaseObject const &ob) — THROWS(PersistException)
  • __EXPORT Engine & operator<< (Engine &ar, BaseObject const *ob) — THROWS(PersistException)
  • __EXPORT Engine & operator>> (Engine &ar, int8 &ob) — THROWS(PersistException)
  • __EXPORT Engine & operator<< (Engine &ar, int8 ob) — THROWS(PersistException)
  • __EXPORT Engine & operator>> (Engine &ar, uint8 &ob) — THROWS(PersistException)
  • __EXPORT Engine & operator<< (Engine &ar, uint8 ob) — THROWS(PersistException)
  • __EXPORT Engine & operator>> (Engine &ar, int16 &ob) — THROWS(PersistException)
  • __EXPORT Engine & operator<< (Engine &ar, int16 ob) — THROWS(PersistException)
  • __EXPORT Engine & operator>> (Engine &ar, uint16 &ob) — THROWS(PersistException)
  • __EXPORT Engine & operator<< (Engine &ar, uint16 ob) — THROWS(PersistException)
  • __EXPORT Engine & operator>> (Engine &ar, int32 &ob) — THROWS(PersistException)
  • __EXPORT Engine & operator<< (Engine &ar, int32 ob) — THROWS(PersistException)
  • __EXPORT Engine & operator>> (Engine &ar, uint32 &ob) — THROWS(PersistException)
  • __EXPORT Engine & operator<< (Engine &ar, uint32 ob) — THROWS(PersistException)
  • __EXPORT Engine & operator>> (Engine &ar, float &ob) — THROWS(PersistException)
  • __EXPORT Engine & operator<< (Engine &ar, float ob) — THROWS(PersistException)
  • __EXPORT Engine & operator>> (Engine &ar, double &ob) — THROWS(PersistException)
  • __EXPORT Engine & operator<< (Engine &ar, double ob) — THROWS(PersistException)
  • __EXPORT Engine & operator>> (Engine &ar, String &ob) — THROWS(PersistException)
  • __EXPORT Engine & operator<< (Engine &ar, String ob) — THROWS(PersistException)
  • __EXPORT Engine & operator>> (Engine &ar, std::string &ob) — THROWS(PersistException)
  • __EXPORT Engine & operator<< (Engine &ar, std::string ob) — THROWS(PersistException)
  • __EXPORT Engine & operator>> (Engine &ar, bool &ob) — THROWS(PersistException)
  • __EXPORT Engine & operator<< (Engine &ar, bool ob) — THROWS(PersistException)
  • template<class T > Engine & operator<< (Engine &ar, typename std::vector< T > const &ob) — THROWS(PersistException). The following are templated classes.
  • template<class T > Engine & operator>> (Engine &ar, typename std::vector< T > &ob) — THROWS(PersistException). deserialize a vector of deserializable content from an engine.
  • template<class T > Engine & operator<< (Engine &ar, typename std::deque< T > const &ob) — THROWS(PersistException). serialize a deque of some serializable content to the engine
  • template<class T > Engine & operator>> (Engine &ar, typename std::deque< T > &ob) — THROWS(PersistException). deserialize a deque of deserializable content from an engine.
  • template<class Key , class Value > Engine & operator<< (Engine &ar, typename std::map< Key, Value > const &ob) — THROWS(PersistException). serialize a map with keys/values which both are serializeable to an engine.
  • template<class Key , class Value > Engine & operator>> (Engine &ar, typename std::map< Key, Value > &ob) — THROWS(PersistException). deserialize a map with keys/values which both are serializeable from an engine.
  • template<class x , class y > Engine & operator<< (Engine &ar, std::pair< x, y > &ob) — THROWS(PersistException). serialize a pair of some serializable content to the engine.
  • template<class x , class y > Engine & operator>> (Engine &ar, std::pair< x, y > &ob) — THROWS(PersistException). deserialize a pair of some serializable content to the engine.

💜 DETAILED DESCRIPTION 💜

Engine.

this class constructs on a standard C++ STL stream and then operates in the mode specified. the stream passed into the constructor must be a binary mode to function properly. no cap — if it's not binary, it's not gonna work. 😭

🌟 Author

Daniel Silverstone

stream serialization of persistent classes. ✨

🧚 MEMBER ENUMERATION DOCUMENTATION 🧚

enum ost::Engine::EngineMode

these are the modes the Persistence::Engine can work in.

Enumerator

  • modeRead
  • modeWrite

💅 CONSTRUCTOR & DESTRUCTOR DOCUMENTATION 💅

ost::Engine::Engine (std::iostream & stream, EngineMode mode, bool compress = true)

constructs a Persistence::Engine with the specified stream in the given mode. the stream must be initialised properly prior to this call or problems will ensue. if built using zlib, compress can be used to enable compression. 🫶

virtual ost::Engine::~Engine () [virtual]

🔥 MEMBER FUNCTION DOCUMENTATION 🔥

  • bool ost::Engine::more () — this says there are more objects to deserialize.
  • void ost::Engine::read (BaseObject & object) — reads a BaseObject into a reference overwriting the object.
  • void ost::Engine::read (BaseObject *& object) — reads a BaseObject into a pointer allocating memory for the object if necessary.
  • void ost::Engine::read (double & i) [inline] — References CCXX_ENGINEREAD_REF.
  • void ost::Engine::read (float & i) [inline] — References CCXX_ENGINEREAD_REF.
  • void ost::Engine::read (int16 & i) [inline] — References CCXX_ENGINEREAD_REF.
  • void ost::Engine::read (int32 & i) [inline] — References CCXX_ENGINEREAD_REF.
  • void ost::Engine::read (int8 & i) [inline] — References CCXX_ENGINEREAD_REF.
  • void ost::Engine::read (std::string & str)
  • void ost::Engine::read (String & str)
  • void ost::Engine::read (uint16 & i) [inline] — References CCXX_ENGINEREAD_REF.
  • void ost::Engine::read (uint32 & i) [inline] — References CCXX_ENGINEREAD_REF.
  • void ost::Engine::read (uint8 & i) [inline] — References CCXX_ENGINEREAD_REF.
  • void ost::Engine::readBinary (uint8 * data, uint32 size)
  • void ost::Engine::sync () — this Flushes the buffers and closes the Persistence::Engine. this must happen before the underlying stream is shut down.
  • void ost::Engine::write (const BaseObject & object) [inline] — writes a BaseObject from a reference.
  • void ost::Engine::write (const BaseObject * object) — writes a BaseObject from a pointer.
  • void ost::Engine::write (const std::string & str)
  • void ost::Engine::write (const String & str)
  • void ost::Engine::write (double i) [inline] — References CCXX_ENGINEWRITE_REF.
  • void ost::Engine::write (float i) [inline] — References CCXX_ENGINEWRITE_REF.
  • void ost::Engine::write (int16 i) [inline] — References CCXX_ENGINEWRITE_REF.
  • void ost::Engine::write (int32 i) [inline] — References CCXX_ENGINEWRITE_REF.
  • void ost::Engine::write (int8 i) [inline] — References CCXX_ENGINEWRITE_REF.
  • void ost::Engine::write (uint16 i) [inline] — References CCXX_ENGINEWRITE_REF.
  • void ost::Engine::write (uint32 i) [inline] — References CCXX_ENGINEWRITE_REF.
  • void ost::Engine::write (uint8 i) [inline] — References CCXX_ENGINEWRITE_REF.
  • void ost::Engine::writeBinary (const uint8 * data, const uint32 size)

part 1 wraps here bestie… part 2 is loading, don't go anywhere 💖

okay bestie, this is the part where the <</>> overloads live — the ones that let you shove all your little values into an Engine and then pull them back out. Every single overload, no skips, no "and friends", we're listing all of them. Let's go 💅

✨ operator<< — the "put it in the engine" crew 🫶

  • __EXPORT Engine & operator<<(Engine & ar, BaseObject const & ob) [related] — the docs give this one no extra blurb, it's just doing its thing.
  • __EXPORT Engine & operator<<(Engine & ar, BaseObject const * ob) [related] — pointer flavour. same, no extra notes in the docs.
  • __EXPORT Engine & operator<<(Engine & ar, bool ob) [related] — bool go in, no commentary attached.
  • __EXPORT Engine & operator<<(Engine & ar, double ob) [related] — no blurb, just vibes.
  • __EXPORT Engine & operator<<(Engine & ar, float ob) [related] — also no blurb.
  • __EXPORT Engine & operator<<(Engine & ar, int16 ob) [related] — nope, no blurb either.
  • __EXPORT Engine & operator<<(Engine & ar, int32 ob) [related] — still no blurb, we move.
  • __EXPORT Engine & operator<<(Engine & ar, int8 ob) [related] — no blurb, moving on fr fr.
  • template<class x , class y > Engine & operator<<(Engine & ar, std::pair< x, y > & ob) [related] — serialize a pair of some serializable content to the engine. 👯
  • __EXPORT Engine & operator<<(Engine & ar, std::string ob) [related] — no extra description given.
  • __EXPORT Engine & operator<<(Engine & ar, String ob) [related] — also no extra description given.
  • template<class T > Engine & operator<<(Engine & ar, typename std::deque< T > const & ob) [related] — serialize a deque of some serializable content to the engine 🧺
  • template<class Key , class Value > Engine & operator<<(Engine & ar, typename std::map< Key, Value > const & ob) [related] — serialize a map with keys/values which both are serializeable to an engine. 🗺️
  • template<class T > Engine & operator<<(Engine & ar, typename std::vector< T > const & ob) [related] — The following are templated classes. serialize a vector of some serializable content to the engine 📦
  • __EXPORT Engine & operator<<(Engine & ar, uint16 ob) [related] — no blurb in the docs.
  • __EXPORT Engine & operator<<(Engine & ar, uint32 ob) [related] — no blurb in the docs.
  • __EXPORT Engine & operator<<(Engine & ar, uint8 ob) [related] — no blurb in the docs.

✨ operator>> — the "get it back out" crew 🦋

  • __EXPORT Engine & operator>>(Engine & ar, BaseObject & ob) [related] — no extra blurb given.
  • __EXPORT Engine & operator>>(Engine & ar, BaseObject *& ob) [related] — pointer-to-pointer, and still no extra blurb.
  • __EXPORT Engine & operator>>(Engine & ar, bool & ob) [related] — no blurb.
  • __EXPORT Engine & operator>>(Engine & ar, double & ob) [related] — no blurb.
  • __EXPORT Engine & operator>>(Engine & ar, float & ob) [related] — no blurb.
  • __EXPORT Engine & operator>>(Engine & ar, int16 & ob) [related] — no blurb.
  • __EXPORT Engine & operator>>(Engine & ar, int32 & ob) [related] — no blurb.
  • __EXPORT Engine & operator>>(Engine & ar, int8 & ob) [related] — no blurb, bestie.
  • template<class x , class y > Engine & operator>>(Engine & ar, std::pair< x, y > & ob) [related] — deserialize a pair of some serializable content to the engine. 💞
  • __EXPORT Engine & operator>>(Engine & ar, std::string & ob) [related] — no extra description given.
  • __EXPORT Engine & operator>>(Engine & ar, String & ob) [related] — no extra description given.
  • template<class T > Engine & operator>>(Engine & ar, typename std::deque< T > & ob) [related] — deserialize a deque of deserializable content from an engine. 🧺
  • template<class Key , class Value > Engine & operator>>(Engine & ar, typename std::map< Key, Value > & ob) [related] — deserialize a map with keys/values which both are serializeable from an engine. 🗺️
  • template<class T > Engine & operator>>(Engine & ar, typename std::vector< T > & ob) [related] — deserialize a vector of deserializable content from an engine. 📦
  • __EXPORT Engine & operator>>(Engine & ar, uint16 & ob) [related] — no blurb in the docs.
  • __EXPORT Engine & operator>>(Engine & ar, uint32 & ob) [related] — no blurb in the docs.
  • __EXPORT Engine & operator>>(Engine & ar, uint8 & ob) [related] — no blurb in the docs.
🌈 that's the whole friend list, all 34 of them, exactly as the docs hand them over. no cap.

👑 AUTHOR

Generated automatically by Doxygen for GNU CommonC++ from the source code.

okay that's a wrap, bestie 💖 this page came to you from GNU CommonC++, dated Sun Dec 27 2020, and it's page ost::Engine(3) — thanks for reading all the way to the end, you're literally the main character of this manpage 🫶✨🌸

📦 where this page comes from