Trait reth_db_api::database::Database

pub trait Database: Send + Sync {
    type TX: DbTx + Send + Sync + Debug + 'static;
    type TXMut: DbTxMut + DbTx + TableImporter + Send + Sync + Debug + 'static;

    // Required methods
    fn tx(&self) -> Result<Self::TX, DatabaseError>;
    fn tx_mut(&self) -> Result<Self::TXMut, DatabaseError>;

    // Provided methods
    fn view<T, F>(&self, f: F) -> Result<T, DatabaseError>
       where F: FnOnce(&Self::TX) -> T { ... }
    fn update<T, F>(&self, f: F) -> Result<T, DatabaseError>
       where F: FnOnce(&Self::TXMut) -> T { ... }
}

Main Database trait that can open read-only and read-write transactions.

Sealed trait which cannot be implemented by 3rd parties, exposed only for consumption.

Required Associated Types

type TX: DbTx + Send + Sync + Debug + 'static

Read-Only database transaction

type TXMut: DbTxMut + DbTx + TableImporter + Send + Sync + Debug + 'static

Read-Write database transaction

Required Methods

fn tx(&self) -> Result<Self::TX, DatabaseError>

Create read only transaction.

fn tx_mut(&self) -> Result<Self::TXMut, DatabaseError>

Create read write transaction only possible if database is open with write access.

Provided Methods

fn view<T, F>(&self, f: F) -> Result<T, DatabaseError>

where F: FnOnce(&Self::TX) -> T,

Takes a function and passes a read-only transaction into it, making sure it’s closed in the end of the execution.

fn update<T, F>(&self, f: F) -> Result<T, DatabaseError>

where F: FnOnce(&Self::TXMut) -> T,

Takes a function and passes a write-read transaction into it, making sure it’s committed in the end of the execution.

Object Safety

This trait is not object safe.

Implementations on Foreign Types

impl<DB: Database> Database for &DB

type TX = <DB as Database>::TX

type TXMut = <DB as Database>::TXMut

fn tx(&self) -> Result<Self::TX, DatabaseError>

fn tx_mut(&self) -> Result<Self::TXMut, DatabaseError>

impl<DB: Database> Database for Arc<DB>

type TX = <DB as Database>::TX

type TXMut = <DB as Database>::TXMut

fn tx(&self) -> Result<Self::TX, DatabaseError>

fn tx_mut(&self) -> Result<Self::TXMut, DatabaseError>

Implementors

impl Database for DatabaseMock

type TX = TxMock

type TXMut = TxMock