Struct EmitterWriter 

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

EmitterWriter implements trait Emitter based on termcolor1.0 for rendering diagnostic as strings and displaying them to the terminal.

termcolor1.0 supports displaying colorful string to terminal.

Examples

// 1. Create a EmitterWriter
let mut term_emitter = EmitterWriter::default();

// 2. Create a diagnostic for emitting.
let mut diagnostic = Diagnostic::<DiagnosticStyle>::new();

// 3. Create components wrapped by `Box<>`.
let err_label = Box::new(Label::Error("E3033".to_string()));
let msg = Box::new(": this is an error!".to_string());

// 4. Add components to `Diagnostic`.
diagnostic.append_component(err_label);
diagnostic.append_component(msg);

// 5. Emit the diagnostic.
term_emitter.emit_diagnostic(&diagnostic);

Implementations

impl<'a> EmitterWriter<'a>

pub fn new_with_writer(dst: Destination<'a>) -> Self

Return a Destination with custom writer.

Examples

use compiler_base_error::Destination;
use compiler_base_error::EmitterWriter;
use termcolor::ColorChoice;
// 1. Create a `Destination` and close the color.
let dest = Destination::from_stderr(ColorChoice::Never);

// 2. Create the EmiterWriter by `Destination` with writer stderr.
let emitter_writer = EmitterWriter::new_with_writer(dest);

Trait Implementations

impl<'a> Default for EmitterWriter<'a>

fn default() -> Self

Return a Destination with writer stderr.

impl<'a, T> Emitter<T> for EmitterWriter<'a>

where T: Clone + PartialEq + Eq + Style + Debug,

fn supports_color(&self) -> bool

Checks if we can use colors in the current output stream. Depends on termcolor1.0 which supports color.

fn emit_diagnostic(&mut self, diag: &Diagnostic<T>) -> Result<()>

Emit a structured diagnostic. It will call format_diagnostic first to format the Diagnostic into StyledString.

It will panic if something wrong during emitting.

fn format_diagnostic( &mut self, diag: &Diagnostic<T>, ) -> Result<StyledBuffer<T>, ComponentError>

Format struct Diagnostic into String and render String into StyledString, and save StyledString in StyledBuffer.