Enum AccountsFile

pub enum AccountsFile {
    AppendVec(AppendVec),
    TieredStorage(TieredStorage),
}

An enum for accessing an accounts file which can be implemented under different formats.

Variants

AppendVec(AppendVec)

TieredStorage(TieredStorage)

Implementations

impl AccountsFile

pub fn new_from_file( path: impl Into<PathBuf>, current_len: usize, storage_access: StorageAccess, ) -> Result<(Self, usize)>

Create an AccountsFile instance from the specified path.

The second element of the returned tuple is the number of accounts in the accounts file.

pub fn flush(&self) -> Result<()>

pub fn reset(&self)

pub fn remaining_bytes(&self) -> u64

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn capacity(&self) -> u64

pub fn file_name(slot: Slot, id: AccountsFileId) -> String

pub fn get_stored_account_meta_callback<Ret>( &self, offset: usize, callback: impl for<'local> FnMut(StoredAccountMeta<'local>) -> Ret, ) -> Option<Ret>

calls callback with the account located at the specified index offset.

pub fn account_matches_owners( &self, offset: usize, owners: &[Pubkey], ) -> Result<usize, MatchAccountOwnerError>

pub fn path(&self) -> &Path

Return the path of the underlying account file.

pub fn scan_accounts( &self, callback: impl for<'local> FnMut(StoredAccountMeta<'local>), )

Iterate over all accounts and call callback with each account.

pub fn scan_pubkeys(&self, callback: impl FnMut(&Pubkey))

iterate over all pubkeys

pub fn append_accounts<'a>( &self, accounts: &impl StorableAccounts<'a>, skip: usize, ) -> Option<StoredAccountsInfo>

Copy each account metadata, account and hash to the internal buffer. If there is no room to write the first entry, None is returned. Otherwise, returns the starting offset of each account metadata. Plus, the final return value is the offset where the next entry would be appended. So, return.len() is 1 + (number of accounts written) After each account is appended, the internal current_len is updated and will be available to other threads.

pub fn internals_for_archive(&self) -> InternalsForArchive<'_>

Returns the way to access this accounts file when archiving

Trait Implementations

impl Debug for AccountsFile

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

Formats the value using the given formatter.