Struct MultiSpan

pub struct MultiSpan {
    pub(crate) primary_spans: Vec<Span>,
    pub(crate) span_labels: Vec<(Span, DiagMessage)>,
}

A collection of Spans.

Spans have two orthogonal attributes:

• They can be primary spans. In this case they are the locus of the error, and would be rendered with ^^^.
• They can have a label. In this case, the label is written next to the mark in the snippet when we render.

Fields

primary_spans: Vec<Span>

span_labels: Vec<(Span, DiagMessage)>

Implementations

impl MultiSpan

pub fn new() -> MultiSpan

pub fn from_span(primary_span: Span) -> MultiSpan

pub fn from_spans(vec: Vec<Span>) -> MultiSpan

pub fn push_span_label(&mut self, span: Span, label: impl Into<DiagMessage>)

pub fn primary_span(&self) -> Option<Span>

Selects the first primary span (if any).

pub fn primary_spans(&self) -> &[Span]

Returns all primary spans.

pub fn has_primary_spans(&self) -> bool

Returns true if any of the primary spans are displayable.

pub fn is_dummy(&self) -> bool

Returns true if this contains only a dummy primary span with any hygienic context.

pub fn replace(&mut self, before: Span, after: Span) -> bool

Replaces all occurrences of one Span with another. Used to move Spans in areas that don’t display well (like std macros). Returns whether replacements occurred.

pub fn pop_span_label(&mut self) -> Option<(Span, DiagMessage)>

pub fn span_labels(&self) -> Vec<SpanLabel>

Returns the strings to highlight. We always ensure that there is an entry for each of the primary spans – for each primary span P, if there is at least one label with span P, we return those labels (marked as primary). But otherwise we return SpanLabel instances with empty labels.

pub fn has_span_labels(&self) -> bool

Returns true if any of the span labels is displayable.

pub fn clone_ignoring_labels(&self) -> MultiSpan

Clone this MultiSpan without keeping any of the span labels - sometimes a MultiSpan is to be re-used in another diagnostic, but includes span_labels which have translated messages. These translated messages would fail to translate without their diagnostic arguments which are unlikely to be cloned alongside the Span.

Trait Implementations

impl Clone for MultiSpan

fn clone(&self) -> MultiSpan

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MultiSpan

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

Formats the value using the given formatter.

impl<__D> Decodable<__D> for MultiSpan

where __D: SpanDecoder,

fn decode(__decoder: &mut __D) -> MultiSpan

impl<__E> Encodable<__E> for MultiSpan

where __E: SpanEncoder,

fn encode(&self, __encoder: &mut __E)

impl From<Span> for MultiSpan

fn from(span: Span) -> MultiSpan

Converts to this type from the input type.

impl From<Vec<Span>> for MultiSpan

fn from(spans: Vec<Span>) -> MultiSpan

Converts to this type from the input type.

impl Hash for MultiSpan

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for MultiSpan

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for MultiSpan

impl StructuralPartialEq for MultiSpan

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: 48 bytes