Skip to main content

NegativeCache

Struct NegativeCache 

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

Thread-safe negative cache for filesystem lookups.

Caches paths that are known to not exist, avoiding repeated system calls for non-existent files. Uses lock-free concurrent access via DashMap.

When adaptive TTL is configured, different paths receive different cache durations based on pattern matching. For example, lookups inside /node_modules/ get a 30s TTL while source files default to 5s.

§Example

use std::time::Duration;
use std::path::PathBuf;
use arcbox_fs::cache::{NegativeCache, NegativeCacheConfig};

let config = NegativeCacheConfig {
    max_entries: 1000,
    timeout: Duration::from_millis(500),
    adaptive_ttl: None,
};
let cache = NegativeCache::new(config);

// File lookup failed, add to negative cache
cache.insert(PathBuf::from("/app/node_modules/missing-package"));

// Later lookup - returns true without syscall
assert!(cache.contains(&PathBuf::from("/app/node_modules/missing-package")));

// File created - invalidate cache
cache.invalidate(&PathBuf::from("/app/node_modules/missing-package"));
assert!(!cache.contains(&PathBuf::from("/app/node_modules/missing-package")));

Implementations§

Source§

impl NegativeCache

Source

pub fn new(config: NegativeCacheConfig) -> Self

Creates a new negative cache with the given configuration.

Source

pub fn with_defaults() -> Self

Creates a new negative cache with default configuration (adaptive TTL enabled).

Source

pub fn contains(&self, path: &Path) -> bool

Checks if the path is in the negative cache and not expired.

Returns true if the path was previously marked as non-existent and the cache entry has not expired.

Source

pub fn insert(&self, path: PathBuf)

Adds a path to the negative cache.

The TTL is determined by adaptive TTL rules if configured, or by the global timeout value otherwise.

If the cache is at capacity, expired entries are evicted first.

Source

pub fn invalidate(&self, path: &Path)

Invalidates a path in the negative cache.

This should be called when a file is created to ensure subsequent lookups don’t incorrectly return “not found” from the cache.

Also invalidates the parent directory path to handle cases where the parent’s directory listing was cached.

Source

pub fn evict_expired(&self)

Removes all expired entries from the cache.

This is called automatically when the cache reaches capacity, but can also be called manually for maintenance.

Source

pub fn stats(&self) -> NegativeCacheStats

Returns current cache statistics.

Source

pub fn clear(&self)

Clears all entries from the cache.

Source

pub fn len(&self) -> usize

Returns the current number of entries in the cache.

Source

pub fn is_empty(&self) -> bool

Returns true if the cache is empty.

Trait Implementations§

Source§

impl Debug for NegativeCache

Source§

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

Formats the value using the given formatter. 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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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