src/librustdoc/html/static/js/externs.js

   1 // This file contains type definitions that are processed by the Closure Compiler but are
   2 // not put into the JavaScript we include as part of the documentation. It is used for
   3 // type checking. See README.md in this directory for more info.
   4 /* eslint-env es6 */
   5 /* eslint no-var: "error" */
   6 /* eslint prefer-const: "error" */
   7
   8 /* eslint-disable */
   9 let searchState;
  10 function initSearch(searchIndex){}
  11
  12 /**
  13  * @typedef {{
  14  *     name: string,
  15  *     fullPath: Array<string>,
  16  *     pathWithoutLast: Array<string>,
  17  *     pathLast: string,
  18  *     generics: Array<QueryElement>,
  19  * }}
  20  */
  21 let QueryElement;
  22
  23 /**
  24  * @typedef {{
  25  *      pos: number,
  26  *      totalElems: number,
  27  *      typeFilter: (null|string),
  28  *      userQuery: string,
  29  * }}
  30  */
  31 let ParserState;
  32
  33 /**
  34  * @typedef {{
  35  *     original: string,
  36  *     userQuery: string,
  37  *     typeFilter: number,
  38  *     elems: Array<QueryElement>,
  39  *     args: Array<QueryElement>,
  40  *     returned: Array<QueryElement>,
  41  *     foundElems: number,
  42  * }}
  43  */
  44 let ParsedQuery;
  45
  46 /**
  47  * @typedef {{
  48  *    crate: string,
  49  *    desc: string,
  50  *    id: number,
  51  *    name: string,
  52  *    normalizedName: string,
  53  *    parent: (Object|null|undefined),
  54  *    path: string,
  55  *    ty: (Number|null|number),
  56  *    type: (Array<?>|null)
  57  * }}
  58  */
  59 let Row;
  60
  61 /**
  62  * @typedef {{
  63  *    in_args: Array<Object>,
  64  *    returned: Array<Object>,
  65  *    others: Array<Object>,
  66  *    query: ParsedQuery,
  67  * }}
  68  */
  69 let ResultsTable;
  70
  71 /**
  72  * @typedef {{
  73  *     desc: string,
  74  *     displayPath: string,
  75  *     fullPath: string,
  76  *     href: string,
  77  *     id: number,
  78  *     lev: number,
  79  *     name: string,
  80  *     normalizedName: string,
  81  *     parent: (Object|undefined),
  82  *     path: string,
  83  *     ty: number,
  84  * }}
  85  */
  86 let Results;