Module internals

Source
Expand description

A selective view of key components in Raft Engine. Exported under the internals feature only.

Modules§

debug
A set of public utilities used for interacting with log files.

Structs§

DefaultMachineFactory
A factory of ReplayMachines that can be default constructed.
EntryIndex
Location of a log entry.
FileBlockHandle
A logical pointer to a chunk of log file data.
FileId
A unique identifier for a log file.
FilePipeLog
A PipeLog implementation that stores data in filesystem.
FilePipeLogBuilder
DualPipes factory that can also recover other customized memory states.
LogFileContext
MemTable
In-memory storage for Raft Groups.
MemTableAccessor
A collection of MemTables.
MemTableRecoverContext
MemTableRecoverContextFactory
PurgeHook
PurgeManager
RecoveryConfig
Container for basic settings on recovery.
VersionIter
An iterator over the variants of Version
WriteBarrier
A synchronizer of Writers.
WriteGroup
A collection of writers. User thread (leader) that receives a WriteGroup is responsible for processing its containing writers.
Writer
WriterIter
An iterator over the Writers in one WriteGroup.

Enums§

LogQueue
The type of log queue.
Version
Version of log file format.

Traits§

EventListener
EventListener contains a set of callback functions that will be notified on specific events inside Raft Engine.
FileNameExt
FileNameExt offers file name formatting extensions to FileId.
PipeLog
A PipeLog serves reads and writes over multiple queues of log files.
ReactiveBytes
Some bytes whose value might be dependent on the file it is written to.
ReplayMachine
ReplayMachine is a type of deterministic state machine that obeys associative law.

Functions§

parse_reserved_file_name

Type Aliases§

FileSeq
Sequence number for log file. It is unique within a log queue.
MemTableHandle
MemTables