1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317
//! Functions for removing things from the cache.
use std::fs;
use std::path::Path;
use ssri::Integrity;
use crate::content::rm;
use crate::errors::{IoErrorExt, Result};
use crate::index;
/// Removes an individual index metadata entry. The associated content will be
/// left in the cache.
///
/// ## Example
/// ```no_run
/// use async_std::prelude::*;
/// use async_attributes;
///
/// #[async_attributes::main]
/// async fn main() -> cacache::Result<()> {
/// let sri = cacache::write("./my-cache", "my-key", b"hello").await?;
///
/// cacache::remove("./my-cache", "my-key").await?;
///
/// // This fails:
/// cacache::read("./my-cache", "my-key").await?;
///
/// // But this succeeds:
/// cacache::read_hash("./my-cache", &sri).await?;
///
/// Ok(())
/// }
/// ```
#[cfg(any(feature = "async-std", feature = "tokio"))]
pub async fn remove<P, K>(cache: P, key: K) -> Result<()>
where
P: AsRef<Path>,
K: AsRef<str>,
{
index::delete_async(cache.as_ref(), key.as_ref()).await
}
/// Removes an individual content entry. Any index entries pointing to this
/// content will become invalidated.
///
/// ## Example
/// ```no_run
/// use async_std::prelude::*;
/// use async_attributes;
///
/// #[async_attributes::main]
/// async fn main() -> cacache::Result<()> {
/// let sri = cacache::write("./my-cache", "my-key", b"hello").await?;
///
/// cacache::remove_hash("./my-cache", &sri).await?;
///
/// // These fail:
/// cacache::read("./my-cache", "my-key").await?;
/// cacache::read_hash("./my-cache", &sri).await?;
///
/// // But this succeeds:
/// cacache::metadata("./my-cache", "my-key").await?;
///
/// Ok(())
/// }
/// ```
#[cfg(any(feature = "async-std", feature = "tokio"))]
pub async fn remove_hash<P: AsRef<Path>>(cache: P, sri: &Integrity) -> Result<()> {
rm::rm_async(cache.as_ref(), sri).await
}
/// Removes entire contents of the cache, including temporary files, the entry
/// index, and all content data.
///
/// ## Example
/// ```no_run
/// use async_std::prelude::*;
/// use async_attributes;
///
/// #[async_attributes::main]
/// async fn main() -> cacache::Result<()> {
/// let sri = cacache::write("./my-cache", "my-key", b"hello").await?;
///
/// cacache::clear("./my-cache").await?;
///
/// // These all fail:
/// cacache::read("./my-cache", "my-key").await?;
/// cacache::metadata("./my-cache", "my-key").await?;
/// cacache::read_hash("./my-cache", &sri).await?;
///
/// Ok(())
/// }
/// ```
#[cfg(any(feature = "async-std", feature = "tokio"))]
pub async fn clear<P: AsRef<Path>>(cache: P) -> Result<()> {
async fn inner(cache: &Path) -> Result<()> {
for entry in cache
.read_dir()
.with_context(|| {
format!(
"Failed to read directory contents while clearing cache, at {}",
cache.display()
)
})?
.flatten()
{
crate::async_lib::remove_dir_all(entry.path())
.await
.with_context(|| format!("Failed to clear cache at {}", cache.display()))?;
}
Ok(())
}
inner(cache.as_ref()).await
}
/// Removes an individual index entry synchronously. The associated content
/// will be left in the cache.
///
/// ## Example
/// ```no_run
/// use std::io::Read;
///
/// fn main() -> cacache::Result<()> {
/// let sri = cacache::write_sync("./my-cache", "my-key", b"hello")?;
///
/// cacache::remove_sync("./my-cache", "my-key")?;
///
/// // This fails:
/// cacache::read_sync("./my-cache", "my-key")?;
///
/// // But this succeeds:
/// cacache::read_hash_sync("./my-cache", &sri)?;
///
/// Ok(())
/// }
/// ```
pub fn remove_sync<P, K>(cache: P, key: K) -> Result<()>
where
P: AsRef<Path>,
K: AsRef<str>,
{
index::delete(cache.as_ref(), key.as_ref())
}
/// Removes an individual content entry synchronously. Any index entries
/// pointing to this content will become invalidated.
///
/// ## Example
/// ```no_run
/// use std::io::Read;
///
/// fn main() -> cacache::Result<()> {
/// let sri = cacache::write_sync("./my-cache", "my-key", b"hello")?;
///
/// cacache::remove_hash_sync("./my-cache", &sri)?;
///
/// // These fail:
/// cacache::read_sync("./my-cache", "my-key")?;
/// cacache::read_hash_sync("./my-cache", &sri)?;
///
/// // But this succeeds:
/// cacache::metadata_sync("./my-cache", "my-key")?;
///
/// Ok(())
/// }
/// ```
pub fn remove_hash_sync<P: AsRef<Path>>(cache: P, sri: &Integrity) -> Result<()> {
rm::rm(cache.as_ref(), sri)
}
/// Removes entire contents of the cache synchronously, including temporary
/// files, the entry index, and all content data.
///
/// ## Example
/// ```no_run
/// use std::io::Read;
///
/// fn main() -> cacache::Result<()> {
/// let sri = cacache::write_sync("./my-cache", "my-key", b"hello")?;
///
/// cacache::clear_sync("./my-cache")?;
///
/// // These all fail:
/// cacache::read_sync("./my-cache", "my-key")?;
/// cacache::read_hash_sync("./my-cache", &sri)?;
/// cacache::metadata_sync("./my-cache", "my-key")?;
///
/// Ok(())
/// }
/// ```
pub fn clear_sync<P: AsRef<Path>>(cache: P) -> Result<()> {
fn inner(cache: &Path) -> Result<()> {
for entry in cache
.read_dir()
.with_context(|| {
format!(
"Failed to read directory contents while clearing cache, at {}",
cache.display()
)
})?
.flatten()
{
fs::remove_dir_all(entry.path())
.with_context(|| format!("Failed to clear cache at {}", cache.display()))?;
}
Ok(())
}
inner(cache.as_ref())
}
#[cfg(test)]
mod tests {
#[cfg(feature = "async-std")]
use async_attributes::test as async_test;
#[cfg(feature = "tokio")]
use tokio::test as async_test;
#[cfg(any(feature = "async-std", feature = "tokio"))]
#[async_test]
async fn test_remove() {
futures::executor::block_on(async {
let tmp = tempfile::tempdir().unwrap();
let dir = tmp.path().to_owned();
let sri = crate::write(&dir, "key", b"my-data").await.unwrap();
crate::remove(&dir, "key").await.unwrap();
let entry = crate::metadata(&dir, "key").await.unwrap();
assert_eq!(entry, None);
let data_exists = crate::exists(&dir, &sri).await;
assert!(data_exists);
});
}
#[cfg(any(feature = "async-std", feature = "tokio"))]
#[async_test]
async fn test_remove_data() {
futures::executor::block_on(async {
let tmp = tempfile::tempdir().unwrap();
let dir = tmp.path().to_owned();
let sri = crate::write(&dir, "key", b"my-data").await.unwrap();
crate::remove_hash(&dir, &sri).await.unwrap();
let entry = crate::metadata(&dir, "key").await.unwrap();
assert!(entry.is_some());
let data_exists = crate::exists(&dir, &sri).await;
assert!(!data_exists);
});
}
#[cfg(any(feature = "async-std", feature = "tokio"))]
#[async_test]
async fn test_clear() {
futures::executor::block_on(async {
let tmp = tempfile::tempdir().unwrap();
let dir = tmp.path().to_owned();
let sri = crate::write(&dir, "key", b"my-data").await.unwrap();
crate::clear(&dir).await.unwrap();
let entry = crate::metadata(&dir, "key").await.unwrap();
assert!(entry.is_none());
let data_exists = crate::exists(&dir, &sri).await;
assert!(!data_exists);
});
}
#[test]
fn test_remove_sync() {
let tmp = tempfile::tempdir().unwrap();
let dir = tmp.path().to_owned();
let sri = crate::write_sync(&dir, "key", b"my-data").unwrap();
crate::remove_sync(&dir, "key").unwrap();
let new_entry = crate::metadata_sync(&dir, "key").unwrap();
assert!(new_entry.is_none());
let data_exists = crate::exists_sync(&dir, &sri);
assert!(data_exists);
}
#[test]
fn test_remove_data_sync() {
let tmp = tempfile::tempdir().unwrap();
let dir = tmp.path().to_owned();
let sri = crate::write_sync(&dir, "key", b"my-data").unwrap();
crate::remove_hash_sync(&dir, &sri).unwrap();
let entry = crate::metadata_sync(&dir, "key").unwrap();
assert!(entry.is_some());
let data_exists = crate::exists_sync(&dir, &sri);
assert!(!data_exists);
}
#[test]
fn test_clear_sync() {
let tmp = tempfile::tempdir().unwrap();
let dir = tmp.path().to_owned();
let sri = crate::write_sync(&dir, "key", b"my-data").unwrap();
crate::clear_sync(&dir).unwrap();
let entry = crate::metadata_sync(&dir, "key").unwrap();
assert_eq!(entry, None);
let data_exists = crate::exists_sync(&dir, &sri);
assert!(!data_exists);
}
}