Struct Formatted 

pub struct Formatted<'a> { /* private fields */ }

A diagnostic formatted for printing.

A Formatted can be printing and converted to a string directly via it’s Display implementation.

Alternatively, you can iterate over the individual Lines and from there over pairs of &str and Style. This allows you to apply custom styling (e.g. colors) to individual parts of the diagnostic.

Formatted also provides a short one-line summary.

Example

use aldrin_parser::{Diagnostic, Parser};

let parsed = Parser::new().parse("schemas/duplicate_id.aldrin");
let err = &parsed.errors()[0];
let formatted = err.format(&parsed);

// Print via Display:
eprintln!("{}", formatted);

// Print a one-line summary:
eprintln!("Error: {}.", formatted.summary());

// Print manually to apply styling to the output:
for line in &formatted {
    for (chunk, style) in line {
        // Apply style to chunk, e.g. colorize the output.
        eprint!("{}", chunk);
    }

    eprintln!();
}

Implementations

impl<'a> Formatted<'a>

pub fn kind(&self) -> DiagnosticKind

Kind of the diagnostic; error or warning.

pub fn summary(&self) -> &str

Short one-line summary.

The summary begins with a lower-case letter and doesn’t end with any punctuation.

Example

eprintln!("An issue occurred: {}.", formatted.summary());

pub fn len(&self) -> usize

Returns the number of lines.

pub fn lines(&'a self) -> Lines<'a>

Returns an iterator over the lines.

Trait Implementations

impl<'a> Clone for Formatted<'a>

fn clone(&self) -> Formatted<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Formatted<'a>

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

Formats the value using the given formatter.

impl Display for Formatted<'_>

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

Formats the value using the given formatter.

impl<'a> IntoIterator for &'a Formatted<'a>

type Item = &'a Line<'a>

The type of the elements being iterated over.

type IntoIter = Lines<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.