proto/indexbackend.proto

   1 // vim:ts=2:sw=2:et
   2 syntax = "proto3";
   3
   4 package proto;
   5
   6 message FilesRequest {
   7   // Text query (e.g. “i3Font”) which will be translated into a trigram query
   8   // (e.g. "3Fo" "Fon" "i3F" "ont").
   9   string query = 1;
  10 }
  11
  12 message FilesReply {
  13   // A path which match the requested trigram query (likely to match
  14   // the regular expression from which the trigram query was derived, but can
  15   // contain false positives).
  16   string path = 1;
  17 }
  18
  19 message ReplaceIndexRequest {
  20   string replacement_path = 1;
  21 }
  22
  23 message ReplaceIndexReply {
  24 }
  25
  26 // IndexBackend allows querying a trigram index.
  27 service IndexBackend {
  28   // Files returns a list of files which match the specified query in the
  29   // trigram index.
  30   rpc Files(FilesRequest) returns (stream FilesReply) {}
  31
  32   // Replaces the loaded index with the specified replacement index. On a file
  33   // system level, the specified file is mv'ed to the file specified by
  34   // -index_path.
  35   rpc ReplaceIndex(ReplaceIndexRequest) returns (ReplaceIndexReply) {}
  36 }