Struct AppendVec

pub struct AppendVec { /* private fields */ }

A thread-safe, file-backed block of memory used to store Account instances. Append operations are serialized such that only one thread updates the internal append_lock at a time. No restrictions are placed on reading. That is, one may read items from one thread while another is appending new items.

Implementations

impl AppendVec

pub fn new(file: impl Into<PathBuf>, create: bool, size: usize) -> Self

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

pub fn reset(&self)

pub fn remaining_bytes(&self) -> u64

how many more bytes can be stored in this append vec

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn capacity(&self) -> u64

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

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

Creates an appendvec from file without performing sanitize checks or counting the number of accounts

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 stored account metadata for the account at offset if its data doesn’t overrun the internal buffer. Otherwise return None.

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

Return Ok(index_of_matching_owner) if the account owner at offset is one of the pubkeys in owners. Return Err(MatchAccountOwnerError::NoMatch) if the account has 0 lamports or the owner is not one of the pubkeys in owners. Return Err(MatchAccountOwnerError::UnableToLoad) if the offset value causes a data overrun.

pub fn path(&self) -> &Path

Returns the path to the file where the data is stored

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 and call callback. This iteration does not deserialize and populate each field in StoredAccountMeta. data is completely ignored, for example. Also, no references have to be maintained/returned from an iterator function. This fn can operate on a batch of data at once.

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.

Trait Implementations

impl Debug for AppendVec

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

Formats the value using the given formatter.

impl Drop for AppendVec

fn drop(&mut self)

Executes the destructor for this type.