Struct Distance

pub struct Distance {
    pub lines: usize,
    pub offset: usize,
}

A vector value representing a span in a buffer. Unlike the Range type, whose two positions are absolutes, a Distance is meant to be used relative to a Position.

Fields

lines: usize

offset: usize

Implementations

impl Distance

pub fn of_str(from: &str) -> Distance

Calculates the distance covered by a string. The offset is calculated from the last line of the string.

Examples

use scribe::buffer::Distance;

let data = "scribe\ndistance";
assert_eq!(Distance::of_str(data), Distance{
    lines: 1,
    offset: 8
});

Trait Implementations

impl Add<Distance> for Position

type Output = Position

The resulting type after applying the + operator.

fn add(self, distance: Distance) -> Self::Output

Performs the + operation.

impl AddAssign<Distance> for Position

fn add_assign(&mut self, distance: Distance)

Performs the += operation.

impl Clone for Distance

fn clone(&self) -> Distance

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Distance

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

Formats the value using the given formatter.

impl PartialEq for Distance

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

impl StructuralPartialEq for Distance