Struct yash_syntax::source::pretty::Annotation

pub struct Annotation<'a> {
    pub type: AnnotationType,
    pub label: Cow<'a, str>,
    pub location: &'a Location,
    pub code: Rc<dyn Deref<Target = str> + 'a>,
}

Source code fragment annotated with a label.

Annotations are part of an entire Message.

Fields

type: AnnotationType

Type of annotation.

label: Cow<'a, str>

String that describes the annotated part of the source code.

location: &'a Location

Position of the annotated fragment in the source code.

code: Rc<dyn Deref<Target = str> + 'a>

Annotated code string.

This value provides an access to the string held in self.location.code.value, which can only be accessed by a Ref.

Implementations

impl<'a> Annotation<'a>

pub fn new( type: AnnotationType, label: Cow<'a, str>, location: &'a Location ) -> Self

Creates a new annotation.

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Annotation<'_>

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

Formats the value using the given formatter.