Struct Ordinal 

pub struct Ordinal<T: ToOrdinal>(pub T);

Represent numbers as ordinals when displayed.

Examples

Get a Number from an integer that implements ToOrdinal.

use ordinal::ToOrdinal as _;
let n = 12.to_ordinal();
assert_eq!(*n, 12);
assert_eq!(format!("{n}"), "12th");

You can also create a Number in a const expression.

use ordinal::Ordinal;
const TWELVE: Ordinal<i32> = Ordinal(12);

Tuple Fields

0: T

Implementations

impl<T: ToOrdinal> Ordinal<T>

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

Gets the suffix for the number.

Examples

use ordinal::Ordinal;
assert_eq!(Ordinal(12).suffix(), "th");

Trait Implementations

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

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Copy + ToOrdinal> Copy for Ordinal<T>

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

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

Formats the value using the given formatter.

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

fn default() -> Ordinal<T>

Returns the “default value” for a type.

impl<T: ToOrdinal> Deref for Ordinal<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: ToOrdinal> Display for Ordinal<T>

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

Formats the value using the given formatter.

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

impl<T: ToOrdinal> From<T> for Ordinal<T>

fn from(value: T) -> Self

Converts to this type from the input type.

impl<T: Hash + ToOrdinal> 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 + ToOrdinal> 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 + ToOrdinal> PartialEq for Ordinal<T>

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

Equality operator ==.

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

Inequality operator !=.

impl<T: PartialOrd + ToOrdinal> 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: PartialEq + ToOrdinal> StructuralPartialEq for Ordinal<T>