Struct blobnet::provider::Cached

pub struct Cached<P> { /* private fields */ }

A provider wrapper that caches data locally.

Implementations

impl<P: Provider + 'static> Cached<P>

pub fn new(inner: P, dir: impl AsRef<Path>, pagesize: u64) -> Self

Create a new cache wrapper for the given provider.

Set the page size in bytes for cached chunks, as well as the directory where fragments should be stored.

pub fn set_prefetch_depth(&mut self, n: u32)

Prefetch the N-ahead chunk. Setting to 0 implies no prefetching.

pub fn cleaner(&self) -> impl Future<Output = ()>

A background process that attempts to keep cache disk usage below 80%.

Since the cache directory is limited in size but local to the machine, it is acceptable to delete files from this folder at any time.

The process monitors the utilization level of the disk that the cache directory is on and removes random files from the cache when utilization exceeds 80%.

pub fn stats_logger(&self) -> impl Future<Output = ()>

A background process that logs stats

pub fn stats_emitter(&self) -> impl Future<Output = ()>

A background process that emits stats to statsd

pub async fn stats(&self) -> CacheStats

Get a snapshot of current stats like volume of pending disk writes.

Trait Implementations

impl<P> Drop for Cached<P>

fn drop(&mut self)

Executes the destructor for this type.

impl<P: Provider + 'static> From<CacheConfig<P>> for Cached<P>

fn from(config: CacheConfig<P>) -> Self

Create a new cache wrapper for a provider with the given config.

impl<P: Provider + 'static> Provider for Cached<P>

fn head<'life0, 'life1, 'async_trait>( &'life0 self, hash: &'life1 str ) -> Pin<Box<dyn Future<Output = Result<u64, Error>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Check if a file exists and returns its size in bytes.

fn get<'life0, 'life1, 'async_trait>( &'life0 self, hash: &'life1 str, range: Option<(u64, u64)> ) -> Pin<Box<dyn Future<Output = Result<BlobRead<'static>, Error>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Returns the data from the file at the given path.

fn put<'life0, 'life1, 'async_trait>( &'life0 self, data: ReadStream<'life1> ) -> Pin<Box<dyn Future<Output = Result<String, Error>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Adds a binary blob to storage, returning its hash.

fn preload<'life0, 'async_trait>( &'life0 self, preload: Preload ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Asynchronously preload a list of blobs into local caches.