Trait substrate_fixed::traits::FromFixed

pub trait FromFixed {
    // Required methods
    fn from_fixed<F: Fixed>(src: F) -> Self;
    fn checked_from_fixed<F: Fixed>(src: F) -> Option<Self>
       where Self: Sized;
    fn saturating_from_fixed<F: Fixed>(src: F) -> Self;
    fn wrapping_from_fixed<F: Fixed>(src: F) -> Self;
    fn overflowing_from_fixed<F: Fixed>(src: F) -> (Self, bool)
       where Self: Sized;
}

Expand description

This trait provides checked conversions from fixed-point numbers.

This trait is implemented for conversions between integer primitives, floating-point primitives and fixed-point numbers.

Examples

use substrate_fixed::traits::FromFixed;
use substrate_fixed::types::U8F8;
// 0x87.65
let f = U8F8::from_bits(0x8765);
assert_eq!(f32::from_fixed(f), f32::from(0x8765u16) / 256.0);
assert_eq!(i32::checked_from_fixed(f), Some(0x87));
assert_eq!(u8::saturating_from_fixed(f), 0x87);
// no fit
assert_eq!(i8::checked_from_fixed(f), None);
assert_eq!(i8::saturating_from_fixed(f), i8::max_value());
assert_eq!(i8::wrapping_from_fixed(f), 0x87u8 as i8);
assert_eq!(i8::overflowing_from_fixed(f), (0x87u8 as i8, true));

Required Methods§

fn from_fixed<F: Fixed>(src: F) -> Self

Converts from a fixed-point number.

Any extra fractional bits are truncated.

Panics

When debug assertions are enabled, panics if the value does not fit. When debug assertions are not enabled, the wrapped value can be returned, but it is not considered a breaking change if in the future it panics; if wrapping is required use wrapping_from_fixed instead.

fn checked_from_fixed<F: Fixed>(src: F) -> Option<Self>where Self: Sized,

Converts from a fixed-point number if it fits, otherwise returns None.

Any extra fractional bits are truncated.

fn saturating_from_fixed<F: Fixed>(src: F) -> Self

Converts from a fixed-point number, saturating if it does not fit.

Any extra fractional bits are truncated.

fn wrapping_from_fixed<F: Fixed>(src: F) -> Self

Converts from a fixed-point number, wrapping if it does not fit.

Any extra fractional bits are truncated.

fn overflowing_from_fixed<F: Fixed>(src: F) -> (Self, bool)where Self: Sized,

Converts from a fixed-point number.

Returns a tuple of the value and a bool indicating whether an overflow has occurred. On overflow, the wrapped value is returned.

Any extra fractional bits are truncated.

Object Safety§

This trait is not object safe.

Implementations on Foreign Types§

impl FromFixed for f32

fn from_fixed<F: Fixed>(src: F) -> Self

Converts a fixed-point number to a floating-point number.

Rounding is to the nearest, with ties rounded to even.

Panics

When debug assertions are enabled, panics if the value does not fit. When debug assertions are not enabled, the wrapped value can be returned, but it is not considered a breaking change if in the future it panics; if wrapping is required use wrapping_from_fixed instead.

fn checked_from_fixed<F: Fixed>(src: F) -> Option<Self>

Converts a fixed-point number to a floating-point number if it fits, otherwise returns None.

Rounding is to the nearest, with ties rounded to even.

fn saturating_from_fixed<F: Fixed>(src: F) -> Self

Converts a fixed-point number to a floating-point number, saturating if it does not fit.

Rounding is to the nearest, with ties rounded to even.

fn wrapping_from_fixed<F: Fixed>(src: F) -> Self

Converts a fixed-point number to a floating-point number, wrapping if it does not fit.

Rounding is to the nearest, with ties rounded to even.

fn overflowing_from_fixed<F: Fixed>(src: F) -> (Self, bool)

Converts a fixed-point number to a floating-point number.

Returns a tuple of the value and a bool indicating whether an overflow has occurred. On overflow, the wrapped value is returned.

Rounding is to the nearest, with ties rounded to even.

impl FromFixed for f64

fn from_fixed<F: Fixed>(src: F) -> Self

Converts a fixed-point number to a floating-point number.

Rounding is to the nearest, with ties rounded to even.

Panics

When debug assertions are enabled, panics if the value does not fit. When debug assertions are not enabled, the wrapped value can be returned, but it is not considered a breaking change if in the future it panics; if wrapping is required use wrapping_from_fixed instead.

fn checked_from_fixed<F: Fixed>(src: F) -> Option<Self>

Converts a fixed-point number to a floating-point number if it fits, otherwise returns None.

Rounding is to the nearest, with ties rounded to even.

fn saturating_from_fixed<F: Fixed>(src: F) -> Self

Converts a fixed-point number to a floating-point number, saturating if it does not fit.

Rounding is to the nearest, with ties rounded to even.

fn wrapping_from_fixed<F: Fixed>(src: F) -> Self

Converts a fixed-point number to a floating-point number, wrapping if it does not fit.

Rounding is to the nearest, with ties rounded to even.

fn overflowing_from_fixed<F: Fixed>(src: F) -> (Self, bool)

Converts a fixed-point number to a floating-point number.

Returns a tuple of the value and a bool indicating whether an overflow has occurred. On overflow, the wrapped value is returned.

Rounding is to the nearest, with ties rounded to even.

impl FromFixed for i8

fn from_fixed<F: Fixed>(src: F) -> Self

Converts a fixed-point number to an integer.

Any fractional bits are truncated.

Panics

When debug assertions are enabled, panics if the value does not fit. When debug assertions are not enabled, the wrapped value can be returned, but it is not considered a breaking change if in the future it panics; if wrapping is required use wrapping_from_fixed instead.

fn checked_from_fixed<F: Fixed>(src: F) -> Option<Self>

Converts a fixed-point number to an integer if it fits, otherwise returns None.

Any fractional bits are truncated.

fn saturating_from_fixed<F: Fixed>(src: F) -> Self

Converts a fixed-point number to an integer, saturating if it does not fit.

Any fractional bits are truncated.

fn wrapping_from_fixed<F: Fixed>(src: F) -> Self

Converts a fixed-point number to an integer, wrapping if it does not fit.

Any fractional bits are truncated.

fn overflowing_from_fixed<F: Fixed>(src: F) -> (Self, bool)

Converts a fixed-point number to an integer.

Returns a tuple of the value and a bool indicating whether an overflow has occurred. On overflow, the wrapped value is returned.

Any fractional bits are truncated.

impl FromFixed for i16

fn from_fixed<F: Fixed>(src: F) -> Self

Converts a fixed-point number to an integer.

Any fractional bits are truncated.

Panics

When debug assertions are enabled, panics if the value does not fit. When debug assertions are not enabled, the wrapped value can be returned, but it is not considered a breaking change if in the future it panics; if wrapping is required use wrapping_from_fixed instead.

fn checked_from_fixed<F: Fixed>(src: F) -> Option<Self>

Converts a fixed-point number to an integer if it fits, otherwise returns None.

Any fractional bits are truncated.

fn saturating_from_fixed<F: Fixed>(src: F) -> Self

Converts a fixed-point number to an integer, saturating if it does not fit.

Any fractional bits are truncated.

fn wrapping_from_fixed<F: Fixed>(src: F) -> Self

Converts a fixed-point number to an integer, wrapping if it does not fit.

Any fractional bits are truncated.

fn overflowing_from_fixed<F: Fixed>(src: F) -> (Self, bool)

Converts a fixed-point number to an integer.

Returns a tuple of the value and a bool indicating whether an overflow has occurred. On overflow, the wrapped value is returned.

Any fractional bits are truncated.

impl FromFixed for i32

fn from_fixed<F: Fixed>(src: F) -> Self

Converts a fixed-point number to an integer.

Any fractional bits are truncated.

Panics

When debug assertions are enabled, panics if the value does not fit. When debug assertions are not enabled, the wrapped value can be returned, but it is not considered a breaking change if in the future it panics; if wrapping is required use wrapping_from_fixed instead.

fn checked_from_fixed<F: Fixed>(src: F) -> Option<Self>

Converts a fixed-point number to an integer if it fits, otherwise returns None.

Any fractional bits are truncated.

fn saturating_from_fixed<F: Fixed>(src: F) -> Self

Converts a fixed-point number to an integer, saturating if it does not fit.

Any fractional bits are truncated.

fn wrapping_from_fixed<F: Fixed>(src: F) -> Self

Converts a fixed-point number to an integer, wrapping if it does not fit.

Any fractional bits are truncated.

fn overflowing_from_fixed<F: Fixed>(src: F) -> (Self, bool)

Converts a fixed-point number to an integer.

Returns a tuple of the value and a bool indicating whether an overflow has occurred. On overflow, the wrapped value is returned.

Any fractional bits are truncated.

impl FromFixed for i64

fn from_fixed<F: Fixed>(src: F) -> Self

Converts a fixed-point number to an integer.

Any fractional bits are truncated.

Panics

When debug assertions are enabled, panics if the value does not fit. When debug assertions are not enabled, the wrapped value can be returned, but it is not considered a breaking change if in the future it panics; if wrapping is required use wrapping_from_fixed instead.

fn checked_from_fixed<F: Fixed>(src: F) -> Option<Self>

Converts a fixed-point number to an integer if it fits, otherwise returns None.

Any fractional bits are truncated.

fn saturating_from_fixed<F: Fixed>(src: F) -> Self

Converts a fixed-point number to an integer, saturating if it does not fit.

Any fractional bits are truncated.

fn wrapping_from_fixed<F: Fixed>(src: F) -> Self

Converts a fixed-point number to an integer, wrapping if it does not fit.

Any fractional bits are truncated.

fn overflowing_from_fixed<F: Fixed>(src: F) -> (Self, bool)

Converts a fixed-point number to an integer.

Returns a tuple of the value and a bool indicating whether an overflow has occurred. On overflow, the wrapped value is returned.

Any fractional bits are truncated.

impl FromFixed for i128

fn from_fixed<F: Fixed>(src: F) -> Self

Converts a fixed-point number to an integer.

Any fractional bits are truncated.

Panics

When debug assertions are enabled, panics if the value does not fit. When debug assertions are not enabled, the wrapped value can be returned, but it is not considered a breaking change if in the future it panics; if wrapping is required use wrapping_from_fixed instead.

fn checked_from_fixed<F: Fixed>(src: F) -> Option<Self>

Converts a fixed-point number to an integer if it fits, otherwise returns None.

Any fractional bits are truncated.

fn saturating_from_fixed<F: Fixed>(src: F) -> Self

Converts a fixed-point number to an integer, saturating if it does not fit.

Any fractional bits are truncated.

fn wrapping_from_fixed<F: Fixed>(src: F) -> Self

Converts a fixed-point number to an integer, wrapping if it does not fit.

Any fractional bits are truncated.

fn overflowing_from_fixed<F: Fixed>(src: F) -> (Self, bool)

Converts a fixed-point number to an integer.

Returns a tuple of the value and a bool indicating whether an overflow has occurred. On overflow, the wrapped value is returned.

Any fractional bits are truncated.

impl FromFixed for isize

fn from_fixed<F: Fixed>(src: F) -> Self

Converts a fixed-point number to an integer.

Any fractional bits are truncated.

Panics

When debug assertions are enabled, panics if the value does not fit. When debug assertions are not enabled, the wrapped value can be returned, but it is not considered a breaking change if in the future it panics; if wrapping is required use wrapping_from_fixed instead.

fn checked_from_fixed<F: Fixed>(src: F) -> Option<Self>

Converts a fixed-point number to an integer if it fits, otherwise returns None.

Any fractional bits are truncated.

fn saturating_from_fixed<F: Fixed>(src: F) -> Self

Converts a fixed-point number to an integer, saturating if it does not fit.

Any fractional bits are truncated.

fn wrapping_from_fixed<F: Fixed>(src: F) -> Self

Converts a fixed-point number to an integer, wrapping if it does not fit.

Any fractional bits are truncated.

fn overflowing_from_fixed<F: Fixed>(src: F) -> (Self, bool)

Converts a fixed-point number to an integer.

Returns a tuple of the value and a bool indicating whether an overflow has occurred. On overflow, the wrapped value is returned.

Any fractional bits are truncated.

impl FromFixed for u8

fn from_fixed<F: Fixed>(src: F) -> Self

Converts a fixed-point number to an integer.

Any fractional bits are truncated.

Panics

When debug assertions are enabled, panics if the value does not fit. When debug assertions are not enabled, the wrapped value can be returned, but it is not considered a breaking change if in the future it panics; if wrapping is required use wrapping_from_fixed instead.

fn checked_from_fixed<F: Fixed>(src: F) -> Option<Self>

Converts a fixed-point number to an integer if it fits, otherwise returns None.

Any fractional bits are truncated.

fn saturating_from_fixed<F: Fixed>(src: F) -> Self

Converts a fixed-point number to an integer, saturating if it does not fit.

Any fractional bits are truncated.

fn wrapping_from_fixed<F: Fixed>(src: F) -> Self

Converts a fixed-point number to an integer, wrapping if it does not fit.

Any fractional bits are truncated.

fn overflowing_from_fixed<F: Fixed>(src: F) -> (Self, bool)

Converts a fixed-point number to an integer.

Returns a tuple of the value and a bool indicating whether an overflow has occurred. On overflow, the wrapped value is returned.

Any fractional bits are truncated.

impl FromFixed for u16

fn from_fixed<F: Fixed>(src: F) -> Self

Converts a fixed-point number to an integer.

Any fractional bits are truncated.

Panics

When debug assertions are enabled, panics if the value does not fit. When debug assertions are not enabled, the wrapped value can be returned, but it is not considered a breaking change if in the future it panics; if wrapping is required use wrapping_from_fixed instead.

fn checked_from_fixed<F: Fixed>(src: F) -> Option<Self>

Converts a fixed-point number to an integer if it fits, otherwise returns None.

Any fractional bits are truncated.

fn saturating_from_fixed<F: Fixed>(src: F) -> Self

Converts a fixed-point number to an integer, saturating if it does not fit.

Any fractional bits are truncated.

fn wrapping_from_fixed<F: Fixed>(src: F) -> Self

Converts a fixed-point number to an integer, wrapping if it does not fit.

Any fractional bits are truncated.

fn overflowing_from_fixed<F: Fixed>(src: F) -> (Self, bool)

Converts a fixed-point number to an integer.

Returns a tuple of the value and a bool indicating whether an overflow has occurred. On overflow, the wrapped value is returned.

Any fractional bits are truncated.

impl FromFixed for u32

fn from_fixed<F: Fixed>(src: F) -> Self

Converts a fixed-point number to an integer.

Any fractional bits are truncated.

Panics

When debug assertions are enabled, panics if the value does not fit. When debug assertions are not enabled, the wrapped value can be returned, but it is not considered a breaking change if in the future it panics; if wrapping is required use wrapping_from_fixed instead.

fn checked_from_fixed<F: Fixed>(src: F) -> Option<Self>

Converts a fixed-point number to an integer if it fits, otherwise returns None.

Any fractional bits are truncated.

fn saturating_from_fixed<F: Fixed>(src: F) -> Self

Converts a fixed-point number to an integer, saturating if it does not fit.

Any fractional bits are truncated.

fn wrapping_from_fixed<F: Fixed>(src: F) -> Self

Converts a fixed-point number to an integer, wrapping if it does not fit.

Any fractional bits are truncated.

fn overflowing_from_fixed<F: Fixed>(src: F) -> (Self, bool)

Converts a fixed-point number to an integer.

Returns a tuple of the value and a bool indicating whether an overflow has occurred. On overflow, the wrapped value is returned.

Any fractional bits are truncated.

impl FromFixed for u64

fn from_fixed<F: Fixed>(src: F) -> Self

Converts a fixed-point number to an integer.

Any fractional bits are truncated.

Panics

When debug assertions are enabled, panics if the value does not fit. When debug assertions are not enabled, the wrapped value can be returned, but it is not considered a breaking change if in the future it panics; if wrapping is required use wrapping_from_fixed instead.

fn checked_from_fixed<F: Fixed>(src: F) -> Option<Self>

Converts a fixed-point number to an integer if it fits, otherwise returns None.

Any fractional bits are truncated.

fn saturating_from_fixed<F: Fixed>(src: F) -> Self

Converts a fixed-point number to an integer, saturating if it does not fit.

Any fractional bits are truncated.

fn wrapping_from_fixed<F: Fixed>(src: F) -> Self

Converts a fixed-point number to an integer, wrapping if it does not fit.

Any fractional bits are truncated.

fn overflowing_from_fixed<F: Fixed>(src: F) -> (Self, bool)

Converts a fixed-point number to an integer.

Returns a tuple of the value and a bool indicating whether an overflow has occurred. On overflow, the wrapped value is returned.

Any fractional bits are truncated.

impl FromFixed for u128

fn from_fixed<F: Fixed>(src: F) -> Self

Converts a fixed-point number to an integer.

Any fractional bits are truncated.

Panics

When debug assertions are enabled, panics if the value does not fit. When debug assertions are not enabled, the wrapped value can be returned, but it is not considered a breaking change if in the future it panics; if wrapping is required use wrapping_from_fixed instead.

fn checked_from_fixed<F: Fixed>(src: F) -> Option<Self>

Converts a fixed-point number to an integer if it fits, otherwise returns None.

Any fractional bits are truncated.

fn saturating_from_fixed<F: Fixed>(src: F) -> Self

Converts a fixed-point number to an integer, saturating if it does not fit.

Any fractional bits are truncated.

fn wrapping_from_fixed<F: Fixed>(src: F) -> Self

Converts a fixed-point number to an integer, wrapping if it does not fit.

Any fractional bits are truncated.

fn overflowing_from_fixed<F: Fixed>(src: F) -> (Self, bool)

Converts a fixed-point number to an integer.

Returns a tuple of the value and a bool indicating whether an overflow has occurred. On overflow, the wrapped value is returned.

Any fractional bits are truncated.

impl FromFixed for usize

fn from_fixed<F: Fixed>(src: F) -> Self

Converts a fixed-point number to an integer.

Any fractional bits are truncated.

Panics

When debug assertions are enabled, panics if the value does not fit. When debug assertions are not enabled, the wrapped value can be returned, but it is not considered a breaking change if in the future it panics; if wrapping is required use wrapping_from_fixed instead.

fn checked_from_fixed<F: Fixed>(src: F) -> Option<Self>

Converts a fixed-point number to an integer if it fits, otherwise returns None.

Any fractional bits are truncated.

fn saturating_from_fixed<F: Fixed>(src: F) -> Self

Converts a fixed-point number to an integer, saturating if it does not fit.

Any fractional bits are truncated.

fn wrapping_from_fixed<F: Fixed>(src: F) -> Self

Converts a fixed-point number to an integer, wrapping if it does not fit.

Any fractional bits are truncated.

fn overflowing_from_fixed<F: Fixed>(src: F) -> (Self, bool)

Converts a fixed-point number to an integer.

Returns a tuple of the value and a bool indicating whether an overflow has occurred. On overflow, the wrapped value is returned.

Any fractional bits are truncated.

impl FromFixed for bf16

fn from_fixed<F: Fixed>(src: F) -> Self

Converts a fixed-point number to a floating-point number.

Rounding is to the nearest, with ties rounded to even.

Panics

When debug assertions are enabled, panics if the value does not fit. When debug assertions are not enabled, the wrapped value can be returned, but it is not considered a breaking change if in the future it panics; if wrapping is required use wrapping_from_fixed instead.

fn checked_from_fixed<F: Fixed>(src: F) -> Option<Self>

Converts a fixed-point number to a floating-point number if it fits, otherwise returns None.

Rounding is to the nearest, with ties rounded to even.

fn saturating_from_fixed<F: Fixed>(src: F) -> Self

Converts a fixed-point number to a floating-point number, saturating if it does not fit.

Rounding is to the nearest, with ties rounded to even.

fn wrapping_from_fixed<F: Fixed>(src: F) -> Self

Converts a fixed-point number to a floating-point number, wrapping if it does not fit.

Rounding is to the nearest, with ties rounded to even.

fn overflowing_from_fixed<F: Fixed>(src: F) -> (Self, bool)

Converts a fixed-point number to a floating-point number.

Returns a tuple of the value and a bool indicating whether an overflow has occurred. On overflow, the wrapped value is returned.

Rounding is to the nearest, with ties rounded to even.

impl FromFixed for f16

fn from_fixed<F: Fixed>(src: F) -> Self

Converts a fixed-point number to a floating-point number.

Rounding is to the nearest, with ties rounded to even.

Panics

When debug assertions are enabled, panics if the value does not fit. When debug assertions are not enabled, the wrapped value can be returned, but it is not considered a breaking change if in the future it panics; if wrapping is required use wrapping_from_fixed instead.

fn checked_from_fixed<F: Fixed>(src: F) -> Option<Self>

Converts a fixed-point number to a floating-point number if it fits, otherwise returns None.

Rounding is to the nearest, with ties rounded to even.

fn saturating_from_fixed<F: Fixed>(src: F) -> Self

Converts a fixed-point number to a floating-point number, saturating if it does not fit.

Rounding is to the nearest, with ties rounded to even.

fn wrapping_from_fixed<F: Fixed>(src: F) -> Self

Converts a fixed-point number to a floating-point number, wrapping if it does not fit.

Rounding is to the nearest, with ties rounded to even.

fn overflowing_from_fixed<F: Fixed>(src: F) -> (Self, bool)

Converts a fixed-point number to a floating-point number.

Returns a tuple of the value and a bool indicating whether an overflow has occurred. On overflow, the wrapped value is returned.

Rounding is to the nearest, with ties rounded to even.

Implementors§

impl<Frac: LeEqU8> FromFixed for FixedI8<Frac>

impl<Frac: LeEqU8> FromFixed for FixedU8<Frac>

impl<Frac: LeEqU16> FromFixed for FixedI16<Frac>

impl<Frac: LeEqU16> FromFixed for FixedU16<Frac>

impl<Frac: LeEqU32> FromFixed for FixedI32<Frac>

impl<Frac: LeEqU32> FromFixed for FixedU32<Frac>

impl<Frac: LeEqU64> FromFixed for FixedI64<Frac>

impl<Frac: LeEqU64> FromFixed for FixedU64<Frac>

impl<Frac: LeEqU128> FromFixed for FixedI128<Frac>

impl<Frac: LeEqU128> FromFixed for FixedU128<Frac>