Struct OutputDir

pub struct OutputDir(PathBuf);

An output directory that is guaranteed to be an absolute, writable directory.

Tuple Fields

0: PathBuf

Implementations

impl OutputDir

pub fn new(path: PathBuf) -> Result<Self, Error>

Creates a new OutputDir from path.

Creates a directory at path if it does not exist yet. Also creates any missing parent directories.

Errors

Returns an error if

• path is not absolute,
• path does not exist and cannot be created,
• the metadata of path cannot be retrieved,
• path is not a directory,
• or path is only read-only.

pub fn as_path(&self) -> &Path

Coerces to a Path slice.

pub fn to_path_buf(&self) -> PathBuf

Converts a Path to an owned PathBuf.

pub fn join(&self, path: impl AsRef<Path>) -> PathBuf

Creates an owned PathBuf with path adjoined to self.

Trait Implementations

impl AsRef<Path> for OutputDir

fn as_ref(&self) -> &Path

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for OutputDir

fn clone(&self) -> OutputDir

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OutputDir

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

Formats the value using the given formatter.

impl From<&OutputDir> for ExistingAbsoluteDir

fn from(value: &OutputDir) -> Self

Creates an ExistingAbsoluteDir from an OutputDir.

As OutputDir provides a more strict set of requirements, this can be infallible.