kotlin-vscode/vscode/WorkspaceSymbolProvider

WorkspaceSymbolProvider

interface WorkspaceSymbolProvider<T : SymbolInformation>(source)

The workspace symbol provider interface defines the contract between extensions and the symbol search-feature.

Online Documentation

Properties

Link copied to clipboard
abstract var resolveWorkspaceSymbol: (symbol: T, token: CancellationToken) -> ProviderResult<T>?

Given a symbol fill in its location. This method is called whenever a symbol is selected in the UI. Providers can implement this method and return incomplete symbols from {@linkcode WorkspaceSymbolProvider.provideWorkspaceSymbols provideWorkspaceSymbols} which often helps to improve performance.

Functions

Link copied to clipboard
abstract fun provideWorkspaceSymbols(query: String, token: CancellationToken): ProviderResult<ReadonlyArray<T>>

Project-wide search for a symbol matching the given query string.