kvarn_utils::prelude::fmt

Struct Error

1.0.0 · source
pub struct Error;
Expand description

The error type which is returned from formatting a message into a stream.

This type does not support transmission of an error other than that an error occurred. This is because, despite the existence of this error, string formatting is considered an infallible operation. fmt() implementors should not return this Error unless they received it from their Formatter. The only time your code should create a new instance of this error is when implementing fmt::Write, in order to cancel the formatting operation when writing to the underlying stream fails.

Any extra information must be arranged to be transmitted through some other means, such as storing it in a field to be consulted after the formatting operation has been cancelled. (For example, this is how std::io::Write::write_fmt() propagates IO errors during writing.)

This type, fmt::Error, should not be confused with std::io::Error or std::error::Error, which you may also have in scope.

§Examples

use std::fmt::{self, write};

let mut output = String::new();
if let Err(fmt::Error) = write(&mut output, format_args!("Hello {}!", "world")) {
    panic!("An error occurred");
}

Trait Implementations§

<