Struct scribe::buffer::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

Methods

impl Position

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
});

fn add(&mut self, distance: &Distance)

Adds the specified Distance to the position.

Examples

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

let mut position = Position{ line: 1, offset: 3 };
let distance = Distance{ lines: 1, offset: 4 };
position.add(&distance);

assert_eq!(position, Position{
    line: 2,
    offset: 4
});

Trait Implementations

impl Copy for Position

impl Clone for Position

fn clone(&self) -> Position

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Position

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

Formats the value using the given formatter.

impl PartialEq for Position

fn eq(&self, __arg_0: &Position) -> bool

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

fn ne(&self, __arg_0: &Position) -> bool

This method tests for !=.

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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