[][src]Crate pagecache

pagecache is a lock-free pagecache and log for building high-performance databases.

Re-exports

pub use self::log::Log;
pub use self::log::LogRead;

Modules

log

Working with Log

Structs

Config

A finalized ConfigBuilder that can be use multiple times to open a Tree or Log.

ConfigBuilder

Top-level configuration for the system.

M

A metric collector for all pagecache users running in this process.

NullMaterializer

A materializer for things that have nothing to materialize or recover, like a standalone Log.

PageCache

A lock-free pagecache which supports fragmented pages for dramatically improving write throughput.

PagePtr

A pointer to shared lock-free state bound by a pinned epoch's lifetime.

Reservation

A pending log reservation which can be aborted or completed. NB the holder should quickly call complete or abort as taking too long to decide will cause the underlying IO buffer to become blocked.

Tx

A handle to an ongoing pagecache transaction. Ensures that any state which is removed from a shared in-memory data structure is not destroyed until all possible readers have concluded.

Enums

CacheEntry

Points to either a memory location or a disk location to page-in data from.

DiskPtr

A pointer to a location on disk or an off-log blob.

Error

An Error type encapsulating various issues that may come up in both the expected and unexpected operation of a PageCache.

PageGet

The result of a get call in the PageCache.

SegmentMode

The log may be configured to write data in several different ways, depending on the constraints of the system using it.

Traits

Materializer

A user of a PageCache needs to provide a Materializer which handles the merging of page fragments.

Functions

pin

Pins the current thread.

Type Definitions

BlobPointer

A pointer to an blob blob.

LogId

A log file offset.

Lsn

A logical sequence number.

MergeOperator

Allows arbitrary logic to be injected into mere operations of the PageCache.

PageId

A page identifier.

Result

The top-level result type for dealing with the PageCache.

SegmentId

An offset for a storage file segment.