Skip to content
Entropy Documentation

EntropyEngine::Core::IO::WriteOptions

EntropyEngine::Core::IO::WriteOptions

Section titled “EntropyEngine::Core::IO::WriteOptions”

Options controlling file writes. More…

#include <IFileSystemBackend.h>

Public Attributes

Section titled “Public Attributes”
Name
std::optional< bool >useLockFile
booltruncate
uint64_toffset
std::optional< std::chrono::milliseconds >lockTimeout
std::optional< std::string >lockSuffix
boolfsync
std::optional< bool >ensureFinalNewline
std::optional< bool >createParentDirs
boolcreateIfMissing
boolappend

Detailed Description

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

Options controlling file writes.

Parameters:

  • offset Starting byte offset (ignored if append=true)
  • append Append to end of file
  • createIfMissing Create the file if it does not exist
  • truncate Truncate file before writing (overrides offset)
  • createParentDirs Per-op override to create parent directories
  • ensureFinalNewline Force presence/absence of final newline for whole-file rewrites

Public Attributes Documentation

Section titled “Public Attributes Documentation”

variable useLockFile

Section titled “variable useLockFile”
std::optional< bool > useLockFile;

variable truncate

Section titled “variable truncate”
bool truncate = false;

variable offset

Section titled “variable offset”
uint64_t offset = 0;

variable lockTimeout

Section titled “variable lockTimeout”
std::optional< std::chrono::milliseconds > lockTimeout;

variable lockSuffix

Section titled “variable lockSuffix”
std::optional< std::string > lockSuffix;

variable fsync

Section titled “variable fsync”
bool fsync = false;

variable ensureFinalNewline

Section titled “variable ensureFinalNewline”
std::optional< bool > ensureFinalNewline;

variable createParentDirs

Section titled “variable createParentDirs”
std::optional< bool > createParentDirs;

variable createIfMissing

Section titled “variable createIfMissing”
bool createIfMissing = true;

variable append

Section titled “variable append”
bool append = false;

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