berkus
/
cacache-rs
mirror of https://github.com/zkat/cacache-rs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: improved documentation for remove_fully 

The documentation is outdated since #63. This merge request aims to update it to reflect the new changes.

According to the the release notes for v13.0.0, this is meant to be a fix, but the documentation makes it looks like a bug.
This commit is contained in:
RustyNova 2024-06-10 14:52:39 +00:00 committed by RustyNova
parent c102c01e76
commit d4f51350aa
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/index.rs
View File

@ -393,13 +393,15 @@ impl RemoveOpts {
} }
/// Set the remove fully option /// Set the remove fully option
/// If remove_fully is set to true then the index file itself will be physically deleted rather than appending a null. /// If remove_fully is set to true then the index and content file itself will be physically deleted rather than appending a null.
pub fn remove_fully(mut self, remove_fully: bool) -> Self { pub fn remove_fully(mut self, remove_fully: bool) -> Self {
self.remove_fully = remove_fully; self.remove_fully = remove_fully;
self self
} }
/// Removes an individual index metadata entry. The associated content will be left in the cache. /// Removes an individual index metadata entry.
/// If remove_fully is set to false (default), the associated content will be left in the cache.
/// If remove_fully is true, both the index entry and the contents will be physically removed from the disk
pub fn remove_sync<P, K>(self, cache: P, key: K) -> Result<()> pub fn remove_sync<P, K>(self, cache: P, key: K) -> Result<()>
where where
P: AsRef<Path>, P: AsRef<Path>,
@ -419,7 +421,9 @@ impl RemoveOpts {
} }
} }
/// Removes an individual index metadata entry. The associated content will be left in the cache. /// Removes an individual index metadata entry.
/// If remove_fully is set to false (default), the associated content will be left in the cache.
/// If remove_fully is true, both the index entry and the contents will be physically removed from the disk
#[cfg(any(feature = "async-std", feature = "tokio"))] #[cfg(any(feature = "async-std", feature = "tokio"))]
pub async fn remove<P, K>(self, cache: P, key: K) -> Result<()> pub async fn remove<P, K>(self, cache: P, key: K) -> Result<()>
where where