Struct overflow_error::Overflowed

pub struct Overflowed;

Operation was performed and overflowed or underflowed.

Methods

impl Overflowed

pub fn val<T>(self, val: T) -> OverflowedValue<T>

Adds a payload to this error, indicating the overflowed result.

Examples

use overflow_error::*;

fn overflowing_add(a: u32, b: u32) -> Result<u32, OverflowedValue<u32>>
{
    let (c, overflowed) = a.overflowing_add(b);
    if overflowed {
        Err(Overflowed.val(c))
    } else {
        Ok(c)
    }
}

let result = overflowing_add(u32::max_value(), 1);
assert!(*result.unwrap_err().as_inner() == 0);

impl Overflowed

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

String representing the error.

Examples

use overflow_error::*;
assert!(Overflowed.as_str() == "operation overflowed");

Trait Implementations

impl Copy for Overflowed

impl Clone for Overflowed

fn clone(&self) -> Overflowed

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Overflowed

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl PartialEq for Overflowed

fn eq(&self, __arg_0: &Overflowed) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Eq for Overflowed

impl Hash for Overflowed

fn hash<__H: Hasher>(&self, __arg_0: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Display for Overflowed

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

Formats the value using the given formatter.