Enum PatchError 

pub enum PatchError {
    PathTraversal(PathBuf),
    TargetNotFound(PathBuf),
    PermissionDenied {
        path: PathBuf,
    },
    TargetIsDirectory {
        path: PathBuf,
    },
    Io {
        path: PathBuf,
        source: Error,
    },
}

Represents “hard” errors that can occur during patch operations.

This error type is returned by functions like apply_patch_to_file() for unrecoverable issues such as I/O errors, permission problems, or security violations like path traversal. It is distinct from a partial apply, which is handled by the result structs.

Examples

let dir = tempdir()?;
// Note: "missing.txt" does not exist in the directory.

let diff = r#"
```diff
--- a/missing.txt
+++ b/missing.txt
@@ -1 +1 @@
-foo
+bar
```
"#;
let patch = parse_single_patch(diff)?;
let options = ApplyOptions::new();

// This will fail because the target file doesn't exist and it's not a creation patch.
let result = apply_patch_to_file(&patch, dir.path(), options);

assert!(matches!(result, Err(PatchError::TargetNotFound(_))));

Variants

PathTraversal(PathBuf)

The patch attempted to access a path outside the target directory. This is a security measure to prevent malicious patches from modifying unintended files (e.g., --- a/../../etc/passwd).

Examples

use mpatch::PatchError;
use std::path::PathBuf;
let err = PatchError::PathTraversal(PathBuf::from("../../etc/passwd"));

TargetNotFound(PathBuf)

The target file for a patch could not be found, and the patch did not appear to be for file creation (i.e., its first hunk was not an addition-only hunk).

Examples

use mpatch::PatchError;
use std::path::PathBuf;
let err = PatchError::TargetNotFound(PathBuf::from("missing.txt"));

PermissionDenied

The user does not have permission to read or write to the specified path.

Examples

use mpatch::PatchError;
use std::path::PathBuf;
let err = PatchError::PermissionDenied { path: PathBuf::from("readonly.txt") };

Fields

path: PathBuf

The path that could not be accessed.

Examples

use mpatch::PatchError;
use std::path::PathBuf;
let err = PatchError::PermissionDenied { path: PathBuf::from("readonly.txt") };
match err {
    PatchError::PermissionDenied { path } => assert_eq!(path.to_str(), Some("readonly.txt")),
    _ => unreachable!(),
}

TargetIsDirectory

The target path for a patch exists but is a directory, not a file.

Examples

use mpatch::PatchError;
use std::path::PathBuf;
let err = PatchError::TargetIsDirectory { path: PathBuf::from("src/") };

Fields

path: PathBuf

The path that resolved to a directory.

Examples

use mpatch::PatchError;
use std::path::PathBuf;
let err = PatchError::TargetIsDirectory { path: PathBuf::from("src/") };
match err {
    PatchError::TargetIsDirectory { path } => assert_eq!(path.to_str(), Some("src/")),
    _ => unreachable!(),
}

Io

An I/O error occurred while reading or writing a file. This is a “hard” error that stops the entire process.

Examples

use mpatch::PatchError;
use std::path::PathBuf;
use std::io::{Error, ErrorKind};
let err = PatchError::Io { path: PathBuf::from("file.txt"), source: Error::new(ErrorKind::Other, "oh no") };

Fields

path: PathBuf

The path associated with the I/O error.

Examples

use mpatch::PatchError;
use std::path::PathBuf;
use std::io::{Error, ErrorKind};
let err = PatchError::Io { path: PathBuf::from("file.txt"), source: Error::new(ErrorKind::Other, "oh no") };
match err {
    PatchError::Io { path, .. } => assert_eq!(path.to_str(), Some("file.txt")),
    _ => unreachable!(),
}

source: Error

The underlying I/O error.

Examples

use mpatch::PatchError;
use std::path::PathBuf;
use std::io::{Error, ErrorKind};
let err = PatchError::Io { path: PathBuf::from("file.txt"), source: Error::new(ErrorKind::Other, "oh no") };
match err {
    PatchError::Io { source, .. } => assert_eq!(source.kind(), ErrorKind::Other),
    _ => unreachable!(),
}

Trait Implementations

impl Debug for PatchError

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

Formats the value using the given formatter.

impl Display for PatchError

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

Formats the value using the given formatter.

impl Error for PatchError

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<PatchError> for StrictApplyError

fn from(source: PatchError) -> Self

Converts to this type from the input type.