Struct FrozenFileCfg 

pub struct FrozenFileCfg {
    pub module_id: u8,
    pub path: PathBuf,
    pub buffer_size: usize,
    pub initial_available_buffers: usize,
}

Config for FrozenFile

Fields

module_id: u8

Identifier used for error propagation by [frozen_core::error::FrozenError]

path: PathBuf

Absolute path for/of the file

NOTE: The caller must make sure that the path represents a file and all the parent directories included in the path do exists.

buffer_size: usize

Size (in bytes) of a single chunk in file

A chunk is a small fixed size allocation and addressing unit used by FrozenFile for all the write/read ops. These ops are operated by index of the chunk and not the offset of the byte.

NOTE: Chunk size when power of 2, is cache efficient and good for performance

initial_available_buffers: usize

Number of chunks to pre-allocate on fs when FrozenFile is initialized

Initial file length will be buffer_size * initial_available_buffers (bytes).

Trait Implementations

impl Clone for FrozenFileCfg

fn clone(&self) -> FrozenFileCfg

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FrozenFileCfg

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

Formats the value using the given formatter.