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

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

Important traits for &'_ mut F

impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized,  type Output = <F as Future>::Output;impl<'_, I> Iterator for &'_ mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;impl<R: Read + ?Sized, '_> Read for &'_ mut Rimpl<W: Write + ?Sized, '_> Write for &'_ mut W

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

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

Trait Implementations

impl DirBuilderExt for DirBuilder

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

This is supported on Unix only.

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

impl Debug for DirBuilder

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.