Struct CurrentDirGuard 

pub struct CurrentDirGuard { /* private fields */ }

An RAII guard that pins the process working directory for its lifetime and restores the previous directory when dropped.

Construct one with CurrentDirGuard::change_to (change the directory) or CurrentDirGuard::pin (hold the current directory without changing it). While the guard is alive it owns a process-wide reentrant lock, so guards on other threads block until it drops; nested guards on the same thread are allowed.

Implementations

impl CurrentDirGuard

pub fn pin() -> AppResult<Self>

Acquire the lock and pin the current working directory without changing it, restoring it on drop.

Errors

Returns an error if the current working directory cannot be read.

pub fn change_to(dir: impl AsRef<Path>) -> AppResult<Self>

Acquire the lock, record the current directory, and switch to dir.

The previous directory is restored when the guard drops.

Errors

Returns an error if the current directory cannot be read or if dir cannot be set as the working directory.

pub fn previous(&self) -> &Path

The working directory captured when the guard was created.

Trait Implementations

impl Debug for CurrentDirGuard

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

Formats the value using the given formatter.

impl Drop for CurrentDirGuard

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.