Struct LineIndex

pub struct LineIndex(pub u32);

A zero-indexed line number

Tuple Fields

0: u32

Implementations

impl LineIndex

pub const fn number(self) -> LineNumber

Convert to a LineNumber

pub const fn to_usize(self) -> usize

Get the raw index value as a usize

pub const fn to_u32(self) -> u32

Get the raw index value as a u32

pub fn checked_add(self, offset: u32) -> Option<Self>

Add offset to this index, returning None on overflow

pub fn checked_add_signed(self, offset: i32) -> Option<Self>

Add a signed offset to this index, returning None on overflow

pub fn checked_sub(self, offset: u32) -> Option<Self>

Subtract offset from this index, returning None on underflow

pub const fn saturating_add(self, offset: u32) -> Self

Add offset to this index, saturating to u32::MAX on overflow

pub const fn saturating_add_signed(self, offset: i32) -> Self

Add a signed offset to this index, saturating to 0 on underflow, and u32::MAX on overflow.

pub const fn saturating_sub(self, offset: u32) -> Self

Subtract offset from this index, saturating to 0 on overflow

Trait Implementations

impl Add<i32> for LineIndex

type Output = LineIndex

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<u32> for LineIndex

type Output = LineIndex

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<i32> for LineIndex

fn add_assign(&mut self, rhs: i32)

Performs the += operation.

impl AddAssign<u32> for LineIndex

fn add_assign(&mut self, rhs: u32)

Performs the += operation.

impl Clone for LineIndex

fn clone(&self) -> LineIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LineIndex

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

Formats the value using the given formatter.

impl Default for LineIndex

fn default() -> LineIndex

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for LineIndex

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for LineIndex

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

Formats the value using the given formatter.

impl From<LineIndex> for LineNumber

fn from(index: LineIndex) -> Self

Converts to this type from the input type.

impl From<LineIndex> for Position

fn from(line: LineIndex) -> Self

Converts to this type from the input type.

impl From<LineNumber> for LineIndex

fn from(index: LineNumber) -> Self

Converts to this type from the input type.

impl From<u32> for LineIndex

fn from(index: u32) -> Self

Converts to this type from the input type.

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

Feeds a slice of this type into the given Hasher.

impl Ord for LineIndex

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

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub<u32> for LineIndex

type Output = LineIndex

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<u32> for LineIndex

fn sub_assign(&mut self, rhs: u32)

Performs the -= operation.

impl Copy for LineIndex

impl Eq for LineIndex

impl StructuralPartialEq for LineIndex