ost::File(3)

📦 version 1.8.1, in ubuntu jammy

💖 ost::File — the ost::File(3) page, but make it cute 💖

okay so bestie, this is the manual page for ost::File from GNU CommonC++, living in section 3 of the manual. It's giving "base class energy" — everything file-ish inherits from it. Let's get into it. 🦋

✨ NAME ✨

ost::File — the blueprint class for files. no cap, that's literally the whole NAME section.

🌸 SYNOPSIS 🌸

#include <file.h>

Inherited by ost::Dir, and ost::RandomFile. (yes queen, they're the children 💅)

🎀 Classes

  • struct _fcb

🎀 Public Types

enum Error { errSuccess = 0, errNotOpened, errMapFailed, errInitFailed,
    errOpenDenied, errOpenFailed, errOpenInUse, errReadInterrupted,
    errReadIncomplete, errReadFailure, errWriteInterrupted,
    errWriteIncomplete, errWriteFailure, errLockFailure, errExtended }
enum Access { accessReadOnly = O_RDONLY, accessWriteOnly = O_WRONLY,
    accessReadWrite = O_RDWR }
enum Open { openReadOnly = O_RDONLY, openWriteOnly = O_WRONLY,
    openReadWrite = O_RDWR, openAppend = O_WRONLY | O_APPEND, openSync =
    O_RDWR, openTruncate = O_RDWR | O_TRUNC }
enum Attr { attrInvalid = 0, attrPrivate = 0400 | 0200, attrGroup =
    attrPrivate | 0040 | 0020, attrPublic = attrGroup | 0004 | 0002 }
enum Mapping { mappedRead = accessReadOnly, mappedWrite =
    accessWriteOnly, mappedReadWrite = accessReadWrite }
enum Complete { completionImmediate, completionDelayed,
    completionDeferred }
typedef enum Error Error
typedef enum Access Access
typedef enum Open Open
typedef enum Attr Attr
typedef enum Complete Complete
typedef enum Mapping Mapping

🎀 Static Public Member Functions

static const char * getExtension (const char *path)
static const char * getFilename (const char *path)
static char * getFilename (const char *path, char *buffer, size_t
    size=64)
static char * getDirname (const char *path, char *buffer, size_t
    size=256)
static char * getRealpath (const char *path, char *buffer, size_t
    size=256)

🎀 Protected Types

typedef struct ost::File::_fcb fcb_t

💜 Member Typedef Documentation 💜

the way that all of these are just the enums getting a little nickname so you can use them as types. iconic behavior honestly.

  • typedef enum Access ost::File::Access
  • typedef enum Attr ost::File::Attr
  • typedef enum Complete ost::File::Complete
  • typedef enum Error ost::File::Error
  • typedef struct ost::File::_fcb ost::File::fcb_t [protected]
  • typedef enum Mapping ost::File::Mapping
  • typedef enum Open ost::File::Open

🌈 Member Enumeration Documentation 🌈

🌟 enum ost::File::Access

Enumerator:

  • accessReadOnly
  • accessWriteOnly
  • accessReadWrite

🌟 enum ost::File::Attr

Enumerator:

  • attrInvalid
  • attrPrivate
  • attrGroup
  • attrPublic

🌟 enum ost::File::Complete

Enumerator:

  • completionImmediate
  • completionDelayed
  • completionDeferred

🌟 enum ost::File::Error

Enumerator:

  • errSuccess
  • errNotOpened
  • errMapFailed
  • errInitFailed
  • errOpenDenied
  • errOpenFailed
  • errOpenInUse
  • errReadInterrupted
  • errReadIncomplete
  • errReadFailure
  • errWriteInterrupted
  • errWriteIncomplete
  • errWriteFailure
  • errLockFailure
  • errExtended

that's fifteen error codes bestie, we are NOT skimping on the enumeration 💅

🌟 enum ost::File::Mapping

Enumerator:

  • mappedRead
  • mappedWrite
  • mappedReadWrite

🌟 enum ost::File::Open

Enumerator:

  • openReadOnly
  • openWriteOnly
  • openReadWrite
  • openAppend
  • openSync
  • openTruncate

🫶 Member Function Documentation 🫶

All five of these are [static], so you can call them without making an object first. main character functions fr.

⭐ static char* ost::File::getDirname (const char * path, char * buffer, size_t size = 256) [static]

⭐ static const char* ost::File::getExtension (const char * path) [static]

⭐ static const char* ost::File::getFilename (const char * path) [static]

⭐ static char* ost::File::getFilename (const char * path, char * buffer, size_t size = 64) [static]

⭐ static char* ost::File::getRealpath (const char * path, char * buffer, size_t size = 256) [static]

👑 Author 👑

Generated automatically by Doxygen for GNU CommonC++ from the source code. (not me getting auto-generated, the robots wrote my whole lore 🙈)

and that's the whole page bestie — ost::File(3) from the GNU CommonC++ Library Functions Manual, dated Sun Dec 27 2020. slay, periodt, go read file.h 💖✨🎀🦋

📦 where this page comes from