Struct ScopedDirBuilder

pub struct ScopedDirBuilder { /* private fields */ }

Safe version of DirBuilder to protect from TOCTOU style of attacks.

The ScopedDirBuilder is a counterpart for DirBuilder, with safety enhancements of:

• ensuring the new directories are created under a specified root directory.
• ensuring all created directories are still scoped under root even under symlink based attacks.
• returning a PinnedPathBuf for the last level of directory, so it could be used for other operations safely.

Implementations

impl ScopedDirBuilder

pub fn new<P: AsRef<Path>>(root: P) -> Result<Self>

Create a new instance of ScopedDirBuilder with with default mode/security settings.

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.

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

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

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

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

This is a helper to create subdirectory with an absolute path, without stripping off self.root. So error will be returned if path does start with self.root. It is considered an error if the directory already exists unless recursive mode is enabled.

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

Creates sub-directory with the options configured in this builder.

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

Trait Implementations

impl Debug for ScopedDirBuilder

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

Formats the value using the given formatter.