Struct Gas 

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

Gas units for NEAR transactions.

Creating Gas Amounts

Use the typed constructors for compile-time safety:

use near_kit::Gas;

// Preferred: short aliases (const, zero-cost)
let default_gas = Gas::tgas(30);
let more_gas = Gas::tgas(100);

// Common constants
let default = Gas::DEFAULT;  // 30 Tgas
let max = Gas::MAX;          // 1 Pgas (1000 Tgas)

Parsing from Strings

String parsing is available for runtime input:

• "30 Tgas" or "30 tgas" - teragas (10^12)
• "5 Ggas" or "5 ggas" - gigagas (10^9)
• "1000000 gas" - raw gas units

use near_kit::Gas;

// For runtime/user input only
let gas: Gas = "30 Tgas".parse().unwrap();
assert_eq!(gas.as_gas(), 30_000_000_000_000);

Implementations

impl Gas

pub const ZERO: Self

Zero gas.

pub const ONE_GGAS: Self

One gigagas (10^9).

pub const ONE_TGAS: Self

One teragas (10^12).

pub const ONE_PGAS: Self

One petagas (10^15).

pub const DEFAULT: Self

Default gas for function calls (30 Tgas).

pub const MAX: Self

Maximum gas per transaction (1 Pgas / 1000 Tgas).

pub const fn tgas(tgas: u64) -> Self

Create from teragas (short alias for from_tgas).

Example

use near_kit::Gas;

let gas = Gas::tgas(30);
assert_eq!(gas, Gas::DEFAULT);

pub const fn ggas(ggas: u64) -> Self

Create from gigagas (short alias for from_ggas).

Example

use near_kit::Gas;

let gas = Gas::ggas(5);
assert_eq!(gas.as_ggas(), 5);

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

Create from raw gas units.

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

Create from gigagas (10^9).

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

Create from teragas (10^12).

pub const fn as_gas(&self) -> u64

Get raw gas value.

pub const fn as_tgas(&self) -> u64

Get value in teragas (truncated).

pub const fn as_ggas(&self) -> u64

Get value in gigagas (truncated).

pub fn checked_add(self, other: Self) -> Option<Self>

Checked addition.

pub fn checked_sub(self, other: Self) -> Option<Self>

Checked subtraction.

pub const fn is_zero(&self) -> bool

Check if zero.

Trait Implementations

impl Add for Gas

type Output = Gas

The resulting type after applying the + operator.

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

Performs the + operation.

impl BorshDeserialize for Gas

fn deserialize_reader<R: Read>(reader: &mut R) -> Result<Self>

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

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

fn default() -> Gas

Returns the “default value” for a type.

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

fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for Gas

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

Formats the value using the given formatter.

impl FromStr for Gas

type Err = ParseGasError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::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 IntoGas for Gas

fn into_gas(self) -> Result<Gas, ParseGasError>

Convert into Gas.

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: Serializer>(&self, s: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl Sub for Gas

type Output = Gas

The resulting type after applying the - operator.

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

Performs the - operation.

impl TryFrom<&str> for Gas

type Error = ParseGasError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for Gas

impl Eq for Gas

impl StructuralPartialEq for Gas