Struct bdk_file_store::Store

source ·

pub struct Store<C>where
    C: Sync + Send,
{ /* private fields */ }

Expand description

Persists an append-only list of changesets (C) to a single file.

Implementations§

source §

impl<C> Store<C>
where C: Append + Serialize + DeserializeOwned + Send + Sync,

source

pub fn create_new(magic: &[u8], file_path: P) -> Result<Self, FileError>
where P: AsRef<Path>,

Create a new Store file in write-only mode; error if the file exists.

magic is the prefixed bytes to write to the new file. This will be checked when opening the Store in the future with open.

source

pub fn open(magic: &[u8], file_path: P) -> Result<Self, FileError>
where P: AsRef<Path>,

Open an existing Store.

Use create_new to create a new Store.

§Errors

If the prefixed bytes of the opened file does not match the provided magic, the FileError::InvalidMagicBytes error variant will be returned.

source

pub fn open_or_create_new( magic: &[u8], file_path: P ) -> Result<Self, FileError>
where P: AsRef<Path>,

Attempt to open existing Store file; create it if the file is non-existent.

Internally, this calls either open or create_new.

source

pub fn iter_changesets(&mut self) -> EntryIter<'_, C> ⓘ

Iterates over the stored changeset from first to last, changing the seek position at each iteration.

The iterator may fail to read an entry and therefore return an error. However, the first time it returns an error will be the last. After doing so, the iterator will always yield None.

WARNING: This method changes the write position in the underlying file. You should always iterate over all entries until None is returned if you want your next write to go at the end; otherwise, you will write over existing entries.

source

pub fn aggregate_changesets( &mut self ) -> Result<Option<C>, AggregateChangesetsError<C>>

Loads all the changesets that have been stored as one giant changeset.

This function returns the aggregate changeset, or None if nothing was persisted. If reading or deserializing any of the entries fails, an error is returned that consists of all those it was able to read.

You should usually check the error. In many applications, it may make sense to do a full wallet scan with a stop-gap after getting an error, since it is likely that one of the changesets was unable to read changes of the derivation indices of a keychain.

WARNING: This method changes the write position of the underlying file. The next changeset will be written over the erroring entry (or the end of the file if none existed).

source