Struct StateDir 

pub struct StateDir { /* private fields */ }

Implementations

impl StateDir

pub fn open(path: &Path) -> Result<Self>

Pin an existing directory.

pub fn create(path: &Path) -> Result<Self>

Create the directory (and missing ancestors, owner-only, through descriptor-relative mkdirat) if needed, then pin it.

pub fn create_in_resolved_parent(path: &Path) -> Result<Self>

Like create but resolves symlinks in the parent first (for example macOS /var -> /private/var). The final component must still be a real directory.

pub fn path(&self) -> &Path

pub fn child(&self, name: &str) -> Result<StateDir>

Create-or-open a direct child directory (owner-only), pinned relative to this one.

pub fn stat(&self, name: &str) -> Result<Option<EntryStat>>

pub fn exists(&self, name: &str) -> Result<bool>

pub fn read(&self, name: &str, max_bytes: u64) -> Result<Vec<u8>>

Read a regular file (never through a symlink), refusing anything over max_bytes.

pub fn read_opt(&self, name: &str, max_bytes: u64) -> Result<Option<Vec<u8>>>

Like read but Ok(None) when the entry does not exist.

pub fn write(&self, name: &str, bytes: &[u8]) -> Result<()>

Atomically create or replace name (owner-only, fsynced file and directory).

pub fn write_new(&self, name: &str, bytes: &[u8]) -> Result<()>

Atomically create name, failing with FsError::AlreadyExists rather than replacing.

pub fn remove(&self, name: &str) -> Result<bool>

Remove a file. Unix removes a symlink itself; Windows refuses reparse points. Missing is Ok(false).

pub fn list(&self, limit: usize) -> Result<Vec<String>>

Names of direct children, capped at limit entries (error past the cap).

pub fn sweep_temps(&self, max_age: Duration) -> Result<usize>

Remove temp files left by writers that were killed mid-write (pid gone, or older than max_age). Returns how many were removed.

Trait Implementations

impl Debug for StateDir

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

Formats the value using the given formatter.