Enum DirectoryExecutionPlanError

pub enum DirectoryExecutionPlanError {
    UnableToAccess {
        path: PathBuf,
        error: Error,
    },
    EntryEscapesSourceDirectory {
        path: PathBuf,
    },
    DestinationItemAlreadyExists {
        path: PathBuf,
    },
    SymbolicLinkIsBroken {
        path: PathBuf,
    },
}

Directory copy or move planning error.

Variants

UnableToAccess

A source or destination directory, one of its sub-directories or a file in it (or its metadata) cannot be read.

For example, this can happen due to missing read permissions.

The inner std::io::Error will likely describe a more precise cause of this error.

Fields

path: PathBuf

The path we were unable to access.

error: Error

IO error describing why the path could not be accessed.

EntryEscapesSourceDirectory

An item inside the source directory “escaped” outside of the base source directory.

Implementation detail

This is an extremely unlikely error, because its requirement is that std::fs::read_dir’s iterator returns a directory entry outside the provided directory path.

Even though this seems extremely unlikely, a panic! would be an extreme measure due to the many types of filesystems that exist. Instead, treat this as a truly fatal error.

Fields

path: PathBuf

The path that “escaped” the source directory.

DestinationItemAlreadyExists

A destination directory or a file inside it already exists, which is against the configured DestinationDirectoryRule.

This can also happen when we intended to copy a file to the destination, but a directory with the same name appeared mid-copy (an unavoidable time-of-check time-of-use bug).

The path field contains the path that already existed, causing this error.

Fields

path: PathBuf

Path of the target directory or file that already exists.

SymbolicLinkIsBroken

A broken symbolic link has been encountered inside the source directory.

This error can occur only when broken_symlink_behaviour is set to BrokenSymlinkBehaviour::Abort.

Fields

path: PathBuf

Path of the broken symbolic link.

Trait Implementations

impl Debug for DirectoryExecutionPlanError

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

Formats the value using the given formatter.

impl Display for DirectoryExecutionPlanError

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

Formats the value using the given formatter.

impl Error for DirectoryExecutionPlanError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<DirectoryExecutionPlanError> for CopyDirectoryPreparationError

fn from(source: DirectoryExecutionPlanError) -> Self

Converts to this type from the input type.

impl From<DirectoryExecutionPlanError> for MoveDirectoryPreparationError

fn from(source: DirectoryExecutionPlanError) -> Self

Converts to this type from the input type.