Struct DataDirectory 

pub struct DataDirectory { /* private fields */ }

An exclusively owned Hyphae data directory.

The operating-system lock is held until this value is dropped. Opening the same directory for a second writer fails instead of relying on cooperative process behavior.

Implementations

impl DataDirectory

pub fn open(path: impl AsRef<Path>) -> Result<Self, DataDirectoryError>

Opens an existing data directory or initializes a new one.

Errors

Returns an error when the directory cannot be initialized, is owned by another writer, has a malformed marker, or uses a future format.

pub fn path(&self) -> &Path

Returns the canonical root path.

pub fn active_log_path(&self) -> PathBuf

Returns the path of the active append-only log segment.

pub fn open_log(&self) -> Result<OpenedLog<'_>, LogError>

Opens the initial durable log while borrowing this directory lock.

The returned writer cannot outlive the exclusive data-directory owner.

Errors

Returns an error for I/O failures or any complete invalid frame.

Trait Implementations

impl Debug for DataDirectory

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for DataDirectory

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.