Struct IndexCache 

pub struct IndexCache { /* private fields */ }

The session’s graph indexes (a session config extension).

Implementations

impl IndexCache

pub fn builds(&self) -> u64

How many indexes this cache has built.

pub fn loads(&self) -> u64

How many indexes this cache has loaded from the database’s stored indexes instead of building them.

pub fn record_build(&self)

Count a build made outside the cache (an index that cannot be shared).

pub fn get(&self, key: &(String, Vec<FileIdentity>)) -> Option<Arc<GraphIndex>>

The index for key, if it is built and cached; nothing is built.

pub async fn get_or_build( &self, key: Option<(String, Vec<FileIdentity>)>, build: BoxFuture<'_, Result<GraphIndex>>, ) -> Result<Arc<GraphIndex>>

The index for key (a fingerprint and file identities), built by build if it is not cached. With no fingerprint, always built. The database’s stored indexes are not consulted: see Self::get_or_build_stored.

pub async fn get_or_build_stored( &self, config: &SessionConfig, key: Option<(String, Vec<FileIdentity>)>, build: BoxFuture<'_, Result<GraphIndex>>, ) -> Result<Arc<GraphIndex>>

As Self::get_or_build, and on a miss, the index stored under the same full key in the database of the session config belongs to, if it has one. An index built in a writable database is stored there, in the background, within the database’s ursa.index_storage_limit.

pub async fn get_or_build_for( &self, config: &SessionConfig, key: Option<(String, Vec<FileIdentity>)>, info: &BuildInfo, build: BoxFuture<'_, Result<GraphIndex>>, ) -> Result<Arc<GraphIndex>>

As Self::get_or_build_stored, with notices about the build (crate::notices) naming the graph in info.

Trait Implementations

impl Debug for IndexCache

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

Formats the value using the given formatter.

impl Default for IndexCache

fn default() -> Self

Returns the “default value” for a type.