Death::IO namespace

File system, streaming and IO-related classes.

Contains types that allow reading and writing to files and data streams, and types that provide basic file and directory support.

Namespaces

namespace Compression: Data compression streaming interfaces.

Classes

class AndroidAssetStream: Read-only streaming directly from Android asset files.
class BoundedFileStream: Provides only specified portion of the specified seekable input stream.
class EmscriptenFilePicker: Allows a user to pick files in the browser.
class EmscriptenFileStream: Provides access to a file selected by the user in the browser.
class FileStream: Allows streaming from/to a file on a local filesystem.
class FileStreamPool: Keeps the open stream of one file between uses, so reading a resource does not reopen it.
class FileSystem: File system related methods.
class MemoryStream: Provides stream interface for a region of memory.
class PakFile: Provides read-only access to contents of .pak file.
class PakWriter: Allows to create a .pak file.
class Stream: Provides a generic view of a sequence of bytes.
class WebAuthChallenge: Contains the authentication challenge information.
class WebCredentials: Contains the username and password to use for authenticating.
class WebProxy: Describes the proxy settings to be used by the session.
class WebRequest: Represents web request.
class WebRequestAsync: Represents asynchronous web request.
class WebRequestBase: Base class of web requests.
class WebRequestEvent: Result of the asynchronous web request.
class WebResponse: Describes the server response of the web request.
class WebSession: Represents web session that allows WebRequest to be created.
class WebSessionAsync: Represents web session that allows WebRequestAsync to be created.
class WebSessionBase: Base class of web sessions.

Enums

enum class FileAccess { None = 0, Read = 0x01, Write = 0x02, ReadWrite = Read | Write, Exclusive = 0x10, InheritHandle = 0x20, Sequential = 0x40, Unpinned = 0x80 }: Defines constants for read, write, or read/write access to a file, supports a bitwise combination of its member values.
enum class PakPreferredCompression { None, Deflate, Lz4, Lzma2Compressed, Zstd }: Preferred file compression, used in PakWriter::AddFile().
enum class SeekOrigin { Begin, Current, End }: Specifies the position in a stream to use for seeking.

Typedefs

using fs = FileSystem: Convenient shortcut to FileSystem.

Enum documentation

enum class Death::IO::FileAccess
#include <IO/FileAccess.h>

Defines constants for read, write, or read/write access to a file, supports a bitwise combination of its member values.

Enumerators
None
Read	Read access to the file.
Write	Write access to the file.
ReadWrite	Read and write access to the file.
Exclusive	Access to the file should be exclusive (not shared). On Windows, the file is opened with a share mode of 0, so no other process can open it while the handle is alive. On Unix, this is emulated with an advisory `flock()` lock, which only excludes other processes that also request exclusive access. In both cases opening fails immediately if the file is already opened exclusively elsewhere.
InheritHandle	A child process can inherit this handle.
Sequential	Indicates that the file is to be accessed sequentially from beginning to end.
Unpinned	The handle does not pin the file's name: other processes may delete, rename or replace the file while it is open. On Windows, an open file cannot be deleted, renamed or replaced by anyone else unless every handle to it was opened with this flag — which is what a reader following a log another process rotates wants. Has no effect together with Exclusive. On Unix, a name is never pinned by an open descriptor, so the flag is accepted and ignored.

enum class Death::IO::PakPreferredCompression
#include <IO/PakFile.h>

Preferred file compression, used in PakWriter::AddFile().

Enumerators
None	None
Deflate	Deflate
Lz4	LZ4
Lzma2Compressed	LZMA2
Zstd	Zstandard

enum class Death::IO::SeekOrigin
#include <IO/Stream.h>

Specifies the position in a stream to use for seeking.

Enumerators
Begin	Specifies the beginning of a stream.
Current	Specifies the current position within a stream.
End	Specifies the end of a stream.

Typedef documentation

using Death::IO::fs = FileSystem
#include <IO/FileSystem.h>

Convenient shortcut to FileSystem.