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