Struct FormattedOutput

pub struct FormattedOutput { /* private fields */ }

A value that has been formatted with Format.

Formatting a value with Format returns this opaque type rather than a string, since we need to encapsulate the colors and text styles information in a cross-platform way. While ANSI escape codes can be included in a string, other platforms (such as Windows) have their own mechanisms for including colors and text styles in stdout/stderr.

Implementations

impl FormattedOutput

pub fn new<Value, Fmt>(value: Value, format: Fmt) -> Result<Self>

where Fmt: Format<Value = Value>,

Create a new FormattedOutput by formatting value with format.

pub fn indented(self, prefix: impl AsRef<str>) -> Self

Return a new FormattedOutput which has been indented by prefix.

To indent with whitespace, you can use whitespace.

pub fn indented_hanging(self, prefix: impl AsRef<str>) -> Self

Return a new FormattedOutput which has been indented by prefix with a hanging indent.

This is the same as indented, but generates a hanging indent.

pub fn fail(&self) -> !

Panic with this output as the error message.

This does not print colors or text styles when the NO_COLOR environment variable is set or when stderr is not a tty.

Trait Implementations

impl Debug for FormattedOutput

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

Formats the value using the given formatter.

impl Display for FormattedOutput

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

Formats the value using the given formatter.

impl From<FormattedFailure> for FormattedOutput

fn from(fail: FormattedFailure) -> Self

Converts to this type from the input type.

impl<Pos, Neg> From<MatchFailure<Pos, Neg>> for FormattedOutput

where Pos: Into<FormattedOutput>, Neg: Into<FormattedOutput>,

fn from(fail: MatchFailure<Pos, Neg>) -> Self

Converts to this type from the input type.