Struct Position

pub struct Position {
    pub line: u32,
    pub character: u32,
}

A struct representing a specific point in a document. Lines and characters are zero-based.

Fields

line: u32

The line in which this position points to, starting from 0.

character: u32

The character in the line that this position points to, starting from 0.

Implementations

impl Position

pub const MAX: Position

The largest value that can be represented by a Position.

pub const MIN: Position

The smallest value that can be represented by a Position.

pub const fn new(line: u32, character: u32) -> Position

Create a new Position.

pub fn offset(&mut self, lines: i32, characters: i32)

Offsets the current position by lines and characters. If you’re adding both lines and characters, making sure to set characters to 0 before calling this function to ensure correct results.

pub fn set_line(&mut self, line: u32)

Sets line to a specific value.

pub fn set_character(&mut self, character: u32)

Sets character to a specific value.

pub fn is_in_bounds(self, start: Position, end: Position) -> bool

Checks whether or not this position is between the 2 passed positions.

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

Checks whether or not this position is after the passed position.

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

Checks whether or not this position is before the passed position.

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

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

Formats the value using the given formatter.

impl Default for Position

fn default() -> Position

Returns the “default value” for a type.

impl Hash for Position

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Position

fn cmp(&self, other: &Position) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

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

impl StructuralPartialEq for Position