Struct PatchFormatter 

pub struct PatchFormatter { /* private fields */ }

Formats patches for display or writing into byte streams.

Examples

use diffy::PatchFormatter;
use diffy::create_patch;

let patch = create_patch("alpha\nbeta\n", "ALPHA\nbeta\n");
let formatter = PatchFormatter::new().missing_newline_message(false);
let mut output = Vec::new();

formatter.write_patch_into(&patch, &mut output).unwrap();

assert_eq!(
    String::from_utf8(output).unwrap(),
    "\
--- original
+++ modified
@@ -1,2 +1,2 @@
-alpha
+ALPHA
 beta
",
);

Implementations

impl PatchFormatter

pub fn new() -> Self

Construct a new formatter

Examples found in repository

examples/patch_formatter.rs (line 13)

fn main() {
    let original = "first line\nlast line";
    let modified = "first line\nmodified last line";

    let patch = create_patch(original, modified);

    println!("PatchFormatter::Default");
    println!("{patch}");

    let formatter = PatchFormatter::new().missing_newline_message(false);
    println!("{formatter:?}");
    println!("{}", formatter.fmt_patch(&patch));

    let formatter = PatchFormatter::new().with_color();
    println!("{formatter:?}");
    println!("{}", formatter.fmt_patch(&patch));

    let formatter = PatchFormatter::new()
        .with_color()
        .missing_newline_message(false);
    println!("{formatter:?}");
    println!("{}", formatter.fmt_patch(&patch));
}

pub fn with_color(self) -> Self

Available on crate feature color only.

Enable formatting a patch with color

Examples found in repository

examples/patch_formatter.rs (line 17)

fn main() {
    let original = "first line\nlast line";
    let modified = "first line\nmodified last line";

    let patch = create_patch(original, modified);

    println!("PatchFormatter::Default");
    println!("{patch}");

    let formatter = PatchFormatter::new().missing_newline_message(false);
    println!("{formatter:?}");
    println!("{}", formatter.fmt_patch(&patch));

    let formatter = PatchFormatter::new().with_color();
    println!("{formatter:?}");
    println!("{}", formatter.fmt_patch(&patch));

    let formatter = PatchFormatter::new()
        .with_color()
        .missing_newline_message(false);
    println!("{formatter:?}");
    println!("{}", formatter.fmt_patch(&patch));
}

pub fn missing_newline_message(self, enable: bool) -> Self

Sets whether to format a patch with a “No newline at end of file” message.

Default is true.

Note: If this is disabled by setting to false, formatted patches will no longer contain sufficient information to determine if a file ended with a newline character (\n) or not and the patch will be formatted as if both the original and modified files ended with a newline character (\n).

Examples found in repository

examples/patch_formatter.rs (line 13)

fn main() {
    let original = "first line\nlast line";
    let modified = "first line\nmodified last line";

    let patch = create_patch(original, modified);

    println!("PatchFormatter::Default");
    println!("{patch}");

    let formatter = PatchFormatter::new().missing_newline_message(false);
    println!("{formatter:?}");
    println!("{}", formatter.fmt_patch(&patch));

    let formatter = PatchFormatter::new().with_color();
    println!("{formatter:?}");
    println!("{}", formatter.fmt_patch(&patch));

    let formatter = PatchFormatter::new()
        .with_color()
        .missing_newline_message(false);
    println!("{formatter:?}");
    println!("{}", formatter.fmt_patch(&patch));
}

pub fn suppress_blank_empty(self, enable: bool) -> Self

Sets whether to suppress printing of a space before empty lines.

Defaults to true.

For more information you can refer to the Omitting trailing blanks manual page of GNU diff or the diff.suppressBlankEmpty config for git-diff.

pub fn fmt_patch<'a>(&'a self, patch: &'a Patch<'a, str>) -> impl Display + 'a

Returns a Display impl which can be used to print a Patch

Examples found in repository

examples/patch_formatter.rs (line 15)

fn main() {
    let original = "first line\nlast line";
    let modified = "first line\nmodified last line";

    let patch = create_patch(original, modified);

    println!("PatchFormatter::Default");
    println!("{patch}");

    let formatter = PatchFormatter::new().missing_newline_message(false);
    println!("{formatter:?}");
    println!("{}", formatter.fmt_patch(&patch));

    let formatter = PatchFormatter::new().with_color();
    println!("{formatter:?}");
    println!("{}", formatter.fmt_patch(&patch));

    let formatter = PatchFormatter::new()
        .with_color()
        .missing_newline_message(false);
    println!("{formatter:?}");
    println!("{}", formatter.fmt_patch(&patch));
}

pub fn write_patch_into<T: ToOwned + AsRef<[u8]> + ?Sized, W: Write>( &self, patch: &Patch<'_, T>, w: W, ) -> Result<()>

Available on crate feature std only.

Writes a formatted patch into a writer.

This is the byte-oriented equivalent of fmt_patch for callers that want to stream the formatted patch into an io::Write sink instead of going through Display.

Trait Implementations

impl Debug for PatchFormatter

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

Formats the value using the given formatter.

impl Default for PatchFormatter

fn default() -> Self

Returns the “default value” for a type.