Struct Rent

#[repr(C)]
pub struct Rent {
    pub lamports_per_byte_year: u64,
    pub exemption_threshold: f64,
    pub burn_percent: u8,
}

Fields

lamports_per_byte_year: u64

Rental rate

exemption_threshold: f64

exemption threshold, in years

burn_percent: u8

Implementations

impl Rent

pub fn calculate_burn(&self, rent_collected: u64) -> (u64, u64)

calculate how much rent to burn from the collected rent

pub fn minimum_balance(&self, data_len: usize) -> u64

minimum balance due for rent-exemption of a given size Account::data.len()

Note: a stripped-down version of this calculation is used in calculate_split_rent_exempt_reserve in the stake program. When this function is updated, – eg. when making rent variable – the stake program will need to be refactored

pub fn is_exempt(&self, balance: u64, data_len: usize) -> bool

whether a given balance and data_len would be exempt

pub fn due(&self, balance: u64, data_len: usize, years_elapsed: f64) -> RentDue

rent due on account’s data_len with balance

pub fn due_amount(&self, data_len: usize, years_elapsed: f64) -> u64

rent due for account that is known to be not exempt

pub fn free() -> Rent

pub fn with_slots_per_epoch(slots_per_epoch: u64) -> Rent

Trait Implementations

impl AbiExample for Rent

fn example() -> Rent

impl Clone for Rent

fn clone(&self) -> Rent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Rent

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

Formats the value using the given formatter.

impl Default for Rent

fn default() -> Rent

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Rent

fn deserialize<__D>( __deserializer: __D, ) -> Result<Rent, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Rent

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

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sysvar for Rent

fn get() -> Result<Rent, ProgramError>

fn size_of() -> usize

fn from_account_info( account_info: &AccountInfo<'_>, ) -> Result<Self, ProgramError>

Deserializes a sysvar from its AccountInfo.

fn to_account_info(&self, account_info: &mut AccountInfo<'_>) -> Option<()>

impl SysvarId for Rent

fn id() -> Pubkey

fn check_id(pubkey: &Pubkey) -> bool

impl Copy for Rent

impl StructuralPartialEq for Rent