Struct LineNumber 

pub struct LineNumber(/* private fields */);

1-based line number in a source file.

Zero is invalid; use LineNumber::try_new to reject it explicitly.

Implementations

impl LineNumber

pub const fn try_new(value: usize) -> Option<Self>

Creates a 1-based coordinate when value is non-zero.

pub const fn new(value: usize) -> Self

Creates a 1-based coordinate.

Panics

Panics when value is zero.

pub const fn get(self) -> usize

Returns the underlying numeric value for this coordinate.

Trait Implementations

impl Clone for LineNumber

fn clone(&self) -> LineNumber

Returns a duplicate 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<LineNumber> for usize

fn from(value: LineNumber) -> Self

Converts to this type from the input type.

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for LineNumber

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

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

impl TryFrom<usize> for LineNumber

type Error = InvalidOneBasedCoordinate

The type returned in the event of a conversion error.

fn try_from(value: usize) -> Result<Self, Self::Error>

Performs the conversion.