quarkdown-lsp/com.quarkdown.lsp.cache/CacheableFunctionCatalogue

CacheableFunctionCatalogue

A cache for functions extracted from the Quarkdown documentation. This cache is used to avoid walking and parsing the documentation files, improving performance throughout the language server.

Functions

getCatalogue

fun getCatalogue(docsDirectory: DocsDirectory): Sequence<DocumentedFunction>

Retrieves the functions from the cache for the given documentation directory. If the cache is empty, it attempts to store the catalogue first. If no functions are found again, an empty sequence is returned.

searchAll

fun searchAll(docsDirectory: DocsDirectory, nameQuery: String): Sequence<DocumentedFunction>

Searches for functions whose names start with the given query string, case-insensitively.

storeCatalogue

fun storeCatalogue(docsDirectory: DocsDirectory)

Stores the functions extracted from the documentation files in the cache, overwriting any existing entries for the given directory. Results are not stored if no functions are found.