Struct annotate_snippets::snippet::Snippet

pub struct Snippet {
    pub slice: Slice,
    pub annotations: Vec<Annotation>,
    pub main_annotation_pos: Option<usize>,
    pub title: Option<TitleAnnotation>,
    pub fold: Option<bool>,
}

Primary structure provided for formatting

Fields

slice: Slice

annotations: Vec<Annotation>

main_annotation_pos: Option<usize>

Index of an Annotation to be used as a main one in the snippet (for the header part).

title: Option<TitleAnnotation>

fold: Option<bool>

If set explicitly to true, the snippet will fold parts of the slice that don't contain any annotations.

Trait Implementations

impl From<Snippet> for DisplayList

fn from(snippet: Snippet) -> Self

Performs the conversion.

impl Debug for Snippet

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Clone for Snippet

fn clone(&self) -> Snippet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Display for Snippet

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

Formats the value using the given formatter.