Struct Span

pub struct Span { /* private fields */ }

A span that records source code locations.

Used to print error messages.

Implementations

impl Span

pub fn new(file_type: FileType) -> Self

Creates a new span.

pub fn log_raw_error(&self, args: Arguments<'_>) -> Error

Available on crate feature logger only.

Logs normal error with no span provided.

pub fn log_raw_fatal_error(&self, args: Arguments<'_>) -> Error

Available on crate feature logger only.

Logs fatal error with no span provided.

pub fn log_raw_warning(&self, args: Arguments<'_>)

Available on crate feature logger only.

Logs warning with no span provided.

pub fn log_summary(&self)

Available on crate feature logger only.

Logs summary information (total error/warning number).

pub fn file_type(&self) -> &FileType

Returns a reference to the file type.

pub fn error_num(&self) -> usize

Gets the number of errors.

pub fn warning_num(&self) -> usize

Gets the number of warnings.

pub fn log_error(&self, args: Arguments<'_>) -> Error

Available on crate feature logger only.

Logs normal error message.

pub fn log_fatal_error(&self, args: Arguments<'_>) -> Error

Available on crate feature logger only.

Logs fatal error message.

pub fn log_warning(&self, args: Arguments<'_>)

Available on crate feature logger only.

Logs warning message.

pub fn start(&self) -> Location

Returns the start location of the span.

pub fn end(&self) -> Location

Returns the end location of the span.

pub fn update<C>(&mut self, c: &C)

where C: LocationUpdate,

Updates the line number ans column number of the start location based on the given character, then set the end location to the start position.

Examples

use laps::span::{FileType, Span};

let mut span = Span::new(FileType::Buffer);
assert_eq!(format!("{span}"), "1:0-1:0");
span.update(&' ');
assert_eq!(format!("{span}"), "1:1-1:1");
span.update(&'\n');
assert_eq!(format!("{span}"), "2:0-2:0");

pub fn into_updated<C>(self, c: &C) -> Self

where C: LocationUpdate,

Converts the current span into a new one where the location has been updated.

pub fn update_loc(&mut self, loc: Location)

Updates both the start and the end location to the given location.

pub fn update_end<S>(&mut self, span: S)

where S: AsRef<Self>,

Updates the end location according to the given span.

Examples

use laps::span::{FileType, Span};

let mut span = Span::new(FileType::Buffer);
span.update_end(&span.clone().into_updated(&'\n'));
assert_eq!(format!("{span}"), "1:0-2:0");

pub fn into_end_updated<S>(self, span: S) -> Self

where S: AsRef<Self>,

Converts the current span into a new one where the end location has been updated according to the given span.

pub fn is_in_same_line_as<S>(&self, span: S) -> bool

where S: AsRef<Self>,

Checks if the current span is in the same line as the given span.

Examples

use laps::span::{FileType, Span};

let span = Span::new(FileType::Buffer);
let span2 = span.clone().into_updated(&' ');
assert!(span.is_in_same_line_as(&span2));
let span3 = span.clone().into_updated(&'\n');
assert!(!span.is_in_same_line_as(&span3));

Trait Implementations

impl AsRef<Span> for Span

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Span

fn clone(&self) -> Span

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Span

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

Formats the value using the given formatter.

impl Display for Span

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

Formats the value using the given formatter.

impl PartialEq for Span

fn eq(&self, other: &Self) -> 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 Span