zipios::FileEntry(3)

📦

version 0.1.5.9+cvs.2007.04.28 · 2 versions

0.1.5.9+cvs.2007.04.28 · ubuntu jammy (latest)
0.1.5.9+cvs.2007.04.28 · ubuntu noble

zipios::FileEntry 💖

okay bestie, welcome to the Library Functions Manual for zipios::FileEntry — this is a C++ library page, so grab a boba and let's get into it ✨

✨ NAME ✨

zipios::FileEntry — A FileEntry represents an entry in a FileCollection. 🗂️

🌸 SYNOPSIS 🌸

#include <fileentry.h>

Inherited by zipios::BasicEntry, and zipios::ZipLocalEntry. 👑

🦋 Classes 🦋

class MatchFileName — a function object you use with the STL find_if algorithm to hunt down a FileEntry in a container whose name (as grabbed with FileEntry::getFileName()) is identical to the name you gave the MatchName constructor. 🔍
class MatchName — same vibe, function object for the STL find_if algorithm, finds a FileEntry in a container whose name (as grabbed with FileEntry::getName()) is identical to the name you gave the MatchName constructor. 💅

💜 Public Member Functions 💜

virtual string getComment () const =0 — returns the comment of the entry, if it has one. 💬
virtual uint32 getCompressedSize () const =0 — returns the compressed size of the entry. 📦
virtual uint32 getCrc () const =0 — returns the Crc for the entry, if it has one. 🧮
virtual vector< unsigned char > getExtra () const =0 — returns a vector of bytes of extra data that may be stored with the entry. 🎀
virtual StorageMethod getMethod () const =0 — returns the method used to store the entry in the FileCollection. 🛠️
virtual string getName () const =0 — returns the full filename of the entry, including a path if the entry is stored in a subfolder. 📁
virtual string getFileName () const =0 — returns the filename of the entry. 🏷️
virtual uint32 getSize () const =0 — returns the (uncompressed) size of the entry data. 📏
virtual int getTime () const =0 — returns the date and time of FIXME: what? " ⏰
virtual bool isValid () const =0 — any method or operator that initializes a FileEntry may set a flag that says whether the read entry is valid or not. 🚦
virtual bool isDirectory () const =0 — returns true if the entry is a directory. 📂
virtual void setComment (const string &comment)=0 — sets the comment field for the FileEntry. ✍️
virtual void setCompressedSize (uint32 size)=0 — set the compressed size field of the entry. 📐
virtual void setCrc (uint32 crc)=0 — sets the crc field. 🔢
virtual void setExtra (const vector< unsigned char > &extra)=0 — sets the extra field. 🎁
virtual void setMethod (StorageMethod method)=0 — sets the storage method field for the entry. ⚙️
virtual void setName (const string &name)=0 — sets the name field for the entry. 🖊️
virtual void setSize (uint32 size)=0 — sets the size field for the entry. 📊
virtual void setTime (int time)=0 — sets the time field for the entry. 🕰️
virtual string toString () const =0 — returns a human-readable string representation of the entry. 🪞
virtual FileEntry * clone () const =0 — create a heap allocated clone of the object this method is called for. 🧬
virtual ~FileEntry () — FileEntry destructor. 💀

🫶 Protected Member Functions 🫶

void ref () const
unsigned int unref () const

🍓 Protected Attributes 🍓

ReferenceCount< FileEntry > _refcount

🌈 Friends 🌈

class SimpleSmartPointer< FileEntry >
class SimpleSmartPointer< const FileEntry >

👑 Detailed Description 👑

A FileEntry represents an entry in a FileCollection. 🗃️

The interface is a copy of the ZipEntry interface from the java.util.zip package. The name has been changed to FileEntry, as FileCollection is a more general abstraction, that covers other types of file collections than just zip files. no cap. 🧚

Definition at line 52 of file fileentry.h. 📍

💅 Constructor & Destructor Documentation 💅

`virtual zipios::FileEntry::~FileEntry () [inline], [virtual]`

FileEntry destructor. say bye bestie 😭

Definition at line 163 of file fileentry.h. 📍

🔥 Member Function Documentation 🔥

`virtual FileEntry* zipios::FileEntry::clone () const [pure 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. (yes, that's on you, own it 🫡)

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

Implemented in zipios::ZipCDirEntry, zipios::ZipLocalEntry, and zipios::BasicEntry.

`virtual string zipios::FileEntry::getComment () const [pure 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.

Implemented in zipios::ZipCDirEntry, zipios::ZipLocalEntry, and zipios::BasicEntry.

`virtual uint32 zipios::FileEntry::getCompressedSize () const [pure virtual]`

Returns the compressed size of the entry. If the entry is not stored in a compressed format, the uncompressed size is returned. 🤏

Returns the compressed size of the entry. If the entry is stored without compression the uncompressed size is returned.

Implemented in zipios::ZipLocalEntry, and zipios::BasicEntry.

`virtual uint32 zipios::FileEntry::getCrc () const [pure virtual]`

Returns the Crc for the entry, if it has one. FIXME: what is returned if it doesn't have one? 🤔 (the original really said that, I'm just the messenger 💀)

Returns the Crc for the entry, if it has one.

Implemented in zipios::ZipLocalEntry, and zipios::BasicEntry.

`virtual vector< unsigned char > zipios::FileEntry::getExtra () const [pure virtual]`

Returns a vector of bytes of extra data that may be stored with the entry. 🎒

Returns A vector< unsigned char > of extra bytes that may potentially be associated with an entry.

Implemented in zipios::ZipLocalEntry, and zipios::BasicEntry.

`virtual string zipios::FileEntry::getFileName () const [pure virtual]`

Returns the filename of the entry. 🏷️

Returns Returns the filename of the entry.

Implemented in zipios::ZipLocalEntry, and zipios::BasicEntry.

`virtual StorageMethod zipios::FileEntry::getMethod () const [pure virtual]`

Returns the method used to store the entry in the FileCollection. 🧰

Returns the storage method used to store the entry in the collection.

See also StorageMethod.

Implemented in zipios::ZipLocalEntry, and zipios::BasicEntry.

`virtual string zipios::FileEntry::getName () const [pure virtual]`

Returns the full filename of the entry, including a path if the entry is stored in a subfolder. 🗺️

Returns the filename of the entry, including path if the entry is stored in a sub-folder.

Implemented in zipios::ZipLocalEntry, and zipios::BasicEntry.

`virtual uint32 zipios::FileEntry::getSize () const [pure virtual]`

Returns the (uncompressed) size of the entry data. 🫧

Returns Returns the (uncompressed) size of the entry.

Implemented in zipios::ZipLocalEntry, and zipios::BasicEntry.

`virtual int zipios::FileEntry::getTime () const [pure virtual]`

Returns the date and time of FIXME: what? ⏳

Returns the date and time of the entry.

Implemented in zipios::ZipLocalEntry, and zipios::BasicEntry.

`virtual bool zipios::FileEntry::isDirectory () const [pure virtual]`

Returns true if the entry is a directory. A directory entry is an entry which name ends with a separator ('/' for Unix systems, '\' for Windows and DOS systems. 📂

Returns true if the entry is a directory.

Implemented in zipios::ZipLocalEntry, and zipios::BasicEntry.

`virtual bool zipios::FileEntry::isValid () const [pure virtual]`

Any method or operator that initializes a FileEntry may set a flag, that specifies whether the read entry is valid or not. If it isn't this method returns false. 🚩

Returns true if the FileEntry has been parsed succesfully.

Implemented in zipios::ZipLocalEntry, and zipios::BasicEntry.

`virtual void zipios::FileEntry::setComment (const string & comment) [pure virtual]`

Sets the comment field for the FileEntry. 💬

Parameters comment — string with the new comment.

Implemented in zipios::ZipCDirEntry, zipios::ZipLocalEntry, and zipios::BasicEntry.

`virtual void zipios::FileEntry::setCompressedSize (uint32 size) [pure virtual]`

Set the compressed size field of the entry. 📦

Parameters size — value to set the compressed size field of the entry to.

Implemented in zipios::ZipLocalEntry, and zipios::BasicEntry.

`virtual void zipios::FileEntry::setCrc (uint32 crc) [pure virtual]`

Sets the crc field. 🔢

Parameters crc — value to set the crc field to.

Implemented in zipios::ZipLocalEntry, and zipios::BasicEntry.

`virtual void zipios::FileEntry::setExtra (const vector< unsigned char > & extra) [pure virtual]`

Sets the extra field. 🎁

Parameters extra — the extra field is set to this value.

Implemented in zipios::ZipLocalEntry, and zipios::BasicEntry.

`virtual void zipios::FileEntry::setMethod (StorageMethod method) [pure virtual]`

Sets the storage method field for the entry. ⚙️

Parameters method — the method field is set to the specified value.

Implemented in zipios::ZipLocalEntry, and zipios::BasicEntry.

`virtual void zipios::FileEntry::setName (const string & name) [pure virtual]`

Sets the name field for the entry. 🖊️

Parameters name — the name field is set to the specified value.

Implemented in zipios::ZipLocalEntry, and zipios::BasicEntry.

`virtual void zipios::FileEntry::setSize (uint32 size) [pure virtual]`

Sets the size field for the entry. 📊

Parameters size — the size field is set to this value.

Implemented in zipios::ZipLocalEntry, and zipios::BasicEntry.

`virtual void zipios::FileEntry::setTime (int time) [pure virtual]`

Sets the time field for the entry. 🕰️

Parameters time — the time field is set to the specified value.

Implemented in zipios::ZipLocalEntry, and zipios::BasicEntry.

`virtual string zipios::FileEntry::toString () const [pure virtual]`

Returns a human-readable string representation of the entry. 🪞

Returns a human-readable string representation of the entry.

Implemented in zipios::ZipCDirEntry, zipios::ZipLocalEntry, and zipios::BasicEntry.

🎀 Author 🎀

Generated automatically by Doxygen for Zipios++ from the source code. (yes bestie, a robot wrote it, but I translated it into vibes ✨)

Zipios++ 🌸 Tue Mar 24 2020 🌸 zipios::FileEntry(3)

and that's the whole page, periodt 💅🫶 go forth and file-entry, bestie 💖🦋

📦 where this page comes from

ubuntu jammy: libzipios++-dev 0.1.5.9+cvs.2007.04.28-11build1 · LGPL-2.0-or-later
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on 2026-10-14: a language model's rewrite of the original, under its terms