Skip to main content

DiskCache

Struct DiskCache 

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

An opened, authenticated cache directory.

Implementations§

Source§

impl DiskCache

Source

pub fn open( dir: impl Into<PathBuf>, limits: CacheLimits, ) -> Result<Self, OpenError>

Open (creating if necessary) the cache directory at dir.

Fails — meaning disable the cache, not fall back to unauthenticated reads — when the directory belongs to another user, when it cannot be made private, or when the key file is absent-and-uncreatable, the wrong length, or readable by anyone but the owner.

Source

pub fn dir(&self) -> &Path

The directory this cache lives in.

Source

pub fn limits(&self) -> CacheLimits

The budget this cache was opened with.

Source

pub fn stats(&self) -> CacheStats

Snapshot of the counters.

Source

pub fn load(&self, key: &str) -> Option<CachedScan>

Load and authenticate the entry for key.

Every failure path — absent, expired, oversized, truncated, wrong magic, bad tag, or a body that does not validate — returns None. A tag mismatch also warns on stderr and bumps CacheStats::tampered.

Source

pub fn store(&self, key: &str, scan: &CachedScan) -> Result<(), String>

Store scan under key, atomically and authenticated.

Source

pub fn purge(&self) -> Result<(u64, u64), String>

Delete every entry. Returns (files, bytes) removed. The key file survives, so a purge does not invalidate anything an operator has backed up out of band — it just empties the cache.

Source

pub fn size_on_disk(&self) -> Result<u64, String>

Total bytes currently held by entries.

Trait Implementations§

Source§

impl Debug for DiskCache

Source§

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

Formats the value using the given formatter. 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> 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> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.