Struct codespan::LineIndex

pub struct LineIndex(pub RawIndex);

A zero-indexed line offset into a source file

Implementations

impl LineIndex

pub const fn number(self) -> LineNumber

The 1-indexed line number. Useful for pretty printing source locations.

use codespan::{LineIndex, LineNumber};

assert_eq!(format!("{}", LineIndex(0).number()), "1");
assert_eq!(format!("{}", LineIndex(3).number()), "4");

pub const fn to_usize(self) -> usize

Convert the index into a usize, for use in array indexing

Trait Implementations

impl Add<LineOffset> for LineIndex

type Output = LineIndex

The resulting type after applying the + operator.

pub fn add(self, rhs: LineOffset) -> LineIndex

Performs the + operation.

impl AddAssign<LineOffset> for LineIndex

pub fn add_assign(&mut self, rhs: LineOffset)

Performs the += operation.

impl Clone for LineIndex

pub fn clone(&self) -> LineIndex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for LineIndex

impl Debug for LineIndex

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

Formats the value using the given formatter.

impl Default for LineIndex

pub fn default() -> LineIndex

Returns the "default value" for a type.

impl Display for LineIndex

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

Formats the value using the given formatter.

impl Eq for LineIndex

impl From<LineIndex> for RawIndex

pub fn from(index: LineIndex) -> RawIndex

Performs the conversion.

impl From<LineIndex> for usize

pub fn from(index: LineIndex) -> usize

Performs the conversion.

impl From<u32> for LineIndex

pub fn from(i: RawIndex) -> Self

Performs the conversion.

impl Hash for LineIndex

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Index for LineIndex

type Offset = LineOffset

impl Ord for LineIndex

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<LineIndex> for LineIndex

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<LineIndex> for LineIndex

pub fn partial_cmp(&self, other: &LineIndex) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

pub fn lt(&self, other: &LineIndex) -> bool

This method tests less than (for self and other) and is used by the < operator.

pub fn le(&self, other: &LineIndex) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

pub fn gt(&self, other: &LineIndex) -> bool

This method tests greater than (for self and other) and is used by the > operator.

pub fn ge(&self, other: &LineIndex) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for LineIndex

impl StructuralPartialEq for LineIndex

impl Sub<LineIndex> for LineIndex

type Output = LineOffset

The resulting type after applying the - operator.

pub fn sub(self, rhs: LineIndex) -> LineOffset

Performs the - operation.

impl Sub<LineOffset> for LineIndex

type Output = LineIndex

The resulting type after applying the - operator.

pub fn sub(self, rhs: LineOffset) -> LineIndex

Performs the - operation.

impl SubAssign<LineOffset> for LineIndex

pub fn sub_assign(&mut self, rhs: LineOffset)

Performs the -= operation.