Struct PinnedVersion 

pub struct PinnedVersion { /* private fields */ }

A point-in-time view of a tree that keeps its files in place.

Taken by AbstractTree::pin. While it lives, every file it lists stays on disk with unchanged bytes, however the tree flushes and compacts meanwhile: the removal of a superseded file, an in-place heal and a tight-space hole punch of a listed file wait for the last pin listing it. Dropping it releases them; a restart drops every pin.

Pins are independent: each lists its own files and releases them on its own drop.

Implementations

impl PinnedVersion

pub fn seqno(&self) -> SeqNo

The sequence number the pin was taken at: it holds every write below it, and reads at any snapshot up to it see what the tree served then.

pub fn tables(&self) -> &[PinnedFile]

The tables, with their levels.

pub fn blob_files(&self) -> &[PinnedFile]

The blob files.

pub fn dictionaries(&self) -> &[PinnedFile]

The compression dictionaries the tables and blob files were written against.

pub fn layout(&self) -> Result<Vec<u8>>

The version descriptor a manifest would hold for the pinned files (levels, runs, restrictions, blob files, dictionaries, the retention floor, a repair report the tree still owes: the pinned files hold that repair’s data, so the restored tree owes it too), serialized in memory, sealed with the tree’s encryption provider when it has one. Opaque: hand it to Config::restore_pinned.

Errors

Propagates an encoding or encryption failure.

pub fn memtable_entries(&self) -> impl Iterator<Item = PinnedEntry> + '_

The entries of the sealed memtables, every version of every key below seqno, with their sequence numbers and value types.

pub fn memtable_range_tombstones(&self) -> Vec<PinnedRangeTombstone>

The range tombstones of the sealed memtables below seqno.

Trait Implementations

impl Drop for PinnedVersion

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.