Struct Ordinal

pub struct Ordinal<T>(pub T);

Tuple Fields

0: T

Implementations

impl<T> Ordinal<T>

where T: Integer + Display + ToPrimitive + Clone,

pub fn suffix(&self) -> &'static str

Returns the suffix of the ordinal number. For example, 1 returns "st", 2 returns "nd", 3 returns "rd", and 4 returns "th". This method is useful when you want to format the ordinal number yourself.

use ordinal_type::Ordinal;

let ordinal = Ordinal(1);
assert_eq!(ordinal.suffix(), "st");

pub fn to_primitive(&self) -> T

Returns the primitive value of the ordinal number.

pub fn to_u8(&self) -> u8

Returns the primitive value of the ordinal number as a u8.

pub fn to_u16(&self) -> u16

Returns the primitive value of the ordinal number as a u16.

pub fn to_u32(&self) -> u32

Returns the primitive value of the ordinal number as a u32.

pub fn to_u64(&self) -> u64

Returns the primitive value of the ordinal number as a u64.

pub fn to_u128(&self) -> u128

Returns the primitive value of the ordinal number as a u128.

pub fn to_usize(&self) -> usize

Returns the primitive value of the ordinal number as a usize.

pub fn to_i8(&self) -> i8

Returns the primitive value of the ordinal number as a i8.

pub fn to_i16(&self) -> i16

Returns the primitive value of the ordinal number as a i16.

pub fn to_i32(&self) -> i32

Returns the primitive value of the ordinal number as a i32.

pub fn to_i64(&self) -> i64

Returns the primitive value of the ordinal number as a i64.

pub fn to_i128(&self) -> i128

Returns the primitive value of the ordinal number as a i128.

pub fn to_isize(&self) -> isize

Returns the primitive value of the ordinal number as a isize.

Trait Implementations

impl<T: Clone> Clone for Ordinal<T>

fn clone(&self) -> Ordinal<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Ordinal<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Ordinal<T>

fn default() -> Ordinal<T>

Returns the “default value” for a type.

impl<T> Display for Ordinal<T>

where T: Integer + Display + ToPrimitive + Clone,

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

Formats the value using the given formatter.

impl<T: Hash> Hash for Ordinal<T>

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<T: Ord> Ord for Ordinal<T>

fn cmp(&self, other: &Ordinal<T>) -> 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<T: PartialEq> PartialEq for Ordinal<T>

fn eq(&self, other: &Ordinal<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

const 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<T: PartialOrd> PartialOrd for Ordinal<T>

fn partial_cmp(&self, other: &Ordinal<T>) -> 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<T: Copy> Copy for Ordinal<T>

impl<T: Eq> Eq for Ordinal<T>

impl<T> StructuralPartialEq for Ordinal<T>