clanCore I/O Data

Classes

class  clan::Directory
 Directory utility class. More...
 
class  clan::DirectoryScanner
 Directory scanning class. More...
 
class  clan::Endian
 Endianess management class. More...
 
class  clan::File
 File I/O device. More...
 
class  clan::FileHelp
 File operation helpers. More...
 
class  clan::FileSystem
 Virtual File System (VFS). More...
 
class  clan::FileSystemProvider
 Virtual File System (VFS) file source. More...
 
class  clan::IODevice
 I/O Device interface. More...
 
class  clan::IODeviceProvider
 I/O device provider interface. More...
 
class  clan::MemoryDevice
 Memory I/O device. More...
 
class  clan::PathHelp
 Path helper functions. More...
 
class  clan::ZipArchive
 Zip archive. More...
 
class  clan::ZipFileEntry
 File entry in zip file. More...
 
class  clan::ZipReader
 Zip file reader. More...
 
class  clan::ZipWriter
 Zip file writer. More...
 
class  clan::ZLibCompression
 Deflate compressor. More...
 

Enumerations

enum  clan::File::AccessFlags { clan::File::access_read = 1, clan::File::access_write = 2, clan::File::access_read_write = access_read | access_write }
 Access flags. More...
 
enum  clan::ZLibCompression::CompressionMode {
  clan::ZLibCompression::default_strategy, clan::ZLibCompression::filtered, clan::ZLibCompression::huffman_only, clan::ZLibCompression::rle,
  clan::ZLibCompression::fixed
}
 
enum  clan::File::Flags { clan::File::flag_write_through = 1, clan::File::flag_no_buffering = 2, clan::File::flag_random_access = 4, clan::File::flag_sequential_scan = 8 }
 Optimization Flags. More...
 
enum  clan::File::OpenMode {
  clan::File::open_always, clan::File::open_existing, clan::File::open_existing_truncate, clan::File::create_always,
  clan::File::create_new
}
 File opening modes. More...
 
enum  clan::PathHelp::PathType { clan::PathHelp::path_type_file, clan::PathHelp::path_type_virtual }
 Path types. More...
 
enum  clan::IODevice::SeekMode { clan::IODevice::seek_set, clan::IODevice::seek_cur, clan::IODevice::seek_end }
 Seeking modes. More...
 
enum  clan::File::ShareFlags { clan::File::share_read = 1, clan::File::share_write = 2, clan::File::share_delete = 4, clan::File::share_all = share_read + share_write + share_delete }
 File sharing flags. More...
 

Detailed Description

Enumeration Type Documentation

Access flags.

File access types available.

Enumerator
access_read 

Generic read access.

access_write 

Generic write access.

access_read_write 

Generic read write access.

Enumerator
default_strategy 
filtered 
huffman_only 
rle 
fixed 

Optimization Flags.

Enumerator
flag_write_through 
flag_no_buffering 
flag_random_access 
flag_sequential_scan 

File opening modes.

Enumerator
open_always 

Open file or create it if it does not exist.

open_existing 

Open existing file. Fails if it does not exist.

open_existing_truncate 

Open existing file and truncate it.

create_always 

Create file, even if it already exists.

create_new 

Create a new file. Fails if it already exists.

Path types.

Enumerator
path_type_file 

Native file system path. (On windows, '/' are turned into '\'. On linux, '\' are turned into '/')

path_type_virtual 

Path using slashes ('/').

Seeking modes.

Enumerator
seek_set 

Set to a specific value from the start.

seek_cur 

Set relative to the current position.

seek_end 

Set to a specific value from the end (use negative position)

File sharing flags.

Enumerator
share_read 

Allow others to open the file for reading.

share_write 

Allow others to open the file for writing.

share_delete 

Allow others to delete the file.

share_all 

All other sharing flags combined.