Struct DirBuilder

pub struct DirBuilder { /* private fields */ }

A builder for creating directories with configurable options.

For Unix-specific options, import the DirBuilderExt trait.

Implementations

impl 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();

pub fn recursive(&mut self, recursive: bool) -> &mut DirBuilder

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);

pub fn create<P>(&self, path: P) -> impl Future<Output = Result<(), Error>>

where P: AsRef<Path>,

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

impl Debug for DirBuilder

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

Formats the value using the given formatter.

impl Default for DirBuilder

fn default() -> DirBuilder

Returns the “default value” for a type.

impl DirBuilderExt for DirBuilder

fn mode(&mut self, mode: u32) -> &mut DirBuilder

Sets the mode to create new directories with.