Struct UncGas

Source
pub struct UncGas { /* private fields */ }

Implementations§

Source§

impl UncGas

Source

pub const fn from_tgas(inner: u64) -> Self

Creates a new UncGas from the specified number of whole tera Gas.

§Examples
use unc_gas::UncGas;

let tera_gas = UncGas::from_tgas(5);

assert_eq!(tera_gas.as_gas(), 5 * 1_000_000_000_000);
Source

pub const fn from_ggas(inner: u64) -> Self

Creates a new UncGas from the specified number of whole giga Gas.

§Examples
use unc_gas::UncGas;

let giga_gas = UncGas::from_ggas(5);

assert_eq!(giga_gas.as_gas(), 5 * 1_000_000_000);
Source

pub const fn from_gas(inner: u64) -> Self

Creates a new UncGas from the specified number of whole Gas.

§Examples
use unc_gas::UncGas;

let gas = UncGas::from_gas(5 * 1_000_000_000_000);

assert_eq!(gas.as_tgas(), 5);
Source

pub const fn as_gas(self) -> u64

Returns the total number of whole Gas contained by this UncGas.

§Examples
use unc_gas::UncGas;
let UncGas = UncGas::from_gas(12345);
assert_eq!(UncGas.as_gas(), 12345);
Source

pub const fn as_ggas(self) -> u64

Returns the total number of a whole part of giga Gas contained by this UncGas.

§Examples
use unc_gas::UncGas;
let UncGas = UncGas::from_gas(1 * 1_000_000_000);
assert_eq!(UncGas.as_ggas(), 1);
Source

pub const fn as_tgas(self) -> u64

Returns the total number of a whole part of tera Gas contained by this UncGas.

§Examples
use unc_gas::UncGas;
let UncGas = UncGas::from_gas(1 * 1_000_000_000_000);
assert_eq!(UncGas.as_tgas(), 1);
Source

pub const fn checked_add(self, rhs: UncGas) -> Option<Self>

Checked integer addition. Computes self + rhs, returning None if overflow occurred.

§Examples
use unc_gas::UncGas;
use std::u64;
assert_eq!(UncGas::from_gas(u64::MAX -2).checked_add(UncGas::from_gas(2)), Some(UncGas::from_gas(u64::MAX)));
assert_eq!(UncGas::from_gas(u64::MAX -2).checked_add(UncGas::from_gas(3)), None);
Source

pub const fn checked_sub(self, rhs: UncGas) -> Option<Self>

Checked integer subtraction. Computes self - rhs, returning None if overflow occurred.

§Examples
use unc_gas::UncGas;
assert_eq!(UncGas::from_gas(2).checked_sub(UncGas::from_gas(2)), Some(UncGas::from_gas(0)));
assert_eq!(UncGas::from_gas(2).checked_sub(UncGas::from_gas(3)), None);
Source

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

Checked integer multiplication. Computes self * rhs, returning None if overflow occurred.

§Examples
use unc_gas::UncGas;
use std::u64;
assert_eq!(UncGas::from_gas(2).checked_mul(2), Some(UncGas::from_gas(4)));
assert_eq!(UncGas::from_gas(u64::MAX).checked_mul(2), None)
Source

pub const fn checked_div(self, rhs: u64) -> Option<Self>

Checked integer division. Computes self / rhs, returning None if rhs == 0.

§Examples
use unc_gas::UncGas;
assert_eq!(UncGas::from_gas(10).checked_div(2), Some(UncGas::from_gas(5)));
assert_eq!(UncGas::from_gas(2).checked_div(0), None);
Source

pub const fn saturating_add(self, rhs: UncGas) -> UncGas

Saturating integer addition. Computes self + rhs, saturating at the numeric bounds instead of overflowing.

§Examples
use unc_gas::UncGas;
assert_eq!(UncGas::from_gas(5).saturating_add(UncGas::from_gas(5)), UncGas::from_gas(10));
assert_eq!(UncGas::from_gas(u64::MAX).saturating_add(UncGas::from_gas(1)), UncGas::from_gas(u64::MAX));
Source

pub const fn saturating_sub(self, rhs: UncGas) -> UncGas

Saturating integer subtraction. Computes self - rhs, saturating at the numeric bounds instead of overflowing.

§Examples
use unc_gas::UncGas;
assert_eq!(UncGas::from_gas(5).saturating_sub(UncGas::from_gas(2)), UncGas::from_gas(3));
assert_eq!(UncGas::from_gas(1).saturating_sub(UncGas::from_gas(2)), UncGas::from_gas(0));
Source

pub const fn saturating_mul(self, rhs: u64) -> UncGas

Saturating integer multiplication. Computes self * rhs, saturating at the numeric bounds instead of overflowing.

§Examples
use unc_gas::UncGas;
use std::u64;
assert_eq!(UncGas::from_gas(2).saturating_mul(5), UncGas::from_gas(10));
assert_eq!(UncGas::from_gas(u64::MAX).saturating_mul(2), UncGas::from_gas(u64::MAX));
Source

pub const fn saturating_div(self, rhs: u64) -> UncGas

Saturating integer division. Computes self / rhs, saturating at the numeric bounds instead of overflowing.

§Examples
use unc_gas::UncGas;
assert_eq!(UncGas::from_gas(10).saturating_div(2), UncGas::from_gas(5));
assert_eq!(UncGas::from_gas(10).saturating_div(0), UncGas::from_gas(0))

Trait Implementations§

Source§

impl Clone for UncGas

Source§

fn clone(&self) -> UncGas

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for UncGas

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for UncGas

Source§

fn default() -> UncGas

Returns the “default value” for a type. Read more
Source§

impl Display for UncGas

UncGas Display implementation rounds up the gas usage to the relevant precision point. There are 4 breakpoints:

  1. exactly 0 Tgas
  2. <0.001 Tgas
  3. 0.001 - 0.999 Tgas (uses 3 digits after the floating point)
  4. 1 Tgas (uses 1 digit after the floating point)

Source§

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

Formats the value using the given formatter. Read more
Source§

impl FromStr for UncGas

Source§

type Err = UncGasError

The associated error which can be returned from parsing.
Source§

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type. Read more
Source§

impl Hash for UncGas

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for UncGas

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

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

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for UncGas

Source§

fn eq(&self, other: &UncGas) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialOrd for UncGas

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

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

impl Copy for UncGas

Source§

impl Eq for UncGas

Source§

impl StructuralPartialEq for UncGas

Auto Trait Implementations§

§

impl Freeze for UncGas

§

impl RefUnwindSafe for UncGas

§

impl Send for UncGas

§

impl Sync for UncGas

§

impl Unpin for UncGas

§

impl UnwindSafe for UncGas

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.