Struct Gas

pub struct Gas { /* private fields */ }

A wrapper struct for u64 that represents gas. And provides helpful methods to convert to and from tera-gas and giga-gas.

Implementations

impl NearGas

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

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

Examples

use near_gas::NearGas;

let tera_gas = NearGas::from_tgas(5);

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

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

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

Examples

use near_gas::NearGas;

let giga_gas = NearGas::from_ggas(5);

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

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

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

Examples

use near_gas::NearGas;

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

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

pub const fn as_gas(self) -> u64

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

Examples

use near_gas::NearGas;
let neargas = NearGas::from_gas(12345);
assert_eq!(neargas.as_gas(), 12345);

pub const fn as_ggas(self) -> u64

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

Examples

use near_gas::NearGas;
let neargas = NearGas::from_gas(1 * 1_000_000_000);
assert_eq!(neargas.as_ggas(), 1);

pub const fn as_tgas(self) -> u64

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

Examples

use near_gas::NearGas;
let neargas = NearGas::from_gas(1 * 1_000_000_000_000);
assert_eq!(neargas.as_tgas(), 1);

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

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

Examples

use near_gas::NearGas;
use std::u64;
assert_eq!(NearGas::from_gas(u64::MAX -2).checked_add(NearGas::from_gas(2)), Some(NearGas::from_gas(u64::MAX)));
assert_eq!(NearGas::from_gas(u64::MAX -2).checked_add(NearGas::from_gas(3)), None);

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

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

Examples

use near_gas::NearGas;
assert_eq!(NearGas::from_gas(2).checked_sub(NearGas::from_gas(2)), Some(NearGas::from_gas(0)));
assert_eq!(NearGas::from_gas(2).checked_sub(NearGas::from_gas(3)), None);

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

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

Examples

use near_gas::NearGas;
use std::u64;
assert_eq!(NearGas::from_gas(2).checked_mul(2), Some(NearGas::from_gas(4)));
assert_eq!(NearGas::from_gas(u64::MAX).checked_mul(2), None)

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

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

Examples

use near_gas::NearGas;
assert_eq!(NearGas::from_gas(10).checked_div(2), Some(NearGas::from_gas(5)));
assert_eq!(NearGas::from_gas(2).checked_div(0), None);

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

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

Examples

use near_gas::NearGas;
assert_eq!(NearGas::from_gas(5).saturating_add(NearGas::from_gas(5)), NearGas::from_gas(10));
assert_eq!(NearGas::from_gas(u64::MAX).saturating_add(NearGas::from_gas(1)), NearGas::from_gas(u64::MAX));

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

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

Examples

use near_gas::NearGas;
assert_eq!(NearGas::from_gas(5).saturating_sub(NearGas::from_gas(2)), NearGas::from_gas(3));
assert_eq!(NearGas::from_gas(1).saturating_sub(NearGas::from_gas(2)), NearGas::from_gas(0));

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

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

Examples

use near_gas::NearGas;
use std::u64;
assert_eq!(NearGas::from_gas(2).saturating_mul(5), NearGas::from_gas(10));
assert_eq!(NearGas::from_gas(u64::MAX).saturating_mul(2), NearGas::from_gas(u64::MAX));

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

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

Examples

use near_gas::NearGas;
assert_eq!(NearGas::from_gas(10).saturating_div(2), NearGas::from_gas(5));
assert_eq!(NearGas::from_gas(10).saturating_div(0), NearGas::from_gas(0))

Trait Implementations

impl BorshDeserialize for NearGas

fn deserialize_reader<__R>(reader: &mut __R) -> Result<NearGas, Error>

where __R: Read,

fn deserialize(buf: &mut &[u8]) -> Result<Self, Error>

Deserializes this instance from a given slice of bytes. Updates the buffer to point at the remaining bytes.

fn try_from_slice(v: &[u8]) -> Result<Self, Error>

Deserialize this instance from a slice of bytes.

fn try_from_reader<R>(reader: &mut R) -> Result<Self, Error>

where R: Read,

impl BorshSchema for NearGas

fn declaration() -> String

Get the name of the type without brackets.

fn add_definitions_recursively(definitions: &mut BTreeMap<String, Definition>)

Recursively, using DFS, add type definitions required for this type. Type definition partially explains how to serialize/deserialize a type.

impl BorshSerialize for NearGas

fn serialize<__W>(&self, writer: &mut __W) -> Result<(), Error>

where __W: Write,

impl Clone for NearGas

fn clone(&self) -> NearGas

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NearGas

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

Formats the value using the given formatter.

impl Default for NearGas

fn default() -> NearGas

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for NearGas

fn deserialize<D>( deserializer: D, ) -> Result<NearGas, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for NearGas

NearGas 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)

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

Formats the value using the given formatter.

impl FromStr for NearGas

type Err = NearGasError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<NearGas, <NearGas as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for NearGas

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

where __H: Hasher,

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 JsonSchema for NearGas

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

fn schema_name() -> String

The name of the generated JSON Schema.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

impl Ord for NearGas

fn cmp(&self, other: &NearGas) -> 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 NearGas

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

fn partial_cmp(&self, other: &NearGas) -> 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 NearGas

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for NearGas

impl Eq for NearGas

impl StructuralPartialEq for NearGas