Struct unsegen::base::basic_types::LineNumber

pub struct LineNumber(_);

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

Implementations

impl LineNumber

pub fn new(val: usize) -> Self

Create a new LineNumber from a raw value.

Panics:

Panics if val is 0 (as line numbers start from 1).

pub fn raw_value(self) -> usize

Unpack the LineNumber and yield the underlying value.

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

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

Examples:

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

Trait Implementations

impl Add<usize> for LineNumber

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<usize> for LineNumber

fn add_assign(&mut self, rhs: usize)

Performs the += operation.

impl Clone for LineNumber

fn clone(&self) -> LineNumber

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for LineNumber

impl Debug for LineNumber

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

Formats the value using the given formatter.

impl Display for LineNumber

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

Formats the value using the given formatter.

impl Eq for LineNumber

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 LineNumber

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 LineNumber

fn into(self) -> usize

Performs the conversion.

impl PartialEq<LineNumber> for LineNumber

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

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

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

This method tests for !=.

impl PartialOrd<LineNumber> for LineNumber

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for LineNumber

impl StructuralPartialEq for LineNumber

impl Sub<usize> for LineNumber

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<usize> for LineNumber

fn sub_assign(&mut self, rhs: usize)

Performs the -= operation.