Struct tweep::Position

pub struct Position {
    pub line: usize,
    pub column: usize,
    pub kind: PositionKind,
}

One-indexed, line and column numbers to be used within a Context

Examples

let c = Position::abs(1, 3);
assert_eq!((c.line, c.column), (1, 3));

Fields

line: usize

The one-indexed line number

column: usize

The one-indexed column number

kind: PositionKind

Kind of position

Implementations

impl Position

pub fn abs(line: usize, column: usize) -> Self

Create a new absolute Position

Examples

let c = Position::abs(2, 3);
assert_eq!((c.line, c.column), (2, 3));

pub fn rel(line: usize, column: usize) -> Self

Create a new relative Position

Examples

let c = Position::rel(2, 3);
assert_eq!((c.line, c.column), (2, 3));

pub fn subposition(&self, line: usize, column: usize) -> Self

Creates another Position using one-indexed line and column numbers to offset from this position

Examples

let c = Position::abs(2, 3);
// Since these are 1-indexed, this should be the same as c
let s = c.subposition(1, 1);
assert_eq!(c, s);

let c = Position::abs(2, 3);
// When the line number is one, the sub position column will be offset
// from the source position column
let s = c.subposition(1, 3);
assert_eq!(s, Position::abs(2, 5));

let c = Position::abs(2, 3);
// When the line number is greater than one, the column number will be
// offset from the start of that line
let s = c.subposition(2, 1);
assert_eq!(s, Position::abs(3, 1));

Trait Implementations

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 Copy for Position

impl Debug for Position

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

Formats the value using the given formatter.

impl Display for Position

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

Formats the value using the given formatter.

impl Eq for Position

impl PartialEq<Position> for Position

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

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

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

This method tests for !=.

impl StructuralEq for Position

impl StructuralPartialEq for Position