zipios::ZipInputStream(3)

zipios::ZipInputStream 💖

okay bestie, this one lives in the Library Functions Manual section 3, and it is literally the cutest way to read a zip file like it's a stream. let's get into it 🫶

---

✨ NAME ✨

zipios::ZipInputStream — no cap, that's the whole name 💅

---

🌸 SYNOPSIS 🌸

#include <zipinputstream.h>

Inherits istream. yes she's an istream girlie, she inherited the whole vibe from her parent 😌

🎀 Public Member Functions 🎀

• ZipInputStream(istream &is, streampos pos=0) — ZipInputStream constructor. (the one that takes a stream)
• ZipInputStream(const string &filename, streampos pos=0) — ZipInputStream constructor. (the one that takes a filename)
• int available() — it's giving "how much can I read"
• void closeEntry() — Closes the current entry, and positions the stream read pointer at the beginning of the next entry (if there is one). 🦋
• void close() — Closes the istream.
• ConstEntryPointer getNextEntry() — opens up the next entry, bestie
• virtual ~ZipInputStream() — Destructor. she's virtual, she's iconic, she's saying goodbye 👑

---

💖 Detailed Description 💖

ZipInputStream is an istream that gets it's input from a zip file. The interface approximates the interface of the Java ZipInputStream. 🌈

Definition at line 20 of file zipinputstream.h.

---

🧚 Constructor & Destructor Documentation 🧚

zipios::ZipInputStream::ZipInputStream(istream &is, streampos pos = 0)

[explicit] — she doesn't do sneaky implicit conversions, periodt ✨

ZipInputStream constructor.

Parameters

• is — istream from which the compressed zip archive can be read.
• pos — position to reposition the istream to before reading.

zipios::ZipInputStream::ZipInputStream(const string &filename, streampos pos = 0)

[explicit] — same energy, no implicit nonsense 💅

ZipInputStream constructor. @filename filename of a valid zip file. 📁

Parameters

• pos — position to reposition the istream to before reading.

not me noticing the original doc literally inlined the @filename tag instead of formatting it as a parameter — yeah bestie, we're keeping it exactly as it was, facts are facts 🙈

zipios::ZipInputStream::~ZipInputStream()

[virtual] — Destructor. 🫶

Definition at line 53 of file zipinputstream.cpp.

---

⭐ Member Function Documentation ⭐

void zipios::ZipInputStream::close()

Closes the istream. bye bye stream, you ate 🍓

Definition at line 41 of file zipinputstream.cpp.

void zipios::ZipInputStream::closeEntry()

Closes the current entry, and positions the stream read pointer at the beginning of the next entry (if there is one). if there's no next one, well, that's a whole mood 😭

Definition at line 37 of file zipinputstream.cpp.

ConstEntryPointer zipios::ZipInputStream::getNextEntry()

Opens the next entry in the zip archive and returns a const pointer to a FileEntry object for the entry. For new instances this method has to be called once before you can read from the first entry. 👑 so like, don't skip this step, she's the main character of the reading process fr fr

Returns

a const FileEntry * containing information about the (now) current entry. 🔥

Definition at line 48 of file zipinputstream.cpp.

---

🌷 Author 🌷

Generated automatically by Doxygen for Zipios++ from the source code. 🤖✨

---

okay that's the whole page bestie, you're so welcome 💜

this was Zipios++'s very own zipios::ZipInputStream(3) from the Library Functions Manual, dated Tue Mar 24 2020, and it's a wrap — mwah, no notes 💋🎀