Struct Gas 

pub struct Gas(/* private fields */);

Wrapper type over near_gas::NearGas, which itself is a wrapper type over u64.

This wrapper exists to maintain JSON RPC compatibility. While NearGas serializes to a JSON string for precision, we need to continue serializing Gas values to JSON numbers for backward compatibility with existing clients.

Note: NearGas deserialization already handles both JSON numbers and JSON strings, so we don’t need to redefine deserialization behavior here.

Implementations

impl Gas

pub const MAX: Gas

Maximum value for Gas (u64::MAX)

pub const ZERO: Gas

Zero value for Gas

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

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

Examples

use near_primitives_core::gas::Gas;

let tera_gas = Gas::from_teragas(5);

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

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

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

Examples

use near_primitives_core::gas::Gas;
    
let giga_gas = Gas::from_gigagas(5);

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

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

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

Examples

use near_primitives_core::gas::Gas;

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

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

pub const fn as_gas(self) -> u64

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

Examples

use near_primitives_core::gas::Gas;

let gas = Gas::from_gas(12345);
assert_eq!(gas.as_gas(), 12345);

pub const fn as_gigagas(self) -> u64

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

Examples

use near_primitives_core::gas::Gas;

let gas = Gas::from_gigagas(1);
assert_eq!(gas.as_gigagas(), 1);

pub const fn as_teragas(self) -> u64

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

Examples

use near_primitives_core::gas::Gas;

let gas = Gas::from_gas(1 * 1_000_000_000_000);
assert_eq!(gas.as_teragas(), 1);

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

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

Examples

use near_primitives_core::gas::Gas;

assert_eq!(Gas::from_gas(u64::MAX -2).checked_add(Gas::from_gas(2)), Some(Gas::MAX));
assert_eq!(Gas::from_gas(u64::MAX -2).checked_add(Gas::from_gas(3)), None);

pub fn checked_add_result(self, rhs: Gas) -> Result<Self, IntegerOverflowError>

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

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

Examples

use near_primitives_core::gas::Gas;

assert_eq!(Gas::from_gas(2).checked_sub(Gas::from_gas(2)), Some(Gas::ZERO));
assert_eq!(Gas::from_gas(2).checked_sub(Gas::from_gas(3)), None);

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

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

Examples

use near_primitives_core::gas::Gas;

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

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

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

Examples

use near_primitives_core::gas::Gas;

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

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

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

Examples

use near_primitives_core::gas::Gas;
assert_eq!(Gas::from_gas(5).saturating_add(Gas::from_gas(5)), Gas::from_gas(10));
assert_eq!(Gas::MAX.saturating_add(Gas::from_gas(1)), Gas::MAX);

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

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

Examples

use near_primitives_core::gas::Gas;
assert_eq!(Gas::from_gas(5).saturating_sub(Gas::from_gas(2)), Gas::from_gas(3));
assert_eq!(Gas::from_gas(1).saturating_sub(Gas::from_gas(2)), Gas::ZERO);

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

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

Examples

use near_primitives_core::gas::Gas;
use std::u64;
assert_eq!(Gas::from_gas(2).saturating_mul(5), Gas::from_gas(10));
assert_eq!(Gas::MAX.saturating_mul(2), Gas::MAX);

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

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

Examples

use near_primitives_core::gas::Gas;
assert_eq!(Gas::from_gas(10).saturating_div(2), Gas::from_gas(5));
assert_eq!(Gas::from_gas(10).saturating_div(0), Gas::ZERO)

Trait Implementations

impl BorshDeserialize for Gas

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

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 BorshSerialize for Gas

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

impl Clone for Gas

fn clone(&self) -> Gas

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Gas

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

Formats the value using the given formatter.

impl DecType for Gas

fn serialize(&self) -> Option<String>

Formats number as a decimal string; passes None as is.

fn try_from_str(value: &str) -> Result<Self, ParseIntError>

Tries to parse decimal string as an integer.

fn from_u64(value: u64) -> Self

Constructs Self from a 64-bit unsigned integer.

fn try_from_unit() -> Result<Self, ParseUnitError>

Constructs Self from a null value. Returns error if this type does not accept null values.

impl Default for Gas

fn default() -> Gas

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Gas

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Gas

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

Formats the value using the given formatter.

impl FromStr for Gas

type Err = <NearGas as FromStr>::Err

The associated error which can be returned from parsing.

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

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

impl Hash for Gas

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 Gas

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

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

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

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 Gas

impl Eq for Gas

impl StructuralPartialEq for Gas