Struct docchi::fs::history::FileHistory

pub struct FileHistory { /* fields omitted */ }

Represents every history file in a hash directory

Implementations

impl FileHistory

pub fn max_phase(&self) -> usize

pub fn cumulative(&self) -> bool

pub fn create<P>(
    history_dir: P,
    hash: u128,
    max_phase: usize,
    cumulative: bool
) -> Result<FileHistory, FsError> where
    P: AsRef<Path>, 

pub fn list_files(&self) -> Vec<&FileNameProps, Global>

show every file in chronological order

pub fn get_removable_old_items(
    &self,
    keep_latest: usize
) -> Vec<&FileNameProps, Global>

returns old files which can be removed.

pub fn remove_old_files<P>(
    self,
    keep_latest: usize,
    history_hash_dir: P
) -> Vec<PathBuf, Global> where
    P: AsRef<Path>, 

Remove old files. Files will be deleted in this method, and this history will be inconsistent with saved files, so the history will be consumed.

Returns file paths which is failed to remove if any.

pub unsafe fn remove_files<'a, P>(
    filenames: impl Iterator<Item = &'a FileNameProps>,
    history_hash_dir: P
) -> Vec<PathBuf, Global> where
    P: AsRef<Path>, 

remove files. History files have dependencies, so arbitrary removing can make files inconsistent.

If the “filenames” are created from “get_removable_old_items”, this function itself will be safe, but removing files make existing FileHistory inconsistent with saved files.

Returns paths which is failed to remove

pub fn newest_file_path(&self, history_hash_dir: &Path) -> Option<PathBuf>

get the newest file path in this hash_dir

pub fn get_props(&self, ctl: u32, order: &[u32]) -> Option<&FileNameProps>

pub fn get_parent(&self, props: &FileNameProps) -> Option<&FileNameProps>

Trait Implementations

impl Debug for FileHistory

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

Formats the value using the given formatter.