Skip to main content

PackIndexCache

Struct PackIndexCache 

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

In-process LRU cache of decoded pack indices keyed by (prefix, content-sha).

Capacity is bounded by byte size, not entry count: a single 1 GB pack carries an .idx file of multiple MiB, so an entry-count cap would either over- or under-budget for realistic chains. Eviction is least-recently-used.

The cache is Send + Sync and shareable across read_blob calls. Multiple concurrent calls block briefly on the inner mutex during lookup / insert; the inflate / range-GET work happens outside the lock so contention stays bounded.

§LRU bookkeeping cost

get and insert walk the order VecDeque via iter().position to move the touched key to the back — O(n) in the cache size. For typical packchain workloads (single-digit indices in flight), the constant factor dominates and this is faster than a true O(1) linked-list LRU. If a workload starts seeing hundreds of cached indices, this should be revisited (e.g. swap to the lru crate or hand-roll a HashMap + intrusive doubly-linked list). The simple shape is intentional for now.

§Example

use git_remote_object_store::{packchain::PackIndexCache, Remote};

let remote = Remote::connect("s3+https://bucket/repo?engine=packchain").await?;
let cache = PackIndexCache::default();
let bytes = git_remote_object_store::packchain::read_blob(
    &remote,
    "refs/heads/main",
    "src/main.rs",
    &cache,
).await?;
println!("{}", String::from_utf8_lossy(&bytes));

Implementations§

Source§

impl PackIndexCache

Source

pub fn new(capacity_bytes: u64) -> Self

Construct a cache with the requested byte budget.

capacity_bytes of zero disables caching (every lookup misses). Use Self::default for the standard 64 MiB budget.

Source

pub fn resident_bytes(&self) -> u64

Total resident bytes accounted for by the cache.

§Panics

Panics only if a previous holder of the inner mutex panicked while mutating cache state — an invariant violation that would be unsafe to silently recover from.

Source

pub fn len(&self) -> usize

Number of cached entries.

§Panics

See Self::resident_bytes.

Source

pub fn is_empty(&self) -> bool

Whether the cache currently holds zero entries.

Trait Implementations§

Source§

impl Debug for PackIndexCache

Source§

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

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

impl Default for PackIndexCache

Source§

fn default() -> Self

Returns the “default value” for a type. 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<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
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> 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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