Struct Multiplier

pub struct Multiplier(pub i64, pub i16);

The multiplier of a TimeUnit.

The multiplier consists of two numbers (m, e) which are applied to another number x as follows:

x * m * 10 ^ e

Examples:

let nano_second = Multiplier(1, -9);
let second = Multiplier(1, 0);
let hour = Multiplier(3600, 0);

Tuple Fields

0: i64

1: i16

Implementations

impl Multiplier

pub const fn coefficient(&self) -> i64

Return the coefficient component of the Multiplier

Examples

use fundu_core::time::Multiplier;

let multiplier = Multiplier(123, 45);
assert_eq!(multiplier.coefficient(), 123);

pub const fn exponent(&self) -> i16

Return the exponent component of the Multiplier

Examples

use fundu_core::time::Multiplier;

let multiplier = Multiplier(123, 45);
assert_eq!(multiplier.exponent(), 45);

pub const fn is_negative(&self) -> bool

Return true if the Multiplier is negative

Examples

use fundu_core::time::Multiplier;

let multiplier = Multiplier(-123, 45);
assert!(multiplier.is_negative());

pub const fn is_positive(&self) -> bool

Return true if the Multiplier is positive

Examples

use fundu_core::time::Multiplier;

let multiplier = Multiplier(123, 45);
assert!(multiplier.is_positive());

pub const fn checked_mul(&self, rhs: Self) -> Option<Self>

Checked Multiplier multiplication. Computes self * other, returning None if an overflow occurred.

Let a, b be multipliers, with m being the coefficient and e the exponent. The multiplication is performed such that (x.m, x.e) = (a.m * b.m, a.e + b.e)

Examples

use fundu_core::time::Multiplier;

assert_eq!(
    Multiplier(1, 2).checked_mul(Multiplier(3, 4)),
    Some(Multiplier(3, 6))
);
assert_eq!(
    Multiplier(-1, 2).checked_mul(Multiplier(3, -4)),
    Some(Multiplier(-3, -2))
);
assert_eq!(Multiplier(2, 0).checked_mul(Multiplier(i64::MAX, 1)), None);
assert_eq!(Multiplier(1, 2).checked_mul(Multiplier(1, i16::MAX)), None);

pub const fn saturating_neg(&self) -> Self

Saturating negation. Computes -self, returning i64::MAX if self.coefficient() == i64::MIN instead of overflowing.

Examples

use fundu_core::time::Multiplier;

assert_eq!(Multiplier(1, 2).saturating_neg(), Multiplier(-1, 2));
assert_eq!(Multiplier(-1, 2).saturating_neg(), Multiplier(1, 2));
assert_eq!(
    Multiplier(i64::MIN, 2).saturating_neg(),
    Multiplier(i64::MAX, 2)
);

Trait Implementations

impl Clone for Multiplier

fn clone(&self) -> Multiplier

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Multiplier

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

Formats the value using the given formatter.

impl Default for Multiplier

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Multiplier

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Multiplier

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 Mul for Multiplier

type Output = Multiplier

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Self::Output

Performs the * operation.

impl PartialEq for Multiplier

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Multiplier

impl Eq for Multiplier

impl StructuralPartialEq for Multiplier