Module annotate_snippets::snippet

source ·
Expand description

Structures used as an input for the library.

Example:

use annotate_snippets::snippet::*;

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

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