Struct pretty_assertions::StrComparison

pub struct StrComparison<'a, TLeft, TRight>where
    TLeft: ?Sized,
    TRight: ?Sized,{ /* private fields */ }

A comparison of two strings.

In contrast to Comparison, which uses the core::fmt::Debug representation, StrComparison uses the string values directly, resulting in multi-line output for multiline strings.

use pretty_assertions::StrComparison;

print!("{}", StrComparison::new("foo\nbar", "foo\nbaz"));

Value type bounds

Any value that can be referenced as a str via AsRef may be used:

use pretty_assertions::StrComparison;

#[derive(PartialEq)]
struct MyString(String);

impl AsRef<str> for MyString {
    fn as_ref(&self) -> &str {
        &self.0
    }
}

print!(
    "{}",
    StrComparison::new(
        &MyString("foo\nbar".to_owned()),
        &MyString("foo\nbaz".to_owned()),
    ),
);

The values may have different types, although in practice they are usually the same.

Implementations

impl<'a, TLeft, TRight> StrComparison<'a, TLeft, TRight>where
    TLeft: AsRef<str> + ?Sized,
    TRight: AsRef<str> + ?Sized,

pub fn new(
    left: &'a TLeft,
    right: &'a TRight
) -> StrComparison<'a, TLeft, TRight>

Store two values to be compared in future.

Expensive diffing is deferred until calling Debug::fmt.

Trait Implementations

impl<'a, TLeft, TRight> Display for StrComparison<'a, TLeft, TRight>where
    TLeft: AsRef<str> + ?Sized,
    TRight: AsRef<str> + ?Sized,

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

Formats the value using the given formatter.