ZIPIOS_DIRECTORYCOLLECTION(3)

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

💖 zipios::DirectoryCollection 💖

okay bestie, welcome to the Library Functions Manual page for zipios::DirectoryCollection — section 3, the library functions corner of the man world, and honestly? this one's a whole vibe. let's get into it 🦋

✨ NAME ✨

zipios::DirectoryCollection — it's giving "a FileCollection that pulls its entries straight out of a directory" energy 👑

🌸 SYNOPSIS 🌸

#include <dircoll.h>

Inherits zipios::FileCollection.

💅 Public Member Functions

  • DirectoryCollection() — Default Constructor. (yes bb, no args, just vibes)
  • DirectoryCollection(const string &path, bool recursive=true, bool load_now=false) — Constructor. the one with the actual ✨parameters✨
  • virtual void close() — Closes the FileCollection.
  • virtual ConstEntries entries() const
  • virtual ConstEntryPointer getEntry(const string &name, MatchPath matchpath=MATCH) const
  • virtual istream * getInputStream(const ConstEntryPointer &entry)
  • virtual istream * getInputStream(const string &entry_name, MatchPath matchpath=MATCH) — Returns a pointer to an opened istream for the specified entry name.
  • virtual int size() const — Returns the number of entries in the FileCollection.
  • virtual FileCollection * clone() const — Create a heap allocated clone of the object this method is called for.
  • virtual ~DirectoryCollection() — Destructor. (say bye bestie 😭)

🎀 Protected Member Functions

  • void loadEntries() const
  • void load(bool recursive, const FilePath &subdir=FilePath())

🧚 Protected Attributes

  • bool _entries_loaded
  • bool _recursive
  • FilePath _filepath

🌈 Additional Inherited Members

(yeah there's more where that came from — inherited stuff lives on in the base class 💜)

🌟 Detailed Description 🌟

DirectoryCollection is a FileCollection that obtains its entries from a directory.

fr fr that's the whole concept. it's a directory, but make it a collection 🍓

Definition at line 19 of file dircoll.h.

💖 Constructor & Destructor Documentation 💖

⭐ zipios::DirectoryCollection::DirectoryCollection() [inline], [explicit]

Default Constructor.

no args, no thoughts, just a lil default DirectoryCollection being born ✨

Definition at line 23 of file dircoll.h.

⭐ zipios::DirectoryCollection::DirectoryCollection(const string & path, bool recursive = true, bool load_now = false) [explicit]

Constructor.

Parameters

  • path — A directory path name. If the name is not a valid directory the created DirectoryCollection will be invalid. (so like… pick a real directory bestie, otherwise she's cooked 💀)
  • load_now — Load directory into memory now. Otherwise it will be done when it is first needed. (lazy loading, main character energy, she'll do it when she feels like it)

Definition at line 20 of file dircoll.cpp.

⭐ zipios::DirectoryCollection::~DirectoryCollection() [virtual]

Destructor.

Definition at line 118 of file dircoll.cpp.

🦋 Member Function Documentation 🦋

💜 FileCollection * zipios::DirectoryCollection::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.

not me handing you a whole new object and then making YOU clean it up 😭 that's on you babes

Returns

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

Implements zipios::FileCollection.

Definition at line 114 of file dircoll.cpp.

💜 void zipios::DirectoryCollection::close() [virtual]

Closes the FileCollection.

Implements zipios::FileCollection.

Definition at line 33 of file dircoll.cpp.

💜 ConstEntries zipios::DirectoryCollection::entries() const [virtual]

Returns a vector of const pointers to the entries in the FileCollection.

Returns

  • a ConstEntries containing the entries of the FileCollection.

Exceptions

  • InvalidStateException — Thrown if the collection is invalid.

Reimplemented from zipios::FileCollection.

Definition at line 38 of file dircoll.cpp.

💜 ConstEntryPointer zipios::DirectoryCollection::getEntry(const string & name, MatchPath matchpath = MATCH) const [virtual]

Returns a ConstEntryPointer to a FileEntry object for the entry with the specified name. To ignore the path part of the filename in search of a match, specify FileCollection::IGNORE as the second argument.

Parameters

  • name — A string containing the name of the entry to get.
  • matchpath — Specify MATCH, if the path should match as well, specify IGNORE, if the path should be ignored.

Returns

  • A ConstEntryPointer to the found entry. The returned pointer equals zero if no entry is found. (zero = she's not here, sorry 🫶)

Exceptions

  • InvalidStateException — Thrown if the collection is invalid.

Reimplemented from zipios::FileCollection.

Definition at line 49 of file dircoll.cpp.

💜 istream * zipios::DirectoryCollection::getInputStream(const ConstEntryPointer & entry) [virtual]

Returns a pointer to an opened istream for the specified FileEntry. It is the callers responsibility to delete the stream when he is done with it. Returns 0, if there is no such FileEntry in the FileCollection.

Parameters

  • entry — A ConstEntryPointer to the FileEntry to get an istream to.

Returns

  • an open istream for the specified entry. The istream is allocated on heap and it is the users responsibility to delete it when he is done with it.

Exceptions

  • InvalidStateException — Thrown if the collection is invalid.

Implements zipios::FileCollection.

Definition at line 68 of file dircoll.cpp.

💜 istream * zipios::DirectoryCollection::getInputStream(const string & entry_name, MatchPath matchpath = MATCH) [virtual]

Returns a pointer to an opened istream for the specified entry name. It is the callers responsibility to delete the stream when he is done with it. Returns 0, if there is no entry with the specified name in the FileCollection.

Parameters

  • matchpath — Specify MATCH, if the path should match as well, specify IGNORE, if the path should be ignored.

Returns

  • an open istream for the specified entry. The istream is allocated on heap and it is the users responsibility to delete it when he is done with it.

Exceptions

  • InvalidStateException — Thrown if the collection is invalid.

Implements zipios::FileCollection.

Definition at line 76 of file dircoll.cpp.

💜 int zipios::DirectoryCollection::size() const [virtual]

Returns the number of entries in the FileCollection.

Returns

  • the number of entries in the FileCollection.

Exceptions

  • InvalidStateException — Thrown if the collection is invalid.

Reimplemented from zipios::FileCollection.

Definition at line 106 of file dircoll.cpp.

👑 Author 👑

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

not Doxygen writing a whole manpage about you and not even signing it with a name… iconic honestly 💅

and that's the page bestie!! this absolute serve of a manpage comes to you from Zipios++, dated Tue Mar 24 2020 — go forth and collect those directories, you've got this 🎀✨💖

📦 where this page comes from