Struct InMemory

pub struct InMemory { /* private fields */ }

Available on crate feature in-memory only.

In-memory store. Note that invoices stored in memory will not be recoverable on power loss. Burning bug mitigation will also be reset after application restart.

Implementations

impl InMemory

pub fn new() -> InMemory

Create a new in-memory store.

Trait Implementations

impl Default for InMemory

fn default() -> Self

Returns the “default value” for a type.

impl HeightStorage for InMemory

type Error = InMemoryStorageError

Error type for the storage layer.

fn upsert(&mut self, height: u64) -> Result<Option<u64>, Self::Error>

Updates the payment gateway’s block height, or inserts the height if there is nothing to update. Returns the old height if it existed.

fn get(&self) -> Result<Option<u64>, Self::Error>

Returns the block height of the payment gateway, if it exists.

impl InvoiceStorage for InMemory

type Error = InMemoryStorageError

Error type for the storage layer.

fn insert(&mut self, invoice: Invoice) -> Result<(), Self::Error>

Insert invoice into storage for tracking.

fn remove( &mut self, invoice_id: InvoiceId, ) -> Result<Option<Invoice>, Self::Error>

Remove invoice from storage, returning the invoice if it existed.

fn update(&mut self, invoice: Invoice) -> Result<Option<Invoice>, Self::Error>

Update existing invoice in storage, returning old value if it existed. If the invoice does not already exist, does nothing.

fn get(&self, invoice_id: InvoiceId) -> Result<Option<Invoice>, Self::Error>

Retrieve invoice from storage, returning None if it does not exist.

fn get_ids(&self) -> Result<Vec<InvoiceId>, Self::Error>

Retrieve all currently-tracked invoice ids from storage.

fn contains_sub_index(&self, sub_index: SubIndex) -> Result<bool, Self::Error>

Returns whether an invoice for the given subaddress exists in storage.

fn try_for_each<F>(&self, f: F) -> Result<(), Self::Error>

where F: FnMut(Result<Invoice, Self::Error>) -> Result<(), Self::Error>,

Iterates over all invoices in storage, executing the supplied closure on each.

fn is_empty(&self) -> Result<bool, Self::Error>

Returns true if there are no invoices in storage.

fn lowest_height(&self) -> Result<Option<u64>, Self::Error>

Find lowest current height of an invoice in storage.

impl OutputKeyStorage for InMemory

type Error = InMemoryStorageError

Error type for the storage layer.

fn insert( &mut self, key: OutputPubKey, output_id: OutputId, ) -> Result<(), Self::Error>

Insert an output’s public key into storage.

fn get(&self, key: OutputPubKey) -> Result<Option<OutputId>, Self::Error>

Returns the output ID associated with the given key, if it exists.

impl Storage for InMemory

type Error = InMemoryStorageError

Error type for the storage layer.

fn flush(&self) -> Result<(), <Self as Storage>::Error>

Flush all changes to disk. This method should be manually implemented for any storage layer that does not automatically flush on write. The default implementation does nothing.