#nom #parser #patch #diff

gitpatch

Parse patches in the unified diff format

1 unstable release

new 0.7.1 Apr 15, 2025

#1496 in Parser implementations

MIT license

38KB
755 lines

Parse and produce patch files (diffs) in the Unified Format.

The format is not fully specified, but people like Guido van Rossum have done the work to figure out the details.

The parser attempts to be forgiving enough to be compatible with diffs produced by programs like git. It accomplishes this by ignoring the additional code context and information provided in the diff by those programs.

Example

// Make sure you add the `gitpatch` crate to the `[dependencies]` key of your Cargo.toml file.
use gitpatch::Patch;

let sample = "\
--- before.py
+++ path/to/after.py
@@ -1,4 +1,4 @@
-bacon
-eggs
-ham
+python
+eggy
+hamster
 guido\n";

let patch = Patch::from_single(sample)?;
assert_eq!(&patch.old.path, "before.py");
assert_eq!(&patch.new.path, "path/to/after.py");

// Print out the parsed patch file in its Rust representation
println!("{:#?}", patch);

// Print out the parsed patch file in the Unified Format. For input that was originally in the
// Unified Format, this will produce output identical to that original input.
println!("{}", patch); // use format!("{}\n", patch) to get this as a String

Patch

Checks Crates.io Badge docs.rs Lines of Code

Rust crate for parsing and producing patch files in the Unified Format.

The parser attempts to be forgiving enough to be compatible with diffs produced by programs like git. It accomplishes this by ignoring the additional code context and information provided in the diff by those programs.

See the Documentation for more information and for examples.

Dependencies

~2.5MB
~38K SLoC