Skip to main content

CacheConfig

Struct CacheConfig 

Source
#[non_exhaustive]
pub struct CacheConfig { pub enabled: bool, pub fetch_timeout_secs: u64, pub max_concurrent_fetches: usize, }
Expand description

Configuration for HTTP caching behavior.

Controls cache settings for registry requests. The cache uses ETag and Last-Modified headers for validation, minimizing network traffic.

§Defaults

  • enabled: true
  • fetch_timeout_secs: 10 (10 seconds per package)
  • max_concurrent_fetches: 20 (20 concurrent requests)

§Examples

use deps_core::policy_config::CacheConfig;

let config = CacheConfig::new()
    .with_fetch_timeout_secs(5)
    .with_max_concurrent_fetches(20);

assert_eq!(config.fetch_timeout_secs, 5);

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§enabled: bool

Whether deps_core::cache::HttpCache’s entry map is used at all (issue #482): false bypasses it entirely (fetch fresh every time, never store).

Offline override: while network.offline (see NetworkConfig::offline) is set, this flag’s false value is overridden and treated as true — otherwise a warm entry fetched before going offline could never survive an online→offline transition, since nothing would have been stored while online in the first place.

Maven exception: deps-maven’s peek_cached-based stale-data fallback (crates/deps-maven/src/registry.rs) behaves differently from every other ecosystem under enabled: false, which has no equivalent second-layer fallback to diverge on. This only “always misses” for a process that started cold with the flag already off — peek_cached reads the entry map directly and set_cache_enabled never clears it, so a live true -> false toggle leaves every already-stored entry servable through this fallback indefinitely.

§fetch_timeout_secs: u64

Timeout for fetching a single package’s versions (default: 10 seconds)

§max_concurrent_fetches: usize

Maximum concurrent package fetches (default: 20)

Implementations§

Source§

impl CacheConfig

Source

pub const fn new() -> Self

Builds the default configuration (mirrors Self::default).

§Examples
use deps_core::policy_config::CacheConfig;

let config = CacheConfig::new();
assert!(config.enabled);
Source

pub const fn with_enabled(self, enabled: bool) -> Self

Overrides Self::enabled. See Self::new.

Source

pub const fn with_fetch_timeout_secs(self, fetch_timeout_secs: u64) -> Self

Overrides Self::fetch_timeout_secs. See Self::new. Not clamped to the bounds deserialize_fetch_timeout enforces — that validation only guards untrusted LSP-client input, not construction from trusted Rust code.

Source

pub const fn with_max_concurrent_fetches( self, max_concurrent_fetches: usize, ) -> Self

Overrides Self::max_concurrent_fetches. See Self::new. Enforces the same >= 1 floor (MIN_CONCURRENT_FETCHES) that deserialize_max_concurrent enforces on untrusted LSP-client input — but, unlike that deserializer, does not also cap the MAX_CONCURRENT_FETCHES ceiling, so a very large value passes through uncapped: this value is used directly as futures::StreamExt::buffer_unordered’s concurrency limit (document::fetch), and buffer_unordered(0) never polls its source stream, hanging the fetch forever instead of erroring (issue #833) — unlike Self::with_fetch_timeout_secs, 0 here is not a merely degenerate value, so this setter enforces the floor itself rather than relying on a downstream re-guard (handlers::diagnostics::loading_ceiling also re-guards its own divisor, but that is a second, independent consumer, not a safety net for this one).

§Examples
use deps_core::policy_config::CacheConfig;

let config = CacheConfig::new().with_max_concurrent_fetches(0);
assert_eq!(config.max_concurrent_fetches, 1);

Trait Implementations§

Source§

impl Clone for CacheConfig

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CacheConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for CacheConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for CacheConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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: Sized + 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.
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