Struct LocalStorage 

pub struct LocalStorage { /* private fields */ }

Filesystem-backed binary cache storage.

Implementations

impl LocalStorage

pub fn new(path: impl Into<PathBuf>) -> LocalStorage

Create a new local storage backend rooted at path.

The directory structure is created lazily on first write.

pub fn root(&self) -> &Path

Return the root path.

Trait Implementations

impl Clone for LocalStorage

fn clone(&self) -> LocalStorage

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LocalStorage

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

Formats the value using the given formatter.

impl NarRefIndex for LocalStorage

The reverse index as a directory tree: one empty file per edge.

record is a blind create of a path that names its own content, so it is idempotent and two writers racing on the same edge simply write the same empty file. Nothing here reads a set to write it back, which is why concurrent narinfo pushes cannot lose an edge.

fn record<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, nar_path: &'life1 str, hash: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<(), StoreError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, LocalStorage: 'async_trait,

Record “hash’s narinfo advertises nar_path”. Idempotent.

fn forget<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, nar_path: &'life1 str, hash: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<(), StoreError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, LocalStorage: 'async_trait,

Forget that edge. Idempotent — forgetting an absent edge is Ok(()).

fn referrers<'life0, 'life1, 'async_trait>( &'life0 self, nar_path: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Vec<String>, StoreError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, LocalStorage: 'async_trait,

Every store-path hash whose narinfo advertises nar_path, sorted and deduplicated.

impl StorageBackend for LocalStorage

fn nar_residency(&self) -> NarResidency

O(chunk). Reads and writes go through a bounded buffer; the file’s size never appears in this process’s heap.

fn put_nar_stream<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, path: &'life1 str, src: &'life2 dyn NarSource, ) -> Pin<Box<dyn Future<Output = Result<(), StoreError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, LocalStorage: 'async_trait,

Write chunk-by-chunk through a temp file, then rename.

The rename is not tidiness: a streamed write is no longer atomic the way a single write(2) of a whole buffer was, so a crash (or an ENOSPC three chunks in — the exact live failure on the full tmpfs) would otherwise leave a truncated NAR at the real path, and a truncated NAR is silent corruption, strictly worse than the OOM being fixed. Writing aside and renaming means a partial write leaves nothing: the next read is a clean miss and the client rebuilds.

fn wipe_all<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<usize, StoreError>> + Send + 'async_trait>>

where 'life0: 'async_trait, LocalStorage: 'async_trait,

Complete L3 wipe: remove the entire cache directory (narinfos + the nar/ blob subtree), reclaiming NAR bytes a per-hash delete cannot reach. The directory is re-created lazily on the next put. Returns the narinfo count removed.

fn get_narinfo<'life0, 'life1, 'async_trait>( &'life0 self, hash: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Option<String>, StoreError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, LocalStorage: 'async_trait,

Retrieve narinfo text by store path hash.

fn put_narinfo_record<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, hash: &'life1 str, content: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<(), StoreError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, LocalStorage: 'async_trait,

Store narinfo text keyed by store path hash — the record verb: one key, no index maintenance.

fn delete_narinfo_record<'life0, 'life1, 'async_trait>( &'life0 self, hash: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), StoreError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, LocalStorage: 'async_trait,

Remove a narinfo record by store path hash. Idempotent; removing an absent narinfo is Ok(()).

fn delete_nar_record<'life0, 'life1, 'async_trait>( &'life0 self, nar_path: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), StoreError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, LocalStorage: 'async_trait,

Remove one NAR blob by its relative path. Idempotent.

fn nar_ref_index(&self) -> &dyn NarRefIndex

This backend’s narhash → store-hash reverse index.

fn get_nar<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Option<Vec<u8>>, StoreError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, LocalStorage: 'async_trait,

Retrieve a NAR blob by its relative path.

fn put_nar<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, path: &'life1 str, data: &'life2 [u8], ) -> Pin<Box<dyn Future<Output = Result<(), StoreError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, LocalStorage: 'async_trait,

Store a NAR blob at the given relative path.

fn get_nar_stream<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Option<Pin<Box<dyn Stream<Item = Result<Bytes, StoreError>> + Send>>>, StoreError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, LocalStorage: 'async_trait,

Retrieve a NAR blob as a bounded-chunk stream.

fn list_narinfos<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<String>, StoreError>> + Send + 'async_trait>>

where 'life0: 'async_trait, LocalStorage: 'async_trait,

List all stored narinfo hashes.

fn put_narinfo<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, hash: &'life1 str, content: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<(), StoreError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Self: 'async_trait,

Store narinfo text and record the reverse edge it creates.

fn advertised_nar<'life0, 'life1, 'async_trait>( &'life0 self, hash: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Option<String>, StoreError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

The NAR path this store path’s narinfo advertises — resolved, never guessed.

fn delete<'life0, 'life1, 'async_trait>( &'life0 self, hash: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), StoreError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

Delete a store path’s narinfo, and its NAR only if nothing else advertises that NAR.

fn reindex_nar_refs<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<usize, StoreError>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: 'async_trait,

Rebuild every reverse edge from the narinfos this backend holds, and return the number of edges recorded.