Struct rustc_errors::snippet::Annotation

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

Fields

start_col: AnnotationColumn

Start column. Note that it is important that this field goes first, so that when we sort, we sort orderings by start column.

end_col: AnnotationColumn

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.

Implementations

impl Annotation

pub fn is_line(&self) -> bool

Whether this annotation is a vertical line placeholder.

pub fn len(&self) -> usize

Length of this annotation as displayed in the stderr output

pub fn has_label(&self) -> bool

pub fn takes_space(&self) -> bool

Trait Implementations

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

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq 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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd 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: &Rhs) -> bool

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

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

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

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

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

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

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

impl Eq for Annotation

impl StructuralPartialEq for Annotation

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 80 bytes