Vector::BLF::File(3)

📦 version 2.4.2, in arch rolling

💖 NAME 💖

Vector::BLF::File — hii bestie, welcome to the Vector::BLF::File(3) page from the Library Functions Manual ✨ This one is literally the BLF file object, and it's giving main-character file I/O energy 💅

🌸 SYNOPSIS 🌸

#include <File.h>

🎀 Public Member Functions 🎀

virtual void open (const char *filename, const std::ios_base::openmode mode=std::ios_base::in)
virtual void open (const std::string &filename, const std::ios_base::openmode mode=std::ios_base::in)
virtual bool is_open () const
virtual bool good () const
virtual bool eof () const
virtual ObjectHeaderBase * read ()
virtual void write (ObjectHeaderBase *ohb)
virtual void close ()
virtual uint32_t defaultLogContainerSize () const
virtual void setDefaultLogContainerSize (uint32_t defaultLogContainerSize)

🦋 Static Public Member Functions 🦋

static ObjectHeaderBase * createObject (ObjectType type)

🍓 Public Attributes 🍓

FileStatistics fileStatistics {}
uint64_t currentUncompressedFileSize {}
std::atomic< uint32_t > currentObjectCount {}
int compressionLevel {1}
bool writeRestorePoints {true}

🌈 Detailed Description 🌈

Okay so File is literally the BLF version of std::fstream — same "open, read, write, close" bestie energy, but for BLFs 🦋 no cap.

🧚 Member Function Documentation 🧚

void Vector::BLF::File::close () [virtual]

Closes the file. Bye-bye, file handle 👋💅

ObjectHeaderBase * Vector::BLF::File::createObject (ObjectType type) [static]

Makes you a new object of the given type ⭐

Parameters

  • type — object type

Returns

  • new object

uint32_t Vector::BLF::File::defaultLogContainerSize () const [virtual]

Gets the default log container size, bestie 🎀

Returns

  • default log container size

bool Vector::BLF::File::eof () const [virtual]

Checks whether eofbit is set — aka are we at the end of the file? 😭

Returns

  • true if end-of-file reached

bool Vector::BLF::File::good () const [virtual]

Checks whether the stream state is good — no error flags, no drama ✨

Returns

  • true if no error flags set

bool Vector::BLF::File::is_open () const [virtual]

Is the file open? The people wanna know 👀

Returns

  • true if file is open

void Vector::BLF::File::open (const char * filename, const std::ios_base::openmode mode = std::ios_base::in) [virtual]

Opens the file using a const char * filename, honey 🍓

Parameters

  • filename — file name
  • mode — open mode, either in (read) or out (write)

void Vector::BLF::File::open (const std::string & filename, const std::ios_base::openmode mode = std::ios_base::in) [virtual]

Same open-file slay, but with a std::string filename this time 💖

Parameters

  • filename — file name
  • mode — open mode, either in (read) or out (write)

ObjectHeaderBase * Vector::BLF::File::read () [virtual]

Reads an object from the file 📖✨

Ownership is taken over from the library to the user. The user has to take care to delete the object — yes, that means you, bestie, gotta clean up 🧹😭

Todo: Use std::unique_ptr in future versions.

Returns

  • read object or nullptr

void Vector::BLF::File::setDefaultLogContainerSize (uint32_t defaultLogContainerSize) [virtual]

Sets the default log container size — customize that container, icon behavior 💅

Parameters

  • defaultLogContainerSize — default log container size

void Vector::BLF::File::write (ObjectHeaderBase * ohb) [virtual]

Writes an object to the file 🖊️🔥

Ownership is taken over from the user to the library. The object should not be further accessed any more — like, let it go, it's the library's problem now 🙈

Todo: Use std::unique_ptr in future versions.

Parameters

  • ohb — write object

👑 Member Data Documentation 👑

int Vector::BLF::File::compressionLevel {1}

Compression level 🗜️✨

zlib compression levels:

  • 0: Z_NO_COMPRESSION
  • 1: Z_BEST_SPEED
  • 9: Z_BEST_COMPRESSION

Vector BLF compression levels:

  • 0: no compression
  • 6: default compression
  • 10: maximum compression

std::atomic<uint32_t> Vector::BLF::File::currentObjectCount {}

Current number of objects read 🔢

Unknown115 is not counted. Don't ask, bestie, it's just not 💀

uint64_t Vector::BLF::File::currentUncompressedFileSize {}

Current uncompressed file size 📏

This includes the LogContainer headers, and the uncompressed content. So yeah, the headers are part of the vibe 🎀

FileStatistics Vector::BLF::File::fileStatistics {}

File statistics from the file header — contains total counts/sizes 🧮✨

bool Vector::BLF::File::writeRestorePoints {true}

Write restore points at file close — and yes, it's true by default ✅

🌸 Author 🌸

Generated automatically by Doxygen for Vector BLF from the source code. Yes, the robots wrote this one — we just gave it the group-chat makeover 💖

Mwah 💋 — this cutie comes from Vector BLF, page Vector::BLF::File(3). The footer didn't hand us a date, so no fake timestamp here, bestie 💅🫶

📦 where this page comes from