Struct cuprate_database::ConcreteEnv

pub struct ConcreteEnv { /* private fields */ }

A strongly typed, concrete database environment, backed by heed.

Trait Implementations

impl Drop for ConcreteEnv

fn drop(&mut self)

Executes the destructor for this type.

impl Env for ConcreteEnv

type TxRw<'tx> = RefCell<RwTxn<'tx>>

HACK: heed::RwTxn is wrapped in RefCell to allow:

• opening a database with only a & to it
• allowing 1 write tx to open multiple tables

Our mutable accesses are safe and will not panic as:

• Write transactions are !Sync
• A table operation does not hold a reference to the inner cell once the call is over
• The function to manipulate the table takes the same type of reference that the RefCell gets for that function

Also see:

• https://github.com/Cuprate/cuprate/pull/102#discussion_r1548695610
• https://github.com/Cuprate/cuprate/pull/104

const MANUAL_RESIZE: bool = true

Does the database backend need to be manually resized when the memory-map is full?

const SYNCS_PER_TX: bool = false

Does the database backend forcefully sync/flush to disk on every transaction commit?

type EnvInner<'env> = RwLockReadGuard<'env, Env>

The struct representing the actual backend’s database environment.

type TxRo<'tx> = RoTxn<'tx>

The read-only transaction type of the backend.

fn open(config: Config) -> Result<Self, InitError>

Open the database environment, using the passed Config.

fn config(&self) -> &Config

Return the Config that this database was Env::opened with.

fn sync(&self) -> Result<(), RuntimeError>

Fully sync the database caches to disk.

fn resize_map(&self, resize_algorithm: Option<ResizeAlgorithm>) -> NonZeroUsize

Resize the database’s memory map to a new (bigger) size using a ResizeAlgorithm.

fn current_map_size(&self) -> usize

What is the current size of the database’s memory map in bytes?

fn env_inner(&self) -> Self::EnvInner<'_>

Return the Env::EnvInner.

fn disk_size_bytes(&self) -> Result<u64>

Return the amount of actual of bytes the database is taking up on disk.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 112 bytes