clang-tools  7.0.0
Public Attributes | List of all members
clang::clangd::FuzzyFindRequest Struct Reference

#include <Index.h>

Collaboration diagram for clang::clangd::FuzzyFindRequest:
[legend]

Public Attributes

std::string Query
 A query string for the fuzzy find. More...
 
std::vector< std::string > Scopes
 If this is non-empty, symbols must be in at least one of the scopes (e.g. More...
 
size_t MaxCandidateCount = UINT_MAX
 The number of top candidates to return. More...
 
bool RestrictForCodeCompletion = false
 If set to true, only symbols for completion support will be considered. More...
 
std::vector< std::string > ProximityPaths
 Contextually relevant files (e.g. More...
 

Detailed Description

Definition at line 290 of file Index.h.

Member Data Documentation

◆ MaxCandidateCount

size_t clang::clangd::FuzzyFindRequest::MaxCandidateCount = UINT_MAX

The number of top candidates to return.

The index may choose to return more than this, e.g. if it doesn't know which candidates are best.

Definition at line 303 of file Index.h.

Referenced by clang::clangd::MemIndex::fuzzyFind().

◆ ProximityPaths

std::vector<std::string> clang::clangd::FuzzyFindRequest::ProximityPaths

Contextually relevant files (e.g.

the file we're code-completing in). Paths should be absolute.

Definition at line 308 of file Index.h.

◆ Query

std::string clang::clangd::FuzzyFindRequest::Query

A query string for the fuzzy find.

This is matched against symbols' un-qualified identifiers and should not contain qualifiers like "::".

Definition at line 293 of file Index.h.

Referenced by clang::clangd::MemIndex::fuzzyFind().

◆ RestrictForCodeCompletion

bool clang::clangd::FuzzyFindRequest::RestrictForCodeCompletion = false

If set to true, only symbols for completion support will be considered.

Definition at line 305 of file Index.h.

Referenced by clang::clangd::MemIndex::fuzzyFind().

◆ Scopes

std::vector<std::string> clang::clangd::FuzzyFindRequest::Scopes

If this is non-empty, symbols must be in at least one of the scopes (e.g.

namespaces) excluding nested scopes. For example, if a scope "xyz::" is provided, the matched symbols must be defined in namespace xyz but not namespace xyz::abc.

The global scope is "", a top level scope is "foo::", etc.

Definition at line 300 of file Index.h.

Referenced by clang::clangd::MemIndex::fuzzyFind().


The documentation for this struct was generated from the following file: