Struct AnnotationList

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

List of annotations applied to some input string. Doesn’t owns string, so has a limited lifetime.

Implementations

impl<'a> AnnotationList<'a>

pub fn new(filename: impl AsRef<str>, string: &'a str) -> Self

Create an annotation list from string. filename is used only to format messages, so corresponding file doesn’t need to exist.

pub fn add(&mut self, annotation: Annotation) -> Result<&mut Self>

Add an Annotation to list. You may also use .info(), .warning() and .error() methods.

pub fn info( &mut self, range: Range<usize>, header: impl AnnotationText, text: impl AnnotationText, ) -> Result<&mut Self>

Add an Severity::Info annotation to list. See Annotation::new docs for details

pub fn warning( &mut self, range: Range<usize>, header: impl AnnotationText, text: impl AnnotationText, ) -> Result<&mut Self>

Add an Severity::Warning annotation to list. See Annotation::new docs for details

pub fn error( &mut self, range: Range<usize>, header: impl AnnotationText, text: impl AnnotationText, ) -> Result<&mut Self>

Add an Severity::Error annotation to list. See Annotation::new docs for details

pub fn show<W: Write + WriteColor>( &self, stream: W, stylesheet: &Stylesheet, ) -> Result<()>

Print an error message to stream using given stylesheet. If your stream implements Write, but not WriteColor, consider wrapping it into termcolor::Ansi or termcolor::NoColor.

This method uses no buffering, so you probably want to pass termcolor::Buffer to it rather than raw stream.

If you want to just print message to stdout/stderr, consider using .print_stdout() or .print_stderr() instead.

pub fn show_stdout(&self, stylesheet: &Stylesheet) -> Result<()>

Print error message to stdout. Output will be colorized if stdout is a TTY

pub fn show_stderr(&self, stylesheet: &Stylesheet) -> Result<()>

Print error message to stderr. Output will be colorized if stderr is a TTY

pub fn to_bytes(&self) -> Result<Vec<u8>>

“Print” monochrome message to Vec<u8>

pub fn to_ansi_bytes(&self, stylesheet: &Stylesheet) -> Result<Vec<u8>>

“Print” message to Vec<u8>, colorizing it using ANSI escape codes

pub fn to_string(&self) -> Result<String>

“Print” monochrome message to String

Panics

Panics if message cannot be converted to UTF-8

pub fn to_ansi_string(&self, stylesheet: &Stylesheet) -> Result<String>

“Print” message to String, colorizing it using ANSI escape codes

Panics

Panics if message cannot be converted to UTF-8

Trait Implementations

impl<'a> Debug for AnnotationList<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for AnnotationList<'a>

fn eq(&self, other: &AnnotationList<'a>) -> 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.

impl<'a> Eq for AnnotationList<'a>

impl<'a> StructuralPartialEq for AnnotationList<'a>