pub trait Numeric {
type BinIter: Iterator<Item = char>;
type OctIter: Iterator<Item = char>;
type DecLeftIter: Iterator<Item = char>;
type DecRightIter: Iterator<Item = char>;
type HexIter: Iterator<Item = char>;
// Required methods
fn binary(&self) -> Option<Self::BinIter>;
fn octal(&self) -> Option<Self::OctIter>;
fn decimal(&self) -> (Self::DecLeftIter, Option<Self::DecRightIter>);
fn hex(&self) -> Option<Self::HexIter>;
fn is_negative(&self) -> bool;
}Expand description
This trait enables a type to be formatted by NumFmt.
The fundamental abstraction used is an optional iterator over a stream of characters. Returning
None always indicates that representation in that base is not available for this type. Any
particular function implemented for a type should always return either None or Some; it
should not depend on the value being formatted.
In all cases, when implemented, the iterators must iterate away from the decimal: for a
representation of N in base B, it must return the appropriate digit for B**0, B**1, …
BN**k where k is ceil(log_B(N)).
Iterators should only return digits within the appropriate range for the base. All other formatting is handled by the formatter.
Iterator types must be declared even when the appropriate function always returns None. In
those cases, std::iter::Empty is appropriate.
Required Associated Types§
Sourcetype BinIter: Iterator<Item = char>
type BinIter: Iterator<Item = char>
Iterate over binary digits of this number.
Legal output characters: [01].
Sourcetype OctIter: Iterator<Item = char>
type OctIter: Iterator<Item = char>
Iterate over octal digits of this number.
Legal output characters: [0-7].
Sourcetype DecLeftIter: Iterator<Item = char>
type DecLeftIter: Iterator<Item = char>
Iterate over decimal digits of this number which are >= 1.
Legal output characters: [0-9].
Sourcetype DecRightIter: Iterator<Item = char>
type DecRightIter: Iterator<Item = char>
Iterate over decimal digits of this number which are < 1.
Legal output characters: [0-9].
This should iterate away from the decimal: for a representation of N, it must return the appropriate
digit for 10**-1, 10**-2, etc.
Required Methods§
Sourcefn binary(&self) -> Option<Self::BinIter>
fn binary(&self) -> Option<Self::BinIter>
Iterate over the binary digits of this number, from least to most significant.
This function should always return either None or Some; it should not depend on the
value of self.
Sourcefn octal(&self) -> Option<Self::OctIter>
fn octal(&self) -> Option<Self::OctIter>
Iterate over the octal digits of this number, from least to most significant.
This function should always return either None or Some; it should not depend on the
value of self.
Sourcefn decimal(&self) -> (Self::DecLeftIter, Option<Self::DecRightIter>)
fn decimal(&self) -> (Self::DecLeftIter, Option<Self::DecRightIter>)
Produce a pair of iterators over the decimal digits of this number.
§DecLeftIter
Self::DecLeftIter must iterate over the decimal digits of this number which are >= 1, from
least to most significant. Note that it is assumed that all numeric types can produce a
decimal representation of an integer component.
§DecRightIter
Self::DecRightIter should iterate away from the decimal: for a representation of N, it
must return the appropriate digit for 10**-1, 10**-2, etc.
It is an exception to the general rule; it may return None or Some according to the
value of self.
If Self is not an integral type, such as f64, but self is an integer, like 1.0, then
the output will vary by what this function returns as follows:
None=>"1"Some(std::iter::empty())=>"1."Some(std::iter::once('0')) =>“1.0”`
Sourcefn hex(&self) -> Option<Self::HexIter>
fn hex(&self) -> Option<Self::HexIter>
Iterate over the hexadecimal digits of this number, with letters as lowercase.
This function should always return either None or Some; it should not depend on the
value of self.
Note that the implementation must provide only the lowercase implementation. The formatter uppercases the output of this function when the user requests uppercase hexadecimal.
Sourcefn is_negative(&self) -> bool
fn is_negative(&self) -> bool
true when this value is less than 0.