Struct Options

pub struct Options {
    pub log_format_version: u8,
    pub max_segment_size: u64,
    pub max_records_in_commit: NonZeroU16,
    pub offset_index_interval_bytes: NonZeroU64,
    pub offset_index_require_segment_fsync: bool,
}

Commitlog options.

Fields

log_format_version: u8

Set the log format version to write, and the maximum supported version.

Choosing a payload format T of Commitlog should usually result in updating the DEFAULT_LOG_FORMAT_VERSION of this crate. Sometimes it may however be useful to set the version at runtime, e.g. to experiment with new or very old versions.

Default: DEFAULT_LOG_FORMAT_VERSION

max_segment_size: u64

The maximum size in bytes to which log segments should be allowed to grow.

Default: 1GiB

max_records_in_commit: NonZeroU16

The maximum number of records in a commit.

If this number is exceeded, the commit is flushed to disk even without explicitly calling Commitlog::flush.

Default: 65,535

offset_index_interval_bytes: NonZeroU64

Whenever at least this many bytes have been written to the currently active segment, an entry is added to its offset index.

Default: 4096

offset_index_require_segment_fsync: bool

If true, require that the segment must be synced to disk before an index entry is added.

Setting this to false (the default) will update the index every offset_index_interval_bytes, even if the commitlog wasn’t synced. This means that the index could contain non-existent entries in the event of a crash.

Setting it to true will update the index when the commitlog is synced, and offset_index_interval_bytes have been written. This means that the index could contain fewer index entries than

Default: false

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Options

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Options

fn default() -> Self

Returns the “default value” for a type.

impl Copy for Options