Struct Gas

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

The Gas struct represents a U512 amount of gas.

Implementations

impl Gas

pub const MAX: Gas

The maximum value of Gas.

pub fn new<T: Into<U512>>(value: T) -> Self

Constructs a new Gas.

pub const fn zero() -> Self

Constructs a new Gas with value 0.

pub fn value(&self) -> U512

Returns the inner U512 value.

pub fn from_motes(motes: Motes, motes_per_unit_of_gas: u8) -> Option<Self>

Converts the given motes to Gas by dividing them by conv_rate.

Returns None if motes_per_unit_of_gas == 0.

pub fn from_price(base_amount: U512, gas_price: u8) -> Option<Self>

Converts the given U512 to Gas by dividing it by gas_price.

Returns None if gas_price == 0.

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

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

pub fn saturating_add(self, rhs: Self) -> Self

Saturating integer addition. Computes self + rhs, returning max if overflow occurred.

pub fn saturating_sub(self, rhs: Self) -> Self

Saturating integer subtraction. Computes self + rhs, returning min if overflow occurred.

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

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

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

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

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

Checked integer division. Computes self / rhs, returning None if overflow occurred.

pub fn random(rng: &mut TestRng) -> Self

Available on crate feature testing only.

Returns a random Gas.

Trait Implementations

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

const IS_DYNAMIC: bool = false

If true, the type has a heap size that can vary at runtime, depending on the actual value.

const STATIC_HEAP_SIZE: usize = 0usize

The amount of space a value of the type always occupies. If IS_DYNAMIC is false, this is the total amount of heap memory occupied by the value. Otherwise this is a lower bound.

fn estimate_heap_size(&self) -> usize

Estimates the size of heap memory taken up by this value.

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: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

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 From<u32> for Gas

fn from(gas: u32) -> Self

Converts to this type from the input type.

impl From<u64> for Gas

fn from(gas: u64) -> Self

Converts to this type from the input type.

impl FromBytes for Gas

fn from_bytes(bytes: &[u8]) -> Result<(Self, &[u8]), Error>

Deserializes the slice into Self.

fn from_vec(bytes: Vec<u8>) -> Result<(Self, Vec<u8>), Error>

Deserializes the Vec<u8> into Self.

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

fn schema_name() -> String

The name of the generated JSON Schema.

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

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

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

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

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

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

fn to_bytes(&self) -> Result<Vec<u8>, Error>

Serializes &self to a Vec<u8>.

fn serialized_length(&self) -> usize

Returns the length of the Vec<u8> which would be returned from a successful call to to_bytes() or into_bytes(). The data is not actually serialized, so this call is relatively cheap.

fn write_bytes(&self, writer: &mut Vec<u8>) -> Result<(), Error>

Writes &self into a mutable writer.

fn into_bytes(self) -> Result<Vec<u8>, Error>

where Self: Sized,

Consumes self and serializes to a Vec<u8>.

impl Copy for Gas

impl Eq for Gas

impl StructuralPartialEq for Gas