Trait Number

pub trait Number:
    Sized
    + Copy
    + Clone
    + PartialOrd
    + Ord
    + PartialEq
    + Eq {
    type UnderlyingType: Number + Debug + From<u8> + TryFrom<u16> + TryFrom<u32> + TryFrom<u64> + TryFrom<u128>;

    const BITS: usize;
    const MIN: Self;
    const MAX: Self;

    // Required methods
    fn new(value: Self::UnderlyingType) -> Self;
    fn try_new(value: Self::UnderlyingType) -> Result<Self, TryNewError>;
    fn value(self) -> Self::UnderlyingType;
    fn from_<T: Number>(value: T) -> Self;
    fn masked_new<T: Number>(value: T) -> Self;
    fn as_u8(&self) -> u8;
    fn as_u16(&self) -> u16;
    fn as_u32(&self) -> u32;
    fn as_u64(&self) -> u64;
    fn as_u128(&self) -> u128;
    fn as_usize(&self) -> usize;

    // Provided method
    fn as_<T: Number>(self) -> T { ... }
}

Required Associated Constants

const BITS: usize

Number of bits that can fit in this type

const MIN: Self

Minimum value that can be represented by this type

const MAX: Self

Maximum value that can be represented by this type

Required Associated Types

type UnderlyingType: Number + Debug + From<u8> + TryFrom<u16> + TryFrom<u32> + TryFrom<u64> + TryFrom<u128>

Required Methods

fn new(value: Self::UnderlyingType) -> Self

Creates a number from the given value, throwing an error if the value is too large. This constructor is useful when creating a value from a literal.

fn try_new(value: Self::UnderlyingType) -> Result<Self, TryNewError>

Creates a number from the given value, return None if the value is too large

fn value(self) -> Self::UnderlyingType

fn from_<T: Number>(value: T) -> Self

Creates a number from the given value, throwing an error if the value is too large. This constructor is useful when the value is convertable to T. Use Self::new for literals.

fn masked_new<T: Number>(value: T) -> Self

Creates an instance from the given value. Unlike the various new... functions, this will never fail as the value is masked to the result size.

fn as_u8(&self) -> u8

fn as_u16(&self) -> u16

fn as_u32(&self) -> u32

fn as_u64(&self) -> u64

fn as_u128(&self) -> u128

fn as_usize(&self) -> usize

Provided Methods

fn as_<T: Number>(self) -> T

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl Number for u8

const BITS: usize = 8usize

const MIN: Self = 0u8

const MAX: Self = 255u8

type UnderlyingType = u8

fn new(value: Self::UnderlyingType) -> Self

fn try_new(value: Self::UnderlyingType) -> Result<Self, TryNewError>

fn value(self) -> Self::UnderlyingType

fn from_<T: Number>(value: T) -> Self

fn masked_new<T: Number>(value: T) -> Self

fn as_u8(&self) -> u8

fn as_u16(&self) -> u16

fn as_u32(&self) -> u32

fn as_u64(&self) -> u64

fn as_u128(&self) -> u128

fn as_usize(&self) -> usize

impl Number for u16

const BITS: usize = 16usize

const MIN: Self = 0u16

const MAX: Self = 65_535u16

type UnderlyingType = u16

fn new(value: Self::UnderlyingType) -> Self

fn try_new(value: Self::UnderlyingType) -> Result<Self, TryNewError>

fn value(self) -> Self::UnderlyingType

fn from_<T: Number>(value: T) -> Self

fn masked_new<T: Number>(value: T) -> Self

fn as_u8(&self) -> u8

fn as_u16(&self) -> u16

fn as_u32(&self) -> u32

fn as_u64(&self) -> u64

fn as_u128(&self) -> u128

fn as_usize(&self) -> usize

impl Number for u32

const BITS: usize = 32usize

const MIN: Self = 0u32

const MAX: Self = 4_294_967_295u32

type UnderlyingType = u32

fn new(value: Self::UnderlyingType) -> Self

fn try_new(value: Self::UnderlyingType) -> Result<Self, TryNewError>

fn value(self) -> Self::UnderlyingType

fn from_<T: Number>(value: T) -> Self

fn masked_new<T: Number>(value: T) -> Self

fn as_u8(&self) -> u8

fn as_u16(&self) -> u16

fn as_u32(&self) -> u32

fn as_u64(&self) -> u64

fn as_u128(&self) -> u128

fn as_usize(&self) -> usize

impl Number for u64

const BITS: usize = 64usize

const MIN: Self = 0u64

const MAX: Self = 18_446_744_073_709_551_615u64

type UnderlyingType = u64

fn new(value: Self::UnderlyingType) -> Self

fn try_new(value: Self::UnderlyingType) -> Result<Self, TryNewError>

fn value(self) -> Self::UnderlyingType

fn from_<T: Number>(value: T) -> Self

fn masked_new<T: Number>(value: T) -> Self

fn as_u8(&self) -> u8

fn as_u16(&self) -> u16

fn as_u32(&self) -> u32

fn as_u64(&self) -> u64

fn as_u128(&self) -> u128

fn as_usize(&self) -> usize

impl Number for u128

const BITS: usize = 128usize

const MIN: Self = 0u128

const MAX: Self = 340_282_366_920_938_463_463_374_607_431_768_211_455u128

type UnderlyingType = u128

fn new(value: Self::UnderlyingType) -> Self

fn try_new(value: Self::UnderlyingType) -> Result<Self, TryNewError>

fn value(self) -> Self::UnderlyingType

fn from_<T: Number>(value: T) -> Self

fn masked_new<T: Number>(value: T) -> Self

fn as_u8(&self) -> u8

fn as_u16(&self) -> u16

fn as_u32(&self) -> u32

fn as_u64(&self) -> u64

fn as_u128(&self) -> u128

fn as_usize(&self) -> usize

Implementors

impl<const BITS: usize> Number for UInt<u8, BITS>

const BITS: usize = BITS

const MIN: Self

const MAX: Self

type UnderlyingType = u8

impl<const BITS: usize> Number for UInt<u16, BITS>

const BITS: usize = BITS

const MIN: Self

const MAX: Self

type UnderlyingType = u16

impl<const BITS: usize> Number for UInt<u32, BITS>

const BITS: usize = BITS

const MIN: Self

const MAX: Self

type UnderlyingType = u32

impl<const BITS: usize> Number for UInt<u64, BITS>

const BITS: usize = BITS

const MIN: Self

const MAX: Self

type UnderlyingType = u64

impl<const BITS: usize> Number for UInt<u128, BITS>

const BITS: usize = BITS

const MIN: Self

const MAX: Self

type UnderlyingType = u128