file.h(3)

📦 version 1.8.1, in ubuntu jammy

💖 file.h — bestie edition 💖

okay so this is file.h from the Library Functions Manual, and it's literally the header that gives you files and dynamic loader services. that's the whole vibe. let's get into it 🫶

✨ NAME ✨

file.h — files and dynamic loader services. that's it, that's the girl. 💅

🌸 SYNOPSIS 🌸

first up, the includes. you gotta pull in ALL of these, no skipping:

#include <cc++/config.h>
#include <cc++/missing.h>
#include <cc++/thread.h>
#include <cc++/exception.h>
#include <cstdio>
#include <dirent.h>
#include <sys/stat.h>
#include <sys/mman.h>
#include <sys/types.h>

🎀 Classes 🎀

here's the roster, and honestly? iconic lineup:

  • class ost::File — the main character. just... File.
  • struct ost::File::_fcb — a lil struct nested inside File. iykyk.
  • class ost::Dir — a low level portable directory class.
  • class ost::DirTree — a generic class to walk a hierarchical directory structure. she walks. 🚶‍♀️
  • class ost::RandomFile — the purpose of this class is to define a base class for low level random file access that is portable between Win32 and Posix systems. cross-platform queen 👑
  • class ost::ThreadFile — this class defines a database I/O file service that can be shared by multiple threads. sharing is caring fr fr
  • class ost::SharedFile — this class defines a database I/O file service that can be shared by multiple processes. now the processes are sharing, we love to see it
  • class ost::MappedFile — create and map a disk file into memory. it's giving memory-mapped ✨
  • class ost::DSO — the DSO dynamic loader class is used to load object files. loading... loading... 💀

🦋 Namespaces 🦋

just the one, and she's everywhere:

  • ost

🌈 Macros 🌈

these are all defined for you, don't come for me:

#define PATH_MAX   256
#define NAME_MAX   64
#define S_IRUSR   0400
#define S_IWUSR   0200
#define S_IRGRP   0040
#define S_IWGRP   0020
#define S_IROTH   0004
#define S_IWOTH   0002

⭐ Typedefs ⭐

  • typedef unsigned long ost::pos_t
  • typedef size_t ost::ccxx_size_t

💜 Detailed Description 💜

files and dynamic loader services. that's the description. short, sweet, ate. 💅

🔥 Macro Definition Documentation 🔥

here they are again because the docs said so, and we respect the docs:

  • #define NAME_MAX 64
  • #define PATH_MAX 256
  • #define S_IRGRP 0040
  • #define S_IROTH 0004
  • #define S_IRUSR 0400
  • #define S_IWGRP 0020
  • #define S_IWOTH 0002
  • #define S_IWUSR 0200

🧚 Author 🧚

generated automatically by Doxygen for GNU CommonC++ from the source code. not a human author, a robot did this, and honestly? she served. 🤖💖

okay bestie that's the whole page, no cap, every single flag and macro accounted for. this edition came from GNU CommonC++, dated Sun Dec 27 2020 — go forth and #include responsibly 🎀✨💅

📦 where this page comes from