ost::Dir(3)

πŸ“¦ version 1.8.1, in ubuntu jammy

πŸ’– ost::Dir πŸ’–

okay bestie, gather round, because today we're reading the manual page for ost::Dir, straight out of the Library Functions Manual (section 3, if you're keeping score πŸŽ€). it's a lowkey lil class but it's doing SO much, i promise.


✨ NAME ✨

ost::Dir β€” a low level portable directory class. that's it, that's the whole name section. short, sweet, iconic. πŸ’…


πŸ¦‹ SYNOPSIS πŸ¦‹

#include <file.h>

Inherits ost::File. yes bestie, it's giving family tree energy. 🌳

🌸 Public Member Functions

Dir (const char *name=NULL)
void open (const char *name)
void close (void)
virtual ~Dir ()
const char * getName (void)
const char * operator++ ()
const char * operator++ (int)
const char * operator* ()
bool rewind (void)
bool operator! ()
bool isValid (void)

⭐ Static Public Member Functions

static bool create (const char *path, Attr attr=attrGroup)
static bool remove (const char *path)
static bool setPrefix (const char *path)
static bool getPrefix (char *path, size_t size=256)

🌈 Additional Inherited Members

(they're inherited, so like, they came with the genes, not our problem πŸ’€)


πŸ‘‘ DETAILED DESCRIPTION πŸ‘‘

A low level portable directory class.

Used to support ccstd Directory container. This provides a basic mechanism for allocating and accessing file entries.

Author β€” David Sugar dyfet@ostel.com

low level directory access class. 🫢


πŸŽ€ CONSTRUCTOR & DESTRUCTOR DOCUMENTATION πŸŽ€

ost::Dir::Dir (const char * name = NULL)

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


πŸ’œ MEMBER FUNCTION DOCUMENTATION πŸ’œ

void ost::Dir::close (void)

static bool ost::Dir::create (const char * path, Attr attr = attrGroup) [static]

const char* ost::Dir::getName (void)

static bool ost::Dir::getPrefix (char * path, size_t size = 256) [static]

bool ost::Dir::isValid (void)

void ost::Dir::open (const char * name)

bool ost::Dir::operator! () [inline]

const char* ost::Dir::operator* ()

const char* ost::Dir::operator++ () [inline]

const char* ost::Dir::operator++ (int) [inline]

static bool ost::Dir::remove (const char * path) [static]

bool ost::Dir::rewind (void)

static bool ost::Dir::setPrefix (const char * path) [static]


πŸ’– AUTHOR πŸ’–

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


and that's the whole vibe check bestie ✨ no cap, every single function is still here, every [static] and [inline] marker survived, and the author credit is untouched because we respect the source. this page came from GNU CommonC++, dated Sun Dec 27 2020, and it's the ost::Dir(3) page from the Library Functions Manual. slay, go read a directory, mwah πŸ’…πŸ’–πŸ¦‹

πŸ“¦ where this page comes from