Struct rrsync::IndexTransaction

pub struct IndexTransaction<'a> { /* fields omitted */ }

A transaction on the index, for safety and performance

Methods

impl<'a> IndexTransaction<'a>

pub fn add_file(
    &mut self,
    name: &Path,
    modified: DateTime<Utc>
) -> Result<(u32, bool), Error>

Add a file to the index

This returns a tuple (file_id, up_to_date) where file_id can be used to insert blocks, and up_to_date indicates whether the file's modification date has changed and it should be re-indexed.

pub fn add_file_overwrite(
    &mut self,
    name: &Path,
    modified: DateTime<Utc>
) -> Result<u32, Error>

Replace file in the index

This is like add_file but will always replace an existing file.

pub fn remove_file(&mut self, file_id: u32) -> Result<(), Error>

Remove a file and all its blocks from the index

pub fn move_file(
    &mut self,
    file_id: u32,
    destination: &Path
) -> Result<(), Error>

Move a file, possibly over another

pub fn list_files(&self) -> Result<Vec<(u32, PathBuf, DateTime<Utc>)>, Error>

Get a list of all the files in the index

pub fn add_block(
    &mut self,
    hash: &HashDigest,
    file_id: u32,
    offset: usize,
    size: usize
) -> Result<(), Error>

Add a block to the index

pub fn list_file_blocks(
    &self,
    file_id: u32
) -> Result<Vec<(HashDigest, usize, usize)>, Error>

Get a list of all the blocks in a specific file

pub fn get_block(
    &self,
    hash: &HashDigest
) -> Result<Option<(PathBuf, usize, usize)>, Error>

Try to find a block in the indexed files

pub fn index_file(&mut self, path: &Path, name: &Path) -> Result<(), Error>

Cut up a file into blocks and add them to the index

pub fn index_path(&mut self, path: &Path) -> Result<(), Error>

Index files and directories recursively

pub fn remove_missing_files(&mut self, path: &Path) -> Result<(), Error>

List all files and remove those that don't exist on disk

pub fn commit(self) -> Result<(), Error>

Commit the transaction