Struct GasPayment

#[non_exhaustive]
pub struct GasPayment {
    pub objects: Vec<ObjectReference>,
    pub owner: Option<String>,
    pub price: Option<u64>,
    pub budget: Option<u64>,
}

Payment information for executing a transaction.

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.

objects: Vec<ObjectReference>

Set of gas objects to use for payment.

owner: Option<String>

Owner of the gas objects, either the transaction sender or a sponsor.

price: Option<u64>

Gas unit price to use when charging for computation.

Must be greater than or equal to the network’s current RGP (reference gas price).

budget: Option<u64>

Total budget willing to spend for the execution of a transaction.

Implementations

impl GasPayment

pub const OBJECTS_FIELD: &'static MessageField

pub const OWNER_FIELD: &'static MessageField

pub const PRICE_FIELD: &'static MessageField

pub const BUDGET_FIELD: &'static MessageField

impl GasPayment

pub fn path_builder() -> GasPaymentFieldPathBuilder

impl GasPayment

pub const fn const_default() -> Self

pub fn objects(&self) -> &[ObjectReference]

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

pub fn objects_mut(&mut self) -> &mut Vec<ObjectReference>

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

pub fn set_objects(&mut self, field: Vec<ObjectReference>)

Sets objects with the provided value.

pub fn with_objects(self, field: Vec<ObjectReference>) -> Self

Sets objects with the provided value.

pub fn owner_opt_mut(&mut self) -> Option<&mut String>

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

pub fn owner_mut(&mut self) -> &mut String

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

pub fn owner_opt(&self) -> Option<&str>

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

pub fn set_owner<T: Into<String>>(&mut self, field: T)

Sets owner with the provided value.

pub fn with_owner<T: Into<String>>(self, field: T) -> Self

Sets owner with the provided value.

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

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

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

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

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

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

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

Sets price with the provided value.

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

Sets price with the provided value.

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

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

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

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

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

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

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

Sets budget with the provided value.

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

Sets budget with the provided value.

impl GasPayment

pub fn owner(&self) -> &str

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

pub fn price(&self) -> u64

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

pub fn budget(&self) -> u64

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

Trait Implementations

impl Clone for GasPayment

fn clone(&self) -> GasPayment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GasPayment

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

Formats the value using the given formatter.

impl Default for GasPayment

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GasPayment

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<GasPayment> for GasPayment

fn from(value: GasPayment) -> Self

Converts to this type from the input type.

impl Message for GasPayment

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 GasPayment

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

impl PartialEq for GasPayment

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

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&GasPayment> for GasPayment

type Error = TryFromProtoError

The type returned in the event of a conversion error.

fn try_from(value: &GasPayment) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for GasPayment