Struct Position

pub struct Position {
    pub line: usize,
    pub offset: usize,
}

A two (zero-based) coordinate value representing a location in a buffer. The offset field is so named to emphasize that positions point to locations before/after characters, not characters themselves, in an effort to avoid fencepost errors.

Fields

line: usize

offset: usize

Implementations

impl Position

pub fn new() -> Position

Creates a new position with a line/offset of 0.

Examples

use scribe::buffer::Position;

let mut position = Position::new();
assert_eq!(position, Position{
    line: 0,
    offset: 0
});

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 Position

fn clone(&self) -> Position

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Position

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

Formats the value using the given formatter.

impl Default for Position

fn default() -> Position

Returns the “default value” for a type.

impl PartialEq for Position

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

fn partial_cmp(&self, other: &Position) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Position

impl StructuralPartialEq for Position