Struct asciifile::span::Span

pub struct Span<'f> { /* fields omitted */ }

Methods

impl<'f> Span<'f>

pub fn new(a: Position<'f>, b: Position<'f>) -> Self

Create a new span from two positions.

This is guranteed to return a valid range. If the order of the arguments is incorrect, they will be swapped. If the same position is given twice, the span will cover a single character, the character given by the position,

pub fn from_single_position(position: Position<'f>) -> Self

Creates a span containing only the given position

use asciifile::{AsciiFile, Position, Span};

let file = AsciiFile::new(b"ABCD").unwrap();
let position = file.iter().nth(2).unwrap();
let span = Span::from_single_position(position);
assert_eq!("C", span.as_str());

pub fn as_str(&self) -> &'f str

Creates a span containing only the given position

use asciifile::{AsciiFile, Position, Span};

let file = AsciiFile::new(b"abcdfeghAAA").unwrap();

let positions = file
    .iter()
    .take_while(|position| position.chr().is_lowercase())
    .collect::<Vec<_>>();

let span = Span::from_positions(&positions).unwrap();
assert_eq!("abcdfegh", span.as_str());

pub fn as_bytes(&self) -> &'f [u8]

pub fn is_empty(&self) -> bool

pub fn is_single_char(&self) -> bool

pub fn start_position(&self) -> Position<'f>

pub fn end_position(&self) -> Position<'f>

pub fn is_multiline(&self) -> bool

Check if a span extends over multiple lines

This will not consider spans that contain a single trailing whitespace as multiline.

use asciifile::{AsciiFile, Span};

let file = AsciiFile::new("a\n".as_bytes()).unwrap();
let first = file.iter().next().unwrap();
let last = file.iter().last().unwrap();
let span = Span::new(first, last);
assert!(!span.is_multiline());

Also, A span only containing a newline will not be considered multiline.

use asciifile::{AsciiFile, Span};

let file = AsciiFile::new("\n".as_bytes()).unwrap();
let newline = file.iter().next().unwrap();
let span = Span::new(newline, newline);
assert!(!span.is_multiline());

A span with one or more newlines as a prefix will be considered multiline.

use asciifile::{AsciiFile, Span};

let file = AsciiFile::new("\na".as_bytes()).unwrap();
let first = file.iter().next().unwrap();
let last = file.iter().last().unwrap();
let span = Span::new(first, last);
assert!(span.is_multiline());

Important traits for LineIterator<'span, 'file>

impl<'span, 'file> Iterator for LineIterator<'span, 'file> type Item = Span<'file>;

pub fn lines<'span>(&'span self) -> LineIterator<'span, 'f>

An iterator over the lines of a span.

pub fn extend_to_position(self, position: &Position<'f>) -> Span<'f>

extends the span to include the given position

pub fn has_subset(self, span: &Span<'f>) -> bool

test if a span contains another span

pub fn combine(a: &Span<'f>, b: &Span<'f>) -> Span<'f>

pub fn intersect(a: &Span<'f>, b: &Span<'f>) -> Option<Span<'f>>

Get the overlapping part of two spans. Returns None if the spans are disjunct (do not overlap).

pub fn len(&self) -> usize

Get the number of characters in a span

pub fn from_positions(positions: &[Position<'f>]) -> Option<Self>

Trait Implementations

impl<'f> PartialEq<Span<'f>> for Span<'f>

fn eq(&self, other: &Span<'f>) -> bool

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

fn ne(&self, other: &Span<'f>) -> bool

This method tests for !=.

impl<'f> Clone for Span<'f>

fn clone(&self) -> Span<'f>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'f> Copy for Span<'f>

impl<'f> Eq for Span<'f>

impl<'_> Display for Span<'_>

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

Formats the value using the given formatter.

impl<'f> Debug for Span<'f>

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

Formats the value using the given formatter.