Struct StakeSubsidy

#[non_exhaustive]
pub struct StakeSubsidy {
    pub balance: Option<u64>,
    pub distribution_counter: Option<u64>,
    pub current_distribution_amount: Option<u64>,
    pub stake_subsidy_period_length: Option<u64>,
    pub stake_subsidy_decrease_rate: Option<u32>,
    pub extra_fields: Option<MoveTable>,
}

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.

balance: Option<u64>

Balance of SUI set aside for stake subsidies that will be drawn down over time.

distribution_counter: Option<u64>

Count of the number of times stake subsidies have been distributed.

current_distribution_amount: Option<u64>

The amount of stake subsidy to be drawn down per distribution. This amount decays and decreases over time.

stake_subsidy_period_length: Option<u64>

Number of distributions to occur before the distribution amount decays.

stake_subsidy_decrease_rate: Option<u32>

The rate at which the distribution amount decays at the end of each period. Expressed in basis points.

extra_fields: Option<MoveTable>

Any extra fields that’s not defined statically.

Implementations

impl StakeSubsidy

pub const BALANCE_FIELD: &'static MessageField

pub const DISTRIBUTION_COUNTER_FIELD: &'static MessageField

pub const CURRENT_DISTRIBUTION_AMOUNT_FIELD: &'static MessageField

pub const STAKE_SUBSIDY_PERIOD_LENGTH_FIELD: &'static MessageField

pub const STAKE_SUBSIDY_DECREASE_RATE_FIELD: &'static MessageField

pub const EXTRA_FIELDS_FIELD: &'static MessageField

impl StakeSubsidy

pub fn path_builder() -> StakeSubsidyFieldPathBuilder

impl StakeSubsidy

pub const fn const_default() -> Self

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<T: Into<u64>>(&mut self, field: T)

Sets balance with the provided value.

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

Sets balance with the provided value.

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

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

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

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

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

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

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

Sets distribution_counter with the provided value.

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

Sets distribution_counter with the provided value.

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

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

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

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

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

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

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

Sets current_distribution_amount with the provided value.

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

Sets current_distribution_amount with the provided value.

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

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

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

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

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

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

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

Sets stake_subsidy_period_length with the provided value.

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

Sets stake_subsidy_period_length with the provided value.

pub fn stake_subsidy_decrease_rate_opt_mut(&mut self) -> Option<&mut u32>

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

pub fn stake_subsidy_decrease_rate_mut(&mut self) -> &mut u32

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

pub fn stake_subsidy_decrease_rate_opt(&self) -> Option<u32>

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

pub fn set_stake_subsidy_decrease_rate<T: Into<u32>>(&mut self, field: T)

Sets stake_subsidy_decrease_rate with the provided value.

pub fn with_stake_subsidy_decrease_rate<T: Into<u32>>(self, field: T) -> Self

Sets stake_subsidy_decrease_rate with the provided value.

pub fn extra_fields(&self) -> &MoveTable

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

pub fn extra_fields_opt_mut(&mut self) -> Option<&mut MoveTable>

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

pub fn extra_fields_mut(&mut self) -> &mut MoveTable

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

pub fn extra_fields_opt(&self) -> Option<&MoveTable>

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

pub fn set_extra_fields<T: Into<MoveTable>>(&mut self, field: T)

Sets extra_fields with the provided value.

pub fn with_extra_fields<T: Into<MoveTable>>(self, field: T) -> Self

Sets extra_fields with the provided value.

impl StakeSubsidy

pub fn balance(&self) -> u64

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

pub fn distribution_counter(&self) -> u64

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

pub fn current_distribution_amount(&self) -> u64

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

pub fn stake_subsidy_period_length(&self) -> u64

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

pub fn stake_subsidy_decrease_rate(&self) -> u32

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

Trait Implementations

impl Clone for StakeSubsidy

fn clone(&self) -> StakeSubsidy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StakeSubsidy

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

Formats the value using the given formatter.

impl Default for StakeSubsidy

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for StakeSubsidy

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for StakeSubsidy

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 StakeSubsidy

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

impl PartialEq for StakeSubsidy

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

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StakeSubsidy