Struct Diagnostic

pub struct Diagnostic<T>
where
    T: Clone + PartialEq + Eq + Style + Debug,
{ /* private fields */ }

Diagnostic is a collection of various components, and any data structure that implements Component can be a part of Diagnostic.

Examples

// If you want a diagnostic message “error[E3033]: this is an error!”.
let mut diagnostic = Diagnostic::new();

// First, create a label component wrapped by `Box<>`
let err_label = Box::new(Label::Error("E3033".to_string()));

// Second, add the label component to `Diagnostic`.
diagnostic.append_component(err_label);

// Then, create a string component wrapped by `Box<>`.
let msg = Box::new(": this is an error!".to_string());

// And add it to `Diagnostic`.
diagnostic.append_component(msg);

// Create a `Styledbuffer` to get the result.
let mut sb = StyledBuffer::<DiagnosticStyle>::new();

// Create an error set for collecting errors.
let mut errs = vec![];

// Rendering !
diagnostic.format(&mut sb, &mut errs);
let result = sb.render();

// “error[E3033]: this is an error!” is only one line.
assert_eq!(result.len(), 1);

// “error[E3033]: this is an error!” has three different style snippets.

// "error" - DiagnosticStyle::NeedFix
// "[E3033]" - DiagnosticStyle::Helpful
// ": this is an error!" - None

// `DiagnosticStyle` can be rendered into different text colors and formats when diaplaying.

assert_eq!(result.get(0).unwrap().len(), 3);
assert_eq!(result.get(0).unwrap().get(0).unwrap().text, "error");
assert_eq!(result.get(0).unwrap().get(1).unwrap().text, "[E3033]");
assert_eq!(result.get(0).unwrap().get(2).unwrap().text, ": this is an error!");

assert_eq!(result.get(0).unwrap().get(0).unwrap().style, Some(DiagnosticStyle::NeedFix));
assert_eq!(result.get(0).unwrap().get(1).unwrap().style, Some(DiagnosticStyle::Helpful));
assert_eq!(result.get(0).unwrap().get(2).unwrap().style, None);

Implementations

impl<T> Diagnostic<T>

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

pub fn new() -> Self

pub fn append_component(&mut self, component: Box<dyn Component<T>>)

pub fn prepend_component(&mut self, component: Box<dyn Component<T>>)

Trait Implementations

impl<T> Component<T> for Diagnostic<T>

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

fn format(&self, sb: &mut StyledBuffer<T>, errs: &mut Vec<ComponentFormatError>)

format() formats components into StyledString and saves them in StyledBuffer.

impl<T> Debug for Diagnostic<T>

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

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

Formats the value using the given formatter.

impl<T> Default for Diagnostic<T>

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

fn default() -> Diagnostic<T>

Returns the “default value” for a type.

impl<T> PartialEq for Diagnostic<T>

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

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.