Struct async_std::fs::DirBuilder

pub struct DirBuilder { /* fields omitted */ }

A builder for creating directories in various manners.

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

Methods

impl DirBuilder

pub fn new() -> DirBuilder

Creates a new builder with recursive set to false.

Examples

use async_std::fs::DirBuilder;

let builder = DirBuilder::new();

Important traits for &'_ mut F

impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized,  type Output = <F as Future>::Output;

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

Sets the option for recursive mode.

This option, when true, means that all parent directories should be created recursively if they don't exist. Parents are created with the same security settings and permissions as the final directory.

This option defaults 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.

Examples

use async_std::fs::DirBuilder;

DirBuilder::new()
    .recursive(true)
    .create("/tmp/foo/bar/baz")
    .await?;

Trait Implementations

impl DirBuilderExt for DirBuilder

Important traits for &'_ mut F

impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized,  type Output = <F as Future>::Output;

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 Debug for DirBuilder

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

Formats the value using the given formatter.