Skip to main content

IncrementalIndex

Struct IncrementalIndex 

Source
pub struct IncrementalIndex { /* private fields */ }
Expand description

Persistent index for incremental deduplication.

Tracks which files have been seen and their state at the time of the last scan, enabling subsequent scans to skip unchanged files.

Implementations§

Source§

impl IncrementalIndex

Source

pub fn new() -> Self

Create a new, empty index.

Source

pub fn tracked_count(&self) -> usize

Number of tracked files.

Source

pub fn scan_count(&self) -> u64

Number of scans completed.

Source

pub fn last_scan_epoch(&self) -> u64

Epoch of the last scan.

Source

pub fn classify(&self, path: &Path) -> DedupResult<(FileChange, FileState)>

Classify a single file against the stored state.

§Errors

Returns an error if the file’s metadata cannot be read.

Source

pub fn scan(&self, candidates: &[PathBuf]) -> ScanResult

Perform an incremental scan over a list of candidate paths.

Classifies each file, identifies deleted files (tracked but not in the candidate list), and returns a ScanResult.

Does not update the index – call commit after processing.

Source

pub fn commit(&mut self, paths: &[PathBuf])

Commit processed files to the index, updating their state.

Call this after successfully processing the files from a scan.

Source

pub fn commit_file(&mut self, path: &Path, state: FileState)

Commit a single file with an explicit state (e.g. with content hash).

Source

pub fn prune_deleted(&mut self, deleted: &[PathBuf])

Remove deleted files from the index.

Source

pub fn get_state(&self, path: &Path) -> Option<&FileState>

Get the stored state for a file.

Source

pub fn is_tracked(&self, path: &Path) -> bool

Check if a file is tracked.

Source

pub fn to_json(&self) -> DedupResult<String>

Serialise the index to JSON.

§Errors

Returns an error if serialisation fails.

Source

pub fn from_json(json: &str) -> DedupResult<Self>

Deserialise an index from JSON.

§Errors

Returns an error if the JSON is invalid.

Source

pub fn save_to_file(&self, path: &Path) -> DedupResult<()>

Save the index to a file.

§Errors

Returns an I/O error if the file cannot be written.

Source

pub fn load_from_file(path: &Path) -> DedupResult<Self>

Load the index from a file.

§Errors

Returns an error if the file cannot be read or parsed.

Source

pub fn clear(&mut self)

Clear the entire index.

Source

pub fn tracked_paths(&self) -> Vec<String>

Return all tracked file paths.

Source

pub fn merge(&mut self, other: &IncrementalIndex)

Merge another index into this one. Files in other override this index.

Trait Implementations§

Source§

impl Clone for IncrementalIndex

Source§

fn clone(&self) -> IncrementalIndex

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for IncrementalIndex

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for IncrementalIndex

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for IncrementalIndex

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for IncrementalIndex

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.