clang-tools  14.0.0git
Public Attributes | List of all members
clang::clangd::config::Fragment::IndexBlock::ExternalBlock Struct Reference

An external index uses data source outside of clangd itself. More...

#include <ConfigFragment.h>

Collaboration diagram for clang::clangd::config::Fragment::IndexBlock::ExternalBlock:
Collaboration graph
[legend]

Public Attributes

Located< bool > IsNone = false
 Whether the block is explicitly set to None. More...
 
llvm::Optional< Located< std::string > > File
 Path to an index file generated by clangd-indexer. More...
 
llvm::Optional< Located< std::string > > Server
 Address and port number for a clangd-index-server. More...
 
llvm::Optional< Located< std::string > > MountPoint
 Source root governed by this index. More...
 

Detailed Description

An external index uses data source outside of clangd itself.

This is usually prepared using clangd-indexer. Exactly one source (File/Server) should be configured.

Definition at line 178 of file ConfigFragment.h.

Member Data Documentation

◆ File

llvm::Optional<Located<std::string> > clang::clangd::config::Fragment::IndexBlock::ExternalBlock::File

Path to an index file generated by clangd-indexer.

Relative paths may be used, if config fragment is associated with a directory.

Definition at line 184 of file ConfigFragment.h.

◆ IsNone

Located<bool> clang::clangd::config::Fragment::IndexBlock::ExternalBlock::IsNone = false

Whether the block is explicitly set to None.

Can be used to clear any external index specified before.

Definition at line 181 of file ConfigFragment.h.

◆ MountPoint

llvm::Optional<Located<std::string> > clang::clangd::config::Fragment::IndexBlock::ExternalBlock::MountPoint

Source root governed by this index.

Default is the directory associated with the config fragment. Absolute in case of user config and relative otherwise. Should always use forward-slashes.

Definition at line 191 of file ConfigFragment.h.

◆ Server

llvm::Optional<Located<std::string> > clang::clangd::config::Fragment::IndexBlock::ExternalBlock::Server

Address and port number for a clangd-index-server.

e.g. 123.1.1.1:13337.

Definition at line 187 of file ConfigFragment.h.


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