Struct Checked 

pub struct Checked<T>(/* private fields */);

Container for safe integers operators

let x = Checked::new(2_u32);

assert_eq!((x + 3).unwrap(), 5);
assert!(matches!((x + 4).check(), Ok(6)));
assert!((x + u32::MAX).is_err());

Implementations

impl<T> Checked<T>

pub fn new(val: T) -> Self

pub fn check(self) -> Result<T, MathError>

Returns the result of the calculation

impl Checked<u8>

pub fn u8(self) -> Checked<u8>

impl Checked<u8>

pub fn u16(self) -> Checked<u16>

impl Checked<u8>

pub fn u32(self) -> Checked<u32>

impl Checked<u8>

pub fn u64(self) -> Checked<u64>

impl Checked<u8>

pub fn i16(self) -> Checked<i16>

impl Checked<u8>

pub fn i32(self) -> Checked<i32>

impl Checked<u8>

pub fn i64(self) -> Checked<i64>

impl Checked<u8>

pub fn usize(self) -> Checked<usize>

impl Checked<u16>

pub fn u8(self) -> Checked<u8>

impl Checked<u16>

pub fn u16(self) -> Checked<u16>

impl Checked<u16>

pub fn u32(self) -> Checked<u32>

impl Checked<u16>

pub fn u64(self) -> Checked<u64>

impl Checked<u16>

pub fn i16(self) -> Checked<i16>

impl Checked<u16>

pub fn i32(self) -> Checked<i32>

impl Checked<u16>

pub fn i64(self) -> Checked<i64>

impl Checked<u16>

pub fn usize(self) -> Checked<usize>

impl Checked<u32>

pub fn u8(self) -> Checked<u8>

impl Checked<u32>

pub fn u16(self) -> Checked<u16>

impl Checked<u32>

pub fn u32(self) -> Checked<u32>

impl Checked<u32>

pub fn u64(self) -> Checked<u64>

impl Checked<u32>

pub fn i16(self) -> Checked<i16>

impl Checked<u32>

pub fn i32(self) -> Checked<i32>

impl Checked<u32>

pub fn i64(self) -> Checked<i64>

impl Checked<u32>

pub fn usize(self) -> Checked<usize>

impl Checked<u64>

pub fn u8(self) -> Checked<u8>

impl Checked<u64>

pub fn u16(self) -> Checked<u16>

impl Checked<u64>

pub fn u32(self) -> Checked<u32>

impl Checked<u64>

pub fn u64(self) -> Checked<u64>

impl Checked<u64>

pub fn i16(self) -> Checked<i16>

impl Checked<u64>

pub fn i32(self) -> Checked<i32>

impl Checked<u64>

pub fn i64(self) -> Checked<i64>

impl Checked<u64>

pub fn usize(self) -> Checked<usize>

impl Checked<i16>

pub fn u8(self) -> Checked<u8>

impl Checked<i16>

pub fn u16(self) -> Checked<u16>

impl Checked<i16>

pub fn u32(self) -> Checked<u32>

impl Checked<i16>

pub fn u64(self) -> Checked<u64>

impl Checked<i16>

pub fn i16(self) -> Checked<i16>

impl Checked<i16>

pub fn i32(self) -> Checked<i32>

impl Checked<i16>

pub fn i64(self) -> Checked<i64>

impl Checked<i16>

pub fn usize(self) -> Checked<usize>

impl Checked<i32>

pub fn u8(self) -> Checked<u8>

impl Checked<i32>

pub fn u16(self) -> Checked<u16>

impl Checked<i32>

pub fn u32(self) -> Checked<u32>

impl Checked<i32>

pub fn u64(self) -> Checked<u64>

impl Checked<i32>

pub fn i16(self) -> Checked<i16>

impl Checked<i32>

pub fn i32(self) -> Checked<i32>

impl Checked<i32>

pub fn i64(self) -> Checked<i64>

impl Checked<i32>

pub fn usize(self) -> Checked<usize>

impl Checked<i64>

pub fn u8(self) -> Checked<u8>

impl Checked<i64>

pub fn u16(self) -> Checked<u16>

impl Checked<i64>

pub fn u32(self) -> Checked<u32>

impl Checked<i64>

pub fn u64(self) -> Checked<u64>

impl Checked<i64>

pub fn i16(self) -> Checked<i16>

impl Checked<i64>

pub fn i32(self) -> Checked<i32>

impl Checked<i64>

pub fn i64(self) -> Checked<i64>

impl Checked<i64>

pub fn usize(self) -> Checked<usize>

impl Checked<usize>

pub fn u8(self) -> Checked<u8>

impl Checked<usize>

pub fn u16(self) -> Checked<u16>

impl Checked<usize>

pub fn u32(self) -> Checked<u32>

impl Checked<usize>

pub fn u64(self) -> Checked<u64>

impl Checked<usize>

pub fn i16(self) -> Checked<i16>

impl Checked<usize>

pub fn i32(self) -> Checked<i32>

impl Checked<usize>

pub fn i64(self) -> Checked<i64>

impl Checked<usize>

pub fn usize(self) -> Checked<usize>

Methods from Deref<Target = Result<T, MathError>>

pub fn is_ok(&self) -> bool

Returns true if the result is Ok.

Examples

let x: Result<i32, &str> = Ok(-3);
assert_eq!(x.is_ok(), true);

let x: Result<i32, &str> = Err("Some error message");
assert_eq!(x.is_ok(), false);

pub fn is_err(&self) -> bool

Returns true if the result is Err.

Examples

let x: Result<i32, &str> = Ok(-3);
assert_eq!(x.is_err(), false);

let x: Result<i32, &str> = Err("Some error message");
assert_eq!(x.is_err(), true);

pub fn as_ref(&self) -> Result<&T, &E>

Converts from &Result<T, E> to Result<&T, &E>.

Produces a new Result, containing a reference into the original, leaving the original in place.

Examples

let x: Result<u32, &str> = Ok(2);
assert_eq!(x.as_ref(), Ok(&2));

let x: Result<u32, &str> = Err("Error");
assert_eq!(x.as_ref(), Err(&"Error"));

pub fn as_deref(&self) -> Result<&<T as Deref>::Target, &E>

where T: Deref,

Converts from Result<T, E> (or &Result<T, E>) to Result<&<T as Deref>::Target, &E>.

Coerces the Ok variant of the original Result via Deref and returns the new Result.

Examples

let x: Result<String, u32> = Ok("hello".to_string());
let y: Result<&str, &u32> = Ok("hello");
assert_eq!(x.as_deref(), y);

let x: Result<String, u32> = Err(42);
let y: Result<&str, &u32> = Err(&42);
assert_eq!(x.as_deref(), y);

pub fn iter(&self) -> Iter<'_, T>

Returns an iterator over the possibly contained value.

The iterator yields one value if the result is Result::Ok, otherwise none.

Examples

let x: Result<u32, &str> = Ok(7);
assert_eq!(x.iter().next(), Some(&7));

let x: Result<u32, &str> = Err("nothing!");
assert_eq!(x.iter().next(), None);

Trait Implementations

impl Add<Checked<i16>> for i16

type Output = Checked<i16>

The resulting type after applying the + operator.

fn add(self, rhs: Checked<i16>) -> Self::Output

Performs the + operation.

impl Add<Checked<i32>> for i32

type Output = Checked<i32>

The resulting type after applying the + operator.

fn add(self, rhs: Checked<i32>) -> Self::Output

Performs the + operation.

impl Add<Checked<i64>> for i64

type Output = Checked<i64>

The resulting type after applying the + operator.

fn add(self, rhs: Checked<i64>) -> Self::Output

Performs the + operation.

impl Add<Checked<u16>> for u16

type Output = Checked<u16>

The resulting type after applying the + operator.

fn add(self, rhs: Checked<u16>) -> Self::Output

Performs the + operation.

impl Add<Checked<u32>> for u32

type Output = Checked<u32>

The resulting type after applying the + operator.

fn add(self, rhs: Checked<u32>) -> Self::Output

Performs the + operation.

impl Add<Checked<u64>> for u64

type Output = Checked<u64>

The resulting type after applying the + operator.

fn add(self, rhs: Checked<u64>) -> Self::Output

Performs the + operation.

impl Add<Checked<u8>> for u8

type Output = Checked<u8>

The resulting type after applying the + operator.

fn add(self, rhs: Checked<u8>) -> Self::Output

Performs the + operation.

impl Add<Checked<usize>> for usize

type Output = Checked<usize>

The resulting type after applying the + operator.

fn add(self, rhs: Checked<usize>) -> Self::Output

Performs the + operation.

impl<R: Into<Self> + Copy> Add<R> for Checked<i16>

type Output = Checked<i16>

The resulting type after applying the + operator.

fn add(self, rhs: R) -> Self::Output

Performs the + operation.

impl<R: Into<Self> + Copy> Add<R> for Checked<i32>

type Output = Checked<i32>

The resulting type after applying the + operator.

fn add(self, rhs: R) -> Self::Output

Performs the + operation.

impl<R: Into<Self> + Copy> Add<R> for Checked<i64>

type Output = Checked<i64>

The resulting type after applying the + operator.

fn add(self, rhs: R) -> Self::Output

Performs the + operation.

impl<R: Into<Self> + Copy> Add<R> for Checked<u16>

type Output = Checked<u16>

The resulting type after applying the + operator.

fn add(self, rhs: R) -> Self::Output

Performs the + operation.

impl<R: Into<Self> + Copy> Add<R> for Checked<u32>

type Output = Checked<u32>

The resulting type after applying the + operator.

fn add(self, rhs: R) -> Self::Output

Performs the + operation.

impl<R: Into<Self> + Copy> Add<R> for Checked<u64>

type Output = Checked<u64>

The resulting type after applying the + operator.

fn add(self, rhs: R) -> Self::Output

Performs the + operation.

impl<R: Into<Self> + Copy> Add<R> for Checked<u8>

type Output = Checked<u8>

The resulting type after applying the + operator.

fn add(self, rhs: R) -> Self::Output

Performs the + operation.

impl<R: Into<Self> + Copy> Add<R> for Checked<usize>

type Output = Checked<usize>

The resulting type after applying the + operator.

fn add(self, rhs: R) -> Self::Output

Performs the + operation.

impl<T: Clone> Clone for Checked<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Checked<T>

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

Formats the value using the given formatter.

impl<T> Deref for Checked<T>

type Target = Result<T, MathError>

The resulting type after dereferencing.

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

Dereferences the value.

impl Div<Checked<i16>> for i16

type Output = Checked<i16>

The resulting type after applying the / operator.

fn div(self, rhs: Checked<i16>) -> Self::Output

Performs the / operation.

impl Div<Checked<i32>> for i32

type Output = Checked<i32>

The resulting type after applying the / operator.

fn div(self, rhs: Checked<i32>) -> Self::Output

Performs the / operation.

impl Div<Checked<i64>> for i64

type Output = Checked<i64>

The resulting type after applying the / operator.

fn div(self, rhs: Checked<i64>) -> Self::Output

Performs the / operation.

impl Div<Checked<u16>> for u16

type Output = Checked<u16>

The resulting type after applying the / operator.

fn div(self, rhs: Checked<u16>) -> Self::Output

Performs the / operation.

impl Div<Checked<u32>> for u32

type Output = Checked<u32>

The resulting type after applying the / operator.

fn div(self, rhs: Checked<u32>) -> Self::Output

Performs the / operation.

impl Div<Checked<u64>> for u64

type Output = Checked<u64>

The resulting type after applying the / operator.

fn div(self, rhs: Checked<u64>) -> Self::Output

Performs the / operation.

impl Div<Checked<u8>> for u8

type Output = Checked<u8>

The resulting type after applying the / operator.

fn div(self, rhs: Checked<u8>) -> Self::Output

Performs the / operation.

impl Div<Checked<usize>> for usize

type Output = Checked<usize>

The resulting type after applying the / operator.

fn div(self, rhs: Checked<usize>) -> Self::Output

Performs the / operation.

impl<R: Into<Self> + Copy> Div<R> for Checked<i16>

type Output = Checked<i16>

The resulting type after applying the / operator.

fn div(self, rhs: R) -> Self::Output

Performs the / operation.

impl<R: Into<Self> + Copy> Div<R> for Checked<i32>

type Output = Checked<i32>

The resulting type after applying the / operator.

fn div(self, rhs: R) -> Self::Output

Performs the / operation.

impl<R: Into<Self> + Copy> Div<R> for Checked<i64>

type Output = Checked<i64>

The resulting type after applying the / operator.

fn div(self, rhs: R) -> Self::Output

Performs the / operation.

impl<R: Into<Self> + Copy> Div<R> for Checked<u16>

type Output = Checked<u16>

The resulting type after applying the / operator.

fn div(self, rhs: R) -> Self::Output

Performs the / operation.

impl<R: Into<Self> + Copy> Div<R> for Checked<u32>

type Output = Checked<u32>

The resulting type after applying the / operator.

fn div(self, rhs: R) -> Self::Output

Performs the / operation.

impl<R: Into<Self> + Copy> Div<R> for Checked<u64>

type Output = Checked<u64>

The resulting type after applying the / operator.

fn div(self, rhs: R) -> Self::Output

Performs the / operation.

impl<R: Into<Self> + Copy> Div<R> for Checked<u8>

type Output = Checked<u8>

The resulting type after applying the / operator.

fn div(self, rhs: R) -> Self::Output

Performs the / operation.

impl<R: Into<Self> + Copy> Div<R> for Checked<usize>

type Output = Checked<usize>

The resulting type after applying the / operator.

fn div(self, rhs: R) -> Self::Output

Performs the / operation.

impl<T> From<T> for Checked<T>

fn from(val: T) -> Self

Converts to this type from the input type.

impl Mul<Checked<i16>> for i16

type Output = Checked<i16>

The resulting type after applying the * operator.

fn mul(self, rhs: Checked<i16>) -> Self::Output

Performs the * operation.

impl Mul<Checked<i32>> for i32

type Output = Checked<i32>

The resulting type after applying the * operator.

fn mul(self, rhs: Checked<i32>) -> Self::Output

Performs the * operation.

impl Mul<Checked<i64>> for i64

type Output = Checked<i64>

The resulting type after applying the * operator.

fn mul(self, rhs: Checked<i64>) -> Self::Output

Performs the * operation.

impl Mul<Checked<u16>> for u16

type Output = Checked<u16>

The resulting type after applying the * operator.

fn mul(self, rhs: Checked<u16>) -> Self::Output

Performs the * operation.

impl Mul<Checked<u32>> for u32

type Output = Checked<u32>

The resulting type after applying the * operator.

fn mul(self, rhs: Checked<u32>) -> Self::Output

Performs the * operation.

impl Mul<Checked<u64>> for u64

type Output = Checked<u64>

The resulting type after applying the * operator.

fn mul(self, rhs: Checked<u64>) -> Self::Output

Performs the * operation.

impl Mul<Checked<u8>> for u8

type Output = Checked<u8>

The resulting type after applying the * operator.

fn mul(self, rhs: Checked<u8>) -> Self::Output

Performs the * operation.

impl Mul<Checked<usize>> for usize

type Output = Checked<usize>

The resulting type after applying the * operator.

fn mul(self, rhs: Checked<usize>) -> Self::Output

Performs the * operation.

impl<R: Into<Self> + Copy> Mul<R> for Checked<i16>

type Output = Checked<i16>

The resulting type after applying the * operator.

fn mul(self, rhs: R) -> Self::Output

Performs the * operation.

impl<R: Into<Self> + Copy> Mul<R> for Checked<i32>

type Output = Checked<i32>

The resulting type after applying the * operator.

fn mul(self, rhs: R) -> Self::Output

Performs the * operation.

impl<R: Into<Self> + Copy> Mul<R> for Checked<i64>

type Output = Checked<i64>

The resulting type after applying the * operator.

fn mul(self, rhs: R) -> Self::Output

Performs the * operation.

impl<R: Into<Self> + Copy> Mul<R> for Checked<u16>

type Output = Checked<u16>

The resulting type after applying the * operator.

fn mul(self, rhs: R) -> Self::Output

Performs the * operation.

impl<R: Into<Self> + Copy> Mul<R> for Checked<u32>

type Output = Checked<u32>

The resulting type after applying the * operator.

fn mul(self, rhs: R) -> Self::Output

Performs the * operation.

impl<R: Into<Self> + Copy> Mul<R> for Checked<u64>

type Output = Checked<u64>

The resulting type after applying the * operator.

fn mul(self, rhs: R) -> Self::Output

Performs the * operation.

impl<R: Into<Self> + Copy> Mul<R> for Checked<u8>

type Output = Checked<u8>

The resulting type after applying the * operator.

fn mul(self, rhs: R) -> Self::Output

Performs the * operation.

impl<R: Into<Self> + Copy> Mul<R> for Checked<usize>

type Output = Checked<usize>

The resulting type after applying the * operator.

fn mul(self, rhs: R) -> Self::Output

Performs the * operation.

impl Sub<Checked<i16>> for i16

type Output = Checked<i16>

The resulting type after applying the - operator.

fn sub(self, rhs: Checked<i16>) -> Self::Output

Performs the - operation.

impl Sub<Checked<i32>> for i32

type Output = Checked<i32>

The resulting type after applying the - operator.

fn sub(self, rhs: Checked<i32>) -> Self::Output

Performs the - operation.

impl Sub<Checked<i64>> for i64

type Output = Checked<i64>

The resulting type after applying the - operator.

fn sub(self, rhs: Checked<i64>) -> Self::Output

Performs the - operation.

impl Sub<Checked<u16>> for u16

type Output = Checked<u16>

The resulting type after applying the - operator.

fn sub(self, rhs: Checked<u16>) -> Self::Output

Performs the - operation.

impl Sub<Checked<u32>> for u32

type Output = Checked<u32>

The resulting type after applying the - operator.

fn sub(self, rhs: Checked<u32>) -> Self::Output

Performs the - operation.

impl Sub<Checked<u64>> for u64

type Output = Checked<u64>

The resulting type after applying the - operator.

fn sub(self, rhs: Checked<u64>) -> Self::Output

Performs the - operation.

impl Sub<Checked<u8>> for u8

type Output = Checked<u8>

The resulting type after applying the - operator.

fn sub(self, rhs: Checked<u8>) -> Self::Output

Performs the - operation.

impl Sub<Checked<usize>> for usize

type Output = Checked<usize>

The resulting type after applying the - operator.

fn sub(self, rhs: Checked<usize>) -> Self::Output

Performs the - operation.

impl<R: Into<Self> + Copy> Sub<R> for Checked<i16>

type Output = Checked<i16>

The resulting type after applying the - operator.

fn sub(self, rhs: R) -> Self::Output

Performs the - operation.

impl<R: Into<Self> + Copy> Sub<R> for Checked<i32>

type Output = Checked<i32>

The resulting type after applying the - operator.

fn sub(self, rhs: R) -> Self::Output

Performs the - operation.

impl<R: Into<Self> + Copy> Sub<R> for Checked<i64>

type Output = Checked<i64>

The resulting type after applying the - operator.

fn sub(self, rhs: R) -> Self::Output

Performs the - operation.

impl<R: Into<Self> + Copy> Sub<R> for Checked<u16>

type Output = Checked<u16>

The resulting type after applying the - operator.

fn sub(self, rhs: R) -> Self::Output

Performs the - operation.

impl<R: Into<Self> + Copy> Sub<R> for Checked<u32>

type Output = Checked<u32>

The resulting type after applying the - operator.

fn sub(self, rhs: R) -> Self::Output

Performs the - operation.

impl<R: Into<Self> + Copy> Sub<R> for Checked<u64>

type Output = Checked<u64>

The resulting type after applying the - operator.

fn sub(self, rhs: R) -> Self::Output

Performs the - operation.

impl<R: Into<Self> + Copy> Sub<R> for Checked<u8>

type Output = Checked<u8>

The resulting type after applying the - operator.

fn sub(self, rhs: R) -> Self::Output

Performs the - operation.

impl<R: Into<Self> + Copy> Sub<R> for Checked<usize>

type Output = Checked<usize>

The resulting type after applying the - operator.

fn sub(self, rhs: R) -> Self::Output

Performs the - operation.

impl<T: Copy> Copy for Checked<T>