Struct syntex_syntax2::diagnostics::plugin::snippet::Annotation

pub struct Annotation {
    pub start_col: usize,
    pub end_col: usize,
    pub is_primary: bool,
    pub label: Option<String>,
    pub annotation_type: AnnotationType,
}

Fields

start_col: usize

Start column, 0-based indexing -- counting characters, not utf-8 bytes. Note that it is important that this field goes first, so that when we sort, we sort orderings by start column.

end_col: usize

End column within the line (exclusive)

is_primary: bool

Is this annotation derived from primary span

label: Option<String>

Optional label to display adjacent to the annotation.

annotation_type: AnnotationType

Is this a single line, multiline or multiline span minimized down to a smaller span.

Methods

impl Annotation

pub fn is_line(&self) -> bool

Wether this annotation is a vertical line placeholder.

pub fn is_multiline(&self) -> bool

pub fn len(&self) -> usize

pub fn has_label(&self) -> bool

pub fn takes_space(&self) -> bool

Trait Implementations

impl Eq for Annotation

impl Clone for Annotation

fn clone(&self) -> Annotation

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<(), Error>

Formats the value using the given formatter.

impl Ord for Annotation

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Annotation> for Annotation

fn eq(&self, other: &Annotation) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Annotation) -> bool

This method tests for !=.

impl PartialOrd<Annotation> for Annotation

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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