# tokio::fs::DirBuilder - Rust
API documentation for the Rust `DirBuilder` struct in crate `tokio`.
Keywords: rust, rustlang, rust-lang, DirBuilder

# Struct tokio::fs::DirBuilder [−] [src]

    pub struct DirBuilder { /* fields omitted */ }

A builder for creating directories in various manners.

This is a specialized version of `std::fs::DirBuilder` for usage on the Tokio runtime.

## Implementations

### `impl DirBuilder` [src]

#### `pub fn new() -> Self` [src]

Creates a new set of options with default mode/security settings for all platforms and also non-recursive.

This is an async version of `std::fs::DirBuilder::new`

# Examples

    use tokio::fs::DirBuilder;

    let builder = DirBuilder::new();

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

### Notable traits for &'_ mut F

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

Indicates whether to create directories recursively (including all parent directories). Parents that do not exist are created with the same security and permissions settings.

This option defaults to `false`.

This is an async version of `std::fs::DirBuilder::recursive`

# Examples

    use tokio::fs::DirBuilder;

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

#### `pub async fn create(&self, path: impl AsRef<Path>) -> Result<()>` [src]

Creates the specified directory with the configured options.

It is considered an error if the directory already exists unless recursive mode is enabled.

This is an async version of `std::fs::DirBuilder::create`

# Errors

An error will be returned under the following circumstances:

- Path already points to an existing file.
- Path already points to an existing directory and the mode is non-recursive.
- The calling process doesn't have permissions to create the directory or its missing parents.
- Other I/O error occurred.

# Examples

    use tokio::fs::DirBuilder;
    use std::io;

    #[tokio::main]
    async fn main() -> io::Result<()> {
        DirBuilder::new()
            .recursive(true)
            .create("/tmp/foo/bar/baz")
            .await?;

        Ok(())
    }

### `impl DirBuilder` [src]

#### `pub fn mode(&mut self, mode: u32) -> &mut Selfⓘ

### Notable traits for &'_ mut F

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

Sets the mode to create new directories with.

This option defaults to 0o777.

# Examples

    use tokio::fs::DirBuilder;

    let mut builder = DirBuilder::new();
    builder.mode(0o775);

## Trait Implementations

### `impl Debug for DirBuilder` [src]

#### `fn fmt(&self, f: &mut Formatter<'_>) -> Result` [src]

Formats the value using the given formatter. Read more

### `impl Default for DirBuilder` [src]

#### `fn default() -> DirBuilder` [src]

Returns the "default value" for a type. Read more

## Auto Trait Implementations

### `impl RefUnwindSafe for DirBuilder` [src]

### `impl Send for DirBuilder` [src]

### `impl Sync for DirBuilder` [src]

### `impl Unpin for DirBuilder` [src]

### `impl UnwindSafe for DirBuilder` [src]

## Blanket Implementations

### `impl<T> Any for T where
T: 'static + ?Sized,` [src]

#### `pub fn type_id(&self) -> TypeId` [src]

Gets the `TypeId` of `self`. Read more

### `impl<T> Borrow<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow(&self) -> &Tⓘ

### Notable traits for &'_ mut F

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

Immutably borrows from an owned value. Read more

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow_mut(&mut self) -> &mut Tⓘ

### Notable traits for &'_ mut F

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

Mutably borrows from an owned value. Read more

### `impl<T> From<T> for T` [src]

#### `pub fn from(t: T) -> T` [src]

Performs the conversion.

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `pub fn into(self) -> U` [src]

Performs the conversion.

### `impl<T, U> TryFrom<U> for T where
U: Into<T>,` [src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

#### `pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>` [src]

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

#### `type Error = <U as TryFrom<T>>::Error`

The type returned in the event of a conversion error.

#### `pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>` [src]

Performs the conversion.