Struct Rent 

#[repr(C)]
pub struct Rent {
    pub lamports_per_byte: u64,
    pub exemption_threshold: [u8; 8],
    pub burn_percent: u8,
}

Configuration of network rent.

Fields

lamports_per_byte: u64

Rental rate in lamports/byte.

exemption_threshold: [u8; 8]

👎Deprecated since 4.1.0:

Use Rent::minimum_balance() directly

Formerly, the amount of time (in years) a balance must include rent for the account to be rent exempt. Now it’s just empty space.

burn_percent: u8

👎Deprecated since 4.1.0:

Rent no longer exists

Formerly, the percentage of collected rent that is burned.

Implementations

impl Rent

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

Calculates the minimum balance for rent exemption.

This method avoids floating-point operations when the exemption_threshold is the default value.

Arguments

• data_len - The number of bytes in the account

Returns

The minimum balance in lamports for rent exemption.

Panics

Panics if data_len exceeds the maximum permitted data length or if the lamports_per_byte is too large based on the exemption_threshold.

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

Calculates the minimum balance for rent exemption without performing any validation.

This method avoids floating-point operations when the exemption_threshold is the default value.

Important

The caller must ensure that data_len is within the permitted limit and the lamports_per_byte is within the permitted limit based on the exemption_threshold to avoid overflow.

Arguments

• data_len - The number of bytes in the account

Returns

The minimum balance in lamports for rent exemption.

pub fn try_minimum_balance(&self, data_len: usize) -> Option<u64>

Calculates the minimum balance for rent exemption.

This method avoids floating-point operations when the exemption_threshold is the default value.

Arguments

• data_len - The number of bytes in the account

Returns

• Some(u64) - The minimum balance in lamports for rent exemption, if all checks pass.
• None - If data_len exceeds the maximum permitted data length, or if the lamports_per_byte is too large based on the exemption_threshold, which would cause an overflow.

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

Whether a given balance and data length would be exempt.

pub fn free() -> Rent

Creates a Rent that charges no lamports.

This is used for testing.

pub fn with_lamports_per_byte(lamports_per_byte: u64) -> Rent

Creates a Rent with lamports per byte

Trait Implementations

impl Clone for Rent

fn clone(&self) -> Rent

Returns a duplicate 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 GetSysvar for Rent

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

Load the sysvar directly from the runtime.

impl PartialEq for Rent

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

Equality operator ==.

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

Inequality operator !=.

impl<'de, __WincodeConfig> SchemaRead<'de, __WincodeConfig> for Rent

where __WincodeConfig: Config,

const TYPE_META: TypeMeta

Metadata about the type’s serialization.

type Dst = Rent

fn read( reader: impl Reader<'de>, dst: &mut MaybeUninit<<Rent as SchemaRead<'de, __WincodeConfig>>::Dst>, ) -> Result<(), ReadError>

Read into dst from reader.

fn get(reader: impl Reader<'de>) -> Result<Self::Dst, ReadError>

Read Self::Dst from reader into a new Self::Dst.

impl<__WincodeConfig> SchemaWrite<__WincodeConfig> for Rent

where __WincodeConfig: Config,

const TYPE_META: TypeMeta

Metadata about the type’s serialization.

type Src = Rent

fn size_of( src: &<Rent as SchemaWrite<__WincodeConfig>>::Src, ) -> Result<usize, WriteError>

Get the serialized size of Self::Src.

fn write( writer: impl Writer, src: &<Rent as SchemaWrite<__WincodeConfig>>::Src, ) -> Result<(), WriteError>

Write Self::Src to writer.

impl StructuralPartialEq for Rent

impl SysvarId for Rent

fn id() -> Address

The Address of the sysvar.

fn check_id(address: &Address) -> bool

Returns true if the given address is the ID.

impl<__WincodeConfig> ZeroCopy<__WincodeConfig> for Rent

where __WincodeConfig: Config, u64: for<'_wincode_internal> ZeroCopy<__WincodeConfig>, [u8; 8]: for<'_wincode_internal> ZeroCopy<__WincodeConfig>, u8: for<'_wincode_internal> ZeroCopy<__WincodeConfig>, __WincodeAssert<solana_rent::::_#2::{impl#1}::{constant#1}>: for<'_wincode_internal> __WincodeIsTrue,

fn from_bytes<'de>(bytes: &'de [u8], config: C) -> Result<&'de Self, ReadError>

where Self: Sized + SchemaRead<'de, C, Dst = Self>,

Like crate::ZeroCopy::from_bytes, but allows the caller to provide a custom configuration.

fn from_bytes_mut<'de>( bytes: &'de mut [u8], config: C, ) -> Result<&'de mut Self, ReadError>

where Self: Sized + SchemaRead<'de, C, Dst = Self>,

Like crate::ZeroCopy::from_bytes_mut, but allows the caller to provide a custom configuration.