Struct scribe::buffer::Range

pub struct Range { /* private fields */ }

A two-position type, representing a span of characters.

Implementations

impl Range

pub fn new(start: Position, end: Position) -> Range

Creates a new buffer range. Checks and swaps arguments in the event that the end precedes the start.

pub fn start(&self) -> Position

pub fn end(&self) -> Position

pub fn includes(&self, position: &Position) -> bool

Whether or not the range includes the specified position. The range is exclusive, such that its ending position is not included.

Examples

use scribe::buffer::{Position, Range};

// Builder a range.
let range = Range::new(
    Position{ line: 0, offset: 0 },
    Position{ line: 1, offset: 5 }
);

assert!(range.includes(
    &Position{ line: 1, offset: 0 }
));

assert!(range.includes(
    &Position{ line: 1, offset: 4 }
));

assert!(!range.includes(
    &Position{ line: 1, offset: 5 }
));

Trait Implementations

impl Clone for Range

fn clone(&self) -> Range

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Range

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

Formats the value using the given formatter.

impl PartialEq for Range

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