Struct hlvm_runtime::number::Status

pub struct Status { /* fields omitted */ }

The status of the floating point context. Instead of faulting after every operation errors are added to this status. User code can check and/or clear the status fully or partially at specific points to check the validity of the computation. Each thread gets its own status. The status is initially empty.

Examples

assert_eq!(d128::get_status(), Status::empty());
let _ = d128!(1) / &d128!(0);
assert!(d128::get_status().contains(decimal::Status::DIVISION_BY_ZERO));
let _ = d128!(0) / &d128!(0);
assert!(d128::get_status().contains(decimal::Status::DIVISION_UNDEFINED));
// The previous status flag was not cleared!
assert!(d128::get_status().contains(decimal::Status::DIVISION_BY_ZERO));

Methods

impl Status

pub const CONVERSION_SYNTAX: Status

Conversion syntax error.

pub const DIVISION_BY_ZERO: Status

Division by zero.

pub const DIVISION_IMPOSSIBLE: Status

Division impossible.

pub const DIVISION_UNDEFINED: Status

Division undefined.

pub const INEXACT: Status

The result is inexact.

pub const INVALID_OPERATION: Status

An invalid operation was requested.

pub const OVERFLOW: Status

Overflow.

pub const UNDERFLOW: Status

Underflow.

pub fn empty() -> Status

Returns an empty set of flags.

pub fn all() -> Status

Returns the set containing all flags.

pub fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u32) -> Option<Status>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub fn from_bits_truncate(bits: u32) -> Status

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub fn intersects(&self, other: Status) -> bool

Returns true if there are flags common to both self and other.

pub fn contains(&self, other: Status) -> bool

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: Status)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: Status)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: Status)

Toggles the specified flags in-place.

pub fn set(&mut self, other: Status, value: bool)

Inserts or removes the specified flags depending on the passed value.

Trait Implementations

impl Binary for Status

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

Formats the value using the given formatter.

impl Copy for Status

impl Clone for Status

fn clone(&self) -> Status

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Extend<Status> for Status

fn extend<T>(&mut self, iterator: T) where
    T: IntoIterator<Item = Status>, 

Extends a collection with the contents of an iterator.

impl BitOrAssign<Status> for Status

fn bitor_assign(&mut self, other: Status)

Adds the set of flags.

impl BitAndAssign<Status> for Status

fn bitand_assign(&mut self, other: Status)

Disables all flags disabled in the set.

impl Hash for Status

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

Feeds this value into the given [Hasher].

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

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

impl BitOr<Status> for Status

type Output = Status

The resulting type after applying the | operator.

fn bitor(self, other: Status) -> Status

Returns the union of the two sets of flags.

impl BitXor<Status> for Status

type Output = Status

The resulting type after applying the ^ operator.

fn bitxor(self, other: Status) -> Status

Returns the left flags, but with all the right flags toggled.

impl PartialEq<Status> for Status

fn eq(&self, other: &Status) -> bool

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

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

This method tests for !=.

impl SubAssign<Status> for Status

fn sub_assign(&mut self, other: Status)

Disables all flags enabled in the set.

impl BitXorAssign<Status> for Status

fn bitxor_assign(&mut self, other: Status)

Toggles the set of flags.

impl Octal for Status

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

Formats the value using the given formatter.

impl Not for Status

type Output = Status

The resulting type after applying the ! operator.

fn not(self) -> Status

Returns the complement of this set of flags.

impl UpperHex for Status

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

Formats the value using the given formatter.

impl Ord for Status

fn cmp(&self, other: &Status) -> Ordering

This method returns an Ordering between self and other.

default fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

default fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

default fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl LowerHex for Status

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

Formats the value using the given formatter.

impl BitAnd<Status> for Status

type Output = Status

The resulting type after applying the & operator.

fn bitand(self, other: Status) -> Status

Returns the intersection between the two sets of flags.

impl FromIterator<Status> for Status

fn from_iter<T>(iterator: T) -> Status where
    T: IntoIterator<Item = Status>, 

Creates a value from an iterator.

impl Sub<Status> for Status

type Output = Status

The resulting type after applying the - operator.

fn sub(self, other: Status) -> Status

Returns the set difference of the two sets of flags.

impl Eq for Status

impl PartialOrd<Status> for Status

fn partial_cmp(&self, other: &Status) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Status) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Status) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Status) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Status) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Debug for Status

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

Formats the value using the given formatter.