annotate rust/hg-core/src/fncache.rs @ 52769:1b7a57a5b47a

rust: add safe bindings to bdiff.c I wrote C FFI bindings manually rather than using a bindgen build step because there are only 2 structs and 3 functions and they're not going to change. Note that the relative path in build.rs means that cargo publish will no longer work. If in the future we want to publish to crates.io, we would probably need to add a Makefile step that copies bdiff sources into the hg-core crate.
author Mitchell Kember <mkember@janestreet.com>
date Wed, 18 Dec 2024 10:35:01 -0500
parents 1a8466fd904a
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
52296
1a8466fd904a hg-core: add fncache module
Rapha?l Gom?s <rgomes@octobus.net>
parents:
diff changeset
1 use std::path::Path;
1a8466fd904a hg-core: add fncache module
Rapha?l Gom?s <rgomes@octobus.net>
parents:
diff changeset
2
1a8466fd904a hg-core: add fncache module
Rapha?l Gom?s <rgomes@octobus.net>
parents:
diff changeset
3 use dyn_clone::DynClone;
1a8466fd904a hg-core: add fncache module
Rapha?l Gom?s <rgomes@octobus.net>
parents:
diff changeset
4
1a8466fd904a hg-core: add fncache module
Rapha?l Gom?s <rgomes@octobus.net>
parents:
diff changeset
5 /// The FnCache stores the list of most files contained in the store and is
1a8466fd904a hg-core: add fncache module
Rapha?l Gom?s <rgomes@octobus.net>
parents:
diff changeset
6 /// used for stream/copy clones.
1a8466fd904a hg-core: add fncache module
Rapha?l Gom?s <rgomes@octobus.net>
parents:
diff changeset
7 ///
1a8466fd904a hg-core: add fncache module
Rapha?l Gom?s <rgomes@octobus.net>
parents:
diff changeset
8 /// It keeps track of the name of "all" indexes and data files for all revlogs.
1a8466fd904a hg-core: add fncache module
Rapha?l Gom?s <rgomes@octobus.net>
parents:
diff changeset
9 /// The names are relative to the store roots and are stored before any
1a8466fd904a hg-core: add fncache module
Rapha?l Gom?s <rgomes@octobus.net>
parents:
diff changeset
10 /// encoding or path compression.
1a8466fd904a hg-core: add fncache module
Rapha?l Gom?s <rgomes@octobus.net>
parents:
diff changeset
11 ///
1a8466fd904a hg-core: add fncache module
Rapha?l Gom?s <rgomes@octobus.net>
parents:
diff changeset
12 /// Despite its name, the FnCache is *NOT* a cache, it keep tracks of
1a8466fd904a hg-core: add fncache module
Rapha?l Gom?s <rgomes@octobus.net>
parents:
diff changeset
13 /// information that is not easily available elsewhere. It has no mechanism
1a8466fd904a hg-core: add fncache module
Rapha?l Gom?s <rgomes@octobus.net>
parents:
diff changeset
14 /// for detecting isn't up to date, and de-synchronization with the actual
1a8466fd904a hg-core: add fncache module
Rapha?l Gom?s <rgomes@octobus.net>
parents:
diff changeset
15 /// contents of the repository will lead to a corrupted clone and possibly
1a8466fd904a hg-core: add fncache module
Rapha?l Gom?s <rgomes@octobus.net>
parents:
diff changeset
16 /// other corruption during maintenance operations.
1a8466fd904a hg-core: add fncache module
Rapha?l Gom?s <rgomes@octobus.net>
parents:
diff changeset
17 /// Strictly speaking, it could be recomputed by looking at the contents of all
1a8466fd904a hg-core: add fncache module
Rapha?l Gom?s <rgomes@octobus.net>
parents:
diff changeset
18 /// manifests AND actual store files on disk, however that is a
1a8466fd904a hg-core: add fncache module
Rapha?l Gom?s <rgomes@octobus.net>
parents:
diff changeset
19 /// prohibitively expensive operation.
1a8466fd904a hg-core: add fncache module
Rapha?l Gom?s <rgomes@octobus.net>
parents:
diff changeset
20 pub trait FnCache: Sync + Send + DynClone {
1a8466fd904a hg-core: add fncache module
Rapha?l Gom?s <rgomes@octobus.net>
parents:
diff changeset
21 /// Whether the fncache was loaded from disk
1a8466fd904a hg-core: add fncache module
Rapha?l Gom?s <rgomes@octobus.net>
parents:
diff changeset
22 fn is_loaded(&self) -> bool;
1a8466fd904a hg-core: add fncache module
Rapha?l Gom?s <rgomes@octobus.net>
parents:
diff changeset
23 /// Add a path to be tracked in the fncache
1a8466fd904a hg-core: add fncache module
Rapha?l Gom?s <rgomes@octobus.net>
parents:
diff changeset
24 fn add(&self, path: &Path);
1a8466fd904a hg-core: add fncache module
Rapha?l Gom?s <rgomes@octobus.net>
parents:
diff changeset
25 // TODO add more methods once we start doing more with the FnCache
1a8466fd904a hg-core: add fncache module
Rapha?l Gom?s <rgomes@octobus.net>
parents:
diff changeset
26 }