Struct encryption::file_dict_file::FileDictionaryFile

pub struct FileDictionaryFile {
    base: PathBuf,
    name: String,
    append_file: Option<File>,
    file_dict: FileDictionary,
    enable_log: bool,
    file_rewrite_threshold: u64,
    removed: u64,
    file_size: usize,
}

FileDictionaryFile is used to store log style file dictionary.

Layout:

Encrypted File Header + FileDictionary Content | Record Header + Record Content | etc

Fields

base: PathBuf

name: String

append_file: Option<File>

file_dict: FileDictionary

enable_log: bool

file_rewrite_threshold: u64

removed: u64

file_size: usize

Implementations

impl FileDictionaryFile

const RECORD_HEADER_SIZE: usize

Header of record.

+----+--+--+-+----+----
|    |  |  | |    |
++---++-++-++++---++---
 ^    ^  ^  ^ ^    ^
 |    |  |  | |    + FileInfo content (variable bytes)
 |    |  |  | + File name content (variable bytes)
 |    |  |  + Log type (1 bytes)
 |    |  + FileInfo length (2 bytes)
 |    + File name length (2 bytes)
 + Crc32 (4 bytes)

pub fn new<P: AsRef<Path>>(
    base: P,
    name: &str,
    enable_log: bool,
    file_rewrite_threshold: u64
) -> Result<FileDictionaryFile>

pub fn open<P: AsRef<Path>>(
    base: P,
    name: &str,
    enable_log: bool,
    file_rewrite_threshold: u64,
    skip_rewrite: bool
) -> Result<(FileDictionaryFile, FileDictionary)>

pub fn file_path(&self) -> PathBuf

Get the file path.

fn rewrite(&mut self) -> Result<()>

Rewrite the log file to reduce file size and reduce the time of next recovery.

pub fn recovery(&mut self) -> Result<FileDictionary>

Recovery from the log file and return FileDictionary.

pub fn insert(&mut self, name: &str, info: &FileInfo) -> Result<()>

Append an insert operation to the log file.

Warning: self.write(file_dict) must be called before.

pub fn remove(&mut self, name: &str) -> Result<()>

Append a remove operation to the log file.

Warning: self.write(file_dict) must be called before.

fn check_compact(&mut self) -> Result<()>

This function needs to be called after each append operation to check if compact is needed.

fn convert_record_to_bytes(
    fname: &str,
    record_type: LogRecord
) -> Result<Vec<u8>>

fn parse_next_record(remained: &[u8]) -> Result<(usize, String, LogRecord)>

fn update_metrics(&self)

Trait Implementations

impl Debug for FileDictionaryFile

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

Formats the value using the given formatter.