Struct bdk_file_store::EntryIter

impl<'t, T> EntryIter<'t, T>

pub fn new(start_pos: u64, db_file: &'t mut File) -> Self

Trait ImplementationsÂ§

impl<'t, T> Drop for EntryIter<'t, T>

fn drop(&mut self)

Executes the destructor for this type. Read more

impl<'t, T> Iterator for EntryIter<'t, T>where
T: DeserializeOwned,

type Item = Result<T, IterError>

The type of the elements being iterated over.

fn next(&mut self) -> Option<Self::Item>

Advances the iterator and returns the next value. Read more

fn next_chunk<const N: usize>(
&mut self
) -> Result<[Self::Item; N], IntoIter<Self::Item, N>>where
Self: Sized,

ð¬This is a nightly-only experimental API. (iter_next_chunk)

Advances the iterator and returns an array containing the next N values. Read more

1.0.0 Â· sourceÂ§

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the iterator. Read more

1.0.0 Â· sourceÂ§

fn count(self) -> usizewhere
Self: Sized,

Consumes the iterator, counting the number of iterations and returning it. Read more

1.0.0 Â· sourceÂ§

fn last(self) -> Option<Self::Item>where
Self: Sized,

Consumes the iterator, returning the last element. Read more

fn advance_by(&mut self, n: usize) -> Result<(), usize>

ð¬This is a nightly-only experimental API. (iter_advance_by)

Advances the iterator by n elements. Read more

1.0.0 Â· sourceÂ§

fn nth(&mut self, n: usize) -> Option<Self::Item>

Returns the nth element of the iterator. Read more

1.28.0 Â· sourceÂ§

fn step_by(self, step: usize) -> StepBy<Self>where
Self: Sized,

Creates an iterator starting at the same point, but stepping by +

ImplementationsÂ§

impl<'t, T> EntryIter<'t, T>

pub fn new(start_pos: u64, db_file: &'t mut File) -> Self

Trait ImplementationsÂ§

impl<'t, T> Drop for EntryIter<'t, T>

fn drop(&mut self)

Executes the destructor for this type. Read more

impl<'t, T> Iterator for EntryIter<'t, T>where
T: DeserializeOwned,

type Item = Result<T, IterError>

The type of the elements being iterated over.

fn next(&mut self) -> Option<Self::Item>

Advances the iterator and returns the next value. Read more

fn next_chunk<const N: usize>(
&mut self
) -> Result<[Self::Item; N], IntoIter<Self::Item, N>>where
Self: Sized,

ð¬This is a nightly-only experimental API. (iter_next_chunk)

Advances the iterator and returns an array containing the next N values. Read more

1.0.0 Â· sourceÂ§

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the iterator. Read more

1.0.0 Â· sourceÂ§

fn count(self) -> usizewhere
Self: Sized,

Consumes the iterator, counting the number of iterations and returning it. Read more

1.0.0 Â· sourceÂ§

fn last(self) -> Option<Self::Item>where
Self: Sized,

Consumes the iterator, returning the last element. Read more

fn advance_by(&mut self, n: usize) -> Result<(), usize>

ð¬This is a nightly-only experimental API. (iter_advance_by)

Advances the iterator by n elements. Read more

1.0.0 Â· sourceÂ§

fn nth(&mut self, n: usize) -> Option<Self::Item>

Returns the nth element of the iterator. Read more

1.28.0 Â· sourceÂ§

fn step_by(self, step: usize) -> StepBy<Self>where
Self: Sized,

Creates an iterator starting at the same point, but stepping by the given amount at each iteration. Read more

1.0.0 Â· sourceÂ§

fn chain(self, other: U) -> Chain<Self, ::IntoIter>where
Self: Sized,
U: IntoIterator<Item = Self::Item>,

Takes two iterators and creates a new iterator over both in sequence. Read more

1.0.0 Â· sourceÂ§

fn zip(self, other: U) -> Zip<Self, ::IntoIter>where
Self: Sized,
U: IntoIterator,

âZips upâ two iterators into a single iterator of pairs. Read more

fn intersperse_with<G>(self, separator: G) -> IntersperseWith<Self, G>where
Self: Sized,
G: FnMut() -> Self::Item,

ð¬This is a nightly-only experimental API. (iter_intersperse)

Creates a new iterator which places an item generated by separator between adjacent items of the original iterator. Read more

1.0.0 Â· sourceÂ§

fn map<B, F>(self, f: F) -> Map<Self, F>where
Self: Sized,
F: FnMut(Self::Item) -> B,

Takes a closure and creates an iterator which calls that closure on each element. Read more

1.21.0 Â· sourceÂ§

fn for_each<F>(self, f: F)where
Self: Sized,
F: FnMut(Self::Item),

Calls a closure on each element of an iterator. Read more

1.0.0 Â· sourceÂ§

fn filter(self, predicate: P) -> Filter<Self, P>where
Self: Sized,
P: FnMut(&Self::Item) -> bool,

Creates an iterator which uses a closure to determine if an element 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 5199b27a9e..74c349ce05 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,6 +1,6 @@ Store in bdk_file_store - Rust

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Â§

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

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.

+

ImplementationsÂ§

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

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.

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

Open an existing Store.

@@ -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Â§

impl<C: Debug> Debug for Store<C>

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

Formats the value using the given formatter. Read more

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.

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

Writes a changeset to the persistence backend. Read more

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

Return the aggregate changeset C from persistence.

Auto Trait ImplementationsÂ§

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

Blanket ImplementationsÂ§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable Â· sourceÂ§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

impl<T> From<T> for T

const: unstable Â· sourceÂ§

fn from(t: T) -> T

Returns the argument unchanged.

+

Trait ImplementationsÂ§

impl<C: Debug> Debug for Store<C>

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

Formats the value using the given formatter. Read more

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.

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

Writes a changeset to the persistence backend. Read more

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Â§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable Â· sourceÂ§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

impl<T> From<T> for T

const: unstable Â· sourceÂ§

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into 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.

-

impl<T, U> TryFrom 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>::Error>

Performs the conversion.

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable Â· sourceÂ§

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

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

fn vzip(self) -> V

\ No newline at end of file +

impl<T, U> TryFrom 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>::Error>

Performs the conversion.

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable Â· sourceÂ§

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

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