Module annotate_snippets::snippet

Structures used as an input for the library.

Example:

use annotate_snippets::snippet::*;

Snippet {
    title: Some(Annotation {
        label: Some("mismatched types".to_string()),
        id: None,
        annotation_type: AnnotationType::Error,
    }),
    footer: vec![],
    slices: vec![
        Slice {
            source: "Foo".to_string(),
            line_start: 51,
            origin: Some("src/format.rs".to_string()),
            fold: false,
            annotations: vec![],
        },
        Slice {
            source: "Faa".to_string(),
            line_start: 129,
            origin: Some("src/display.rs".to_string()),
            fold: false,
            annotations: vec![],
        },
    ],
};

Structs

Annotation

An annotation for a Snippet.

Slice

Structure containing the slice of text to be annotated and basic information about the location of the slice.

Snippet

Primary structure provided for formatting

SourceAnnotation

An annotation for a Slice.

Enums

AnnotationType

Types of annotations.