Struct tokio::fs::DirBuilder

source ·
pub struct DirBuilder { /* private fields */ }
Expand description

A builder for creating directories in various manners.

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

Implementations§

source§

impl DirBuilder

source

pub fn new() -> Self

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

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

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

pub async fn create(&self, path: impl AsRef<Path>) -> Result<()>

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(())
}
source§

impl DirBuilder

source

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

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§

source§

impl Debug for DirBuilder

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for DirBuilder

source§

fn default() -> DirBuilder

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

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

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.