Struct TextSpan 

pub struct TextSpan {
    pub start: Position,
    pub end: Position,
    pub literal: String,
}

Represents a span of text between two positions, including the literal text.

Fields

start: Position

The starting position of the text span.

end: Position

The ending position of the text span.

literal: String

The literal text contained in the span.

Implementations

impl TextSpan

pub fn new(start: Position, end: Position, literal: String) -> Self

Creates a new TextSpan from a starting position, an ending position, and a literal string.

Arguments

• start - The starting position of the text span.
• end - The ending position of the text span.
• literal - The literal text represented by the span.

Example

use roan_error::{Position, TextSpan};
let start = Position::new(1, 1, 0);
let end = Position::new(1, 5, 4);
let span = TextSpan::new(start, end, "test".to_string());
assert_eq!(span.length(), 4);

pub fn combine(spans: Vec<TextSpan>) -> Option<TextSpan>

Combines multiple TextSpan objects into one. The spans are sorted by their starting positions.

Panics

Panics if the input vector is empty.

Arguments

• spans - A vector of TextSpan objects to combine.

Returns

A new TextSpan that spans from the start of the first span to the end of the last span, with the concatenated literal text.

Example

use roan_error::{Position, TextSpan};
let span1 = TextSpan::new(Position::new(1, 1, 0), Position::new(1, 5, 4), "test".to_string());
let span2 = TextSpan::new(Position::new(1, 6, 5), Position::new(1, 10, 9), "span".to_string());
let combined = TextSpan::combine(vec![span1, span2]);
assert_eq!(combined.unwrap().literal, "testspan");

pub fn length(&self) -> usize

Returns the length of the span, calculated as the difference between the end and start indices.

Returns

The length of the text span in bytes.

pub fn literal<'a>(&self, input: &'a str) -> &'a str

Extracts the literal text from the given input string based on the start and end positions.

Arguments

• input - The input string from which to extract the literal text.

Returns

A slice of the input string that corresponds to the span’s range.

Trait Implementations

impl Clone for TextSpan

fn clone(&self) -> TextSpan

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TextSpan

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

Formats the TextSpan as "literal" (line:column).

Example

use roan_error::{Position, TextSpan};
let span = TextSpan::new(Position::new(1, 1, 0), Position::new(1, 5, 4), "test".to_string());
assert_eq!(format!("{:?}", span), "\"test\" (1:1)");

impl Default for TextSpan

fn default() -> Self

Creates a new TextSpan with default values.

Returns

A new TextSpan with the starting and ending positions set to (0, 0, 0) and an empty string.

impl Eq for TextSpan

impl PartialEq for TextSpan

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