AccountRentState

Struct AccountRentState 

Source
pub struct AccountRentState {
    pub num_bytes: u64,
    pub current_slot: u64,
    pub current_lamports: u64,
    pub last_claimed_slot: u64,
}
Expand description

Account state information needed for rent calculations

Fields§

§num_bytes: u64

Size of the account in bytes

§current_slot: u64

Current blockchain slot

§current_lamports: u64

Current account balance in lamports

§last_claimed_slot: u64

Slot when rent was last claimed

Implementations§

Source§

impl AccountRentState

Source

pub fn get_completed_epochs(&self) -> u64

The number of complete epochs that have passed since rent was last claimed.

Source

pub fn is_compressible( &self, config: &impl RentConfigTrait, rent_exemption_lamports: u64, ) -> Option<u64>

Check if the account is compressible based on its rent status. An account becomes compressible when it lacks sufficient rent for the current epoch + 1.

§Returns
  • Some(deficit): The account is compressible, returns the deficit amount including compression costs
  • None: The account is not compressible
Source

pub fn calculate_claimable_rent( &self, config: &impl RentConfigTrait, rent_exemption_lamports: u64, ) -> Option<u64>

Calculate rent that can be claimed for completed epochs.

Rent can only be claimed for fully completed epochs, not the current ongoing epoch. If the account is compressible, returns None (should compress instead of claim).

§Returns
  • Some(amount): Claimable rent for completed epochs
  • None: Account is compressible and should be compressed instead
Source

pub fn calculate_close_distribution( &self, config: &impl RentConfigTrait, rent_exemption_lamports: u64, ) -> CloseDistribution

Calculate how lamports are distributed when closing an account.

When a compressible account is closed:

  • Completed epoch rent goes to the rent sponsor
  • Partial epoch rent (unutilized) is returned to the user
§Returns

A CloseDistribution specifying how lamports are split

Source

pub fn epochs_funded_ahead( &self, config: &impl RentConfigTrait, rent_exemption_lamports: u64, ) -> u64

Calculate how many epochs AFTER the current epoch are funded.

§Parameters
  • config: Rent configuration (provides compression_cost and rent curve)
  • rent_exemption_lamports: Solana’s required minimum balance
§Returns

Number of epochs funded beyond the current epoch (0 if none)

Trait Implementations§

Source§

impl Clone for AccountRentState

Source§

fn clone(&self) -> AccountRentState

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AccountRentState

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Copy for AccountRentState

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.