VECTOR_BLF_COMPRESSEDFILE(3)

📦 version 2.4.2, in arch rolling

💖 NAME 💖

Vector::BLF::CompressedFile — this is the page from the Library Functions Manual, bestie. It's a compressed input/output file stream class, and the docs say it's thread-safe.

✨ SYNOPSIS ✨

#include <CompressedFile.h>

Inherits Vector::BLF::AbstractFile.

🎀 Public Member Functions 🎀

  • CompressedFile (const CompressedFile &)=delete — copy constructor? literally deleted, not invited to the group chat 💀
  • CompressedFile & operator= (const CompressedFile &)=delete — copy assignment? also deleted, no cap
  • CompressedFile (CompressedFile &&)=delete — move constructor? deleted too, bestie
  • CompressedFile & operator= (CompressedFile &&)=delete — move assignment? yep, deleted
  • std::streamsize gcount () const override — grab the number of characters from the last read operation
  • void read (char *s, std::streamsize n) override — read a block of data
  • std::streampos tellg () override — tell me the read position, bestie
  • void seekg (std::streamoff off, const std::ios_base::seekdir way=std::ios_base::cur) override — set the input position
  • void write (const char *s, std::streamsize n) override — write a block of data
  • std::streampos tellp () override — tell me the write position
  • bool good () const override — vibe check the stream state
  • bool eof () const override — check whether eofbit is set
  • virtual void open (const char *filename, std::ios_base::openmode openMode) — open the file
  • virtual bool is_open () const — is the file open?
  • virtual void close () — close the file
  • virtual void seekp (std::streampos pos) — set the output position

🌈 Public Member Functions inherited from Vector::BLF::AbstractFile 🌈

  • AbstractFile (const AbstractFile &)=default — default copy constructor
  • AbstractFile & operator= (const AbstractFile &)=default — default copy assignment
  • AbstractFile (AbstractFile &&)=default — default move constructor
  • AbstractFile & operator= (AbstractFile &&)=default — default move assignment
  • virtual void skipp (std::streamsize s) final — skip business, inherited and marked final

🦋 DETAILED DESCRIPTION 🦋

CompressedFile (Input/output file stream)

This class is thread-safe. Periodt. 💅

👑 MEMBER FUNCTION DOCUMENTATION 👑

💖 void Vector::BLF::CompressedFile::close () [virtual]

Close file. That's the whole assignment. Shut it down.

🦋 bool Vector::BLF::CompressedFile::eof () const [override], [virtual]

Check whether eofbit is set.

Returns: true if eofbit is set.

Implements: Vector::BLF::AbstractFile.

✨ std::streamsize Vector::BLF::CompressedFile::gcount () const [override], [virtual]

Get characters returned by last read operation.

Returns: Number of characters.

Implements: Vector::BLF::AbstractFile.

🌸 bool Vector::BLF::CompressedFile::good () const [override], [virtual]

Check whether state of stream is good. Literally the stream's vibe check.

Returns: true if no error flags are set.

Implements: Vector::BLF::AbstractFile.

🎀 bool Vector::BLF::CompressedFile::is_open () const [virtual]

is file open?

Returns: true if file is open.

🫶 void Vector::BLF::CompressedFile::open (const char * filename, std::ios_base::openmode openMode) [virtual]

open file.

Parameters:

  • filename — file name
  • openMode — open in read or write mode

🔥 void Vector::BLF::CompressedFile::read (char * s, std::streamsize n) [override], [virtual]

Read block of data.

This operation blocks until the data is available.

Parameters:

  • s — Pointer to data
  • n — Requested size of data

Implements: Vector::BLF::AbstractFile.

🌈 void Vector::BLF::CompressedFile::seekg (std::streamoff off, const std::ios_base::seekdir way = std::ios_base::cur) [override], [virtual]

Set position in input sequence.

Parameters:

  • off — Offset
  • way — Direction

Implements: Vector::BLF::AbstractFile.

💜 void Vector::BLF::CompressedFile::seekp (std::streampos pos) [virtual]

Set position in output sequence.

Parameters:

  • pos — Position

⭐ std::streampos Vector::BLF::CompressedFile::tellg () [override], [virtual]

Get position in input sequence.

Returns: Read position.

Implements: Vector::BLF::AbstractFile.

🍓 std::streampos Vector::BLF::CompressedFile::tellp () [override], [virtual]

Get position in output sequence.

Returns: Write position.

Implements: Vector::BLF::AbstractFile.

🧚 void Vector::BLF::CompressedFile::write (const char * s, std::streamsize n) [override], [virtual]

Write block of data.

Parameters:

  • s — Pointer to data
  • n — Size of data

Implements: Vector::BLF::AbstractFile.

🌟 AUTHOR 🌟

Generated automatically by Doxygen for Vector BLF from the source code.

💖 Source/version: Vector BLF. Date: the footer didn't print one on this page, bestie. Stay compressed, stay iconic. 💅✨

📦 where this page comes from