Skip to main content

BinaryCacheStore

Struct BinaryCacheStore 

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

A read-only binary cache store accessed over HTTP.

Implementations§

Source§

impl BinaryCacheStore

Source

pub fn builder(base_url: &str) -> BinaryCacheStoreBuilder

Create a builder for a binary cache store with the given base URL.

Source

pub fn new(base_url: &str, trusted_keys: Vec<String>) -> Self

Create a new binary cache client with default HTTP backend.

Source

pub fn with_http_client( base_url: &str, trusted_keys: Vec<String>, client: Box<dyn HttpClient>, ) -> Self

Create a new binary cache client with a custom HTTP backend.

Source

pub async fn fetch_narinfo(&self, hash: &str) -> StoreResult<Option<NarInfo>>

Fetch NarInfo for a store path hash.

Source

pub fn base_url(&self) -> &str

Return the base URL of this binary cache (without trailing slash).

Source

pub fn trusted_keys(&self) -> &[String]

Return the trusted public keys used for signature verification.

Source

pub fn auth_header(&self) -> Option<(&str, &str)>

Return the configured authorization header, if any.

Source

pub async fn fetch_nar(&self, url_path: &str) -> StoreResult<Vec<u8>>

Download a NAR file from the cache.

Source

pub fn verify_narinfo_signatures( narinfo: &NarInfo, trusted_keys: &[String], ) -> StoreResult<bool>

Verify that a NarInfo has at least one valid signature from the trusted keys.

The NarInfo fingerprint is: 1;{storePath};{narHash};{narSize};{sortedReferences}. Each signature in the NarInfo is in keyname:base64sig format. Each trusted key is in keyname:base64pubkey format.

Returns Ok(true) if at least one signature matches a trusted key, Ok(false) if no trusted keys are provided or no signatures match.

Trait Implementations§

Source§

impl Store for BinaryCacheStore

Source§

fn query_path_info<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 StorePath, ) -> Pin<Box<dyn Future<Output = StoreResult<Option<PathInfo>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Query information about a store path.
Source§

fn is_valid_path<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 StorePath, ) -> Pin<Box<dyn Future<Output = StoreResult<bool>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Check whether a store path is valid (registered in the store).
Source§

fn query_all_valid_paths<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = StoreResult<Vec<StorePath>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

List all valid store paths.
Source§

fn query_references<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 StorePath, ) -> Pin<Box<dyn Future<Output = StoreResult<Vec<StorePath>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Query the runtime references (dependencies) of a store path.
Source§

fn compute_closure<'life0, 'life1, 'async_trait>( &'life0 self, roots: &'life1 [StorePath], ) -> Pin<Box<dyn Future<Output = StoreResult<Vec<StorePath>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Compute the transitive closure of a set of store paths. Read more
Source§

fn collect_garbage<'life0, 'life1, 'async_trait>( &'life0 self, _options: &'life1 GcOptions, ) -> Pin<Box<dyn Future<Output = StoreResult<GcResult>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Run garbage collection on the store.
Source§

fn add_to_store<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, _name: &'life1 str, _nar_data: &'life2 [u8], _references: &'life3 [String], ) -> Pin<Box<dyn Future<Output = StoreResult<PathInfo>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Add a store path with its NAR content. Returns the registered PathInfo.
Source§

fn register_path<'life0, 'life1, 'async_trait>( &'life0 self, _info: &'life1 PathInfo, ) -> Pin<Box<dyn Future<Output = StoreResult<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Register a pre-built path in the store database.
Source§

fn add_signatures<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _path: &'life1 StorePath, _signatures: &'life2 [String], ) -> Pin<Box<dyn Future<Output = StoreResult<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Add signatures to an existing store path.
Source§

fn query_referrers<'life0, 'life1, 'async_trait>( &'life0 self, _path: &'life1 StorePath, ) -> Pin<Box<dyn Future<Output = StoreResult<Vec<StorePath>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Query paths that refer to the given path (reverse dependencies).
Source§

fn verify_store<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = StoreResult<VerifyResult>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Verify store integrity by checking NAR hashes of all valid paths.
Source§

fn delete_path<'life0, 'life1, 'async_trait>( &'life0 self, _path: &'life1 StorePath, ) -> Pin<Box<dyn Future<Output = StoreResult<u64>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Delete a store path from disk and the database. Read more
Source§

fn optimise_store<'life0, 'async_trait>( &'life0 self, _dry_run: bool, ) -> Pin<Box<dyn Future<Output = StoreResult<OptimiseResult>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Optimise the store by hard-linking identical files. 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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more