2aa08a5898
This is a more generic version of `keychain::persist::*` structures. Additional changes: * The `Append` trait has a new method `is_empty`. * Introduce `Store` structure for `bdk_file_store`.
74 lines
2.0 KiB
Rust
74 lines
2.0 KiB
Rust
#![doc = include_str!("../README.md")]
|
|
mod entry_iter;
|
|
mod keychain_store;
|
|
mod store;
|
|
use std::io;
|
|
|
|
use bdk_chain::{
|
|
keychain::{KeychainChangeSet, KeychainTracker, PersistBackend},
|
|
sparse_chain::ChainPosition,
|
|
};
|
|
use bincode::{DefaultOptions, Options};
|
|
pub use entry_iter::*;
|
|
pub use keychain_store::*;
|
|
pub use store::*;
|
|
|
|
pub(crate) fn bincode_options() -> impl bincode::Options {
|
|
DefaultOptions::new().with_varint_encoding()
|
|
}
|
|
|
|
/// Error that occurs due to problems encountered with the file.
|
|
#[derive(Debug)]
|
|
pub enum FileError<'a> {
|
|
/// IO error, this may mean that the file is too short.
|
|
Io(io::Error),
|
|
/// Magic bytes do not match what is expected.
|
|
InvalidMagicBytes { got: Vec<u8>, expected: &'a [u8] },
|
|
}
|
|
|
|
impl<'a> core::fmt::Display for FileError<'a> {
|
|
fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
|
|
match self {
|
|
Self::Io(e) => write!(f, "io error trying to read file: {}", e),
|
|
Self::InvalidMagicBytes { got, expected } => write!(
|
|
f,
|
|
"file has invalid magic bytes: expected={:?} got={:?}",
|
|
expected, got,
|
|
),
|
|
}
|
|
}
|
|
}
|
|
|
|
impl<'a> From<io::Error> for FileError<'a> {
|
|
fn from(value: io::Error) -> Self {
|
|
Self::Io(value)
|
|
}
|
|
}
|
|
|
|
impl<'a> std::error::Error for FileError<'a> {}
|
|
|
|
impl<K, P> PersistBackend<K, P> for KeychainStore<K, P>
|
|
where
|
|
K: Ord + Clone + core::fmt::Debug,
|
|
P: ChainPosition,
|
|
KeychainChangeSet<K, P>: serde::Serialize + serde::de::DeserializeOwned,
|
|
{
|
|
type WriteError = std::io::Error;
|
|
|
|
type LoadError = IterError;
|
|
|
|
fn append_changeset(
|
|
&mut self,
|
|
changeset: &KeychainChangeSet<K, P>,
|
|
) -> Result<(), Self::WriteError> {
|
|
KeychainStore::append_changeset(self, changeset)
|
|
}
|
|
|
|
fn load_into_keychain_tracker(
|
|
&mut self,
|
|
tracker: &mut KeychainTracker<K, P>,
|
|
) -> Result<(), Self::LoadError> {
|
|
KeychainStore::load_into_keychain_tracker(self, tracker)
|
|
}
|
|
}
|