index.html 6.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156
  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 `cfg_if` crate.">
  8. <meta name="keywords" content="rust, rustlang, rust-lang, cfg_if">
  9. <title>cfg_if - 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 cfg_if</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#macros">Macros</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'cfg_if', 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=''>cfg_if</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/cfg_if/lib.rs.html#1-133' title='goto source code'>[src]</a></span></h1>
  50. <div class='docblock'><p>A macro for defining #[cfg] if-else statements.</p>
  51. <p>The macro provided by this crate, <code>cfg_if</code>, is similar to the <code>if/elif</code> C
  52. preprocessor macro by allowing definition of a cascade of <code>#[cfg]</code> cases,
  53. emitting the implementation which matches first.</p>
  54. <p>This allows you to conveniently provide a long list #[cfg]'d blocks of code
  55. without having to rewrite each clause multiple times.</p>
  56. <h1 id="example" class="section-header"><a href="#example">Example</a></h1>
  57. <pre class="rust rust-example-rendered">
  58. <span class="attribute">#[<span class="ident">macro_use</span>]</span>
  59. <span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">cfg_if</span>;
  60. <span class="macro">cfg_if</span><span class="macro">!</span> {
  61. <span class="kw">if</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">unix</span>)]</span> {
  62. <span class="kw">fn</span> <span class="ident">foo</span>() { <span class="comment">/* unix specific functionality */</span> }
  63. } <span class="kw">else</span> <span class="kw">if</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">target_pointer_width</span> <span class="op">=</span> <span class="string">&quot;32&quot;</span>)]</span> {
  64. <span class="kw">fn</span> <span class="ident">foo</span>() { <span class="comment">/* non-unix, 32-bit functionality */</span> }
  65. } <span class="kw">else</span> {
  66. <span class="kw">fn</span> <span class="ident">foo</span>() { <span class="comment">/* fallback implementation */</span> }
  67. }
  68. }
  69. </pre>
  70. </div><h2 id='macros' class='section-header'><a href="#macros">Macros</a></h2>
  71. <table>
  72. <tr class=' module-item'>
  73. <td><a class="macro" href="macro.cfg_if.html"
  74. title='macro cfg_if::cfg_if'>cfg_if</a></td>
  75. <td class='docblock-short'>
  76. </td>
  77. </tr></table></section>
  78. <section id='search' class="content hidden"></section>
  79. <section class="footer"></section>
  80. <aside id="help" class="hidden">
  81. <div>
  82. <h1 class="hidden">Help</h1>
  83. <div class="shortcuts">
  84. <h2>Keyboard Shortcuts</h2>
  85. <dl>
  86. <dt><kbd>?</kbd></dt>
  87. <dd>Show this help dialog</dd>
  88. <dt><kbd>S</kbd></dt>
  89. <dd>Focus the search field</dd>
  90. <dt><kbd>↑</kbd></dt>
  91. <dd>Move up in search results</dd>
  92. <dt><kbd>↓</kbd></dt>
  93. <dd>Move down in search results</dd>
  94. <dt><kbd>↹</kbd></dt>
  95. <dd>Switch tab</dd>
  96. <dt><kbd>&#9166;</kbd></dt>
  97. <dd>Go to active search result</dd>
  98. <dt><kbd>+</kbd></dt>
  99. <dd>Expand all sections</dd>
  100. <dt><kbd>-</kbd></dt>
  101. <dd>Collapse all sections</dd>
  102. </dl>
  103. </div>
  104. <div class="infos">
  105. <h2>Search Tricks</h2>
  106. <p>
  107. Prefix searches with a type followed by a colon (e.g.
  108. <code>fn:</code>) to restrict the search to a given type.
  109. </p>
  110. <p>
  111. Accepted types are: <code>fn</code>, <code>mod</code>,
  112. <code>struct</code>, <code>enum</code>,
  113. <code>trait</code>, <code>type</code>, <code>macro</code>,
  114. and <code>const</code>.
  115. </p>
  116. <p>
  117. Search functions by type signature (e.g.
  118. <code>vec -> usize</code> or <code>* -> vec</code>)
  119. </p>
  120. </div>
  121. </div>
  122. </aside>
  123. <script>
  124. window.rootPath = "../";
  125. window.currentCrate = "cfg_if";
  126. </script>
  127. <script src="../main.js"></script>
  128. <script defer src="../search-index.js"></script>
  129. </body>
  130. </html>