Enum FormatWriteError 

#[non_exhaustive]
pub enum FormatWriteError {
    Encoding(OneShotError),
    Formatter {
        confirmed: usize,
    },
    Backend {
        fault: BackendFault,
        confirmed: usize,
    },
}

Error from allocation-free formatter encoding.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Encoding(OneShotError)

Encoding preflight failed before any formatter call.

Formatter

A formatter call returned fmt::Error.

Fields

confirmed: usize

Bytes passed through fully successful prior write_str calls.

Backend

A validated internal output invariant failed.

Fields

fault: BackendFault

Internal backend failure classification.

confirmed: usize

Bytes passed through fully successful prior write_str calls.

Implementations

impl FormatWriteError

pub const fn confirmed(&self) -> usize

Returns bytes confirmed by fully successful formatter calls.

A failing write_str implementation may have partially mutated its sink before returning. Those unreported bytes are intentionally not included.

Trait Implementations

impl Clone for FormatWriteError

fn clone(&self) -> FormatWriteError

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for FormatWriteError

impl Debug for FormatWriteError

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

Formats the value using the given formatter.

impl Display for FormatWriteError

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

Formats the value using the given formatter.

impl Eq for FormatWriteError

impl Error for FormatWriteError

Available on crate feature std only.

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl PartialEq for FormatWriteError

fn eq(&self, other: &FormatWriteError) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for FormatWriteError