Struct ClientDatabaseFormatOptions

pub struct ClientDatabaseFormatOptions {
    pub page_group_size: NonZeroU32,
    pub force: bool,
}

Options for ClientDatabase

Fields

page_group_size: NonZeroU32

The number of AlignedPages in a single page group.

Each group always has a set of storage items with monotonically increasing sequence numbers. The database only frees page groups for reuse when all storage items there are no longer in use.

A smaller number means storage can be reclaimed for reuse more quickly and higher concurrency during restart, but must not be too small that no storage item fits within a page group anymore. A larger number allows finding the range of sequence numbers that are already used and where potential write interruption happened on restart more efficiently, but will use more RAM in the process.

The recommended size is 256 MiB unless a tiny database is used for testing purposes, where a smaller value might work too.

force: bool

By default, formatting will be aborted if the database appears to be already formatted.

Setting this option to true skips the check and formats the database anyway.

Trait Implementations

impl Clone for ClientDatabaseFormatOptions

fn clone(&self) -> ClientDatabaseFormatOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientDatabaseFormatOptions

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

Formats the value using the given formatter.

impl Copy for ClientDatabaseFormatOptions