Struct unsegen::base::basic_types::LineIndex

pub struct LineIndex(_);

A type for enumerating lines by index (rather than by number), i.e., starting from 0. Conversions between LineNumber and LineIndex are always safe.

Implementations

impl LineIndex

pub fn new(val: usize) -> Self

Create a new LineIndex from a raw value.

pub fn raw_value(self) -> usize

Unpack the LineIndex and yield the underlying value.

pub fn checked_sub(&self, rhs: usize) -> Option<LineIndex>

Checked integer subtraction. Computes self - rhs, returning None if the result is invalid (i.e., smaller than 0).

Examples:

use unsegen::base::LineIndex;
assert_eq!(LineIndex::new(37).checked_sub(27), Some(LineIndex::new(10)));
assert_eq!(LineIndex::new(27).checked_sub(37), None);

Trait Implementations

impl Add<usize> for LineIndex

type Output = Self

The resulting type after applying the + operator.

fn add(self, rhs: usize) -> Self

Performs the + operation.

impl AddAssign<usize> for LineIndex

fn add_assign(&mut self, rhs: usize)

Performs the += operation.

impl Clone for LineIndex

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

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

Formats the value using the given formatter.

impl Display for LineIndex

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

Formats the value using the given formatter.

impl Eq for LineIndex

impl From<LineIndex> for LineNumber

fn from(LineIndex: LineIndex) -> Self

Performs the conversion.

impl From<LineNumber> for LineIndex

fn from(LineNumber: LineNumber) -> Self

Performs the conversion.

impl Hash for LineIndex

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 Into<usize> for LineIndex

fn into(self) -> usize

Performs the conversion.

impl PartialEq<LineIndex> for LineIndex

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

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<usize> for LineIndex

type Output = Self

The resulting type after applying the - operator.

fn sub(self, rhs: usize) -> Self

Performs the - operation.

impl SubAssign<usize> for LineIndex

fn sub_assign(&mut self, rhs: usize)

Performs the -= operation.