Struct DrawDiff

pub struct DrawDiff<'a> { /* private fields */ }

The struct that draws the diff

Can use either the similar crate or our own Myers algorithm implementation

Implementations

impl<'input> DrawDiff<'input>

pub fn new<'a>(old: &'a str, new: &'a str, theme: &'a dyn Theme) -> DrawDiff<'a>

Make a new instance of the diff drawer

Examples

use termdiff::{ArrowsTheme, DrawDiff};
let theme = ArrowsTheme::default();
assert_eq!(
    format!(
        "{}",
        DrawDiff::new(
            "The quick brown fox and\njumps over the sleepy dog",
            "The quick red fox and\njumps over the lazy dog",
            &theme
        )
    ),
    "< left / > right
<The quick brown fox and
<jumps over the sleepy dog
>The quick red fox and
>jumps over the lazy dog
"
);

pub fn with_algorithm<'a>( old: &'a str, new: &'a str, theme: &'a dyn Theme, algorithm: Algorithm, ) -> DrawDiff<'a>

Make a new instance of the diff drawer with a specific algorithm

Examples

use termdiff::{Algorithm, ArrowsTheme, DrawDiff};
let theme = ArrowsTheme::default();
assert_eq!(
    format!(
        "{}",
        DrawDiff::with_algorithm(
            "The quick brown fox and\njumps over the sleepy dog",
            "The quick red fox and\njumps over the lazy dog",
            &theme,
            Algorithm::Myers
        )
    ),
    "< left / > right
<The quick brown fox and
<jumps over the sleepy dog
>The quick red fox and
>jumps over the lazy dog
"
);

Trait Implementations

impl<'a> Debug for DrawDiff<'a>

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

Formats the value using the given formatter.

impl Display for DrawDiff<'_>

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

Formats the value using the given formatter.

impl From<DrawDiff<'_>> for String

fn from(diff: DrawDiff<'_>) -> Self

Converts to this type from the input type.