EntropyEngine::Core::IO

Namespaces

Name
EntropyEngine::Core::IO::PackageFlags

Classes

	Name
struct	EntropyEngine::Core::IO::WriteOptions Options controlling file writes.
class	EntropyEngine::Core::IO::WriteBatch WriteBatch - Collects multiple write operations and applies them atomically.
struct	EntropyEngine::Core::IO::WatchOptions Options for configuring file system watches.
class	EntropyEngine::Core::IO::VirtualFileSystem
struct	EntropyEngine::Core::IO::StreamOptions Options for opening streams.
struct	EntropyEngine::Core::IO::SceneInfo Scene-specific metadata in the manifest.
struct	EntropyEngine::Core::IO::ReadOptions Options controlling file reads.
struct	EntropyEngine::Core::IO::ProgressOptions Options for chunked operations with progress.
struct	EntropyEngine::Core::IO::ProcessedAsset
struct	EntropyEngine::Core::IO::PendingAsset
struct	EntropyEngine::Core::IO::PackageWriterOptions Options for package creation.
class	EntropyEngine::Core::IO::PackageWriter Builds and writes EntropyPackage files.
struct	[EntropyEngine::Core::IO::PackageResult< void >](/api/EntropyEngine/Core/IO/PackageResult< void >/) Specialization for void result (operations that don’t return a value).
struct	EntropyEngine::Core::IO::PackageResult Result type for package operations.
class	EntropyEngine::Core::IO::PackageReader Reads assets from EntropyPackage files.
struct	EntropyEngine::Core::IO::PackageManifest Package manifest structure.
struct	EntropyEngine::Core::IO::PackageHeader Package file header (64 bytes, fixed size).
class	EntropyEngine::Core::IO::PackageBackend Read-only VFS backend for EntropyPackage files.
class	EntropyEngine::Core::IO::MappedFile
class	EntropyEngine::Core::IO::LocalFileSystemBackend
class	EntropyEngine::Core::IO::LocalFileStream
struct	EntropyEngine::Core::IO::ListDirectoryOptions Options controlling directory listings.
struct	EntropyEngine::Core::IO::IoResult
class	EntropyEngine::Core::IO::IFileSystemBackend
class	EntropyEngine::Core::IO::FileWatchManager Manager for FileWatch objects using EntropyObject handle stamping.
class	EntropyEngine::Core::IO::FileWatchListener efsw listener implementation that dispatches to FileWatchManager
struct	EntropyEngine::Core::IO::FileWatchInfo Information about a file system event.
class	EntropyEngine::Core::IO::FileWatch File system watch object (refcounted, handle-stampable).
class	EntropyEngine::Core::IO::FileStream
class	EntropyEngine::Core::IO::FileOperationHandle
struct	EntropyEngine::Core::IO::FileMetadata
class	EntropyEngine::Core::IO::FileHandle Copyable handle to a file path routed through a backend.
struct	EntropyEngine::Core::IO::FileErrorInfo Error details accompanying a failed operation.
struct	EntropyEngine::Core::IO::ExecContext
class	EntropyEngine::Core::IO::DirectoryHandle Copyable handle to a directory path routed through a backend.
struct	EntropyEngine::Core::IO::DirectoryEntry
struct	EntropyEngine::Core::IO::CopyOptions Options controlling file copy behavior.
class	EntropyEngine::Core::IO::BufferedFileStream
struct	EntropyEngine::Core::IO::BatchMetadataOptions Options to retrieve metadata for multiple paths.
struct	EntropyEngine::Core::IO::BackendCapabilities Capabilities advertised by a backend.
struct	EntropyEngine::Core::IO::AssetInfo Metadata for a single asset within a package or catalog.

Types

	Name
enum class	PackageError { UnsupportedVersion, NotSupported, None = 0, ManifestTooLarge, KeyRequired, IoError, InvalidPath, InvalidManifest, InvalidMagic, HashMismatch, FileNotFound, DecryptionFailed, DecompressionFailed, AssetNotFound} Error codes for package operations.
using std::array< uint8_t, 32 >	Hash256 Generic 256-bit hash for verification purposes.
enum class	FileWatchEvent { Renamed, Modified, Deleted, Created} Types of file system events.
using std::function< void(const FileWatchInfo &)>	FileWatchCallback Callback function for file system events.
enum class	FileOpStatus { Running, Pending, Partial, Failed, Complete}
enum class	FileError { Unknown, Timeout, None = 0, NetworkError, InvalidPath, IOError, FileNotFound, DiskFull, Conflict, AccessDenied} Public error taxonomy surfaced by VFS operations.
enum class uint8_t	DeliveryMethod { DirectFetch = 0, CanvasWebRTC = 2, CanvasHTTP = 1} Method for portal to fetch asset data.
enum class uint8_t	ContentType { Texture = 1, Sound = 2, Shader = 5, Scene = 3, Mesh = 0, Material = 4} Type of asset content.

Functions

	Name
entropy_FileOperationHandle	wrap_file_operation_handle(FileOperationHandle && handle)
const char *	packageErrorToString(PackageError error) Get a human-readable string for a PackageError.
bool	matchGlob(const std::string & str, const std::string & pattern)
const char *	deliveryMethodToString(DeliveryMethod method) Get a human-readable string for a DeliveryMethod.
const char *	contentTypeToString(ContentType type) Get a human-readable string for a ContentType.

Attributes

	Name
uint32_t	kPackageVersion
size_t	kPackageTagSize
size_t	kPackageSymmetricKeySize
size_t	kPackageNonceSize
char[4]	kPackageMagic
size_t	kPackageKeyIdSize
size_t	kPackageHeaderSize
size_t	kMaxManifestSize

Types Documentation

enum PackageError

Enumerator	Value	Description
UnsupportedVersion
NotSupported
None	0
ManifestTooLarge
KeyRequired
IoError
InvalidPath
InvalidManifest
InvalidMagic
HashMismatch
FileNotFound
DecryptionFailed
DecompressionFailed
AssetNotFound

Error codes for package operations.

using Hash256

using EntropyEngine::Core::IO::Hash256 = std::array<uint8_t, 32>;

Generic 256-bit hash for verification purposes.

Used for hashes that are NOT asset lookup keys (e.g., plaintext verification). For asset lookup, use EntropyCanvas::AssetId instead.

enum FileWatchEvent

Enumerator	Value	Description
Renamed		File or directory renamed/moved.
Modified		File content or directory structure changed.
Deleted		File or directory deleted.
Created		New file or directory created.

Types of file system events.

using FileWatchCallback

using EntropyEngine::Core::IO::FileWatchCallback = std::function<void(const FileWatchInfo&)>;

Callback function for file system events.

enum FileOpStatus

Enumerator	Value	Description
Running
Pending
Partial
Failed
Complete

enum FileError

Enumerator	Value	Description
Unknown
Timeout
None	0
NetworkError
InvalidPath
IOError
FileNotFound
DiskFull
Conflict
AccessDenied

Public error taxonomy surfaced by VFS operations.

Mapping guidelines:

FileNotFound: path does not exist when required (read/stat)
AccessDenied: open/create denied by OS/permissions
DiskFull: ENOSPC/EDQUOT or equivalent on write/flush
InvalidPath: malformed path, name too long, or parent missing
IOError: other local I/O failures (including fsync failures)
NetworkError: remote/backend transport failure (future backends)
Timeout: bounded waits exceeded (advisory lock or backend scope)
Conflict: contention detected (backend Busy without fallback)

enum DeliveryMethod

Enumerator	Value	Description
DirectFetch	0
CanvasWebRTC	2
CanvasHTTP	1

Method for portal to fetch asset data.

enum ContentType

Enumerator	Value	Description
Texture	1
Sound	2
Shader	5
Scene	3
Mesh	0
Material	4

Type of asset content.

Functions Documentation

function wrap_file_operation_handle

entropy_FileOperationHandle wrap_file_operation_handle(
    FileOperationHandle && handle
)

function packageErrorToString

inline const char * packageErrorToString(
    PackageError error
)

Get a human-readable string for a PackageError.

function matchGlob

static bool matchGlob(
    const std::string & str,
    const std::string & pattern
)

function deliveryMethodToString

inline const char * deliveryMethodToString(
    DeliveryMethod method
)

Get a human-readable string for a DeliveryMethod.

function contentTypeToString

inline const char * contentTypeToString(
    ContentType type
)

Get a human-readable string for a ContentType.

Attributes Documentation

variable kPackageVersion

uint32_t kPackageVersion = 1;

variable kPackageTagSize

size_t kPackageTagSize = 16;

variable kPackageSymmetricKeySize

size_t kPackageSymmetricKeySize = 32;

variable kPackageNonceSize

size_t kPackageNonceSize = 12;

variable kPackageMagic

char[4] kPackageMagic = {'E', 'P', 'A', 'K'};

variable kPackageKeyIdSize

size_t kPackageKeyIdSize = 32;

variable kPackageHeaderSize

size_t kPackageHeaderSize = 64;

variable kMaxManifestSize

size_t kMaxManifestSize = 16 * 1024 * 1024;

Updated on 2026-01-26 at 17:14:35 -0500