Trait Number

Source

pub trait Number:
    Bound
    + Count
    + Ident
    + Sign {
    type InnerRepr;
    type InnermostRepr;

    // Required methods
    fn from_inner_repr(inner: Self::InnerRepr) -> NumeraResult<Self>
       where Self: Sized;
    unsafe fn from_inner_repr_unchecked(inner: Self::InnerRepr) -> Self;
    fn from_innermost_repr(innermost: Self::InnermostRepr) -> NumeraResult<Self>
       where Self: Sized;
    unsafe fn from_innermost_repr_unchecked(
        innermost: Self::InnermostRepr,
    ) -> Self;
    fn into_inner_repr(self) -> Self::InnerRepr;
    fn into_innermost_repr(self) -> Self::InnermostRepr;

    // Provided method
    fn try_from_inner_repr(
        inner: impl Into<Self::InnerRepr>,
    ) -> NumeraResult<Self>
       where Self: Sized { ... }
}

Expand description

Common trait for all numbers.

Required Associated Types§

Source

type InnerRepr

The inner primitive representation of the number.

May be the same as InnermostRepr.

For example a NonNegativeInteger8 would have InnerRepr = NonZeroU8, and InnermostRepr = u8, while an Integer8 and an i8 would both have an i8 in both cases.

Source

type InnermostRepr

The innermost primitive representation of the number.

May be the same as InnerRepr.

For example a NonNegativeInteger8 would have InnerRepr = NonZeroU8, and InnermostRepr = u8, while an Integer8 and an i8 would both have an i8 in both cases.

Required Methods§

Source

fn from_inner_repr(inner: Self::InnerRepr) -> NumeraResult<Self>
where Self: Sized,

Forms a new number from its given inner representation.

§Errors

Returns an error if inner does not conform to the invariants of what’s considered a valid state for this type of number.

For example a NonNegativeInteger8 would have InnerRepr = NonZeroU8, and InnermostRepr = u8, while an Integer8 would have i8 in both cases.

Source

unsafe fn from_inner_repr_unchecked(inner: Self::InnerRepr) -> Self

Available on crate feature not(safe) only.

Forms a new number from its given inner representation.

§Panics

Could panic (specially in debug) if inner does not conform to the invariants of what’s considered a valid state for this number.

§Safety

The invariants inherent to the specific number type must be maintained.

Source

fn from_innermost_repr(innermost: Self::InnermostRepr) -> NumeraResult<Self>
where Self: Sized,

Forms a new number from its innermost representation.

§Errors

Returns an error if innermost does not conform to the invariants of what’s considered a valid state for this type of number.

For example a NonNegativeInteger8 would have InnerRepr = NonZeroU8, and InnermostRepr = u8, while an Integer8 would have i8 in both cases.

Source

unsafe fn from_innermost_repr_unchecked(innermost: Self::InnermostRepr) -> Self

Available on crate feature not(safe) only.

Forms a new number from its innermost representation.

§Panics

Could panic (specially in debug) if innermost does not conform to the invariants of what’s considered a valid state for this number.

§Safety

The invariants inherent to the specific number type must be maintained.

Source

fn into_inner_repr(self) -> Self::InnerRepr

Deconstructs the number to its inner representation.

Source

fn into_innermost_repr(self) -> Self::InnermostRepr

Deconstructs the number to its innermost representation.

Provided Methods§

Source

fn try_from_inner_repr(inner: impl Into<Self::InnerRepr>) -> NumeraResult<Self>
where Self: Sized,

Forms a new number from its converted given inner representation.

§Errors

Returns an error if the converted inner does not conform to the invariants of what’s considered a valid state for this number.

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.

Trait Number Copy item path

Required Associated Types§

type InnerRepr

type InnermostRepr

Required Methods§

fn from_inner_repr(inner: Self::InnerRepr) -> NumeraResult<Self>where Self: Sized,

§Errors

unsafe fn from_inner_repr_unchecked(inner: Self::InnerRepr) -> Self

§Panics

§Safety

fn from_innermost_repr(innermost: Self::InnermostRepr) -> NumeraResult<Self>where Self: Sized,

§Errors

unsafe fn from_innermost_repr_unchecked(innermost: Self::InnermostRepr) -> Self

§Panics

§Safety

fn into_inner_repr(self) -> Self::InnerRepr

fn into_innermost_repr(self) -> Self::InnermostRepr

Provided Methods§

fn try_from_inner_repr(inner: impl Into<Self::InnerRepr>) -> NumeraResult<Self>where Self: Sized,

§Errors

Dyn Compatibility§

Implementations on Foreign Types§

impl Number for f32

type InnerRepr = f32

type InnermostRepr = f32

fn from_inner_repr(value: Self::InnerRepr) -> NumeraResult<Self>

unsafe fn from_inner_repr_unchecked(value: Self::InnerRepr) -> Self

fn from_innermost_repr(value: Self::InnermostRepr) -> NumeraResult<Self>

unsafe fn from_innermost_repr_unchecked(value: Self::InnermostRepr) -> Self

fn into_inner_repr(self) -> Self::InnerRepr

fn into_innermost_repr(self) -> Self::InnermostRepr

impl Number for f64

type InnerRepr = f64

type InnermostRepr = f64

fn from_inner_repr(value: Self::InnerRepr) -> NumeraResult<Self>

unsafe fn from_inner_repr_unchecked(value: Self::InnerRepr) -> Self

fn from_innermost_repr(value: Self::InnermostRepr) -> NumeraResult<Self>

unsafe fn from_innermost_repr_unchecked(value: Self::InnermostRepr) -> Self

fn into_inner_repr(self) -> Self::InnerRepr

fn into_innermost_repr(self) -> Self::InnermostRepr

impl Number for i8

type InnerRepr = i8

type InnermostRepr = i8

fn from_inner_repr(value: Self::InnerRepr) -> NumeraResult<Self>

unsafe fn from_inner_repr_unchecked(value: Self::InnerRepr) -> Self

fn from_innermost_repr(value: Self::InnermostRepr) -> NumeraResult<Self>

unsafe fn from_innermost_repr_unchecked(value: Self::InnermostRepr) -> Self

fn into_inner_repr(self) -> Self::InnerRepr

fn into_innermost_repr(self) -> Self::InnermostRepr

impl Number for i16

type InnerRepr = i16

type InnermostRepr = i16

fn from_inner_repr(value: Self::InnerRepr) -> NumeraResult<Self>

unsafe fn from_inner_repr_unchecked(value: Self::InnerRepr) -> Self

fn from_innermost_repr(value: Self::InnermostRepr) -> NumeraResult<Self>

unsafe fn from_innermost_repr_unchecked(value: Self::InnermostRepr) -> Self

fn into_inner_repr(self) -> Self::InnerRepr

fn into_innermost_repr(self) -> Self::InnermostRepr

impl Number for i32

type InnerRepr = i32

type InnermostRepr = i32

fn from_inner_repr(value: Self::InnerRepr) -> NumeraResult<Self>

unsafe fn from_inner_repr_unchecked(value: Self::InnerRepr) -> Self

fn from_innermost_repr(value: Self::InnermostRepr) -> NumeraResult<Self>

unsafe fn from_innermost_repr_unchecked(value: Self::InnermostRepr) -> Self

fn into_inner_repr(self) -> Self::InnerRepr

fn into_innermost_repr(self) -> Self::InnermostRepr

impl Number for i64

type InnerRepr = i64

type InnermostRepr = i64

fn from_inner_repr(value: Self::InnerRepr) -> NumeraResult<Self>

unsafe fn from_inner_repr_unchecked(value: Self::InnerRepr) -> Self

fn from_innermost_repr(value: Self::InnermostRepr) -> NumeraResult<Self>

unsafe fn from_innermost_repr_unchecked(value: Self::InnermostRepr) -> Self

fn into_inner_repr(self) -> Self::InnerRepr

fn into_innermost_repr(self) -> Self::InnermostRepr

impl Number for i128

type InnerRepr = i128

type InnermostRepr = i128

fn from_inner_repr(value: Self::InnerRepr) -> NumeraResult<Self>

Trait Number

fn from_inner_repr(inner: Self::InnerRepr) -> NumeraResult<Self>
where Self: Sized,

fn from_innermost_repr(innermost: Self::InnermostRepr) -> NumeraResult<Self>
where Self: Sized,

fn try_from_inner_repr(inner: impl Into<Self::InnerRepr>) -> NumeraResult<Self>
where Self: Sized,