Struct StakeSubsidy

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

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 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 copy 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 From<StakeSubsidyV1> for StakeSubsidy

fn from(_: StakeSubsidyV1) -> Self

Converts to this type from the input type.

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 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 StructuralPartialEq for StakeSubsidy