Struct StorageEngine

pub struct StorageEngine { /* private fields */ }

Keeps track of handles towards a ChunkStore and its QueryCache.

A StorageEngine doesn’t add any feature on top of what ChunkStoreHandle and QueryCacheHandle already offer: the job of the StorageEngine is to leverage the type system in order to protect against deadlocks and race conditions at compile time.

The handles stored within will never be publicly accessible past construction.

The underlying ChunkStore and QueryCache can be accessed through one of the following methods:

• StorageEngine::read
• StorageEngine::read_arc
• StorageEngine::write
• StorageEngine::write_arc

Implementations

impl StorageEngine

pub unsafe fn new(store: ChunkStoreHandle, cache: QueryCacheHandle) -> Self

Creates a new StorageEngine with the specified ChunkStore and QueryCache handles.

Safety

It is the responsibility of the caller to make sure that the given handles have not escaped anywhere else before constructing this type, otherwise the StorageEngine cannot make any safety guarantees.

impl StorageEngine

pub fn read(&self) -> StorageEngineReadGuard<'_>

pub fn try_read(&self) -> Option<StorageEngineReadGuard<'_>>

pub fn try_read_arc(&self) -> Option<StorageEngineArcReadGuard>

pub fn write(&self) -> StorageEngineWriteGuard<'_>

pub fn try_write(&self) -> Option<StorageEngineWriteGuard<'_>>

pub fn read_arc(&self) -> StorageEngineArcReadGuard

pub fn write_arc(&self) -> StorageEngineArcWriteGuard

pub fn try_write_arc(&self) -> Option<StorageEngineArcWriteGuard>

Trait Implementations

impl Clone for StorageEngine

fn clone(&self) -> StorageEngine

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl StorageEngineLike for StorageEngine

fn with<F: FnOnce(&ChunkStore, &QueryCache) -> R, R>(&self, f: F) -> R

fn try_with<F: FnOnce(&ChunkStore, &QueryCache) -> R, R>( &self, f: F, ) -> Option<R>