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

# 1.6.0[−][src]Struct std::fs::DirBuilder

    pub struct DirBuilder { /* fields omitted */ }

A builder used to create directories in various manners.

This builder also supports platform-specific options.

## Methods

### `impl DirBuilder`[src]

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

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

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

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

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

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

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

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

Formats the value using the given formatter. Read more

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

#### `fn mode(&mut self, mode: u32) -> &mut DirBuilder`[src]

This is supported on Unix only.

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

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

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

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

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

#### `fn borrow(&self) -> &T`[src]

Immutably borrows from an owned value. Read more

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

#### `fn borrow_mut(&mut self) -> &mut T`[src]

Mutably borrows from an owned value. Read more

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

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

Performs the conversion.

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

#### `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.

#### `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.

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

Performs the conversion.