Struct StorageFund

#[non_exhaustive]
pub struct StorageFund {
    pub total_object_storage_rebates: Option<u64>,
    pub non_refundable_balance: Option<u64>,
}

Struct representing the onchain storage fund.

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.

total_object_storage_rebates: Option<u64>

This is the sum of storage_rebate of all objects currently stored on-chain. To maintain this invariant, the only inflow of this balance is storage charges collected from transactions, and the only outflow is storage rebates of transactions, including both the portion refunded to the transaction senders as well as the non-refundable portion taken out and put into non_refundable_balance.

non_refundable_balance: Option<u64>

Represents any remaining inflow of the storage fund that should not be taken out of the fund.

Implementations

impl StorageFund

pub const TOTAL_OBJECT_STORAGE_REBATES_FIELD: &'static MessageField

pub const NON_REFUNDABLE_BALANCE_FIELD: &'static MessageField

impl StorageFund

pub fn path_builder() -> StorageFundFieldPathBuilder

impl StorageFund

pub const fn const_default() -> Self

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

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

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

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

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

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

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

Sets total_object_storage_rebates with the provided value.

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

Sets total_object_storage_rebates with the provided value.

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

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

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

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

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

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

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

Sets non_refundable_balance with the provided value.

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

Sets non_refundable_balance with the provided value.

impl StorageFund

pub fn total_object_storage_rebates(&self) -> u64

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

pub fn non_refundable_balance(&self) -> u64

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

Trait Implementations

impl Clone for StorageFund

fn clone(&self) -> StorageFund

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StorageFund

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

Formats the value using the given formatter.

impl Default for StorageFund

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for StorageFund

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for StorageFund

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 StorageFund

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

impl PartialEq for StorageFund

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

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for StorageFund

impl StructuralPartialEq for StorageFund