Struct GasCostSummary

#[non_exhaustive]
pub struct GasCostSummary {
    pub computation_cost: Option<u64>,
    pub storage_cost: Option<u64>,
    pub storage_rebate: Option<u64>,
    pub non_refundable_storage_fee: Option<u64>,
}

Summary of gas charges.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

computation_cost: Option<u64>

Cost of computation/execution.

storage_cost: Option<u64>

Storage cost, it’s the sum of all storage cost for all objects created or mutated.

storage_rebate: Option<u64>

The amount of storage cost refunded to the user for all objects deleted or mutated in the transaction.

non_refundable_storage_fee: Option<u64>

The fee for the rebate. The portion of the storage rebate kept by the system.

Implementations

impl GasCostSummary

pub const COMPUTATION_COST_FIELD: &'static MessageField

pub const STORAGE_COST_FIELD: &'static MessageField

pub const STORAGE_REBATE_FIELD: &'static MessageField

pub const NON_REFUNDABLE_STORAGE_FEE_FIELD: &'static MessageField

impl GasCostSummary

pub fn path_builder() -> GasCostSummaryFieldPathBuilder

impl GasCostSummary

pub const fn const_default() -> Self

pub fn computation_cost_opt_mut(&mut self) -> Option<&mut u64>

If computation_cost is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn computation_cost_mut(&mut self) -> &mut u64

Returns a mutable reference to computation_cost. If the field is unset, it is first initialized with the default value.

pub fn computation_cost_opt(&self) -> Option<u64>

If computation_cost is set, returns Some with the value; otherwise returns None.

pub fn set_computation_cost<T: Into<u64>>(&mut self, field: T)

Sets computation_cost with the provided value.

pub fn with_computation_cost<T: Into<u64>>(self, field: T) -> Self

Sets computation_cost with the provided value.

pub fn storage_cost_opt_mut(&mut self) -> Option<&mut u64>

If storage_cost is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn storage_cost_mut(&mut self) -> &mut u64

Returns a mutable reference to storage_cost. If the field is unset, it is first initialized with the default value.

pub fn storage_cost_opt(&self) -> Option<u64>

If storage_cost is set, returns Some with the value; otherwise returns None.

pub fn set_storage_cost<T: Into<u64>>(&mut self, field: T)

Sets storage_cost with the provided value.

pub fn with_storage_cost<T: Into<u64>>(self, field: T) -> Self

Sets storage_cost with the provided value.

pub fn storage_rebate_opt_mut(&mut self) -> Option<&mut u64>

If storage_rebate is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn storage_rebate_mut(&mut self) -> &mut u64

Returns a mutable reference to storage_rebate. If the field is unset, it is first initialized with the default value.

pub fn storage_rebate_opt(&self) -> Option<u64>

If storage_rebate is set, returns Some with the value; otherwise returns None.

pub fn set_storage_rebate<T: Into<u64>>(&mut self, field: T)

Sets storage_rebate with the provided value.

pub fn with_storage_rebate<T: Into<u64>>(self, field: T) -> Self

Sets storage_rebate with the provided value.

pub fn non_refundable_storage_fee_opt_mut(&mut self) -> Option<&mut u64>

If non_refundable_storage_fee is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn non_refundable_storage_fee_mut(&mut self) -> &mut u64

Returns a mutable reference to non_refundable_storage_fee. If the field is unset, it is first initialized with the default value.

pub fn non_refundable_storage_fee_opt(&self) -> Option<u64>

If non_refundable_storage_fee is set, returns Some with the value; otherwise returns None.

pub fn set_non_refundable_storage_fee<T: Into<u64>>(&mut self, field: T)

Sets non_refundable_storage_fee with the provided value.

pub fn with_non_refundable_storage_fee<T: Into<u64>>(self, field: T) -> Self

Sets non_refundable_storage_fee with the provided value.

impl GasCostSummary

pub fn computation_cost(&self) -> u64

Returns the value of computation_cost, or the default value if computation_cost is unset.

pub fn storage_cost(&self) -> u64

Returns the value of storage_cost, or the default value if storage_cost is unset.

pub fn storage_rebate(&self) -> u64

Returns the value of storage_rebate, or the default value if storage_rebate is unset.

pub fn non_refundable_storage_fee(&self) -> u64

Returns the value of non_refundable_storage_fee, or the default value if non_refundable_storage_fee is unset.

Trait Implementations

impl Clone for GasCostSummary

fn clone(&self) -> GasCostSummary

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GasCostSummary

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

Formats the value using the given formatter.

impl Default for GasCostSummary

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GasCostSummary

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<GasCostSummary> for GasCostSummary

fn from(_: GasCostSummary) -> Self

Converts to this type from the input type.

impl Message for GasCostSummary

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl MessageFields for GasCostSummary

const FIELDS: &'static [&'static MessageField]

impl PartialEq for GasCostSummary

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

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&GasCostSummary> for GasCostSummary

type Error = TryFromProtoError

The type returned in the event of a conversion error.

fn try_from(_: &GasCostSummary) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for GasCostSummary

impl StructuralPartialEq for GasCostSummary