Struct codespan::LineIndex

[+] Show declaration

pub struct LineIndex(pub RawIndex);

[−] Expand description

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[+]

[+] Show hidden undocumented items

type Output = LineIndex

The resulting type after applying the + operator.

fn add(self, rhs: LineOffset) -> LineIndex[−]

Performs the + operation.

impl AddAssign<LineOffset> for LineIndex[+]

[+] Show hidden undocumented items

fn add_assign(&mut self, rhs: LineOffset)[−]

Performs the += operation.

impl Clone for LineIndex[+]

[+] Show hidden undocumented items

fn clone(&self) -> LineIndex[−]

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Copy for LineIndex

impl Debug for LineIndex[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Default for LineIndex[+]

[+] Show hidden undocumented items

fn default() -> LineIndex[−]

Returns the "default value" for a type.

impl Display for LineIndex[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Eq for LineIndex

impl From<LineIndex> for RawIndex[+]

[+] Show hidden undocumented items

fn from(index: LineIndex) -> RawIndex[−]

Performs the conversion.

impl From<LineIndex> for usize[+]

[+] Show hidden undocumented items

fn from(index: LineIndex) -> usize[−]

Performs the conversion.

impl From<u32> for LineIndex[+]

[+] Show hidden undocumented items

fn from(i: RawIndex) -> Self[−]

Performs the conversion.

impl Hash for LineIndex[+]

[+] Show hidden undocumented items

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, [−]

Feeds a slice of this type into the given Hasher.

impl Index for LineIndex

type Offset = LineOffset

impl Ord for LineIndex[+]

[+] Show hidden undocumented items

fn cmp(&self, other: &LineIndex) -> Ordering[−]

This method returns an Ordering between self and other.

[+] Expand attributes

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

Compares and returns the maximum of two values.

[+] Expand attributes

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

Compares and returns the minimum of two values.

[+] Expand attributes

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<LineIndex> for LineIndex[+]

[+] Show hidden undocumented items

fn eq(&self, other: &LineIndex) -> bool[−]

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

fn ne(&self, other: &LineIndex) -> bool[−]

This method tests for !=.

impl PartialOrd<LineIndex> for LineIndex[+]

[+] Show hidden undocumented items

fn partial_cmp(&self, other: &LineIndex) -> Option<Ordering>[−]

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

fn lt(&self, other: &LineIndex) -> bool[−]

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

fn le(&self, other: &LineIndex) -> bool[−]

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

fn gt(&self, other: &LineIndex) -> bool[−]

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

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[+]

[+] Show hidden undocumented items

type Output = LineOffset

The resulting type after applying the - operator.

fn sub(self, rhs: LineIndex) -> LineOffset[−]

Performs the - operation.

impl Sub<LineOffset> for LineIndex[+]

[+] Show hidden undocumented items

type Output = LineIndex

The resulting type after applying the - operator.

fn sub(self, rhs: LineOffset) -> LineIndex[−]

Performs the - operation.

impl SubAssign<LineOffset> for LineIndex[+]

[+] Show hidden undocumented items

fn sub_assign(&mut self, rhs: LineOffset)[−]

Performs the -= operation.