Struct rustpython_parser::source_code::OneIndexed

pub struct OneIndexed(_);

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 NonZeroU32, this enables some memory optimizations

Implementations

impl OneIndexed

pub const MIN: OneIndexed = unwrap(Self::new(1))

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

pub const MAX: OneIndexed = unwrap(Self::new(u32::MAX))

The largest value that can be represented by this integer type

pub const fn new(value: u32) -> Option<OneIndexed>

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

pub const fn from_zero_indexed(value: u32) -> OneIndexed

Construct a new OneIndexed from a zero-indexed value

pub const fn try_from_zero_indexed(value: usize) -> Result<OneIndexed, usize>

Construct a new OneIndexed from a zero-indexed usize value

pub const fn get(self) -> u32

Returns the value as a primitive type.

pub const fn to_usize(self) -> usize

Return the usize value for this OneIndexed

pub const fn to_zero_indexed(self) -> u32

Return the zero-indexed primitive value for this OneIndexed

pub const fn to_zero_indexed_usize(self) -> usize

Return the zero-indexed usize value for this OneIndexed

pub const fn saturating_add(self, rhs: u32) -> OneIndexed

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

pub const fn saturating_sub(self, rhs: u32) -> OneIndexed

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

Trait Implementations

impl Clone for OneIndexed

fn clone(&self) -> OneIndexed

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OneIndexed

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

Formats the value using the given formatter.

impl Display for OneIndexed

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

Formats the value using the given formatter.

impl Hash for OneIndexed

fn hash<__H>(&self, state: &mut __H)where __H: Hasher,

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

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<OneIndexed> for OneIndexed

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<OneIndexed> 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

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

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

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

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

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

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

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

impl Copy for OneIndexed

impl Eq for OneIndexed

impl StructuralEq for OneIndexed

impl StructuralPartialEq for OneIndexed