Struct CwdGuard 

pub struct CwdGuard<'lock> { /* private fields */ }

A version of Cwd that will reset() the current working directory to it’s previous state on drop().

reset() can be called manually to handle errors or automatically on drop().

Implementations

impl CwdGuard<'_>

pub fn reset(&mut self) -> Result<()>

Resets the current working directory to the initial current working directory at the time of selfs creation.

Errors

The current directory cannot be set as per env::set_current_dir()

Methods from Deref<Target = Cwd>

pub fn get_expected(&self) -> Option<PathBuf>

Returns the expected current working directory if any. By default the only expectations set are when this crate produces a panic.

pub fn get(&self) -> Result<PathBuf>

Wrapper function to ensure env::current_dir() is called with the Cwd borrowed.

pub fn set<P: AsRef<Path>>(&mut self, path: P) -> Result<()>

Wrapper function to ensure env::set_current_dir() is called with the Cwd borrowed.

Trait Implementations

impl Deref for CwdGuard<'_>

type Target = Cwd

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for CwdGuard<'_>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Drop for CwdGuard<'_>

fn drop(&mut self)

Panics

If the current directory cannot be reset()

impl<'lock> TryFrom<&'lock mut Cwd> for CwdGuard<'lock>

fn try_from(cwd: &'lock mut Cwd) -> Result<Self, Self::Error>

Creates a CwdGuard mutably borrowing the locked Self.

Errors

The current directory cannot be retrieved as per env::current_dir()

type Error = Error

The type returned in the event of a conversion error.

impl<'lock> TryFrom<&'lock mut CwdGuard<'_>> for CwdGuard<'lock>

fn try_from(cwd_guard: &'lock mut CwdGuard<'_>) -> Result<Self, Self::Error>

Create a new CwdGuard under cwd_guard that will reset() to cwd_guard when drop() is called.

Errors

The current directory cannot be retrieved as per env::current_dir()

type Error = Error

The type returned in the event of a conversion error.