Struct SpanLocation 

pub struct SpanLocation {
    line: usize,
    char_offset: usize,
}

A struct used to represent Span’s index field as line and character offset indices. Meant for logging purposes.

line and char_offset are 0-based indices.

Fields

line: usize

char_offset: usize

Implementations

impl SpanLocation

pub fn new(line: usize, char_offset: usize) -> Self

Constructs a SpanLocation with provided line and char_offset indices.

pub fn from_index(source: &str, index: usize) -> Result<Self, SpanError>

Constructs a SpanLocation with a provided source and index.

Error Handling

If index is out of bounds of source, this method will return SpanError::OutOfBounds.

pub fn from_index_unchecked(source: &str, index: usize) -> Self

Constructs a SpanLocation with a provided source and index

Panics

This method panics if index is out of the bounds of source

pub fn line(&self) -> usize

Returns line.

pub fn char_offset(&self) -> usize

Returns char_offset.

Trait Implementations

impl Clone for SpanLocation

fn clone(&self) -> SpanLocation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SpanLocation

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

Formats the value using the given formatter.

impl Display for SpanLocation

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

Formats the value using the given formatter.

impl Ord for SpanLocation

fn cmp(&self, other: &SpanLocation) -> 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,

Restrict a value to a certain interval.

impl PartialEq for SpanLocation

fn eq(&self, other: &SpanLocation) -> 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 PartialOrd for SpanLocation

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for SpanLocation

impl Eq for SpanLocation

impl StructuralPartialEq for SpanLocation

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