Struct xpct::format::HeaderFormat

source ·
pub struct HeaderFormat<Fmt> { /* private fields */ }
Expand description

A formatter that adds a header to the output of another formatter.

Examples

let formatter = HeaderFormat::new(
    SomeFailuresFormat::new(),
    "Expected at least one of these to match:",
    "Expected all of these to match:",
);

Implementations§

source§

impl<Fmt> HeaderFormat<Fmt>

source

pub fn new( inner: Fmt, pos_header: impl Into<String>, neg_header: impl Into<String> ) -> Self

Create a new HeaderFormat from the header string and inner formatter.

This accepts two header strings, one for the positive case and one for the negative case respectively. The first is used normally, and the second is used when the matcher is negated.

Trait Implementations§

source§

impl<Fmt: Debug> Debug for HeaderFormat<Fmt>

source§

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

Formats the value using the given formatter. Read more
source§

impl<Fmt: Default> Default for HeaderFormat<Fmt>

source§

fn default() -> HeaderFormat<Fmt>

Returns the “default value” for a type. Read more
source§

impl<Fmt> Format for HeaderFormat<Fmt>where Fmt: Format,

§

type Value = MatchFailure<<Fmt as Format>::Value, <Fmt as Format>::Value>

The value to format.
source§

fn fmt(&self, f: &mut Formatter, value: Self::Value) -> Result<()>

Format the value.

Auto Trait Implementations§

§

impl<Fmt> RefUnwindSafe for HeaderFormat<Fmt>where Fmt: RefUnwindSafe,

§

impl<Fmt> Send for HeaderFormat<Fmt>where Fmt: Send,

§

impl<Fmt> Sync for HeaderFormat<Fmt>where Fmt: Sync,

§

impl<Fmt> Unpin for HeaderFormat<Fmt>where Fmt: Unpin,

§

impl<Fmt> UnwindSafe for HeaderFormat<Fmt>where Fmt: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, Pos, Neg> MatcherFormat for Twhere T: Format<Value = MatchFailure<Pos, Neg>>,

§

type Pos = Pos

The match result in the positive case (when we were expecting the matcher to succeed).
§

type Neg = Neg

The match result in the negative case (when we were expecting the matcher to fail).
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.