Enum FormatError 

pub enum FormatError {
    SyntaxError {
        message: &'static str,
    },
    RangeError {
        input: TextRange,
        tree: TextRange,
    },
    InvalidDocument(InvalidDocumentError),
    PoorLayout,
}

Series of errors encountered during formatting

Variants

SyntaxError

In case a node can’t be formatted because it either misses a require child element or a child is present that should not (e.g. a trailing comma after a rest element).

Fields

message: &'static str

RangeError

In case range formatting failed because the provided range was larger than the formatted syntax tree

Fields

input: TextRange

tree: TextRange

InvalidDocument(InvalidDocumentError)

In case printing the document failed because it has an invalid structure.

PoorLayout

Formatting failed because some content encountered a situation where a layout choice by an enclosing crate::Format resulted in a poor layout for a child crate::Format.

It’s up to an enclosing crate::Format to handle the error and pick another layout. This error should not be raised if there’s no outer crate::Format handling the poor layout error, avoiding that formatting of the whole document fails.

Implementations

impl FormatError

pub fn syntax_error(message: &'static str) -> Self

Trait Implementations

impl Clone for FormatError

fn clone(&self) -> FormatError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for FormatError

impl Debug for FormatError

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

Formats the value using the given formatter.

impl Display for FormatError

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

Formats the value using the given formatter.

impl Eq for FormatError

impl Error for FormatError

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 From<&PrintError> for FormatError

fn from(error: &PrintError) -> Self

Converts to this type from the input type.

impl From<PrintError> for FormatError

fn from(error: PrintError) -> Self

Converts to this type from the input type.

impl PartialEq for FormatError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FormatError