Filesystem API

Filesystem utilities.

Namespaces

namespace BLFileSystem

Classes

struct BLFileCore

struct BLFileInfo

class BLFile

BLFile API Constants

enum BLFileInfoFlags : uint32_t

enum BLFileOpenFlags : uint32_t

enum BLFileSeekType : uint32_t

enum BLFileReadFlags : uint32_t

BLFile C API Functions

File read/write functionality is provided by BLFileCore in C API and wrapped by BLFile in C++ API.

BLResult blFileInit(BLFileCore* self)

BLResult blFileReset(BLFileCore* self)

BLResult blFileOpen(BLFileCore* self, const char* fileName, BLFileOpenFlags openFlags)

BLResult blFileClose(BLFileCore* self)

BLResult blFileSeek(BLFileCore* self, int64_t offset, BLFileSeekType seekType, int64_t* positionOut)

BLResult blFileRead(BLFileCore* self, void* buffer, size_t n, size_t* bytesReadOut)

BLResult blFileWrite(BLFileCore* self, const void* buffer, size_t n, size_t* bytesWrittenOut)

BLResult blFileTruncate(BLFileCore* self, int64_t maxSize)

BLResult blFileGetInfo(BLFileCore* self, BLFileInfo* infoOut)

BLResult blFileGetSize(BLFileCore* self, uint64_t* fileSizeOut)

BLFileSystem C API Functions

BLResult blFileSystemGetInfo(const char* fileName, BLFileInfo* infoOut)

BLResult blFileSystemReadFile(const char* fileName, BLArrayCore* dst, size_t maxSize, BLFileReadFlags readFlags)

BLResult blFileSystemWriteFile(const char* fileName, const void* data, size_t size, size_t* bytesWrittenOut)

Enumeration Type Documentation

BLFileInfoFlags : uint32_tenum

File information flags, used by BLFileInfo.

Constant	Description
BL_FILE_INFO_OWNER_R	File owner has read permission (compatible with 0400 octal notation).
BL_FILE_INFO_OWNER_W	File owner has write permission (compatible with 0200 octal notation).
BL_FILE_INFO_OWNER_X	File owner has execute permission (compatible with 0100 octal notation).
BL_FILE_INFO_OWNER_MASK	A combination of BL_FILE_INFO_OWNER_R, BL_FILE_INFO_OWNER_W, and BL_FILE_INFO_OWNER_X.
BL_FILE_INFO_GROUP_R	File group owner has read permission (compatible with 040 octal notation).
BL_FILE_INFO_GROUP_W	File group owner has write permission (compatible with 020 octal notation).
BL_FILE_INFO_GROUP_X	File group owner has execute permission (compatible with 010 octal notation).
BL_FILE_INFO_GROUP_MASK	A combination of BL_FILE_INFO_GROUP_R, BL_FILE_INFO_GROUP_W, and BL_FILE_INFO_GROUP_X.
BL_FILE_INFO_OTHER_R	Other users have read permission (compatible with 04 octal notation).
BL_FILE_INFO_OTHER_W	Other users have write permission (compatible with 02 octal notation).
BL_FILE_INFO_OTHER_X	Other users have execute permission (compatible with 01 octal notation).
BL_FILE_INFO_OTHER_MASK	A combination of BL_FILE_INFO_OTHER_R, BL_FILE_INFO_OTHER_W, and BL_FILE_INFO_OTHER_X.
BL_FILE_INFO_SUID	Set user ID to file owner user ID on execution (compatible with 04000 octal notation).
BL_FILE_INFO_SGID	Set group ID to file's user group ID on execution (compatible with 02000 octal notation).
BL_FILE_INFO_PERMISSIONS_MASK	A combination of all file permission bits.
BL_FILE_INFO_REGULAR	A flag specifying that this is a regular file.
BL_FILE_INFO_DIRECTORY	A flag specifying that this is a directory.
BL_FILE_INFO_SYMLINK	A flag specifying that this is a symbolic link.
BL_FILE_INFO_CHAR_DEVICE	A flag describing a character device.
BL_FILE_INFO_BLOCK_DEVICE	A flag describing a block device.
BL_FILE_INFO_FIFO	A flag describing a FIFO (named pipe).
BL_FILE_INFO_SOCKET	A flag describing a socket.
BL_FILE_INFO_HIDDEN	A flag describing a hidden file (Windows only).
BL_FILE_INFO_EXECUTABLE	A flag describing a hidden file (Windows only).
BL_FILE_INFO_ARCHIVE	A flag describing an archive (Windows only).
BL_FILE_INFO_SYSTEM	A flag describing a system file (Windows only).
BL_FILE_INFO_VALID	File information is valid (the request succeeded).

BLFileOpenFlags : uint32_tenum

File open flags, see BLFile::open().

Constant	Description
BL_FILE_OPEN_NO_FLAGS	No flags.
BL_FILE_OPEN_READ	Opens the file for reading. The following system flags are used when opening the file: O_RDONLY (Posix) GENERIC_READ (Windows)
BL_FILE_OPEN_WRITE	Opens the file for writing: The following system flags are used when opening the file: O_WRONLY (Posix) GENERIC_WRITE (Windows)
BL_FILE_OPEN_RW	Opens the file for reading & writing. The following system flags are used when opening the file: O_RDWR (Posix) GENERIC_READ | GENERIC_WRITE (Windows)
BL_FILE_OPEN_CREATE	Creates the file if it doesn't exist or opens it if it does. The following system flags are used when opening the file: O_CREAT (Posix) CREATE_ALWAYS or OPEN_ALWAYS depending on other flags (Windows)
BL_FILE_OPEN_DELETE	Opens the file for deleting or renaming (Windows). Adds DELETE flag when opening the file to ACCESS_MASK.
BL_FILE_OPEN_TRUNCATE	Truncates the file. The following system flags are used when opening the file: O_TRUNC (Posix) TRUNCATE_EXISTING (Windows)
BL_FILE_OPEN_READ_EXCLUSIVE	Opens the file for reading in exclusive mode (Windows). Exclusive mode means to not specify the FILE_SHARE_READ option.
BL_FILE_OPEN_WRITE_EXCLUSIVE	Opens the file for writing in exclusive mode (Windows). Exclusive mode means to not specify the FILE_SHARE_WRITE option.
BL_FILE_OPEN_RW_EXCLUSIVE	Opens the file for both reading and writing (Windows). This is a combination of both BL_FILE_OPEN_READ_EXCLUSIVE and BL_FILE_OPEN_WRITE_EXCLUSIVE.
BL_FILE_OPEN_CREATE_EXCLUSIVE	Creates the file in exclusive mode - fails if the file already exists. The following system flags are used when opening the file: O_EXCL (Posix) CREATE_NEW (Windows)
BL_FILE_OPEN_DELETE_EXCLUSIVE	Opens the file for deleting or renaming in exclusive mode (Windows). Exclusive mode means to not specify the FILE_SHARE_DELETE option.

BLFileSeekType : uint32_tenum

File seek mode, see BLFile::seek().

Note

Seek constants should be compatible with constants used by both POSIX and Windows API.

Constant	Description
BL_FILE_SEEK_SET	Seek from the beginning of the file (SEEK_SET).
BL_FILE_SEEK_CUR	Seek from the current position (SEEK_CUR).
BL_FILE_SEEK_END	Seek from the end of the file (SEEK_END).
BL_FILE_SEEK_MAX_VALUE	Maximum value of BLFileSeekType.

BLFileReadFlags : uint32_tenum

File read flags used by BLFileSystem::readFile().

Constant	Description
BL_FILE_READ_NO_FLAGS	No flags.
BL_FILE_READ_MMAP_ENABLED	Use memory mapping to read the content of the file. The destination buffer BLArray<> would be configured to use the memory mapped buffer instead of allocating its own.
BL_FILE_READ_MMAP_AVOID_SMALL	Avoid memory mapping of small files. The size of small file is determined by Blend2D, however, you should expect it to be 16kB or 64kB depending on host operating system.
BL_FILE_READ_MMAP_NO_FALLBACK	Do not fallback to regular read if memory mapping fails. It's worth noting that memory mapping would fail for files stored on filesystem that is not local (like a mounted network filesystem, etc...).