From 91c7ffc797b36294fdf7a3f414e5d3f8105bd1d6 Mon Sep 17 00:00:00 2001 From: Volker Mische Date: Wed, 8 Jan 2025 13:03:19 +0100 Subject: [PATCH] fix: clean up public API for clearing files `clear_layer_data()` and `clear_caches` are never called within `rust-fil-proofs` and also not used in `rust-filecoin-proofs-api`, hence remove them. The `clear_cache()` and `clear_synthetic_proofs()` functions don't need to be generic over the tree as it's never used within those functions. This is a breaking change. BREAKING CHANGE: signature of `clear_cache()` and `clear_synthetic_proofs()` changed. The generic parameter is no longer needed. --- filecoin-proofs/src/api/mod.rs | 40 ++-------------------------------- 1 file changed, 2 insertions(+), 38 deletions(-) diff --git a/filecoin-proofs/src/api/mod.rs b/filecoin-proofs/src/api/mod.rs index 0789f46fd..c2ed24fe1 100644 --- a/filecoin-proofs/src/api/mod.rs +++ b/filecoin-proofs/src/api/mod.rs @@ -51,10 +51,7 @@ pub use winning_post::*; pub use storage_proofs_update::constants::{partition_count, TreeRHasher}; -// TODO vmx 2023-09-26: The `Tree` generic is not needed, it's only there in order to not breaking -// the public API. Once we break the API, remove that generic. -// Ensure that any associated cached data persisted is discarded. -pub fn clear_cache(cache_dir: &Path) -> Result<()> { +pub fn clear_cache(cache_dir: &Path) -> Result<()> { info!("clear_cache:start"); let result = stacked::clear_cache_dir(cache_dir); @@ -64,40 +61,7 @@ pub fn clear_cache(cache_dir: &Path) -> Result<()> { result } -// TODO vmx 2023-09-26: The `Tree` generic is not needed, it's only there in order to not breaking -// the public API. Once we break the API, remove that generic. -// Ensure that any associated cached data persisted is discarded. -pub fn clear_caches( - replicas: &BTreeMap>, -) -> Result<()> { - info!("clear_caches:start"); - - for replica in replicas.values() { - clear_cache::(replica.cache_dir.as_path())?; - } - - info!("clear_caches:finish"); - - Ok(()) -} - -// TODO vmx 2023-09-26: The `Tree` generic is not needed, it's only there in order to not breaking -// the public API. Once we break the API, remove that generic. -// Ensure that any persisted layer data generated from porep are discarded. -pub fn clear_layer_data(cache_dir: &Path) -> Result<()> { - info!("clear_layer_data:start"); - - let result = stacked::clear_cache_dir(cache_dir); - - info!("clear_layer_data:finish"); - - result -} - -// TODO vmx 2023-09-26: The `Tree` generic is not needed, it's only there in order to not breaking -// the public API. Once we break the API, remove that generic. -// Ensure that any persisted vanilla proofs generated from synthetic porep are discarded. -pub fn clear_synthetic_proofs(cache_dir: &Path) -> Result<()> { +pub fn clear_synthetic_proofs(cache_dir: &Path) -> Result<()> { info!("clear_synthetic_proofs:start"); let result = stacked::clear_synthetic_proofs(cache_dir);