72 lines
2.3 KiB
Nim
72 lines
2.3 KiB
Nim
# nimbus-eth1
|
|
# Copyright (c) 2023 Status Research & Development GmbH
|
|
# Licensed under either of
|
|
# * Apache License, version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
|
|
# http://www.apache.org/licenses/LICENSE-2.0)
|
|
# * MIT license ([LICENSE-MIT](LICENSE-MIT) or
|
|
# http://opensource.org/licenses/MIT)
|
|
# at your option. This file may not be copied, modified, or distributed
|
|
# except according to those terms.
|
|
|
|
## Kvt DB -- backend data types
|
|
## ============================
|
|
##
|
|
|
|
{.push raises: [].}
|
|
|
|
import
|
|
eth/common,
|
|
results,
|
|
./desc_error
|
|
|
|
type
|
|
GetKvpFn* =
|
|
proc(key: openArray[byte]): Result[Blob,KvtError] {.gcsafe, raises: [].}
|
|
## Generic backend database retrieval function
|
|
|
|
# -------------
|
|
|
|
PutHdlRef* = ref object of RootRef
|
|
## Persistent database transaction frame handle. This handle is used to
|
|
## wrap any of `PutVtxFn`, `PutKeyFn`, and `PutIdgFn` into and atomic
|
|
## transaction frame. These transaction frames must not be interleaved
|
|
## by any library function using the backend.
|
|
|
|
PutBegFn* =
|
|
proc(): PutHdlRef {.gcsafe, raises: [].}
|
|
## Generic transaction initialisation function
|
|
|
|
PutKvpFn* =
|
|
proc(hdl: PutHdlRef; kvps: openArray[(Blob,Blob)]) {.gcsafe, raises: [].}
|
|
## Generic backend database bulk storage function.
|
|
|
|
PutEndFn* =
|
|
proc(hdl: PutHdlRef): Result[void,KvtError] {.gcsafe, raises: [].}
|
|
## Generic transaction termination function
|
|
|
|
# -------------
|
|
|
|
CloseFn* =
|
|
proc(flush: bool) {.gcsafe, raises: [].}
|
|
## Generic destructor for the `Kvt DB` backend. The argument `flush`
|
|
## indicates that a full database deletion is requested. If passed
|
|
## `false` the outcome might differ depending on the type of backend
|
|
## (e.g. in-memory backends would flush on close.)
|
|
|
|
# -------------
|
|
|
|
BackendRef* = ref object of RootRef
|
|
## Backend interface.
|
|
|
|
getKvpFn*: GetKvpFn ## Read key-value pair
|
|
|
|
putBegFn*: PutBegFn ## Start bulk store session
|
|
putKvpFn*: PutKvpFn ## Bulk store key-value pairs
|
|
putEndFn*: PutEndFn ## Commit bulk store session
|
|
|
|
closeFn*: CloseFn ## Generic destructor
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# End
|
|
# ------------------------------------------------------------------------------
|