Struct Location 

pub struct Location<'a> { /* private fields */ }

A source indexed as vfile-location reads it: offsets in UTF-16 code units, turned into lines, columns and the byte points of core’s positions, each in constant or log time.

Implementations

impl<'a> Location<'a>

pub fn new(source: &'a str) -> Self

pub fn source(&self) -> &'a str

pub fn len(&self) -> usize

The source’s length in UTF-16 code units.

pub fn is_empty(&self) -> bool

pub fn to_unit(&self, byte: usize) -> usize

The UTF-16 offset of a byte offset, inside a character counting as its start.

pub fn to_byte(&self, unit: usize) -> Option<usize>

The byte offset of a UTF-16 offset, unless it is past the end or inside a pair.

pub fn to_unist_point(&self, point: Point) -> UnistPoint

The unist point of a byte point, as Lines gives it, with its UTF-16 offset.

pub fn to_point(&self, unit: usize) -> Option<UnistPoint>

vfile-location’s toPoint: the point at a UTF-16 offset, unless past the end.

pub fn to_offset(&self, line: usize, column: usize) -> Option<usize>

vfile-location’s toOffset: the UTF-16 offset of a line and column, unless the column is past its line.

pub fn to_position<'b>( &self, start: usize, end: usize, alloc: &'b Allocator, ) -> Option<Position<'b>>

The position of a span of UTF-16 offsets: byte points when both ends start a character, unist points otherwise, none when either is past the end.

pub fn place_nlcst<'b>( &self, nodes: &mut [Node<'b>], start: Option<usize>, alloc: &'b Allocator, ) -> Option<usize>

Place nlcst nodes one after another from a UTF-16 offset, as mdast-util-to-nlcst’s and hast-util-to-nlcst’s patch do: each spans its text’s length, and a node without a start or past the end has no position. The offset after them.

pub fn join<'b>( &self, start: &Position<'b>, end: &Position<'b>, alloc: &'b Allocator, ) -> Position<'b>

The position from one’s start to another’s end, as unist-util-position reads them.

Trait Implementations

impl<'a> Clone for Location<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Location<'a>

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

Formats the value using the given formatter.