Struct NoteUpdates

pub struct NoteUpdates { /* private fields */ }

Contains note changes to apply to the store.

Implementations

impl NoteUpdates

pub fn new( updated_input_notes: impl IntoIterator<Item = InputNoteRecord>, updated_output_notes: impl IntoIterator<Item = OutputNoteRecord>, ) -> Self

Creates a NoteUpdates.

pub fn updated_input_notes(&self) -> impl Iterator<Item = &InputNoteRecord>

Returns all input note records that have been updated. This may include:

• New notes that have been created that should be inserted.
• Existing tracked notes that should be updated.

pub fn updated_output_notes(&self) -> impl Iterator<Item = &OutputNoteRecord>

Returns all output note records that have been updated. This may include:

• New notes that have been created that should be inserted.
• Existing tracked notes that should be updated.

pub fn is_empty(&self) -> bool

Returns whether no new note-related information has been retrieved.

pub fn committed_input_notes(&self) -> impl Iterator<Item = &InputNoteRecord>

Returns any note that has been committed into the chain in this update (either new or already locally tracked)

pub fn committed_note_ids(&self) -> BTreeSet<NoteId>

Returns the IDs of all notes that have been committed in this update. This includes both new notes and tracked expected notes that were committed in this update.

pub fn consumed_note_ids(&self) -> BTreeSet<NoteId>

Returns the IDs of all notes that have been consumed. This includes both notes that have been consumed locally or externally in this update.

Trait Implementations

impl Clone for NoteUpdates

fn clone(&self) -> NoteUpdates

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for NoteUpdates

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

Formats the value using the given formatter.

impl Default for NoteUpdates

fn default() -> NoteUpdates

Returns the “default value” for a type.