Skip to main content

WorkspaceCache

Struct WorkspaceCache 

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

Handle to the cache directory for a single workspace. Construction is cheap (creates directories on demand); the same handle can be shared across threads via Arc — it holds no mutable state.

Implementations§

Source§

impl WorkspaceCache

Source

pub fn new(root: &Path) -> Option<Self>

Create (or re-open) the cache directory for a workspace rooted at root. Returns None when the system has no usable home/cache directory — callers should treat that as “cache disabled” and proceed without persistence.

If the existing cache directory exceeds CACHE_SIZE_CAP, it is cleared before the handle is returned. That’s a coarse knob — K3 could refine to LRU-by-mtime — but crossing 512 MiB at startup indicates the workspace has churned through many content hashes and the rebuild cost is bounded to one full re-scan.

Source

pub fn cache_dir(&self) -> &Path

The filesystem path of this workspace’s cache directory.

Source

pub fn size_bytes(&self) -> Result<u64>

Total bytes consumed by .bin entries in this workspace’s cache directory. Cheap (one read_dir pass, no recursion into subdirectories because the layout is flat).

Source

pub fn with_dir(dir: PathBuf) -> Self

Override the root directory directly. The directory is used verbatim (no schema / workspace subdirectories are appended). Use for tests or when the caller provides an explicit cachePath initializationOption.

Source

pub fn key_for(uri: &str, content: &str) -> CacheKey

Build a cache key from file content. Combines uri and content so that two files with identical content but different URIs get different keys.

Source

pub fn read<T: DeserializeOwned>(&self, key: &CacheKey) -> Option<T>

Deserialize a previously-cached value. Returns None on any I/O or decode failure — a corrupted entry should look identical to a missing one so callers fall through to the recompute path.

Source

pub fn write<T: Serialize>(&self, key: &CacheKey, value: &T) -> Result<()>

Atomically publish an entry to the cache. Writes to a sibling temp file then renames, so readers never see a half-written payload even if the process dies mid-write.

No fsync: the cache is advisory-only — a crash that loses a write just produces a cache miss on the next startup, which safely falls back to re-parsing. Skipping sync_all() avoids 5–15 ms per file on macOS, which on a 1,500-file project accounts for most of the cold indexing time.

Source

pub fn clear(&self) -> Result<()>

Drop every entry in this workspace’s cache. Safe to call while other threads are reading — individual read calls that race with a clear will see None rather than garbage, and the next write recreates the entry.

Trait Implementations§

Source§

impl Clone for WorkspaceCache

Source§

fn clone(&self) -> WorkspaceCache

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 WorkspaceCache

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> 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> Lookup<T> for T

Source§

fn into_owned(self) -> T

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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 = 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