Enum Error

pub enum Error {
    Overflow(Option<i32>),
    Underflow(Option<i32>),
    DivByZero,
    Reserved,
    InvalidStr(String),
}

VAX floating-point errors

Examples

use vax_floating::{FFloating, Error, Result};
use std::str::FromStr;

const ZERO: FFloating = FFloating::from_u8(0);
const TWO: FFloating = FFloating::from_u8(2);

// Failures return a reserved type with the error encoded.
let div_by_zero = TWO / ZERO;
let overflow = FFloating::MAX * TWO;
let underflow = FFloating::MIN_POSITIVE / TWO;

// You can convert a reserved value to the matching error.
assert_eq!(<Result<FFloating>>::from(div_by_zero), Err(Error::DivByZero));
assert_eq!(<Result<FFloating>>::from(overflow),
    Err(Error::Overflow(Some(FFloating::MAX_EXP+1))));
assert_eq!(<Result<FFloating>>::from(underflow),
    Err(Error::Underflow(Some(FFloating::MIN_EXP-1))));

assert_eq!(FFloating::from_str("0.0.0"), Err(Error::InvalidStr("0.0.0".to_string())));

Variants

Overflow(Option<i32>)

Exponent too large for floating-point type.

Underflow(Option<i32>)

Exponent too small for floating-point type.

DivByZero

Set as the result of a division operation where the denominator is zero.

If converted into a Rust floating-point type, this will be converted into an Infinity value. For VAX floating-point types, it will be converted to the Reserved value (negative zero).

Reserved

VAX floating point numbers encoded with a negative zero trigger a reserved operand fault.

If converted into a Rust floating-point type, this will be converted into a NaN value. For VAX floating-point types, it will be converted to the Reserved value (negative zero).

InvalidStr(String)

Invalid string passed to from_str or from_ascii.

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<&str> for Error

fn from(text: &str) -> Self

Converts to this type from the input type.

impl From<Fault> for Error

fn from(fault: Fault) -> Self

Converts to this type from the input type.

impl PartialEq for Error

fn eq(&self, other: &Error) -> 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 Eq for Error

impl StructuralPartialEq for Error