Struct Position 

pub struct Position { /* private fields */ }

A 1-based MCP position taken as input by Translator::handle_* methods.

Kept distinct from Position2D (which carries an output position back to the caller) and made of two NonZeroU32s, so a zero position cannot exist and a call site that swaps line and character still names them (#322). A position typed by a client goes through Self::from_client, the only fallible constructor; positions derived from server output convert infallibly through Position::from_server_output.

Examples

use mcpls_core::bridge::{InvalidPosition, Position};

let position = Position::from_client(3, 5)?;
assert_eq!((position.line().get(), position.character().get()), (3, 5));
assert_eq!(Position::from_client(0, 1), Err(InvalidPosition::ZeroBased));

Implementations

impl Position

pub const fn from_client( line: u32, character: u32, ) -> Result<Self, InvalidPosition>

Builds a position from client-supplied 1-based numbers.

Errors

Returns InvalidPosition::ZeroBased for a zero line or character and InvalidPosition::TooLarge above MAX_POSITION_VALUE.

pub const fn line(self) -> NonZeroU32

Line number (1-based).

pub const fn character(self) -> NonZeroU32

Character offset (1-based).

pub const fn lsp_line(self) -> u32

Zero-based LSP line.

pub const fn lsp_character(self) -> u32

Zero-based character offset, still in UTF-16 units.

Trait Implementations

impl Clone for Position

fn clone(&self) -> Self

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

impl PartialEq for Position

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Position