Struct Options

pub struct Options {
    pub read_only: bool,
    pub roll_metadata_key_byte_count: u64,
    pub pre_commit_hook: PreCommitHook,
    pub post_commit_hook: PostCommitHook,
    pub skip_initial_reap: bool,
    pub trim_config: Option<(Duration, Duration)>,
    pub image_builder_mode: bool,
}

Fields

read_only: bool

True if the filesystem is read-only.

roll_metadata_key_byte_count: u64

The metadata keys will be rolled after this many bytes. This must be large enough such that we can’t end up with more than two live keys (so it must be bigger than the maximum possible size of unflushed journal contents). This is exposed for testing purposes.

pre_commit_hook: PreCommitHook

A callback that runs before every transaction is committed. If this callback returns an error then the transaction is failed with that error.

post_commit_hook: PostCommitHook

A callback that runs after every transaction has been committed. This will be called whilst a lock is held which will block more transactions from being committed.

skip_initial_reap: bool

If true, don’t do an initial reap of the graveyard at mount time. This is useful for testing.

trim_config: Option<(Duration, Duration)>

image_builder_mode: bool

Trait Implementations

impl Default for Options

fn default() -> Self

Returns the “default value” for a type.