Struct async_fs::DirBuilder
source · [−]pub struct DirBuilder { /* private fields */ }
Expand description
A builder for creating directories with configurable options.
For Unix-specific options, import the DirBuilderExt
trait.
Implementations
sourceimpl DirBuilder
impl DirBuilder
sourcepub fn new() -> DirBuilder
pub fn new() -> DirBuilder
Creates a blank set of options.
The recursive()
option is initially set to false
.
Examples
use async_fs::DirBuilder;
let builder = DirBuilder::new();
sourcepub fn recursive(&mut self, recursive: bool) -> &mut Self
pub fn recursive(&mut self, recursive: bool) -> &mut Self
Sets the option for recursive mode.
When set to true
, this option means all parent directories should be created recursively
if they don’t exist. Parents are created with the same permissions as the final directory.
This option is initially set to false
.
Examples
use async_fs::DirBuilder;
let mut builder = DirBuilder::new();
builder.recursive(true);
sourcepub fn create<P: AsRef<Path>>(
&self,
path: P
) -> impl Future<Output = Result<()>>
pub fn create<P: AsRef<Path>>(
&self,
path: P
) -> impl Future<Output = Result<()>>
Creates a directory with the configured options.
It is considered an error if the directory already exists unless recursive mode is enabled.
Errors
An error will be returned in the following situations:
path
already points to an existing file or directory.- The current process lacks permissions to create the directory or its missing parents.
- Some other I/O error occurred.
Examples
use async_fs::DirBuilder;
DirBuilder::new()
.recursive(true)
.create("./some/directory")
.await?;
Trait Implementations
sourceimpl Debug for DirBuilder
impl Debug for DirBuilder
sourceimpl Default for DirBuilder
impl Default for DirBuilder
sourcefn default() -> DirBuilder
fn default() -> DirBuilder
Returns the “default value” for a type. Read more
sourceimpl DirBuilderExt for DirBuilder
impl DirBuilderExt for DirBuilder
Auto Trait Implementations
impl RefUnwindSafe for DirBuilder
impl Send for DirBuilder
impl Sync for DirBuilder
impl Unpin for DirBuilder
impl UnwindSafe for DirBuilder
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more