Struct readable::Float

pub struct Float(_, _);

Human readable float.

Takes a floating point number as input and returns a ready-to-print!() Float.

The fractional floating point may or may not be rounded up/down in the String.

The default Float::from implementation will print 3 decimal numbers.

This can be changed by using different functions when initially creating the Float, or converting an existing Float, for example:

let f2 = Float::from_2(3.0);
let f6 = Float::from_6(3.0);
let f9 = Float::from_9(f2.inner());

assert!(f2 == 3.00);
assert!(f6 == 3.000000);
assert!(f9 == 3.000000000);

Cloning

Clone may be expensive:

// Probably cheap (stack allocated string).
let a = Float::from(100.0);
let b = a.clone();

// Probably expensive (heap allocated string).
let a = Float::from(f64::MAX);
let b = a.clone();

The actual string used internally is not a String, but a CompactString so that any string 24 bytes (12 bytes on 32-bit) or less are stack allocated instead of heap allocated.

The documentation will still refer to the inner string as a String. Anything returned will also be a String.

Float Errors

• Inputting f64::NAN, f64::INFINITY, f64::NEG_INFINITY or the f32 variants returns errors

To disable checks for these, (you are sure you don’t have NaN’s), enable the ignore_nan_inf feature flag.

Math

These operators are overloaded. They will always output a new Self:

• Add +
• Sub -
• Div /
• Mul *
• Rem %

They can either be:

• Combined with another Self: Float::from(1.0) + Float::from(1.0)
• Or with the inner number itself: Float::from(1.0) + 1.0

They also have the same panic!() behavior on overflow as the normal ones, because internally, it is just calling .inner() $OPERATOR $NUMBER.

// Regular operators.
assert!(Float::from(10.0) + 10.0 == Float::from(20.0));
assert!(Float::from(10.0) - 10.0 == Float::from(0.0));
assert!(Float::from(10.0) / 10.0 == Float::from(1.0));
assert!(Float::from(10.0) * 10.0 == Float::from(100.0));
assert!(Float::from(10.0) % 10.0 == Float::from(0.0));

Overflow example (floats don’t panic in this case):

let n = Float::from(f64::MAX) + f64::MAX;
assert!(n.is_inf());

Examples

assert!(Float::from(0.0) == "0.000");

// This gets rounded up to '.568'
assert!(Float::from(1234.5678) == "1,234.568");
// To prevent that, use 4 point.
assert!(Float::from_4(1234.5678) == "1,234.5678");

Implementations

impl Float

pub fn as_str(&self) -> &str

Return a borrowed str without consuming Self.

pub fn as_bytes(&self) -> &[u8]

Returns the valid byte slice of the inner String

These bytes can always safely be used for std::str::from_utf8_unchecked.

pub fn to_vec(&self) -> Vec<u8>

Return the bytes of the inner String as a Vec

pub fn into_vec(self) -> Vec<u8>

Return the bytes of the inner String as a Vec, consuming Self

pub const fn inner(&self) -> f64

Returns the inner number.

pub fn into_string(self) -> String

Consumes Self, returning the inner String.

pub fn into_raw(self) -> (f64, String)

Consumes Self, returning the inner parts.

pub fn head(&self, len: usize) -> &str

Return the first len bytes of this str.

This will return the full str if the len is longer than the actual inner str.

Since all readable types happen to only contain ASCII characters, all char’s are equal to 1 byte.

let date = Date::from_str("2021-12-11").unwrap();

assert!(date.head(5) == "2021-");

pub fn head_dot(&self, len: usize) -> String

Same as Self::head but returns a String ending with ...

This will return the full string without ... if the len is longer than the actual inner str.

let date = Date::from_str("2021-12-11").unwrap();

assert!(date.head_dot(4) == "2021...");

pub fn tail(&self, len: usize) -> &str

Return the last len bytes of this str.

This will return the full str if the len is longer than the actual inner str.

Since all readable types happen to only contain ASCII characters, all char’s are equal to 1 byte.

let date = Date::from_str("2021-12-11").unwrap();

assert!(date.tail(5) == "12-11");

pub fn tail_dot(&self, len: usize) -> String

Same as Self::tail but returns a String starting with ...

This will return the full string without ... if the len is longer than the actual inner str.

let date = Date::from_str("2021-12-11").unwrap();

assert!(date.tail_dot(5) == "...12-11");

pub fn head_tail(&self, head: usize, tail: usize) -> String

Return the first head bytes and last tail bytes of this string separated with ....

Since all readable types happen to only contain ASCII characters, all char’s are equal to 1 byte.

let date = Date::from_str("2021-12-11").unwrap();

assert!(date.head_tail(3, 2) == "202...11");
assert!(date.head_tail(3, 3) == "202...-11");
assert!(date.head_tail(3, 5) == "202...12-11");

pub fn len(&self) -> usize

The length of the inner String

pub fn is_empty(&self) -> bool

If the inner String is empty or not

pub const fn zero() -> Self

Returns a Float with the f64 value of 0.0.

The String is set to ZERO_FLOAT.

pub const fn unknown() -> Self

Returns a Float with the f64 value of f64::NAN.

The String is set to UNKNOWN_FLOAT.

pub const fn nan() -> Self

Returns a Float with the f64 value of f64::NAN.

The String is set to NAN.

pub const fn inf() -> Self

Returns a Float with the f64 value of f64::INFINITY.

The String is set to INFINITY.

pub fn is_nan(&self) -> bool

Calls f64::is_nan.

pub fn is_inf(&self) -> bool

Calls f64::is_infinite.

pub fn from_0(f: f64) -> Self

Same as Float::from but with no floating point on the inner String.

The inner f64 stays the same as the input.

This does not round up or down, it completely ignores the floating point.

Examples

Input	String Output
0.0	0
50.123	50
100.1	100

pub fn from_1(f: f64) -> Self

Same as Float::from but with 1 floating point.

pub fn from_2(f: f64) -> Self

Same as Float::from but with 2 floating point.

pub fn from_4(f: f64) -> Self

Same as Float::from but with 4 floating point.

pub fn from_5(f: f64) -> Self

Same as Float::from but with 5 floating point.

pub fn from_6(f: f64) -> Self

Same as Float::from but with 6 floating point.

pub fn from_7(f: f64) -> Self

Same as Float::from but with 7 floating point.

pub fn from_8(f: f64) -> Self

Same as Float::from but with 8 floating point.

pub fn from_9(f: f64) -> Self

Same as Float::from but with 9 floating point.

pub fn from_10(f: f64) -> Self

Same as Float::from but with 10 floating point.

pub fn from_11(f: f64) -> Self

Same as Float::from but with 11 floating point.

pub fn from_12(f: f64) -> Self

Same as Float::from but with 12 floating point.

pub fn from_13(f: f64) -> Self

Same as Float::from but with 13 floating point.

pub fn from_14(f: f64) -> Self

Same as Float::from but with 14 floating point.

pub fn from_15(f: f64) -> Self

Same as Float::from but with 15 floating point.

pub fn from_16(f: f64) -> Self

Same as Float::from but with 16 floating point.

pub fn from_17(f: f64) -> Self

Same as Float::from but with 17 floating point.

pub fn from_18(f: f64) -> Self

Same as Float::from but with 18 floating point.

Trait Implementations

impl Add<&Float> for Float

type Output = Float

The resulting type after applying the + operator.

fn add(self, other: &Float) -> Self

Performs the + operation.

impl Add<&Float> for f64

type Output = f64

The resulting type after applying the + operator.

fn add(self, other: &Float) -> Self

Performs the + operation.

impl Add<&f64> for Float

type Output = Float

The resulting type after applying the + operator.

fn add(self, other: &f64) -> Self

Performs the + operation.

impl Add<Float> for Float

type Output = Float

The resulting type after applying the + operator.

fn add(self, other: Float) -> Self

Performs the + operation.

impl Add<Float> for f64

type Output = f64

The resulting type after applying the + operator.

fn add(self, other: Float) -> Self

Performs the + operation.

impl Add<f64> for Float

type Output = Float

The resulting type after applying the + operator.

fn add(self, other: f64) -> Self

Performs the + operation.

impl<'__de> BorrowDecode<'__de> for Float

fn borrow_decode<__D: BorrowDecoder<'__de>>( decoder: &mut __D ) -> Result<Self, DecodeError>

Attempt to decode this type with the given BorrowDecode.

impl Clone for Float

fn clone(&self) -> Float

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Float

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

Formats the value using the given formatter.

impl Decode for Float

fn decode<__D: Decoder>(decoder: &mut __D) -> Result<Self, DecodeError>

Attempt to decode this type with the given Decode.

impl Default for Float

fn default() -> Self

Calls Self::zero

impl<'de> Deserialize<'de> for Float

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Float

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

Formats the value using the given formatter.

impl Div<&Float> for Float

type Output = Float

The resulting type after applying the / operator.

fn div(self, other: &Float) -> Self

Performs the / operation.

impl Div<&Float> for f64

type Output = f64

The resulting type after applying the / operator.

fn div(self, other: &Float) -> Self

Performs the / operation.

impl Div<&f64> for Float

type Output = Float

The resulting type after applying the / operator.

fn div(self, other: &f64) -> Self

Performs the / operation.

impl Div<Float> for Float

type Output = Float

The resulting type after applying the / operator.

fn div(self, other: Float) -> Self

Performs the / operation.

impl Div<Float> for f64

type Output = f64

The resulting type after applying the / operator.

fn div(self, other: Float) -> Self

Performs the / operation.

impl Div<f64> for Float

type Output = Float

The resulting type after applying the / operator.

fn div(self, other: f64) -> Self

Performs the / operation.

impl Encode for Float

fn encode<__E: Encoder>(&self, encoder: &mut __E) -> Result<(), EncodeError>

Encode a given type.

impl From<f32> for Float

fn from(number: f32) -> Self

Converts to this type from the input type.

impl From<f64> for Float

fn from(number: f64) -> Self

Converts to this type from the input type.

impl From<i16> for Float

fn from(number: i16) -> Self

Converts to this type from the input type.

impl From<i32> for Float

fn from(number: i32) -> Self

Converts to this type from the input type.

impl From<i8> for Float

fn from(number: i8) -> Self

Converts to this type from the input type.

impl From<u16> for Float

fn from(number: u16) -> Self

Converts to this type from the input type.

impl From<u32> for Float

fn from(number: u32) -> Self

Converts to this type from the input type.

impl From<u8> for Float

fn from(number: u8) -> Self

Converts to this type from the input type.

impl Mul<&Float> for Float

type Output = Float

The resulting type after applying the * operator.

fn mul(self, other: &Float) -> Self

Performs the * operation.

impl Mul<&Float> for f64

type Output = f64

The resulting type after applying the * operator.

fn mul(self, other: &Float) -> Self

Performs the * operation.

impl Mul<&f64> for Float

type Output = Float

The resulting type after applying the * operator.

fn mul(self, other: &f64) -> Self

Performs the * operation.

impl Mul<Float> for Float

type Output = Float

The resulting type after applying the * operator.

fn mul(self, other: Float) -> Self

Performs the * operation.

impl Mul<Float> for f64

type Output = f64

The resulting type after applying the * operator.

fn mul(self, other: Float) -> Self

Performs the * operation.

impl Mul<f64> for Float

type Output = Float

The resulting type after applying the * operator.

fn mul(self, other: f64) -> Self

Performs the * operation.

impl PartialEq<&Float> for f64

fn eq(&self, other: &&Float) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<&Float> for str

fn eq(&self, other: &&Float) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<&str> for Float

fn eq(&self, other: &&str) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Float> for Float

fn eq(&self, other: &Float) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Float> for f64

fn eq(&self, other: &Float) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Float> for str

fn eq(&self, other: &Float) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<f64> for &Float

fn eq(&self, other: &f64) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<f64> for Float

fn eq(&self, other: &f64) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<str> for Float

fn eq(&self, other: &str) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<&Float> for f64

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

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

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

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

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

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

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

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

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

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

impl PartialOrd<&Float> for str

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

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

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

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

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

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

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

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

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

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

impl PartialOrd<&str> for Float

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

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

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

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

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

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

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

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

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

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

impl PartialOrd<Float> for Float

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

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

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

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

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

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

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

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

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

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

impl PartialOrd<Float> for f64

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

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

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

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

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

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

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

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

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

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

impl PartialOrd<Float> for str

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

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

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

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

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

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

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

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

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

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

impl PartialOrd<f64> for &Float

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

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

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

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

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

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

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

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

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

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

impl PartialOrd<f64> for Float

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

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

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

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

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

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

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

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

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

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

impl PartialOrd<str> for Float

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

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

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

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

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

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

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

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

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

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

impl Rem<&Float> for Float

type Output = Float

The resulting type after applying the % operator.

fn rem(self, other: &Float) -> Self

Performs the % operation.

impl Rem<&Float> for f64

type Output = f64

The resulting type after applying the % operator.

fn rem(self, other: &Float) -> Self

Performs the % operation.

impl Rem<&f64> for Float

type Output = Float

The resulting type after applying the % operator.

fn rem(self, other: &f64) -> Self

Performs the % operation.

impl Rem<Float> for Float

type Output = Float

The resulting type after applying the % operator.

fn rem(self, other: Float) -> Self

Performs the % operation.

impl Rem<Float> for f64

type Output = f64

The resulting type after applying the % operator.

fn rem(self, other: Float) -> Self

Performs the % operation.

impl Rem<f64> for Float

type Output = Float

The resulting type after applying the % operator.

fn rem(self, other: f64) -> Self

Performs the % operation.

impl Serialize for Float

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub<&Float> for Float

type Output = Float

The resulting type after applying the - operator.

fn sub(self, other: &Float) -> Self

Performs the - operation.

impl Sub<&Float> for f64

type Output = f64

The resulting type after applying the - operator.

fn sub(self, other: &Float) -> Self

Performs the - operation.

impl Sub<&f64> for Float

type Output = Float

The resulting type after applying the - operator.

fn sub(self, other: &f64) -> Self

Performs the - operation.

impl Sub<Float> for Float

type Output = Float

The resulting type after applying the - operator.

fn sub(self, other: Float) -> Self

Performs the - operation.

impl Sub<Float> for f64

type Output = f64

The resulting type after applying the - operator.

fn sub(self, other: Float) -> Self

Performs the - operation.

impl Sub<f64> for Float

type Output = Float

The resulting type after applying the - operator.

fn sub(self, other: f64) -> Self

Performs the - operation.

impl StructuralPartialEq for Float