Struct spl_stake_pool::state::Fee

#[repr(C)]
pub struct Fee {
    pub denominator: u64,
    pub numerator: u64,
}

Fee rate as a ratio, minted on UpdateStakePoolBalance as a proportion of the rewards If either the numerator or the denominator is 0, the fee is considered to be 0

Fields

denominator: u64

denominator of the fee ratio

numerator: u64

numerator of the fee ratio

Implementations

impl Fee

pub fn apply(&self, amt: u64) -> Option<u128>

Applies the Fee’s rates to a given amount, amt returning the amount to be subtracted from it as fees (0 if denominator is 0 or amt is 0), or None if overflow occurs

pub fn check_withdrawal( &self, old_withdrawal_fee: &Fee ) -> Result<(), StakePoolError>

Withdrawal fees have some additional restrictions, this fn checks if those are met, returning an error if not. Does nothing and returns Ok if fee type is not withdrawal

Trait Implementations

impl BorshDeserialize for Fee

where u64: BorshDeserialize,

fn deserialize_reader<R: Read>(reader: &mut R) -> Result<Self, Error>

fn deserialize(buf: &mut &[u8]) -> Result<Self, Error>

Deserializes this instance from a given slice of bytes. Updates the buffer to point at the remaining bytes.

fn try_from_slice(v: &[u8]) -> Result<Self, Error>

Deserialize this instance from a slice of bytes.

fn try_from_reader<R>(reader: &mut R) -> Result<Self, Error>

where R: Read,

impl BorshSchema for Fee

where u64: BorshSchema,

fn declaration() -> Declaration

Get the name of the type without brackets.

fn add_definitions_recursively( definitions: &mut HashMap<Declaration, Definition> )

Recursively, using DFS, add type definitions required for this type. For primitive types this is an empty map. Type definition explains how to serialize/deserialize a type.

fn add_definition( declaration: String, definition: Definition, definitions: &mut HashMap<String, Definition> )

Helper method to add a single type definition to the map.

fn schema_container() -> BorshSchemaContainer

impl BorshSerialize for Fee

where u64: BorshSerialize,

fn serialize<W: Write>(&self, writer: &mut W) -> Result<(), Error>

fn try_to_vec(&self) -> Result<Vec<u8>, Error>

Serialize this instance into a vector of bytes.

impl Clone for Fee

fn clone(&self) -> Fee

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Fee

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

Formats the value using the given formatter.

impl Default for Fee

fn default() -> Fee

Returns the “default value” for a type.

impl Display for Fee

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

Formats the value using the given formatter.

impl PartialEq for Fee

fn eq(&self, other: &Fee) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Fee

impl StructuralPartialEq for Fee