Struct OneIndexed 

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

Type-safe wrapper for a value whose logical range starts at 1, for instance the line or column numbers in a file

Internally this is represented as a NonZeroUsize, this enables some memory optimizations

Implementations

impl OneIndexed

pub const MAX: Self

The largest value that can be represented by this integer type

pub const MIN: Self

The smallest value that can be represented by this integer type.

pub const ONE: NonZeroUsize

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

Creates a non-zero if the given value is not zero.

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

Construct a new OneIndexed from a zero-indexed value

pub const fn get(self) -> usize

Returns the value as a primitive type.

pub const fn to_zero_indexed(self) -> usize

Return the zero-indexed primitive value for this OneIndexed

pub const fn saturating_add(self, rhs: usize) -> Self

Saturating integer addition. Computes self + rhs, saturating at the numeric bounds instead of overflowing.

pub const fn saturating_sub(self, rhs: usize) -> Self

Saturating integer subtraction. Computes self - rhs, saturating at the numeric bounds instead of overflowing.

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

Checked addition. Returns None if overflow occurred.

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

Checked subtraction. Returns None if overflow occurred.

pub const fn digits(self) -> NonZeroUsize

Calculate the number of digits in self.

This is primarily intended for computing the length of the string representation for formatted printing.

Examples

use ruff_source_file::OneIndexed;

let one = OneIndexed::new(1).unwrap();
assert_eq!(one.digits().get(), 1);

let hundred = OneIndexed::new(100).unwrap();
assert_eq!(hundred.digits().get(), 3);

let thousand = OneIndexed::new(1000).unwrap();
assert_eq!(thousand.digits().get(), 4);

Trait Implementations

impl Clone for OneIndexed

fn clone(&self) -> OneIndexed

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for OneIndexed

impl Debug for OneIndexed

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

Formats the value using the given formatter.

impl Default for OneIndexed

fn default() -> Self

Returns the “default value” for a type.

impl Display for OneIndexed

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

Formats the value using the given formatter.

impl Eq for OneIndexed

impl FromStr for OneIndexed

type Err = ParseIntError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for OneIndexed

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 OneIndexed

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

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

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