index.html 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  6. <meta name="generator" content="rustdoc">
  7. <meta name="description" content="API documentation for the Rust `syn` crate.">
  8. <meta name="keywords" content="rust, rustlang, rust-lang, syn">
  9. <title>syn - Rust</title>
  10. <link rel="stylesheet" type="text/css" href="../normalize.css">
  11. <link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle">
  12. <link rel="stylesheet" type="text/css" href="../dark.css">
  13. <link rel="stylesheet" type="text/css" href="../main.css" id="themeStyle">
  14. <script src="../storage.js"></script>
  15. </head>
  16. <body class="rustdoc mod">
  17. <!--[if lte IE 8]>
  18. <div class="warning">
  19. This old browser is unsupported and will most likely display funky
  20. things.
  21. </div>
  22. <![endif]-->
  23. <nav class="sidebar">
  24. <div class="sidebar-menu">&#9776;</div>
  25. <p class='location'>Crate syn</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'syn', ty: 'mod', relpath: '../'};</script></div>
  26. </nav>
  27. <div class="theme-picker">
  28. <button id="theme-picker" aria-label="Pick another theme!">
  29. <img src="../brush.svg" width="18" alt="Pick another theme!">
  30. </button>
  31. <div id="theme-choices"></div>
  32. </div>
  33. <script src="../theme.js"></script>
  34. <nav class="sub">
  35. <form class="search-form js-only">
  36. <div class="search-container">
  37. <input class="search-input" name="search"
  38. autocomplete="off"
  39. placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
  40. type="search">
  41. </div>
  42. </form>
  43. </nav>
  44. <section id='main' class="content">
  45. <h1 class='fqn'><span class='in-band'>Crate <a class="mod" href=''>syn</a></span><span class='out-of-band'><span id='render-detail'>
  46. <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
  47. [<span class='inner'>&#x2212;</span>]
  48. </a>
  49. </span><a class='srclink' href='../src/syn/lib.rs.html#1-211' title='goto source code'>[src]</a></span></h1>
  50. <h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
  51. <table>
  52. <tr class=' module-item'>
  53. <td><a class="mod" href="parse/index.html"
  54. title='mod syn::parse'>parse</a></td>
  55. <td class='docblock-short'>
  56. <p>This module contains a set of exported nom parsers which can be used to
  57. parse custom grammars when used alongside the <code>synom</code> crate.</p>
  58. </td>
  59. </tr>
  60. <tr class=' module-item'>
  61. <td><a class="mod" href="visit/index.html"
  62. title='mod syn::visit'>visit</a></td>
  63. <td class='docblock-short'>
  64. <p>AST walker. Each overridden visit method has full control over what
  65. happens with its node, it can do its own traversal of the node's children,
  66. call <code>visit::walk_*</code> to apply the default traversal algorithm, or prevent
  67. deeper traversal by doing nothing.</p>
  68. </td>
  69. </tr></table><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
  70. <table>
  71. <tr class=' module-item'>
  72. <td><a class="struct" href="struct.AngleBracketedParameterData.html"
  73. title='struct syn::AngleBracketedParameterData'>AngleBracketedParameterData</a></td>
  74. <td class='docblock-short'>
  75. <p>A path like <code>Foo&lt;'a, T&gt;</code></p>
  76. </td>
  77. </tr>
  78. <tr class=' module-item'>
  79. <td><a class="struct" href="struct.Attribute.html"
  80. title='struct syn::Attribute'>Attribute</a></td>
  81. <td class='docblock-short'>
  82. <p>Doc-comments are promoted to attributes that have <code>is_sugared_doc</code> = true</p>
  83. </td>
  84. </tr>
  85. <tr class=' module-item'>
  86. <td><a class="struct" href="struct.BareFnArg.html"
  87. title='struct syn::BareFnArg'>BareFnArg</a></td>
  88. <td class='docblock-short'>
  89. <p>An argument in a function type.</p>
  90. </td>
  91. </tr>
  92. <tr class=' module-item'>
  93. <td><a class="struct" href="struct.BareFnTy.html"
  94. title='struct syn::BareFnTy'>BareFnTy</a></td>
  95. <td class='docblock-short'>
  96. </td>
  97. </tr>
  98. <tr class=' module-item'>
  99. <td><a class="struct" href="struct.ByteStrLit.html"
  100. title='struct syn::ByteStrLit'>ByteStrLit</a></td>
  101. <td class='docblock-short'>
  102. </td>
  103. </tr>
  104. <tr class=' module-item'>
  105. <td><a class="struct" href="struct.Delimited.html"
  106. title='struct syn::Delimited'>Delimited</a></td>
  107. <td class='docblock-short'>
  108. </td>
  109. </tr>
  110. <tr class=' module-item'>
  111. <td><a class="struct" href="struct.DeriveInput.html"
  112. title='struct syn::DeriveInput'>DeriveInput</a></td>
  113. <td class='docblock-short'>
  114. <p>Struct or enum sent to a <code>proc_macro_derive</code> macro.</p>
  115. </td>
  116. </tr>
  117. <tr class=' module-item'>
  118. <td><a class="struct" href="struct.Field.html"
  119. title='struct syn::Field'>Field</a></td>
  120. <td class='docblock-short'>
  121. <p>A field of a struct or enum variant.</p>
  122. </td>
  123. </tr>
  124. <tr class=' module-item'>
  125. <td><a class="struct" href="struct.FloatLit.html"
  126. title='struct syn::FloatLit'>FloatLit</a></td>
  127. <td class='docblock-short'>
  128. </td>
  129. </tr>
  130. <tr class=' module-item'>
  131. <td><a class="struct" href="struct.Generics.html"
  132. title='struct syn::Generics'>Generics</a></td>
  133. <td class='docblock-short'>
  134. <p>Represents lifetimes and type parameters attached to a declaration
  135. of a function, enum, trait, etc.</p>
  136. </td>
  137. </tr>
  138. <tr class=' module-item'>
  139. <td><a class="struct" href="struct.Ident.html"
  140. title='struct syn::Ident'>Ident</a></td>
  141. <td class='docblock-short'>
  142. </td>
  143. </tr>
  144. <tr class=' module-item'>
  145. <td><a class="struct" href="struct.ImplGenerics.html"
  146. title='struct syn::ImplGenerics'>ImplGenerics</a></td>
  147. <td class='docblock-short'>
  148. <p>Returned by <code>Generics::split_for_impl</code>.</p>
  149. </td>
  150. </tr>
  151. <tr class=' module-item'>
  152. <td><a class="struct" href="struct.IntLit.html"
  153. title='struct syn::IntLit'>IntLit</a></td>
  154. <td class='docblock-short'>
  155. </td>
  156. </tr>
  157. <tr class=' module-item'>
  158. <td><a class="struct" href="struct.Lifetime.html"
  159. title='struct syn::Lifetime'>Lifetime</a></td>
  160. <td class='docblock-short'>
  161. </td>
  162. </tr>
  163. <tr class=' module-item'>
  164. <td><a class="struct" href="struct.LifetimeDef.html"
  165. title='struct syn::LifetimeDef'>LifetimeDef</a></td>
  166. <td class='docblock-short'>
  167. <p>A lifetime definition, e.g. <code>'a: 'b+'c+'d</code></p>
  168. </td>
  169. </tr>
  170. <tr class=' module-item'>
  171. <td><a class="struct" href="struct.Mac.html"
  172. title='struct syn::Mac'>Mac</a></td>
  173. <td class='docblock-short'>
  174. <p>Represents a macro invocation. The Path indicates which macro
  175. is being invoked, and the vector of token-trees contains the source
  176. of the macro invocation.</p>
  177. </td>
  178. </tr>
  179. <tr class=' module-item'>
  180. <td><a class="struct" href="struct.MutTy.html"
  181. title='struct syn::MutTy'>MutTy</a></td>
  182. <td class='docblock-short'>
  183. </td>
  184. </tr>
  185. <tr class=' module-item'>
  186. <td><a class="struct" href="struct.ParenthesizedParameterData.html"
  187. title='struct syn::ParenthesizedParameterData'>ParenthesizedParameterData</a></td>
  188. <td class='docblock-short'>
  189. <p>A path like <code>Foo(A,B) -&gt; C</code></p>
  190. </td>
  191. </tr>
  192. <tr class=' module-item'>
  193. <td><a class="struct" href="struct.Path.html"
  194. title='struct syn::Path'>Path</a></td>
  195. <td class='docblock-short'>
  196. <p>A &quot;Path&quot; is essentially Rust's notion of a name.</p>
  197. </td>
  198. </tr>
  199. <tr class=' module-item'>
  200. <td><a class="struct" href="struct.PathSegment.html"
  201. title='struct syn::PathSegment'>PathSegment</a></td>
  202. <td class='docblock-short'>
  203. <p>A segment of a path: an identifier, an optional lifetime, and a set of types.</p>
  204. </td>
  205. </tr>
  206. <tr class=' module-item'>
  207. <td><a class="struct" href="struct.PolyTraitRef.html"
  208. title='struct syn::PolyTraitRef'>PolyTraitRef</a></td>
  209. <td class='docblock-short'>
  210. </td>
  211. </tr>
  212. <tr class=' module-item'>
  213. <td><a class="struct" href="struct.QSelf.html"
  214. title='struct syn::QSelf'>QSelf</a></td>
  215. <td class='docblock-short'>
  216. <p>The explicit Self type in a &quot;qualified path&quot;. The actual
  217. path, including the trait and the associated item, is stored
  218. separately. <code>position</code> represents the index of the associated
  219. item qualified with this Self type.</p>
  220. </td>
  221. </tr>
  222. <tr class=' module-item'>
  223. <td><a class="struct" href="struct.StrLit.html"
  224. title='struct syn::StrLit'>StrLit</a></td>
  225. <td class='docblock-short'>
  226. </td>
  227. </tr>
  228. <tr class=' module-item'>
  229. <td><a class="struct" href="struct.Turbofish.html"
  230. title='struct syn::Turbofish'>Turbofish</a></td>
  231. <td class='docblock-short'>
  232. <p>Returned by <code>TyGenerics::as_turbofish</code>.</p>
  233. </td>
  234. </tr>
  235. <tr class=' module-item'>
  236. <td><a class="struct" href="struct.TyGenerics.html"
  237. title='struct syn::TyGenerics'>TyGenerics</a></td>
  238. <td class='docblock-short'>
  239. <p>Returned by <code>Generics::split_for_impl</code>.</p>
  240. </td>
  241. </tr>
  242. <tr class=' module-item'>
  243. <td><a class="struct" href="struct.TyParam.html"
  244. title='struct syn::TyParam'>TyParam</a></td>
  245. <td class='docblock-short'>
  246. <p>A generic type parameter, e.g. <code>T: Into&lt;String&gt;</code>.</p>
  247. </td>
  248. </tr>
  249. <tr class=' module-item'>
  250. <td><a class="struct" href="struct.TypeBinding.html"
  251. title='struct syn::TypeBinding'>TypeBinding</a></td>
  252. <td class='docblock-short'>
  253. <p>Bind a type to an associated type: <code>A=Foo</code>.</p>
  254. </td>
  255. </tr>
  256. <tr class=' module-item'>
  257. <td><a class="struct" href="struct.Variant.html"
  258. title='struct syn::Variant'>Variant</a></td>
  259. <td class='docblock-short'>
  260. <p>An enum variant.</p>
  261. </td>
  262. </tr>
  263. <tr class=' module-item'>
  264. <td><a class="struct" href="struct.WhereBoundPredicate.html"
  265. title='struct syn::WhereBoundPredicate'>WhereBoundPredicate</a></td>
  266. <td class='docblock-short'>
  267. <p>A type bound.</p>
  268. </td>
  269. </tr>
  270. <tr class=' module-item'>
  271. <td><a class="struct" href="struct.WhereClause.html"
  272. title='struct syn::WhereClause'>WhereClause</a></td>
  273. <td class='docblock-short'>
  274. <p>A <code>where</code> clause in a definition</p>
  275. </td>
  276. </tr>
  277. <tr class=' module-item'>
  278. <td><a class="struct" href="struct.WhereEqPredicate.html"
  279. title='struct syn::WhereEqPredicate'>WhereEqPredicate</a></td>
  280. <td class='docblock-short'>
  281. <p>An equality predicate (unsupported).</p>
  282. </td>
  283. </tr>
  284. <tr class=' module-item'>
  285. <td><a class="struct" href="struct.WhereRegionPredicate.html"
  286. title='struct syn::WhereRegionPredicate'>WhereRegionPredicate</a></td>
  287. <td class='docblock-short'>
  288. <p>A lifetime predicate.</p>
  289. </td>
  290. </tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
  291. <table>
  292. <tr class=' module-item'>
  293. <td><a class="enum" href="enum.Abi.html"
  294. title='enum syn::Abi'>Abi</a></td>
  295. <td class='docblock-short'>
  296. </td>
  297. </tr>
  298. <tr class=' module-item'>
  299. <td><a class="enum" href="enum.AttrStyle.html"
  300. title='enum syn::AttrStyle'>AttrStyle</a></td>
  301. <td class='docblock-short'>
  302. <p>Distinguishes between Attributes that decorate items and Attributes that
  303. are contained as statements within items. These two cases need to be
  304. distinguished for pretty-printing.</p>
  305. </td>
  306. </tr>
  307. <tr class=' module-item'>
  308. <td><a class="enum" href="enum.BinOp.html"
  309. title='enum syn::BinOp'>BinOp</a></td>
  310. <td class='docblock-short'>
  311. </td>
  312. </tr>
  313. <tr class=' module-item'>
  314. <td><a class="enum" href="enum.BinOpToken.html"
  315. title='enum syn::BinOpToken'>BinOpToken</a></td>
  316. <td class='docblock-short'>
  317. </td>
  318. </tr>
  319. <tr class=' module-item'>
  320. <td><a class="enum" href="enum.Body.html"
  321. title='enum syn::Body'>Body</a></td>
  322. <td class='docblock-short'>
  323. <p>Body of a derived struct or enum.</p>
  324. </td>
  325. </tr>
  326. <tr class=' module-item'>
  327. <td><a class="enum" href="enum.ConstExpr.html"
  328. title='enum syn::ConstExpr'>ConstExpr</a></td>
  329. <td class='docblock-short'>
  330. </td>
  331. </tr>
  332. <tr class=' module-item'>
  333. <td><a class="enum" href="enum.DelimToken.html"
  334. title='enum syn::DelimToken'>DelimToken</a></td>
  335. <td class='docblock-short'>
  336. <p>A delimiter token</p>
  337. </td>
  338. </tr>
  339. <tr class=' module-item'>
  340. <td><a class="enum" href="enum.FloatTy.html"
  341. title='enum syn::FloatTy'>FloatTy</a></td>
  342. <td class='docblock-short'>
  343. </td>
  344. </tr>
  345. <tr class=' module-item'>
  346. <td><a class="enum" href="enum.FunctionRetTy.html"
  347. title='enum syn::FunctionRetTy'>FunctionRetTy</a></td>
  348. <td class='docblock-short'>
  349. </td>
  350. </tr>
  351. <tr class=' module-item'>
  352. <td><a class="enum" href="enum.IntTy.html"
  353. title='enum syn::IntTy'>IntTy</a></td>
  354. <td class='docblock-short'>
  355. </td>
  356. </tr>
  357. <tr class=' module-item'>
  358. <td><a class="enum" href="enum.Lit.html"
  359. title='enum syn::Lit'>Lit</a></td>
  360. <td class='docblock-short'>
  361. <p>Literal kind.</p>
  362. </td>
  363. </tr>
  364. <tr class=' module-item'>
  365. <td><a class="enum" href="enum.MetaItem.html"
  366. title='enum syn::MetaItem'>MetaItem</a></td>
  367. <td class='docblock-short'>
  368. <p>A compile-time attribute item.</p>
  369. </td>
  370. </tr>
  371. <tr class=' module-item'>
  372. <td><a class="enum" href="enum.Mutability.html"
  373. title='enum syn::Mutability'>Mutability</a></td>
  374. <td class='docblock-short'>
  375. </td>
  376. </tr>
  377. <tr class=' module-item'>
  378. <td><a class="enum" href="enum.NestedMetaItem.html"
  379. title='enum syn::NestedMetaItem'>NestedMetaItem</a></td>
  380. <td class='docblock-short'>
  381. <p>Possible values inside of compile-time attribute lists.</p>
  382. </td>
  383. </tr>
  384. <tr class=' module-item'>
  385. <td><a class="enum" href="enum.PathParameters.html"
  386. title='enum syn::PathParameters'>PathParameters</a></td>
  387. <td class='docblock-short'>
  388. <p>Parameters of a path segment.</p>
  389. </td>
  390. </tr>
  391. <tr class=' module-item'>
  392. <td><a class="enum" href="enum.StrStyle.html"
  393. title='enum syn::StrStyle'>StrStyle</a></td>
  394. <td class='docblock-short'>
  395. </td>
  396. </tr>
  397. <tr class=' module-item'>
  398. <td><a class="enum" href="enum.Token.html"
  399. title='enum syn::Token'>Token</a></td>
  400. <td class='docblock-short'>
  401. </td>
  402. </tr>
  403. <tr class=' module-item'>
  404. <td><a class="enum" href="enum.TokenTree.html"
  405. title='enum syn::TokenTree'>TokenTree</a></td>
  406. <td class='docblock-short'>
  407. <p>When the main rust parser encounters a syntax-extension invocation, it
  408. parses the arguments to the invocation as a token-tree. This is a very
  409. loose structure, such that all sorts of different AST-fragments can
  410. be passed to syntax extensions using a uniform type.</p>
  411. </td>
  412. </tr>
  413. <tr class=' module-item'>
  414. <td><a class="enum" href="enum.TraitBoundModifier.html"
  415. title='enum syn::TraitBoundModifier'>TraitBoundModifier</a></td>
  416. <td class='docblock-short'>
  417. <p>A modifier on a bound, currently this is only used for <code>?Sized</code>, where the
  418. modifier is <code>Maybe</code>. Negative bounds should also be handled here.</p>
  419. </td>
  420. </tr>
  421. <tr class=' module-item'>
  422. <td><a class="enum" href="enum.Ty.html"
  423. title='enum syn::Ty'>Ty</a></td>
  424. <td class='docblock-short'>
  425. <p>The different kinds of types recognized by the compiler</p>
  426. </td>
  427. </tr>
  428. <tr class=' module-item'>
  429. <td><a class="enum" href="enum.TyParamBound.html"
  430. title='enum syn::TyParamBound'>TyParamBound</a></td>
  431. <td class='docblock-short'>
  432. <p>The AST represents all type param bounds as types.
  433. <code>typeck::collect::compute_bounds</code> matches these against
  434. the &quot;special&quot; built-in traits (see <code>middle::lang_items</code>) and
  435. detects Copy, Send and Sync.</p>
  436. </td>
  437. </tr>
  438. <tr class=' module-item'>
  439. <td><a class="enum" href="enum.UnOp.html"
  440. title='enum syn::UnOp'>UnOp</a></td>
  441. <td class='docblock-short'>
  442. </td>
  443. </tr>
  444. <tr class=' module-item'>
  445. <td><a class="enum" href="enum.Unsafety.html"
  446. title='enum syn::Unsafety'>Unsafety</a></td>
  447. <td class='docblock-short'>
  448. </td>
  449. </tr>
  450. <tr class=' module-item'>
  451. <td><a class="enum" href="enum.VariantData.html"
  452. title='enum syn::VariantData'>VariantData</a></td>
  453. <td class='docblock-short'>
  454. <p>Data stored within an enum variant or struct.</p>
  455. </td>
  456. </tr>
  457. <tr class=' module-item'>
  458. <td><a class="enum" href="enum.Visibility.html"
  459. title='enum syn::Visibility'>Visibility</a></td>
  460. <td class='docblock-short'>
  461. <p>Visibility level of an item.</p>
  462. </td>
  463. </tr>
  464. <tr class=' module-item'>
  465. <td><a class="enum" href="enum.WherePredicate.html"
  466. title='enum syn::WherePredicate'>WherePredicate</a></td>
  467. <td class='docblock-short'>
  468. <p>A single predicate in a <code>where</code> clause</p>
  469. </td>
  470. </tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
  471. <table>
  472. <tr class=' module-item'>
  473. <td><a class="fn" href="fn.parse_derive_input.html"
  474. title='fn syn::parse_derive_input'>parse_derive_input</a></td>
  475. <td class='docblock-short'>
  476. </td>
  477. </tr>
  478. <tr class=' module-item'>
  479. <td><a class="fn" href="fn.parse_ident.html"
  480. title='fn syn::parse_ident'>parse_ident</a></td>
  481. <td class='docblock-short'>
  482. </td>
  483. </tr>
  484. <tr class=' module-item'>
  485. <td><a class="fn" href="fn.parse_outer_attr.html"
  486. title='fn syn::parse_outer_attr'>parse_outer_attr</a></td>
  487. <td class='docblock-short'>
  488. </td>
  489. </tr>
  490. <tr class=' module-item'>
  491. <td><a class="fn" href="fn.parse_path.html"
  492. title='fn syn::parse_path'>parse_path</a></td>
  493. <td class='docblock-short'>
  494. </td>
  495. </tr>
  496. <tr class=' module-item'>
  497. <td><a class="fn" href="fn.parse_token_trees.html"
  498. title='fn syn::parse_token_trees'>parse_token_trees</a></td>
  499. <td class='docblock-short'>
  500. </td>
  501. </tr>
  502. <tr class=' module-item'>
  503. <td><a class="fn" href="fn.parse_ty_param_bound.html"
  504. title='fn syn::parse_ty_param_bound'>parse_ty_param_bound</a></td>
  505. <td class='docblock-short'>
  506. </td>
  507. </tr>
  508. <tr class=' module-item'>
  509. <td><a class="fn" href="fn.parse_type.html"
  510. title='fn syn::parse_type'>parse_type</a></td>
  511. <td class='docblock-short'>
  512. </td>
  513. </tr>
  514. <tr class=' module-item'>
  515. <td><a class="fn" href="fn.parse_where_clause.html"
  516. title='fn syn::parse_where_clause'>parse_where_clause</a></td>
  517. <td class='docblock-short'>
  518. </td>
  519. </tr></table></section>
  520. <section id='search' class="content hidden"></section>
  521. <section class="footer"></section>
  522. <aside id="help" class="hidden">
  523. <div>
  524. <h1 class="hidden">Help</h1>
  525. <div class="shortcuts">
  526. <h2>Keyboard Shortcuts</h2>
  527. <dl>
  528. <dt><kbd>?</kbd></dt>
  529. <dd>Show this help dialog</dd>
  530. <dt><kbd>S</kbd></dt>
  531. <dd>Focus the search field</dd>
  532. <dt><kbd>↑</kbd></dt>
  533. <dd>Move up in search results</dd>
  534. <dt><kbd>↓</kbd></dt>
  535. <dd>Move down in search results</dd>
  536. <dt><kbd>↹</kbd></dt>
  537. <dd>Switch tab</dd>
  538. <dt><kbd>&#9166;</kbd></dt>
  539. <dd>Go to active search result</dd>
  540. <dt><kbd>+</kbd></dt>
  541. <dd>Expand all sections</dd>
  542. <dt><kbd>-</kbd></dt>
  543. <dd>Collapse all sections</dd>
  544. </dl>
  545. </div>
  546. <div class="infos">
  547. <h2>Search Tricks</h2>
  548. <p>
  549. Prefix searches with a type followed by a colon (e.g.
  550. <code>fn:</code>) to restrict the search to a given type.
  551. </p>
  552. <p>
  553. Accepted types are: <code>fn</code>, <code>mod</code>,
  554. <code>struct</code>, <code>enum</code>,
  555. <code>trait</code>, <code>type</code>, <code>macro</code>,
  556. and <code>const</code>.
  557. </p>
  558. <p>
  559. Search functions by type signature (e.g.
  560. <code>vec -> usize</code> or <code>* -> vec</code>)
  561. </p>
  562. </div>
  563. </div>
  564. </aside>
  565. <script>
  566. window.rootPath = "../";
  567. window.currentCrate = "syn";
  568. </script>
  569. <script src="../main.js"></script>
  570. <script defer src="../search-index.js"></script>
  571. </body>
  572. </html>