Struct file_system::DirBuilder

pub struct DirBuilder {
    inner: DirBuilder,
    recursive: bool,
}

A builder used to create directories in various manners.

This builder also supports platform-specific options.

Fields

inner: DirBuilder

recursive: bool

Implementations

impl DirBuilder

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

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

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

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

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

Trait Implementations

impl Debug for DirBuilder

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

Formats the value using the given formatter.

impl DirBuilderExt for DirBuilder

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

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