Struct ariadne::Label

pub struct Label<S = Range<usize>> { /* private fields */ }

A type that represents a labelled section of source code.

Implementations

impl<S: Span> Label<S>

pub fn new(span: S) -> Self

Create a new Label. If the span is specified as a Range<usize> the numbers have to be zero-indexed character offsets.

Panics

Panics if the given span is backwards.

pub fn with_message<M: ToString>(self, msg: M) -> Self

Give this label a message.

pub fn with_color(self, color: Color) -> Self

Give this label a highlight colour.

pub fn with_order(self, order: i32) -> Self

Specify the order of this label relative to other labels.

Lower values correspond to this label having an earlier order.

If unspecified, labels default to an order of 0.

When labels are displayed after a line the crate needs to decide which labels should be displayed first. By Default, the orders labels based on where their associated line meets the text (see LabelAttach). Additionally, multi-line labels are ordered before inline labels. You can use this function to override this behaviour.

pub fn with_priority(self, priority: i32) -> Self

Specify the priority of this label relative to other labels.

Higher values correspond to this label having a higher priority.

If unspecified, labels default to a priority of 0.

Label spans can overlap. When this happens, the crate needs to decide which labels to prioritise for various purposes such as highlighting. By default, spans with a smaller length get a higher priority. You can use this function to override this behaviour.

Trait Implementations

impl<S: Clone> Clone for Label<S>

fn clone(&self) -> Label<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for Label<S>

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

Formats the value using the given formatter.

impl<S: Hash> Hash for Label<S>

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<S: PartialEq> PartialEq for Label<S>

fn eq(&self, other: &Label<S>) -> 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<S: Eq> Eq for Label<S>

impl<S> StructuralEq for Label<S>

impl<S> StructuralPartialEq for Label<S>