Struct async_std::fs::DirBuilder

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

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.

Implementations§

source§

impl DirBuilder

source

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

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

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§

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
source§

impl DirBuilderExt for DirBuilder

source§

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

Sets the mode to create new directories with. This option defaults to 0o777. 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> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more