Struct Annotation 

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

Highlight and describe a span of text within a Snippet

See AnnotationKind to create an annotation.

Example

use annotate_snippets::{AnnotationKind, Group, Level, Renderer, Snippet};

fn main() {
    let source = r#"                annotations: vec![SourceAnnotation {
                label: "expected struct `annotate_snippets::snippet::Slice`, found reference"
                    ,
                range: <22, 25>,"#;
    let report =
        &[
            Group::with_title(Level::ERROR.primary_title("expected type, found `22`")).element(
                Snippet::source(source)
                    .line_start(26)
                    .path("examples/footer.rs")
                    .annotation(AnnotationKind::Primary.span(193..195).label(
                        "expected struct `annotate_snippets::snippet::Slice`, found reference",
                    ))
                    .annotation(
                        AnnotationKind::Context
                            .span(34..50)
                            .label("while parsing this struct"),
                    ),
            ),
        ];

    let renderer = Renderer::styled();
    anstream::println!("{}", renderer.render(report));
}

Implementations

impl<'a> Annotation<'a>

pub fn label(self, label: impl Into<OptionCow<'a>>) -> Self

Describe the reason the span is highlighted

This will be styled according to the AnnotationKind

Text passed to this function is considered “untrusted input”, as such all text is passed through a normalization function. Pre-styled text is not allowed to be passed to this function.

pub fn highlight_source(self, highlight_source: bool) -> Self

Style the source according to the AnnotationKind

This gives extra emphasis to this annotation

Trait Implementations

impl<'a> Clone for Annotation<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Annotation<'a>

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

Formats the value using the given formatter.