Struct FormatError 

#[non_exhaustive]
pub struct FormatError {
    pub kind: FormatErrorKind,
    pub position: Option<Position>,
    pub message: String,
}

A document of one format that cannot be read or written: what kind of trouble it is, where the reader stood, and the reader’s own words.

Its Display is the message alone; the Error variant holding it names the format, and holds it boxed, so that the crate’s every Result is no wider for it.

use music21::error::{FormatErrorKind, Position};

let error = music21::mei::from_mei("<mei><music").unwrap_err();
let read = error.format_error().unwrap();
assert_eq!(read.kind, FormatErrorKind::Malformed);
assert_eq!(error.position(), Some(&Position::line(1).with_column(12)));

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

kind: FormatErrorKind

What kind of trouble it is.

position: Option<Position>

Where in the document the reader was, where it knows.

message: String

What the reader or writer says went wrong.

Implementations

impl FormatError

pub fn new(kind: FormatErrorKind, message: impl Into<String>) -> Self

An error of kind saying message, at no position yet.

pub fn with_position(self, position: Position) -> Self

The same error, at position.

Trait Implementations

impl Clone for FormatError

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for FormatError

impl PartialEq for FormatError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FormatError