Enum AnnotationKind 

#[non_exhaustive]
pub enum AnnotationKind {
    Primary,
    Context,
    Visible,
}

The type of Annotation being applied to a Snippet

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Primary

For showing the source that the Group’s Title references

For Title-less groups, see Group::with_level

Context

Additional context to better understand the Primary Annotation

See also Renderer::context.

Visible

Prevents the annotated text from getting folded

By default, Snippets will fold (remove) lines that do not contain any annotations. Visible makes it possible to selectively prevent this behavior for specific text, allowing context to be preserved without adding any annotation characters.

Example

use annotate_snippets::{AnnotationKind, Group, Level, Renderer, Snippet};
fn main() {
    let source = r#"struct S {
    field1: usize,
    field2: usize,
    field3: usize,
    field4: usize,
    fn foo() {},
    field6: usize,
}
"#;
    let report = &[Group::with_title(
        Level::ERROR.primary_title("functions are not allowed in struct definitions"),
    )
    .element(
        Snippet::source(source)
            .path("$DIR/struct_name_as_context.rs")
            .annotation(AnnotationKind::Primary.span(91..102))
            .annotation(AnnotationKind::Visible.span(0..8)),
    )
    .element(
        Level::HELP.message("unlike in C++, Java, and C#, functions are declared in `impl` blocks"),
    )];

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

Implementations

impl AnnotationKind

pub fn span<'a>(self, span: Range<usize>) -> Annotation<'a>

Annotate a byte span within Snippet

Trait Implementations

impl Clone for AnnotationKind

fn clone(&self) -> AnnotationKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AnnotationKind

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

Formats the value using the given formatter.

impl Ord for AnnotationKind

fn cmp(&self, other: &AnnotationKind) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for AnnotationKind

fn eq(&self, other: &AnnotationKind) -> 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 PartialOrd for AnnotationKind

fn partial_cmp(&self, other: &AnnotationKind) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for AnnotationKind

impl Eq for AnnotationKind

impl StructuralPartialEq for AnnotationKind