Struct Balance 

#[non_exhaustive]
pub struct Balance {
    pub coin_type: Option<String>,
    pub balance: Option<u64>,
    pub address_balance: Option<u64>,
    pub coin_balance: Option<u64>,
}

Balance information for a specific coin type.

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.

coin_type: Option<String>

The type of the coin (e.g., 0x2::sui::SUI).

balance: Option<u64>

The total balance of coin_type in its smallest unit. This is the sum of all spendable amounts of coin_type (address_balance and coin_balance).

address_balance: Option<u64>

The balance of Balance<T> in this address’s Address Balance.

coin_balance: Option<u64>

The balance of all Coin<T> objects owned by this address.

Implementations

impl Balance

pub const COIN_TYPE_FIELD: &'static MessageField

pub const BALANCE_FIELD: &'static MessageField

pub const ADDRESS_BALANCE_FIELD: &'static MessageField

pub const COIN_BALANCE_FIELD: &'static MessageField

impl Balance

pub fn path_builder() -> BalanceFieldPathBuilder

impl Balance

pub const fn const_default() -> Self

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

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

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

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

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

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

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

Sets coin_type with the provided value.

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

Sets coin_type with the provided value.

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

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

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

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

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

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

pub fn set_balance(&mut self, field: u64)

Sets balance with the provided value.

pub fn with_balance(self, field: u64) -> Self

Sets balance with the provided value.

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

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

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

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

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

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

pub fn set_address_balance(&mut self, field: u64)

Sets address_balance with the provided value.

pub fn with_address_balance(self, field: u64) -> Self

Sets address_balance with the provided value.

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

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

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

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

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

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

pub fn set_coin_balance(&mut self, field: u64)

Sets coin_balance with the provided value.

pub fn with_coin_balance(self, field: u64) -> Self

Sets coin_balance with the provided value.

impl Balance

pub fn coin_type(&self) -> &str

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

pub fn balance(&self) -> u64

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

pub fn address_balance(&self) -> u64

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

pub fn coin_balance(&self) -> u64

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

Trait Implementations

impl Clone for Balance

fn clone(&self) -> Balance

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Balance

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

Formats the value using the given formatter.

impl Default for Balance

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Balance

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Balance

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 Message for Balance

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 Balance

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

impl PartialEq for Balance

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

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Balance

impl StructuralPartialEq for Balance