Skip to content
Entropy Documentation

EntropyEngine::Core::IO::FileOperationHandle::OpState

EntropyEngine::Core::IO::FileOperationHandle::OpState

Section titled “EntropyEngine::Core::IO::FileOperationHandle::OpState”

Shared state for file operations. More…

#include <FileOperationHandle.h>

Public Functions

Section titled “Public Functions”
Name
voidsetError(FileError code, const std::string & msg, const std::string & path ="", std::optional< std::error_code > ec =std::nullopt)
voidcomplete(FileOpStatus final)

Public Attributes

Section titled “Public Attributes”
Name
uint64_twrote
std::stringtext
std::atomic< FileOpStatus >st
std::function< void()>progress
std::vector< FileMetadata >metadataBatch
std::optional< FileMetadata >metadata
std::atomic< bool >isComplete
FileErrorInfoerror
std::vector< DirectoryEntry >directoryEntries
std::mutexcompletionMutex
std::condition_variablecompletionCV
std::vector< uint8_t >bytes

Detailed Description

Section titled “Detailed Description”
struct EntropyEngine::Core::IO::FileOperationHandle::OpState;

Shared state for file operations.

Third-party backends can create and populate OpState, then construct a FileOperationHandle using the same pattern as LocalFileSystemBackend:

auto state = FileOperationHandle::makeState();
// Populate state
state->bytes = fetchData();
state->complete(FileOpStatus::Complete);
return FileOperationHandle(state);

Public Functions Documentation

Section titled “Public Functions Documentation”

function setError

Section titled “function setError”
inline void setError(
    FileError code,
    const std::string & msg,
    const std::string & path ="",
    std::optional< std::error_code > ec =std::nullopt
)

function complete

Section titled “function complete”
inline void complete(
    FileOpStatus final
)

Public Attributes Documentation

Section titled “Public Attributes Documentation”

variable wrote

Section titled “variable wrote”
uint64_t wrote = 0;

variable text

Section titled “variable text”
std::string text;

variable st

Section titled “variable st”
std::atomic< FileOpStatus > st {FileOpStatus::Pending};

variable progress

Section titled “variable progress”
std::function< void()> progress;

variable metadataBatch

Section titled “variable metadataBatch”
std::vector< FileMetadata > metadataBatch;

variable metadata

Section titled “variable metadata”
std::optional< FileMetadata > metadata;

variable isComplete

Section titled “variable isComplete”
std::atomic< bool > isComplete {false};

variable error

Section titled “variable error”
FileErrorInfo error;

variable directoryEntries

Section titled “variable directoryEntries”
std::vector< DirectoryEntry > directoryEntries;

variable completionMutex

Section titled “variable completionMutex”
std::mutex completionMutex;

variable completionCV

Section titled “variable completionCV”
std::condition_variable completionCV;

variable bytes

Section titled “variable bytes”
std::vector< uint8_t > bytes;

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