Struct bdk_chain::Persist

source Â·

pub struct Persist<B, C> { /* private fields */ }

Expand description

Persist wraps a PersistBackend (B) to create a convenient staging area for changes (C) +Persist in bdk_chain - Rust

Struct bdk_chain::Persist

source Â·

pub struct Persist<B, C> { /* private fields */ }

Expand description

Persist wraps a PersistBackend (B) to create a convenient staging area for changes (C) before they are persisted.

Not all changes to the in-memory representation needs to be written to disk right away, so Persist::stage can be used to stage changes first and then Persist::commit can be used to write changes to disk.

-

ImplementationsÂ§

source Â§

impl<B, C> Persist<B, C>where
B: PersistBackend<C>,
C: Default + Append,

source

pub fn new(backend: B) -> Self

Create a new Persist from PersistBackend.

+

ImplementationsÂ§

source Â§

impl<B, C> Persist<B, C>where
B: PersistBackend<C>,
C: Default + Append,

source

pub fn new(backend: B) -> Self

Create a new Persist from PersistBackend.

source

pub fn stage(&mut self, changeset: C)

Stage a changeset to be committed later with commit.

source

pub fn staged(&self) -> &C

Get the changes that have not been committed yet.

source

pub fn commit(&mut self) -> Result<Option<C>, B::WriteError>

Commit the staged changes to the underlying persistence backend.

Changes that are committed (if any) are returned.

Error

Returns a backend-defined error if this fails.

+

source

pub fn stage_and_commit(
&mut self,
changeset: C
) -> Result<Option<C>, B::WriteError>

Stages a new changeset and commits it (along with any other previously staged changes) to +the persistence backend

+

Convience method for calling stage and then commit.

Trait ImplementationsÂ§

source Â§

impl<B: Debug, C: Debug> Debug for Persist<B, C>

source Â§

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

Formats the value using the given formatter. Read more

Auto Trait ImplementationsÂ§

Â§

impl<B, C> RefUnwindSafe for Persist<B, C>where
B: RefUnwindSafe,
C: RefUnwindSafe,

Â§

impl<B, C> UnwindSafe for Persist<B, C>where
B: UnwindSafe,
C: UnwindSafe,

Blanket ImplementationsÂ§

source Â§

impl<T> Any for Twhere
T: 'static + ?Sized,

source Â§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source Â§

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable Â· sourceÂ§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source Â§

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable Â· sourceÂ§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source Â§

impl<T> From<T> for T

const: unstable Â· sourceÂ§

fn from(t: T) -> T

Returns the argument unchanged.

source Â§

impl<T, U> Into<U> for Twhere
U: From<T>,

const: unstable Â· sourceÂ§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/trait.PersistBackend.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/trait.PersistBackend.html index 41b3d30991..de45f13cf6 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/trait.PersistBackend.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/trait.PersistBackend.html @@ -1,4 +1,4 @@ -PersistBackend in bdk_chain - Rust

Trait bdk_chain::PersistBackend

source Â·

pub trait PersistBackend<C> {
+PersistBackend in bdk_chain - Rust
PersistBackend
Required Associated Types
LoadError
WriteError
Required Methods
load_from_persistence
write_changes
Implementations on Foreign Types
()
Implementors
In bdk_chain
?
Trait bdk_chain::PersistBackend
source Â· 
pub trait PersistBackend<C> {
     type WriteError: Debug;
     type LoadError: Debug;
 
@@ -7,12 +7,12 @@
 }
Expand description
A persistence backend for Persist.
 C represents the changeset; a datatype that records changes made to in-memory data structures
 that are to be persisted, or retrieved from persistence.
-
Required Associated TypesÂ§
sourcetype WriteError: Debug
The error the backend returns when it fails to write.
-
sourcetype LoadError: Debug
The error the backend returns when it fails to load changesets C.
-
Required MethodsÂ§
sourcefn write_changes(&mut self, changeset: &C) -> Result<(), Self::WriteError>
Writes a changeset to the persistence backend.
+
Required Associated TypesÂ§
sourcetype WriteError: Debug
The error the backend returns when it fails to write.
+
sourcetype LoadError: Debug
The error the backend returns when it fails to load changesets C.
+
Required MethodsÂ§
sourcefn write_changes(&mut self, changeset: &C) -> Result<(), Self::WriteError>
Writes a changeset to the persistence backend.
 It is up to the backend what it does with this. It could store every changeset in a list or
 it inserts the actual changes into a more structured database. All it needs to guarantee is
 that load_from_persistence restores a keychain tracker to what it should be if all
 changesets had been applied sequentially.
-
sourcefn load_from_persistence(&mut self) -> Result<Option<C>, Self::LoadError>
Return the aggregate changeset C from persistence.
-
Implementations on Foreign TypesÂ§
sourceÂ§impl<C> PersistBackend<C> for ()
Â§type WriteError = Infallible
Â§type LoadError = Infallible
sourceÂ§fn write_changes(&mut self, _changeset: &C) -> Result<(), Self::WriteError>
sourceÂ§fn load_from_persistence(&mut self) -> Result<Option<C>, Self::LoadError>
ImplementorsÂ§

\ No newline at end of file
+

sourcefn load_from_persistence(&mut self) -> Result<Option<C>, Self::LoadError>

Return the aggregate changeset C from persistence.

`Implementations on Foreign TypesÂ§`

sourceÂ§impl<C> PersistBackend<C> for ()

Â§type WriteError = Infallible

Â§type LoadError = Infallible

sourceÂ§fn write_changes(&mut self, _changeset: &C) -> Result<(), Self::WriteError>

sourceÂ§fn load_from_persistence(&mut self) -> Result<Option<C>, Self::LoadError>

`ImplementorsÂ§`


\ No newline at end of file
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/struct.Store.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/struct.Store.html
index 8e31bade64..a3007a1eb8 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/struct.Store.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/struct.Store.html
@@ -1,14 +1,14 @@
-Store in bdk_file_store - Rust
Store
Methods
aggregate_changesets
append_changeset
create_new
iter_changesets
open
open_or_create_new
Trait Implementations
Debug
PersistBackend<C>
Auto Trait Implementations
RefUnwindSafe
Send
Sync
Unpin
UnwindSafe
Blanket Implementations
Any
Borrow<T>
BorrowMut<T>
From<T>
Into<U>
TryFrom<U>
TryInto<U>
VZip<V>
In bdk_file_store
?
Struct bdk_file_store::Store
source Â· 
pub struct Store<'a, C> { /* private fields */ }
Expand description
Persists an append-only list of changesets (C) to a single file.
+Store in bdk_file_store - Rust
Store
Methods
aggregate_changesets
append_changeset
create_new
iter_changesets
open
open_or_create_new
Trait Implementations
Debug
PersistBackend<C>
Auto Trait Implementations
RefUnwindSafe
Send
Sync
Unpin
UnwindSafe
Blanket Implementations
Any
Borrow<T>
BorrowMut<T>
From<T>
Into<U>
TryFrom<U>
TryInto<U>
VZip<V>
In bdk_file_store
?
Struct bdk_file_store::Store
source Â· 
pub struct Store<C> { /* private fields */ }
Expand description
Persists an append-only list of changesets (C) to a single file.
 The changesets are the results of altering a tracker implementation (T).
-
ImplementationsÂ§
sourceÂ§impl<'a, C> Store<'a, C>where
    C: Append + Serialize + DeserializeOwned,
sourcepub fn create_new<P>(
    magic: &'a [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.
+
ImplementationsÂ§
sourceÂ§impl<C> Store<C>where
    C: Append + Serialize + DeserializeOwned,
sourcepub fn create_new<P>(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.
-
sourcepub fn open<P>(magic: &'a [u8], file_path: P) -> Result<Self, FileError<'_>>where
    P: AsRef<Path>,
Open an existing Store.
+
sourcepub fn open<P>(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.
-
sourcepub fn open_or_create_new<P>(
    magic: &'a [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.
+
sourcepub fn open_or_create_new<P>(
    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.
 
sourcepub fn iter_changesets(&mut self) -> EntryIter<'_, C> â
Iterates over the stored changeset from first to last, changing the seek position at each
 iteration.
@@ -30,8 +30,8 @@ changeset will be written over the erroring entry (or the end of the file if non
 changeset.
 The truncation is to avoid the possibility of having a valid but inconsistent changeset
 directly after the appended changeset.
-
Trait ImplementationsÂ§
sourceÂ§impl<'a, C: Debug> Debug for Store<'a, C>
sourceÂ§fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
sourceÂ§impl<'a, C> PersistBackend<C> for Store<'a, C>where
    C: Append + Serialize + DeserializeOwned,
Â§type WriteError = Error
The error the backend returns when it fails to write.
Â§type LoadError = IterError
The error the backend returns when it fails to load changesets C.
sourceÂ§fn write_changes(&mut self, changeset: &C) -> Result<(), Self::WriteError>
Writes a changeset to the persistence backend. Read more
sourceÂ§fn load_from_persistence(&mut self) -> Result<Option<C>, Self::LoadError>
Return the aggregate changeset C from persistence.
Auto Trait ImplementationsÂ§
Â§impl<'a, C> RefUnwindSafe for Store<'a, C>where
    C: RefUnwindSafe,
Â§impl<'a, C> Send for Store<'a, C>where
    C: Send,
Â§impl<'a, C> Sync for Store<'a, C>where
    C: Sync,
Â§impl<'a, C> Unpin for Store<'a, C>where
    C: Unpin,
Â§impl<'a, C> UnwindSafe for Store<'a, C>where
    C: UnwindSafe,
Blanket ImplementationsÂ§
sourceÂ§impl<T> Any for Twhere
    T: 'static + ?Sized,
sourceÂ§fn type_id(&self) -> TypeId
Gets the TypeId of self. Read more
sourceÂ§impl<T> Borrow<T> for Twhere
    T: ?Sized,
const: unstable Â· sourceÂ§fn borrow(&self) -> &T
Immutably borrows from an owned value. Read more
sourceÂ§impl<T> BorrowMut<T> for Twhere
    T: ?Sized,
const: unstable Â· sourceÂ§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceÂ§impl<T> From<T> for T
const: unstable Â· sourceÂ§fn from(t: T) -> T
Returns the argument unchanged.
-
sourceÂ§impl<T, U> Into<U> for Twhere
    U: From<T>,
const: unstable Â· sourceÂ§fn into(self) -> U
Calls U::from(self).
+
Trait ImplementationsÂ§
sourceÂ§impl<C: Debug> Debug for Store<C>
sourceÂ§fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
sourceÂ§impl<C> PersistBackend<C> for Store<C>where
    C: Append + Serialize + DeserializeOwned,
Â§type WriteError = Error
The error the backend returns when it fails to write.
Â§type LoadError = IterError
The error the backend returns when it fails to load changesets C.
sourceÂ§fn write_changes(&mut self, changeset: &C) -> Result<(), Self::WriteError>
Writes a changeset to the persistence backend. Read more
sourceÂ§fn load_from_persistence(&mut self) -> Result<Option<C>, Self::LoadError>
Return the aggregate changeset C from persistence.
Auto Trait ImplementationsÂ§
Â§impl<C> RefUnwindSafe for Store<C>where
    C: RefUnwindSafe,
Â§impl<C> Send for Store<C>where
    C: Send,
Â§impl<C> Sync for Store<C>where
    C: Sync,
Â§impl<C> Unpin for Store<C>where
    C: Unpin,
Â§impl<C> UnwindSafe for Store<C>where
    C: UnwindSafe,
Blanket ImplementationsÂ§
sourceÂ§impl<T> Any for Twhere
    T: 'static + ?Sized,
sourceÂ§fn type_id(&self) -> TypeId
Gets the TypeId of self. Read more
sourceÂ§impl<T> Borrow<T> for Twhere
    T: ?Sized,
const: unstable Â· sourceÂ§fn borrow(&self) -> &T
Immutably borrows from an owned value. Read more
sourceÂ§impl<T> BorrowMut<T> for Twhere
    T: ?Sized,
const: unstable Â· sourceÂ§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceÂ§impl<T> From<T> for T
const: unstable Â· sourceÂ§fn from(t: T) -> T
Returns the argument unchanged.
+
sourceÂ§impl<T, U> Into<U> for Twhere
    U: From<T>,
const: unstable Â· sourceÂ§fn into(self) -> U
Calls U::from(self).
 That is, this conversion is whatever the implementation of
 From<T> for U chooses to do.
-
sourceÂ§impl<T, U> TryFrom<U> for Twhere
    U: Into<T>,
Â§type Error = Infallible
The type returned in the event of a conversion error.
const: unstable Â· sourceÂ§fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
Performs the conversion.
sourceÂ§impl<T, U> TryInto<U> for Twhere
    U: TryFrom<T>,
Â§type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
const: unstable Â· sourceÂ§fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
Performs the conversion.
Â§impl<V, T> VZip<V> for Twhere
    V: MultiLane<T>,
Â§fn vzip(self) -> V

\ No newline at end of file
+

sourceÂ§impl<T, U> TryFrom<U> for Twhere
    U: Into<T>,

Â§type Error = Infallible

The type returned in the event of a conversion error.

const: unstable Â· sourceÂ§fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

sourceÂ§impl<T, U> TryInto<U> for Twhere
    U: TryFrom<T>,

Â§type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable Â· sourceÂ§fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

Â§impl<V, T> VZip<V> for Twhere
    V: MultiLane<T>,

Â§fn vzip(self) -> V

Struct bdk_chain::Persist

Struct bdk_chain::Persist

ImplementationsÂ§

impl<B, C> Persist<B, C>where B: PersistBackend<C>, C: Default + Append,

pub fn new(backend: B) -> Self

ImplementationsÂ§

impl<B, C> Persist<B, C>where B: PersistBackend<C>, C: Default + Append,

pub fn new(backend: B) -> Self

pub fn stage(&mut self, changeset: C)

pub fn staged(&self) -> &C

pub fn commit(&mut self) -> Result<Option<C>, B::WriteError>

pub fn stage_and_commit( &mut self, changeset: C) -> Result<Option<C>, B::WriteError>

Trait ImplementationsÂ§

impl<B: Debug, C: Debug> Debug for Persist<B, C>

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

Auto Trait ImplementationsÂ§

impl<B, C> RefUnwindSafe for Persist<B, C>where B: RefUnwindSafe, C: RefUnwindSafe,

impl<B, C> Send for Persist<B, C>where B: Send, C: Send,

impl<B, C> Sync for Persist<B, C>where B: Sync, C: Sync,

impl<B, C> Unpin for Persist<B, C>where B: Unpin, C: Unpin,

impl<B, C> UnwindSafe for Persist<B, C>where B: UnwindSafe, C: UnwindSafe,

Blanket ImplementationsÂ§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

Trait bdk_chain::PersistBackend

Trait bdk_chain::PersistBackend

Required Associated TypesÂ§

type WriteError: Debug

type LoadError: Debug

Required MethodsÂ§

fn write_changes(&mut self, changeset: &C) -> Result<(), Self::WriteError>

Required Associated TypesÂ§

type WriteError: Debug

type LoadError: Debug

Required MethodsÂ§

fn write_changes(&mut self, changeset: &C) -> Result<(), Self::WriteError>

fn load_from_persistence(&mut self) -> Result<Option<C>, Self::LoadError>

Implementations on Foreign TypesÂ§

impl<C> PersistBackend<C> for ()

type WriteError = Infallible

type LoadError = Infallible

fn write_changes(&mut self, _changeset: &C) -> Result<(), Self::WriteError>

fn load_from_persistence(&mut self) -> Result<Option<C>, Self::LoadError>

ImplementorsÂ§

fn load_from_persistence(&mut self) -> Result<Option<C>, Self::LoadError>

Implementations on Foreign TypesÂ§

impl<C> PersistBackend<C> for ()

type WriteError = Infallible

type LoadError = Infallible

fn write_changes(&mut self, _changeset: &C) -> Result<(), Self::WriteError>

fn load_from_persistence(&mut self) -> Result<Option<C>, Self::LoadError>

ImplementorsÂ§

Struct bdk_file_store::Store

Struct bdk_file_store::Store

ImplementationsÂ§

impl<'a, C> Store<'a, C>where C: Append + Serialize + DeserializeOwned,

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

ImplementationsÂ§

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

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

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

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

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

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

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

Trait ImplementationsÂ§

impl<'a, C: Debug> Debug for Store<'a, C>

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

impl<'a, C> PersistBackend<C> for Store<'a, C>where C: Append + Serialize + DeserializeOwned,

type WriteError = Error

type LoadError = IterError

fn write_changes(&mut self, changeset: &C) -> Result<(), Self::WriteError>

impl<B, C> Persist<B, C>where
B: PersistBackend<C>,
C: Default + Append,

impl<B, C> Persist<B, C>where
B: PersistBackend<C>,
C: Default + Append,

pub fn stage_and_commit(
&mut self,
changeset: C
) -> Result<Option<C>, B::WriteError>

impl<B, C> RefUnwindSafe for Persist<B, C>where
B: RefUnwindSafe,
C: RefUnwindSafe,

impl<B, C> Send for Persist<B, C>where
B: Send,
C: Send,

impl<B, C> Sync for Persist<B, C>where
B: Sync,
C: Sync,

impl<B, C> Unpin for Persist<B, C>where
B: Unpin,
C: Unpin,

impl<B, C> UnwindSafe for Persist<B, C>where
B: UnwindSafe,
C: UnwindSafe,

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<T, U> Into<U> for Twhere
U: From<T>,

`Implementations on Foreign TypesÂ§`

`ImplementorsÂ§`

impl<'a, C> Store<'a, C>where
C: Append + Serialize + DeserializeOwned,

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

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

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

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

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

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

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

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

impl<'a, C> PersistBackend<C> for Store<'a, C>where
C: Append + Serialize + DeserializeOwned,

impl<'a, C> RefUnwindSafe for Store<'a, C>where
C: RefUnwindSafe,

impl<'a, C> Send for Store<'a, C>where
C: Send,

impl<'a, C> Sync for Store<'a, C>where
C: Sync,

impl<'a, C> Unpin for Store<'a, C>where
C: Unpin,

impl<'a, C> UnwindSafe for Store<'a, C>where
C: UnwindSafe,

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<C> PersistBackend<C> for Store<C>where
C: Append + Serialize + DeserializeOwned,