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

pub struct DirBuilder { /* fields omitted */ }

A builder for creating directories in various manners.

Additional Unix-specific options are available via importing the DirBuilderExt trait.

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: Future + Unpin + ?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<P: AsRef<Path>>(&self, path: P) -> 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(())
}

Trait Implementations

impl Debug for DirBuilder[src]

impl Default for DirBuilder[src]

impl DirBuilderExt for DirBuilder[src]

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

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

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

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

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

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

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.

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.