Struct OpenOptions

pub struct OpenOptions { /* private fields */ }

Options used to configure how a RotateLog is opened.

Implementations

impl OpenOptions

pub fn new() -> Self

Creates a default new set of options ready for configuration.

The default values are:

• Keep 2 logs.
• A log gets rotated when it exceeds 2GB.
• No indexes.
• Do not create on demand.
• Do not sync automatically on append().

pub fn max_log_count(self, count: u8) -> Self

Set the maximum Log count.

A larger value would hurt lookup performance.

pub fn max_bytes_per_log(self, bytes: u64) -> Self

Set the maximum bytes per Log.

pub fn checksum_type(self, checksum_type: ChecksumType) -> Self

Sets the checksum type.

See log::ChecksumType for details.

pub fn create(self, create: bool) -> Self

Set whether create the RotateLog structure if it does not exist.

pub fn index( self, name: &'static str, func: fn(&[u8]) -> Vec<IndexOutput>, ) -> Self

Add an index function.

pub fn index_defs(self, index_defs: Vec<IndexDef>) -> Self

Set the index definitions.

See IndexDef for details.

pub fn flush_filter(self, flush_filter: Option<FlushFilterFunc>) -> Self

Sets the flush filter function.

The function will be called at RotateLog::sync time, if there are changes since open (or last sync) time.

The filter function can be used to avoid writing content that already exists in the latest Log, or rewrite content as needed.

pub fn auto_sync_threshold(self, threshold: impl Into<Option<u64>>) -> Self

Call sync automatically if the in-memory buffer size has exceeded the given size threshold.

This is useful to make in-memory buffer size bounded.

pub fn open(&self, dir: impl AsRef<Path>) -> Result<RotateLog>

Open RotateLog at given location.

pub fn create_in_memory(&self) -> Result<RotateLog>

Open an-empty RotateLog in memory. The RotateLog cannot RotateLog::sync.

pub fn repair(&self, dir: impl AsRef<Path>) -> Result<String>

Try repair all logs in the specified directory.

This just calls into log::OpenOptions::repair recursively.

Trait Implementations

impl Clone for OpenOptions

fn clone(&self) -> OpenOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenOptions

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

Formats the value using the given formatter.