Struct TextIndex 

pub struct TextIndex {
    pub utf8: usize,
    pub line: u32,
    pub col_utf8: u32,
    pub col_utf16: u32,
    pub col_utf32: u32,
}

A position inside of the source code

Lines and columns start at 0.

Fields

utf8: usize

Byte offset from the start of the document

line: u32

Line number (0-based)

col_utf8: u32

Column offset in bytes (0-based)

col_utf16: u32

Column offset in UTF-16 code units (0-based)

col_utf32: u32

Column offset in UTF-32 code points (0-based)

This is the same as Rust’s char count.

Implementations

impl TextIndex

pub const ZERO: TextIndex

Shorthand for a TextIndex with all fields set to 0.

pub fn advance(&mut self, c: char, next: Option<&char>)

Advance the index, accounting for lf/nl/ls/ps characters and combinations.

This is not derived from the definition of ‘newline’ in the language definition, nor is it a complete implementation of the Unicode line breaking algorithm.

Implementation inspired by slang_solidity.

Trait Implementations

impl Add for TextIndex

type Output = TextIndex

The resulting type after applying the + operator.

fn add(self, __rhs: Self) -> Self::Output

Performs the + operation.

impl Clone for TextIndex

fn clone(&self) -> TextIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TextIndex

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

Formats the value using the given formatter.

impl Default for TextIndex

fn default() -> TextIndex

Returns the “default value” for a type.

impl Display for TextIndex

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

Formats the value using the given formatter.

impl From<TextIndex> for TextIndex

Available on crate feature slang only.

fn from(value: SlangTextIndex) -> Self

Converts to this type from the input type.

impl Hash for TextIndex

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 TextIndex

fn cmp(&self, other: &Self) -> 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 TextIndex

fn eq(&self, other: &TextIndex) -> 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 TextIndex

fn partial_cmp(&self, other: &Self) -> 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 TextIndex

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for TextIndex

impl Eq for TextIndex

impl StructuralPartialEq for TextIndex