bpf::io namespace

Contents

Classes

class BinaryReader
class BinaryWriter
class ByteBuf
class Console
class ConsoleReader
class ConsoleWriter
class File
class FileStream
class IDataInputStream
class IDataOutputStream
class IInputStream
class IOException
class IOutputStream
class MemoryMapper
class TextReader
class TextWriter

Enums

enum ECharacterEncoding { UTF8, UTF16, UTF32 }
enum EConsoleColor { BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE }
enum EConsoleStream { OUTPUT, ERROR }
enum EStringSerializer { VARCHAR_32, VARCHAR_16, VARCHAR_8, CSTYLE }

Variables

fint FILE_MODE_READ constexpr
fint FILE_MODE_WRITE constexpr
fint FILE_MODE_APPEND constexpr
fint FILE_MODE_TRUNCATE constexpr
fsize READ_BUF_SIZE constexpr
fsize WRITE_BUF_SIZE constexpr

Enum documentation

enum bpf::io::ECharacterEncoding
#include <Base/include/Framework/IO/ECharacterEncoding.hpp>

Enumeration for character encodings Currently only supports unicode based encodings

Enumerators
UTF8

UTF-8 encoding
UTF16

UTF-16 encoding
UTF32

UTF-32 encoding

enum bpf::io::EConsoleColor
#include <Base/include/Framework/IO/EConsoleColor.hpp>

Enumeration of all available text colors for console

Enumerators
BLACK

Black text color
RED

Red text color
GREEN

Green text color
YELLOW

Yellow text color
BLUE

Blue text color
MAGENTA

Magenta text color
CYAN

Cyan text color
WHITE

White text color

enum bpf::io::EConsoleStream
#include <Base/include/Framework/IO/EConsoleStream.hpp>

Enumeration for selecting console output stream

Enumerators
OUTPUT

The standard output
ERROR

The standard error

enum bpf::io::EStringSerializer
#include <Base/include/Framework/IO/EStringSerializer.hpp>

Enumeration for string serializing functions

Enumerators
VARCHAR_32

Serialize string as <set of characters><32 bits 4 bytes unsigned>
VARCHAR_16

Serialize string as <set of characters><16 bits 2 bytes unsigned>
VARCHAR_8

Serialize string as <set of characters><8 bits 1 bytes unsigned>
CSTYLE

Serialize string as low-level null-terminated c-like string

Variable documentation

fint bpf::io::FILE_MODE_READ constexpr
#include <Base/include/Framework/IO/File.hpp>

Open a file for reading, also used to check if a file is readable

fint bpf::io::FILE_MODE_WRITE constexpr
#include <Base/include/Framework/IO/File.hpp>

Open a file for writing, also used to check if a file is readable

fint bpf::io::FILE_MODE_APPEND constexpr
#include <Base/include/Framework/IO/FileStream.hpp>

Open a file for always appending data at the end

fint bpf::io::FILE_MODE_TRUNCATE constexpr
#include <Base/include/Framework/IO/FileStream.hpp>

If this flag is specified when opening a file, the file is always emptied

fsize bpf::io::READ_BUF_SIZE constexpr
#include <Base/include/Framework/IO/IDataInputStream.hpp>

Recommended buffer size for reading

fsize bpf::io::WRITE_BUF_SIZE constexpr
#include <Base/include/Framework/IO/IDataOutputStream.hpp>

Recommended buffer size for writing