Struct async_std::fs::DirBuilder

pub struct DirBuilder { /* fields omitted */ }

A builder for creating directories with configurable options.

For Unix-specific options, import the os::unix::fs::DirBuilderExt trait.

This type is an async version of std::fs::DirBuilder.

Methods

impl DirBuilder

pub fn new() -> DirBuilder

Creates a blank set of options.

The recursive option is initially set to false.

Examples

use async_std::fs::DirBuilder;

let builder = DirBuilder::new();

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_std::fs::DirBuilder;

let mut builder = DirBuilder::new();
builder.recursive(true);

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_std::fs::DirBuilder;

DirBuilder::new()
    .recursive(true)
    .create("./some/directory")
    .await?;

Trait Implementations

impl DirBuilderExt for DirBuilder

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

This is supported on Unix only.

Sets the mode to create new directories with. This option defaults to 0o777.

impl Default for DirBuilder

fn default() -> DirBuilder

Returns the "default value" for a type.

impl Debug for DirBuilder

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.