diff options
author | Carl Lerche <me@carllerche.com> | 2019-12-22 12:55:09 -0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-12-22 12:55:09 -0800 |
commit | 7b53b7b659fe1feeb30e768cad8fdadf9531beb6 (patch) | |
tree | ce4020f1e63ee9ecaa822ccd9961de6542bb91c3 /tokio/src/fs/create_dir.rs | |
parent | 99fa93bf0ea504413f6e53b46fbefdee4c0a0904 (diff) |
doc: fill out `fs` and remove html links (#2015)
also add an async version of `fs::canonicalize`
Diffstat (limited to 'tokio/src/fs/create_dir.rs')
-rw-r--r-- | tokio/src/fs/create_dir.rs | 40 |
1 files changed, 39 insertions, 1 deletions
diff --git a/tokio/src/fs/create_dir.rs b/tokio/src/fs/create_dir.rs index 99762058..e03b04dc 100644 --- a/tokio/src/fs/create_dir.rs +++ b/tokio/src/fs/create_dir.rs @@ -7,7 +7,45 @@ use std::path::Path; /// /// This is an async version of [`std::fs::create_dir`][std] /// -/// [std]: https://doc.rust-lang.org/std/fs/fn.create_dir.html +/// [std]: std::fs::create_dir +/// +/// # Platform-specific behavior +/// +/// This function currently corresponds to the `mkdir` function on Unix +/// and the `CreateDirectory` function on Windows. +/// Note that, this [may change in the future][changes]. +/// +/// [changes]: https://doc.rust-lang.org/std/io/index.html#platform-specific-behavior +/// +/// **NOTE**: If a parent of the given path doesn't exist, this function will +/// return an error. To create a directory and all its missing parents at the +/// same time, use the [`create_dir_all`] function. +/// +/// # Errors +/// +/// This function will return an error in the following situations, but is not +/// limited to just these cases: +/// +/// * User lacks permissions to create directory at `path`. +/// * A parent of the given path doesn't exist. (To create a directory and all +/// its missing parents at the same time, use the [`create_dir_all`] +/// function.) +/// * `path` already exists. +/// +/// [`create_dir_all`]: super::create_dir_all() +/// +/// # Examples +/// +/// ```no_run +/// use tokio::fs; +/// use std::io; +/// +/// #[tokio::main] +/// async fn main() -> io::Result<()> { +/// fs::create_dir("/some/dir").await?; +/// Ok(()) +/// } +/// ``` pub async fn create_dir(path: impl AsRef<Path>) -> io::Result<()> { let path = path.as_ref().to_owned(); asyncify(move || std::fs::create_dir(path)).await |