#include <file.h>
Public Types | |
enum | AccessFlags { access_read = 1 , access_write = 2 , access_read_write = access_read | access_write } |
Access flags. More... | |
enum | Flags { flag_write_through = 1 , flag_no_buffering = 2 , flag_random_access = 4 , flag_sequential_scan = 8 } |
Optimization Flags. More... | |
enum | OpenMode { open_always , open_existing , open_existing_truncate , create_always , create_new } |
File opening modes. More... | |
enum | ShareFlags { share_read = 1 , share_write = 2 , share_delete = 4 , share_all = share_read + share_write + share_delete } |
File sharing flags. More... | |
![]() | |
enum class | SeekMode { set , cur , end } |
Seeking modes. More... | |
Public Member Functions | |
File () | |
Constructs a file object. | |
File (const std::string &filename) | |
Constructs a file object read only. | |
File (const std::string &filename, OpenMode mode, unsigned int access, unsigned int share=share_all, unsigned int flags=0) | |
Constructs a file object. | |
~File () | |
void | close () |
Close file. | |
bool | open (const std::string &filename) |
Opens a file read only. | |
bool | open (const std::string &filename, OpenMode mode, unsigned int access, unsigned int share=share_all, unsigned int flags=0) |
Opens a file. | |
![]() | |
IODevice () | |
Constructs a null instance. | |
IODevice (IODeviceProvider *provider) | |
Constructs a IODevice. | |
~IODevice () | |
IODevice | duplicate () |
Create a new IODevice referencing the same resource. | |
size_t | get_position () const |
Returns the position in the data stream. | |
IODeviceProvider * | get_provider () |
Returns the provider for this object. | |
const IODeviceProvider * | get_provider () const |
Returns the provider for this object. | |
size_t | get_size () const |
Returns the size of data stream. | |
bool | is_little_endian () const |
Returns true if the input source is in little endian mode. | |
bool | is_null () const |
Returns true if this object is invalid. | |
size_t | peek (void *data, size_t len) |
Peek data from device (data is left in the buffer). | |
size_t | read (void *data, size_t len, bool receive_all=true) |
Alias for receive(data, len, receive_all) | |
float | read_float () |
Reads a float from input source. | |
int16_t | read_int16 () |
Reads a signed 16 bit integer from input source. | |
int32_t | read_int32 () |
Reads a signed 32 bit integer from input source. | |
int64_t | read_int64 () |
Reads a signed 64 bit integer from input source. | |
int8_t | read_int8 () |
Reads a signed 8 bit integer from input source. | |
std::string | read_string_a () |
Reads a string from the input source. | |
std::string | read_string_nul () |
Reads a nul terminated string from the input source. | |
std::string | read_string_text (const char *skip_initial_chars, const char *read_until_chars, bool allow_eof=true) |
Reads a string from the input source where the source is a text file. | |
uint16_t | read_uint16 () |
Reads an unsigned 16 bit integer from input source. | |
uint32_t | read_uint32 () |
Reads an unsigned 32 bit integer from input source. | |
uint64_t | read_uint64 () |
Reads an unsigned 64 bit integer from input source. | |
uint8_t | read_uint8 () |
Reads an unsigned 8 bit integer from input source. | |
size_t | receive (void *data, size_t len, bool receive_all=true) |
Receive data from device. | |
bool | seek (int position, SeekMode mode=SeekMode::set) |
Seek in data stream. | |
size_t | send (const void *data, size_t len, bool send_all=true) |
Send data to device. | |
void | set_big_endian_mode () |
Changes input data endianess to big endian mode. (Default is little endian) | |
void | set_little_endian_mode () |
Changes input data endianess to little endian mode. This is the default setting. | |
void | set_system_mode () |
Changes input data endianess to the local systems mode. | |
void | throw_if_null () const |
Throw an exception if this object is invalid. | |
size_t | write (const void *data, size_t len, bool send_all=true) |
Alias for send(data, len, send_all) | |
void | write_float (float data) |
Writes a float to output source. | |
void | write_int16 (int16_t data) |
Writes a signed 16 bit integer to output source. | |
void | write_int32 (int32_t data) |
Writes a signed 32 bit integer to output source. | |
void | write_int64 (int64_t data) |
Writes a signed 64 bit integer to output source. | |
void | write_int8 (int8_t data) |
Writes a signed 8 bit integer to output source. | |
void | write_string_a (const std::string &str) |
Writes a string to the output source. | |
void | write_string_nul (const std::string &str) |
Writes a nul terminated string to the output source. | |
void | write_string_text (const std::string &str) |
Writes a text string to the output source. | |
void | write_uint16 (uint16_t data) |
Writes an unsigned 16 bit integer to output source. | |
void | write_uint32 (uint32_t data) |
Writes an unsigned 32 bit integer to output source. | |
void | write_uint64 (uint64_t data) |
Writes an unsigned 64 bit integer to output source. | |
void | write_uint8 (uint8_t data) |
Writes an unsigned 8 bit integer to output source. | |
Static Public Member Functions | |
static DataBuffer | read_bytes (const std::string &filename) |
Loads an file into a byte buffer. | |
static std::string | read_text (const std::string &filename) |
Loads an UTF-8 text file into a string. | |
static void | write_bytes (const std::string &filename, const DataBuffer &bytes) |
Saves a byte buffer to file. | |
static void | write_text (const std::string &filename, const std::string &text, bool write_bom=false) |
Saves an UTF-8 text string to file. | |
Additional Inherited Members | |
![]() | |
std::shared_ptr< IODevice_Impl > | impl |
File I/O device.
Access flags.
File access types available.
Enumerator | |
---|---|
access_read | Generic read access. |
access_write | Generic write access. |
access_read_write | Generic read write access. |
enum clan::File::Flags |
enum clan::File::OpenMode |
File opening modes.
File sharing flags.
clan::File::File | ( | ) |
Constructs a file object.
clan::File::File | ( | const std::string & | filename | ) |
Constructs a file object read only.
PathHelp::normalize(filename, PathHelp::path_type_file) is called
clan::File::File | ( | const std::string & | filename, |
OpenMode | mode, | ||
unsigned int | access, | ||
unsigned int | share = share_all, | ||
unsigned int | flags = 0 ) |
Constructs a file object.
PathHelp::normalize(filename, PathHelp::path_type_file) is called
clan::File::~File | ( | ) |
void clan::File::close | ( | ) |
Close file.
bool clan::File::open | ( | const std::string & | filename | ) |
Opens a file read only.
PathHelp::normalize(filename, PathHelp::path_type_file) is called
bool clan::File::open | ( | const std::string & | filename, |
OpenMode | mode, | ||
unsigned int | access, | ||
unsigned int | share = share_all, | ||
unsigned int | flags = 0 ) |
Opens a file.
PathHelp::normalize(filename, PathHelp::path_type_file) is called
|
static |
Loads an file into a byte buffer.
|
static |
Loads an UTF-8 text file into a string.
|
static |
Saves a byte buffer to file.
|
static |
Saves an UTF-8 text string to file.