Struct StakeHistory 

pub struct StakeHistory(pub Arc<RwLock<VecDeque<StakeCacheData>>>);

A history of frozen stake cache snapshots across epochs.

This wraps VecDeque<StakeCacheData> in Arc<RwLock<...>> to allow thread-safe shared access. The Arc allows the same history to be shared between the Bank and StakesHandle.

This maintains a queue of stake snapshots, with the oldest at the front and the most recent at the back. The ValidatorRegistry builtin pushes new snapshots, and the Bank pops completed epochs after reward distribution.

Tuple Fields

0: Arc<RwLock<VecDeque<StakeCacheData>>>

Implementations

impl StakeHistory

pub fn new() -> Self

Create a new empty stake history.

pub fn with_entry(data: StakeCacheData) -> Self

Create a stake history with an initial entry.

pub fn from_arc(arc: Arc<RwLock<VecDeque<StakeCacheData>>>) -> Self

Create a stake history from an existing Arc (for sharing references).

pub fn arc_clone(&self) -> Arc<RwLock<VecDeque<StakeCacheData>>>

Get a clone of the inner Arc for sharing.

pub fn push_back(&self, data: StakeCacheData)

Push a new snapshot to the back of the history.

pub fn pop_front(&self) -> Option<StakeCacheData>

Pop the oldest snapshot from the front of the history.

pub fn len(&self) -> usize

Get the number of snapshots in the history.

pub fn is_empty(&self) -> bool

Check if the history is empty.

pub fn front(&self) -> Option<StakeCacheData>

Get a clone of the oldest snapshot (front).

pub fn back(&self) -> Option<StakeCacheData>

Get a clone of the newest snapshot (back).

This returns the CURRENT epoch’s frozen stake data. In normal operation, this is never None because Bank initialization guarantees at least one entry exists after genesis/register_validators.

Use this for lookups that need the current epoch’s effective stake state (as opposed to StakesHandle::pending which is the next epoch being accumulated).

pub fn iter_cloned(&self) -> Vec<StakeCacheData>

Iterate over all snapshots from oldest to newest, returning cloned data.

Note: This clones all entries. For large histories, consider accessing specific entries via front() or back() instead.

Trait Implementations

impl Clone for StakeHistory

fn clone(&self) -> StakeHistory

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StakeHistory

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

Formats the value using the given formatter.

impl Default for StakeHistory

fn default() -> Self

Returns the “default value” for a type.