Struct syntax_pos::MultiSpan

pub struct MultiSpan { /* fields omitted */ }

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.

Methods

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: String)

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 whether any of the primary spans is 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 true if replacements occurred.

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 whether any of the span labels is displayable.

Trait Implementations

impl From<Span> for MultiSpan

fn from(span: Span) -> MultiSpan

Performs the conversion.

impl From<Vec<Span>> for MultiSpan

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

Performs the conversion.

impl Eq for MultiSpan

impl PartialEq<MultiSpan> for MultiSpan

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

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

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

This method tests for !=.

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

Formats the value using the given formatter.

impl Hash for MultiSpan

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl Decodable for MultiSpan

fn decode<__D: Decoder>(d: &mut __D) -> Result<MultiSpan, __D::Error>

impl Encodable for MultiSpan

fn encode<__S: Encoder>(&self, s: &mut __S) -> Result<(), __S::Error>