Struct Position 

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

A logical cursor position: zero-based line, zero-based byte offset within that line. UTF-8 byte offsets, not codepoint indices.

Ordering is lexicographic — by line, then byte — so < means “earlier in the buffer”. Nothing here validates a position against a buffer: a byte past the end of the line, or inside a multi-byte character, is representable, and it is the consumer’s job to clamp or reject it (ProtocolError::PositionOutOfBounds).

Examples

use lattice_protocol::Position;

// "héllo": `é` is two UTF-8 bytes, so the `l` after it is at byte 3.
let l = Position::new(0, 3);
assert!(Position::ZERO < l);
assert!(Position::new(0, 99) < Position::new(1, 0)); // line wins

Fields

line: u32

Zero-based line index.

byte: u32

Zero-based UTF-8 byte offset from the start of line (tree-sitter’s Point.column convention). A value equal to the line’s byte length is the end-of-line position.

Implementations

impl Position

pub const ZERO: Position

The start of the buffer: line 0, byte 0.

pub const fn new(line: u32, byte: u32) -> Self

A position at line, byte (both zero-based; byte in UTF-8 bytes).

Trait Implementations

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

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<'de> Deserialize<'de> for Position

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Position

impl Hash for Position

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

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

Equality operator ==.

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

Inequality operator !=.

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Position