Struct PatchFormatter

pub struct PatchFormatter { /* private fields */ }

Struct used to adjust the formatting of a Patch

Implementations

impl PatchFormatter

pub fn new() -> Self

Construct a new formatter

pub fn with_color(self) -> Self

Enable formatting a patch with color

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).

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

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

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.