Struct LoaderFile 

pub struct LoaderFile { /* private fields */ }

A handle to one config file on disk.

Handles are cheap to clone and share path, format, and suspend state, so several trees (or the loader and the watcher) can coordinate writes through the same file. While any FileSuspendGuard is held, LoaderFile::write is a silent no-op — the file-level half of breaking the write → watch → write feedback loop.

Implementations

impl LoaderFile

pub fn open(path: impl Into<PathBuf>) -> Result<Self>

Open a .yml, .yaml, or .json config file. The file does not have to exist yet; LoaderFile::read returns an empty document until the first write creates it.

pub fn path(&self) -> &Path

The file path.

pub fn format(&self) -> FileFormat

The detected format.

pub fn read(&self) -> Result<Document>

Read and parse the file. Missing and empty files yield an empty document; ${{ ... }} templates are not expanded here — entries keep their raw config.

pub fn write(&self, document: &Document) -> Result<()>

Serialize the document and replace the file atomically (write to a sibling .tmp file, fsync, rename). A no-op while suspended.

pub fn write_deferred(&self, document: Document, delay: Duration)

Schedule a coalesced write: rapid calls replace the pending document (latest wins), and the physical write happens once delay has passed without a newer call. A suspension active at flush time postpones the write until it lifts. Errors surface through LoaderFile::last_deferred_error and never propagate to callers.

If the flusher thread cannot be spawned, the write happens synchronously instead.

pub fn flush_deferred(&self)

Block until every LoaderFile::write_deferred call made before this one has been flushed (or skipped by suspension lifting and a later flush).

pub fn last_deferred_error(&self) -> Option<String>

The last deferred-write error, if the flusher failed.

pub fn suspend(&self) -> FileSuspendGuard

Increment the suspend counter, returning a guard whose drop resumes writes. Hold this while reloading a file so the resulting tree patches are not written back.

pub fn is_suspended(&self) -> bool

Whether any suspend guard is currently held for this file.

Trait Implementations

impl Clone for LoaderFile

fn clone(&self) -> LoaderFile

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LoaderFile

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

Formats the value using the given formatter.