Struct Pushd

pub struct Pushd { /* private fields */ }

A Pushd changes the current directory when it’s created and returns to the original current directory when it’s dropped.

Implementations

impl Pushd

pub fn new<P: AsRef<Path>>(path: P) -> Result<Pushd, PushdError>

Constructs a new Pushd struct.

This accepts any type that implements AsRef<Path>.

The Pushd returned by this constructor will panic if it cannot change back to its original directory when it is dropped.

This will call log::debug! to log the directory change.

Errors

This method will return an error if the current directory cannot be determined. It will also return an error if the current directory cannot be changed.

pub fn new_no_panic<P: AsRef<Path>>(path: P) -> Result<Pushd, PushdError>

Constructs a new Pushd struct that will never panic.

This accepts any type that implements AsRef<Path>.

This will call log::debug! to log the directory change.

If the Pushd created by this constructor cannot change back to the original directory when it is dropped, then it will simply call log::warn! instead of panicking.

Errors

This method will return an error if the current directory cannot be determined. It will also return an error if the current directory cannot be changed.

pub fn pop(&mut self) -> Result<(), PushdError>

Changes back to the original directory the first time it is called. If this method is called repeatedly it will not do anything on subsequent calls.

Errors

This method return an error if the current directory cannot be changed.

Trait Implementations

impl Drop for Pushd

fn drop(&mut self)

Changes back to the original directory.

When the Pushd struct is dropped, it will change back to the original directory. If this fails, it’s behavior is as follows:

• If the Pushd was constructed with Pushd::new_no_panic, it will log the error by calling log::warn!.

• If the Pushd was constructed with Pushd::new and the error is an io::Error and the error’s io::Error::kind method returns io::ErrorKind::NotFound, it will do nothing.

• Otherwise it will panic with the error from attempting to change the current directory.