zipios::ZipCDirEntry(3)

📦
version 0.1.5.9+cvs.2007.04.28 · 2 versions
, in ubuntu jammy

💖 zipios::ZipCDirEntry — Library Functions Manual, section 3 💖

okay bestie, pull up a chair, because we're about to get intimate with a very specific little C++ class from Zipios++. It's zipios::ZipCDirEntry, it lives in section 3 of the manual (the Library Functions Manual, iykyk), and honestly? It's giving "supporting character who carries the whole plot." 🎀

✨ NAME ✨

zipios::ZipCDirEntry — a specialization of ZipLocalEntry that adds fields for storing the extra information that is only present in the entries in the zip central directory and not in the local entry headers. 💅

Like, think of it this way: the local headers are the trailer, and this class is the director's cut with the deleted scenes. central directory exclusives only, no cap ✨

🌸 SYNOPSIS 🌸

#include <ziphead.h>

Inherits zipios::ZipLocalEntry.

👑 Public Member Functions 👑

  • ZipCDirEntry (const string &_filename='', const string &_file_comment='', const vector< unsigned char > &_extra_field=vector< unsigned char >()) — the constructor, with all three params defaulted, so you can absolutely just roll up empty-handed. 🫶
  • void setDefaultWriter () — sets the default writer. that's it, that's the tweet. ⭐
  • ZipCDirEntry & operator= (const class ZipCDirEntry &src) — assignment operator, taking a const class ZipCDirEntry &src. copy-paste but make it official.
  • virtual string toString () const — returns a human-readable string representation of the entry. it's literally the entry's "tell me about yourself" moment. 💖
  • virtual string getComment () const — returns the comment of the entry, if it has one.
  • virtual void setComment (const string &comment) — sets the comment field for the FileEntry.
  • virtual uint32 getLocalHeaderOffset () const — hands you the local header offset, no explanation, no drama. 🦋
  • virtual void setLocalHeaderOffset (uint32 offset) — sets that local header offset. the yin to the previous yang.
  • int getCDirHeaderSize () const — returns the central directory header size, as an int. yes, it's spelled with a capital D and a lowercase ir, we don't make the rules. 😭
  • virtual FileEntry * clone () const — create a heap allocated clone of the object this method is called for. main character energy, duplicated. ✨

🫶 Friends 🫶

  • istream & operator>> (istream &is, ZipCDirEntry &zcdh)
  • ostream & operator<< (ostream &os, const ZipCDirEntry &zcdh)
  • bool operator== (const ZipLocalEntry &zlh, const ZipCDirEntry &ze)

they're friends, they get special access, that's the whole vibe. 💜

🌈 Additional Inherited Members 🌈

(yes queen, there are more — they come from up the inheritance chain. ZipLocalEntry said "here, take these too.") 🧚

💅 Detailed Description 💅

Specialization of ZipLocalEntry, that add fields for storing the extra information, that is only present in the entries in the zip central directory and not in the local entry headers.

Definition at line 102 of file ziphead.h.

⭐ Member Function Documentation ⭐

🎀 FileEntry * zipios::ZipCDirEntry::clone () const [virtual] 🎀

Create a heap allocated clone of the object this method is called for. The caller is responsible for deallocating the clone when he is done with it.

⚠️ bestie, listen: you are on the hook for deleteing this clone. the class made it, but the class is not cleaning it up. that's a you problem now, and by "you problem" I mean memory leak if you forget. 💀

Returns

A heap allocated copy of the object this method is called for.

Reimplemented from zipios::ZipLocalEntry.

Definition at line 231 of file ziphead.cpp.

🍓 string zipios::ZipCDirEntry::getComment () const [virtual] 🍓

Returns the comment of the entry, if it has one. Otherwise it returns an empty string.

Returns

the comment associated with the entry, if there is one.

Reimplemented from zipios::ZipLocalEntry.

Definition at line 199 of file ziphead.cpp.

💖 void zipios::ZipCDirEntry::setComment (const string & comment) [virtual] 💖

Sets the comment field for the FileEntry.

Parameters

  • comment — string with the new comment.

Reimplemented from zipios::ZipLocalEntry.

Definition at line 212 of file ziphead.cpp.

🦋 string zipios::ZipCDirEntry::toString () const [virtual] 🦋

Returns a human-readable string representation of the entry.

Returns

a human-readable string representation of the entry.

Reimplemented from zipios::ZipLocalEntry.

Definition at line 218 of file ziphead.cpp.

👑 Author 👑

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

and that's the whole page, bestie. no notes, ate, periodt. 💅✨

🌸 this has been Zipios++, on Tue Mar 24 2020, page zipios::ZipCDirEntry(3) — go forth and central-directory responsibly. 🎀

📦 where this page comes from