Struct polkavm_common::utils::Gas

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

A gas value used for gas metering.

Implementations

impl Gas

pub const MAX: Self = _

The maximum possible available gas.

pub const MIN: Self = _

The minimum possible available gas.

pub const fn new(gas: u64) -> Option<Self>

Constructs a new gas value. Alias for Gas::from_u64.

pub const fn from_u64(gas: u64) -> Option<Self>

Constructs a new gas value from an u64, checking whether it’s in range between Gas::MIN and Gas::MAX.

pub const fn from_i64(gas: i64) -> Option<Self>

Constructs a new gas value from an i64, checking whether it’s in range between Gas::MIN and Gas::MAX.

pub const fn get(self) -> u64

Gets the raw gas value.

pub const fn is_empty(self) -> bool

Checks whether there is no gas remaining.

Trait Implementations

impl Clone for Gas

fn clone(&self) -> Gas

Returns a copy 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 Display for Gas

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

Formats the value using the given formatter.

impl From<u32> for Gas

fn from(gas: u32) -> Self

Converts to this type from the input 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Gas

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

This method tests for self and other values to be equal, and is used by ==.

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

This method 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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<i64> for Gas

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(gas: i64) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u64> for Gas

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(gas: u64) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Gas

impl Eq for Gas

impl StructuralPartialEq for Gas