# Struct std::fs::DirBuilder

1.6.0 · source ·

    pub struct DirBuilder { /* private fields */ }

Expand description

A builder used to create directories in various manners.

This builder also supports platform-specific options.

## Implementations§

source§

### impl DirBuilder

source

#### pub fn new() -> DirBuilder

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

##### Examples

    use std::fs::DirBuilder;

    let builder = DirBuilder::new();

Run
source

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

Indicates that directories should be created recursively, creating all parent directories. Parents that do not exist are created with the same security and permissions settings.

This option defaults to `false`.

##### Examples

    use std::fs::DirBuilder;

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

Run
source

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

Creates the specified directory with the options configured in this builder.

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

##### Examples

    use std::fs::{self, DirBuilder};

    let path = "/tmp/foo/bar/baz";
    DirBuilder::new()
        .recursive(true)
        .create(path).unwrap();

    assert!(fs::metadata(path).unwrap().is_dir());

Run

## 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 DirBuilderExt for DirBuilder

Available on Unix only.
source§

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

Sets the mode to create new directories with. This option defaults to 0o777. Read more

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

source§

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

source§

#### fn type_id(&self) -> TypeId

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

### impl<T> Borrow<T> for Twhere T: ?Sized,

source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

### impl<T> BorrowMut<T> for Twhere 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 Twhere 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 Twhere 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 Twhere 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.