BLFile Class Reference

A thin abstraction over a native OS file IO [C++ API].

A thin wrapper around a native OS file support. The file handle is always intptr_t and it refers to either a file descriptor on POSIX targets and file handle on Windows targets.

Member Functions

BLFile(const BLFile& other) = delete

BLFile& operator=(const BLFile& other) = delete

Construction & Destruction

BLFile()

BLFile(BLFile&& other)

BLFile(intptr_t handle)

BLFile& operator=(BLFile&& other)

~BLFile()

Common Functionality

void swap(BLFile& other)

Interface

bool isOpen() const

BLResult open(const char* fileName, BLFileOpenFlags openFlags)

BLResult close()

BLResult seek(int64_t offset, BLFileSeekType seekType)

BLResult seek(int64_t offset, BLFileSeekType seekType, int64_t* positionOut)

BLResult read(void* buffer, size_t n, size_t* bytesReadOut)

BLResult write(const void* buffer, size_t n, size_t* bytesWrittenOut)

BLResult truncate(int64_t maxSize)

BLResult getSize(uint64_t* sizeOut)

Additional Inherited Members

 Public Attributes inherited from BLFileCore

intptr_t handle

Member Function Documentation

bool BLFile::isOpen() const

Tests whether the file is open.

BLResult BLFile::close()

Closes the file (if open) and sets the file handle to -1.