Struct Number

pub struct Number<T: Ordinal + Copy>(/* private fields */);

Represent numbers as ordinals when displayed.

Examples

use ordinal_trait::Ordinal as _;
let n = 12.to_number();
assert_eq!(*n, 12);
assert_eq!(format!("{n}"), "12th");

Implementations

impl<T: Ordinal + Copy> Number<T>

pub const fn new(value: T) -> Self

Create a Number from the value.

Examples

This can be used in constant initialization:

use ordinal_trait::Number;
const TWELVE: Number<i32> = Number::new(12);

Trait Implementations

impl<T: Clone + Ordinal + Copy> Clone for Number<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Ordinal + Copy> Debug for Number<T>

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

Formats the value using the given formatter.

impl<T: Ordinal + Copy> Deref for Number<T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T: Ordinal + Copy> Display for Number<T>

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

Formats the value using the given formatter.

impl<T: Ordinal + Copy> From<T> for Number<T>

fn from(value: T) -> Self

Converts to this type from the input type.

impl<T: Ord + Ordinal + Copy> Ord for Number<T>

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

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

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

impl<T: Eq + Ordinal + Copy> Eq for Number<T>

impl<T: Ordinal + Copy> StructuralPartialEq for Number<T>