Struct current_dir::Cwd

pub struct Cwd { /* private fields */ }

Wrapper type to help the usage of the current working directory for the process.

Implementations

impl Cwd

pub fn mutex() -> &'static Mutex<Self>

The Mutex ensuring the state of the current working directory.

It is a logic error to call env::set_current_dir() or env::current_dir() without this lock acquired.

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 Debug for Cwd

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

Formats the value using the given formatter.

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.