Struct Options

pub struct Options { /* private fields */ }

Implementations

impl Options

pub fn new(path: Path) -> Self

Create a new log options.

pub fn with_fs_options(path: Path, fs_option: FsOptions) -> Self

Create a new log options with FsOptions.

See FsOptions for more details.

pub fn disable_buf(self) -> Self

Disable buffer for the log. It is recommended to keep the buffer enabled and use Logger::flush to flush the data to the log file.

pub fn buf_size(self, buf_size: usize) -> Self

Set the buffer size for the log. Default is 4K.

pub fn fs(self, fs_option: FsOptions) -> Self

Set the filesystem options for the log.

See FsOptions for more details.

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

Open log file with truncate option.

pub async fn build<T>(self) -> Result<Logger<T>, LogError>

where T: Encode,

Open the log file. Return error if open file failed.

pub async fn build_with_fs<T>( self, fs: Arc<dyn DynFs>, ) -> Result<Logger<T>, LogError>

where T: Encode,

Open the log with the given DynFs. Return error if open file failed.

pub async fn recover<T>( self, ) -> Result<impl TryStream<Ok = Vec<T>, Error = LogError> + Unpin, LogError>

where T: Decode,

Recover the log from existing log file. Return a stream of log entries.

pub async fn recover_with_fs<T>( self, fs: Arc<dyn DynFs>, ) -> Result<impl TryStream<Ok = Vec<T>, Error = LogError> + Unpin, LogError>

where T: Decode,

Recover the log from the given DynFs and Options. Return a stream of log entries.

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a duplicate of the value.

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

Performs copy-assignment from source.