Struct lumina_node::store::RedbStore

pub struct RedbStore { /* private fields */ }

A Store implementation based on a redb database.

Implementations

impl RedbStore

pub async fn open(path: impl AsRef<Path>) -> Result<Self, StoreError>

Open a persistent redb store.

pub async fn in_memory() -> Result<Self, StoreError>

Open an in memory redb store.

pub async fn new(db: Arc<Database>) -> Result<Self, StoreError>

Create new RedbStore with an already opened redb::Database.

pub fn raw_db(&self) -> Arc<Database>

Returns the raw redb::Database.

This is useful if you want to pass the database handle to any other stores (e.g. blockstore).

Trait Implementations

impl Debug for RedbStore

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

Formats the value using the given formatter.

impl Store for RedbStore

fn get_head<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<ExtendedHeader, StoreError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns the ExtendedHeader with the highest height.

fn get_by_hash<'life0, 'life1, 'async_trait>( &'life0 self, hash: &'life1 Hash, ) -> Pin<Box<dyn Future<Output = Result<ExtendedHeader, StoreError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Returns the header of a specific hash.

fn get_by_height<'life0, 'async_trait>( &'life0 self, height: u64, ) -> Pin<Box<dyn Future<Output = Result<ExtendedHeader, StoreError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns the header of a specific height.

fn wait_new_head<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = u64> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns when new head is available in the Store.

fn wait_height<'life0, 'async_trait>( &'life0 self, height: u64, ) -> Pin<Box<dyn Future<Output = Result<(), StoreError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns when height is available in the Store.

fn head_height<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<u64, StoreError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns the highest known height.

fn has<'life0, 'life1, 'async_trait>( &'life0 self, hash: &'life1 Hash, ) -> Pin<Box<dyn Future<Output = bool> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Returns true if hash exists in the store.

fn has_at<'life0, 'async_trait>( &'life0 self, height: u64, ) -> Pin<Box<dyn Future<Output = bool> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns true if height exists in the store.

fn insert<'life0, 'async_trait, R>( &'life0 self, headers: R, ) -> Pin<Box<dyn Future<Output = Result<(), StoreError>> + Send + 'async_trait>>

where R: TryInto<VerifiedExtendedHeaders> + Send + 'async_trait, <R as TryInto<VerifiedExtendedHeaders>>::Error: Display, Self: 'async_trait, 'life0: 'async_trait,

Insert a range of headers into the store.

fn update_sampling_metadata<'life0, 'async_trait>( &'life0 self, height: u64, status: SamplingStatus, cids: Vec<Cid>, ) -> Pin<Box<dyn Future<Output = Result<(), StoreError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Sets or updates sampling result for the header.

fn get_sampling_metadata<'life0, 'async_trait>( &'life0 self, height: u64, ) -> Pin<Box<dyn Future<Output = Result<Option<SamplingMetadata>, StoreError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Gets the sampling metadata for the height.

fn get_stored_header_ranges<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<BlockRanges, StoreError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns a list of header ranges currenty held in store.

fn get_accepted_sampling_ranges<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<BlockRanges, StoreError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns a list of accepted sampling ranges currently held in store.

fn remove_last<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<u64, StoreError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Remove header with lowest height from the store.

fn get_range<'life0, 'async_trait, R>( &'life0 self, range: R, ) -> Pin<Box<dyn Future<Output = Result<Vec<ExtendedHeader>, StoreError>> + Send + 'async_trait>>

where R: RangeBounds<u64> + Send + 'async_trait, Self: 'async_trait, 'life0: 'async_trait,

Returns the headers from the given heights range.