Struct Rendered 

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

A finding prepared for display.

Built with Diagnostic::render style helpers on this type and then formatted. Without a source buffer it renders the heading and the labelled details; with one it also quotes and underlines the offending line.

Examples

use molframe_core::{Code, Diagnostic, Rendered};

let finding = Diagnostic::new(Code::E1106);
let text = Rendered::new(&finding).to_string();
assert!(text.starts_with("error[MOLFRAME-E1106]"));

Implementations

impl<'a> Rendered<'a>

pub const fn new(finding: &'a Diagnostic) -> Self

Prepares a finding for display with no source context and no colour.

pub const fn with_source(self, source: &'a [u8]) -> Self

Supplies the bytes the finding was raised against, so the offending line can be quoted.

pub const fn with_origin(self, origin: &'a str) -> Self

Names where the input came from, for the location line.

pub const fn with_color(self, color: bool) -> Self

Enables ANSI colour.

Callers decide this from whether the stream is a terminal and from the user’s own preference; the renderer does not probe the environment.

Trait Implementations

impl<'a> Clone for Rendered<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for Rendered<'a>

impl<'a> Debug for Rendered<'a>

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

Formats the value using the given formatter.

impl Display for Rendered<'_>

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

Formats the value using the given formatter.