Struct Integer

pub struct Integer {
    pub value: i64,
    pub suffix: Option<Suffix>,
}

Any value that can be interpreted as an integer.

This supports any numeric value that can fit in a i64, excluding the suffix. The suffix is parsed separately from the value itself, so if you wish to obtain the true value of the integer, you must account for the suffix after fetching the value. integer::Suffix provides bitwise_offset() to help with the math, or to_decimal() for obtaining a usable value in one step.

Fields

value: i64

The value, without any suffix modification

suffix: Option<Suffix>

A provided suffix, if any.

Implementations

impl Integer

pub fn to_decimal(&self) -> Option<i64>

Canonicalize values as simple decimal numbers. An optional suffix of k, m, or g (case-insensitive), will cause the value to be multiplied by 1024 (k), 1048576 (m), or 1073741824 (g) respectively.

Returns the result if there is no multiplication overflow.

Trait Implementations

impl Clone for Integer

fn clone(&self) -> Integer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Integer

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

Formats the value using the given formatter.

impl Default for Integer

fn default() -> Integer

Returns the “default value” for a type.

impl Display for Integer

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

Formats the value using the given formatter.

impl Hash for Integer

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Integer

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Integer

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

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for Integer

Available on crate feature serde only.

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&BStr> for Integer

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: &BStr) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Cow<'_, BStr>> for Integer

type Error = Error

The type returned in the event of a conversion error.

fn try_from(c: Cow<'_, BStr>) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Integer

impl Eq for Integer

impl StructuralPartialEq for Integer