Add missing platform-specific information on current_dir and set_current_dir

This commit is contained in:
Guillaume Gomez 2022-02-03 23:19:36 +01:00
parent a00e130dae
commit 22a24c98d3

View File

@ -23,6 +23,11 @@ use crate::sys::os as os_imp;
/// Returns the current working directory as a [`PathBuf`].
///
/// # Platform-specific behavior
///
/// This function currently corresponds to the `getcwd` function on Unix
/// and the `GetCurrentDirectoryW` function on Windows.
///
/// # Errors
///
/// Returns an [`Err`] if the current working directory value is invalid.
@ -49,6 +54,11 @@ pub fn current_dir() -> io::Result<PathBuf> {
/// Changes the current working directory to the specified path.
///
/// # Platform-specific behavior
///
/// This function currently corresponds to the `chdir` function on Unix
/// and the `SetCurrentDirectoryW` function on Windows.
///
/// Returns an [`Err`] if the operation fails.
///
/// # Examples