Struct fuel_tx::TransactionFee

pub struct TransactionFee { /* private fields */ }

Implementations

impl TransactionFee

pub const fn new(bytes: Word, total: Word, min_gas: Word, max_gas: Word) -> Self

pub const fn min(&self) -> Word

Minimum fee value to pay for the metered bytes

pub const fn total(&self) -> Word

Maximum fee value composed of metered bytes cost + tx gas limit, with price factor correction

pub const fn min_gas(&self) -> Word

The minimum amount of gas (not fee!) used by this tx

pub const fn max_gas(&self) -> Word

The max amount of gas (not fee!) usable by this tx

pub const fn into_inner(self) -> (Word, Word)

Convert into a tuple containing the inner min & total fee values

pub fn checked_deduct_total(&self, balance: Word) -> Option<Word>

Attempt to subtract the maximum fee value from a given balance

Will return None if arithmetic overflow occurs.

pub fn checked_from_values(
    params: &ConsensusParameters,
    metered_bytes: Word,
    gas_limit: Word,
    gas_price: Word
) -> Option<Self>

Attempt to create a transaction fee from parameters and value arguments

Will return None if arithmetic overflow occurs.

pub fn gas_refund_value(
    params: &ConsensusParameters,
    gas: Word,
    price: Word
) -> Option<Word>

Attempt to calculate a gas as asset value, using the price factor defined in the consensus parameters.

Will return None if overflow occurs

pub fn checked_from_tx<T: Chargeable>(
    params: &ConsensusParameters,
    tx: &T
) -> Option<Self>

Attempt to create a transaction fee from parameters and transaction internals

Will return None if arithmetic overflow occurs.

Trait Implementations

impl Clone for TransactionFee

fn clone(&self) -> TransactionFee

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TransactionFee

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

Formats the value using the given formatter.

impl Default for TransactionFee

fn default() -> TransactionFee

Returns the “default value” for a type.

impl From<TransactionFee> for Word

fn from(fee: TransactionFee) -> Word

Converts to this type from the input type.

impl Hash for TransactionFee

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 TransactionFee

fn cmp(&self, other: &TransactionFee) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<TransactionFee> for TransactionFee

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

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

impl Eq for TransactionFee

impl StructuralEq for TransactionFee

impl StructuralPartialEq for TransactionFee