index.html 6.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154
  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 `error` mod in crate `ocl`.">
  8. <meta name="keywords" content="rust, rustlang, rust-lang, error">
  9. <title>ocl::error - 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'>Module error</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'><a href='../index.html'>ocl</a></p><script>window.sidebarCurrent = {name: 'error', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></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'>Module <a href='../index.html'>ocl</a>::<wbr><a class="mod" href=''>error</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/ocl/error.rs.html#1-185' title='goto source code'>[src]</a></span></h1>
  50. <div class='docblock'><p>Standard error type for ocl futures.</p>
  51. </div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
  52. <table>
  53. <tr class=' module-item'>
  54. <td><a class="struct" href="struct.Error.html"
  55. title='struct ocl::error::Error'>Error</a></td>
  56. <td class='docblock-short'>
  57. <p>An Error.</p>
  58. </td>
  59. </tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
  60. <table>
  61. <tr class=' module-item'>
  62. <td><a class="enum" href="enum.ErrorKind.html"
  63. title='enum ocl::error::ErrorKind'>ErrorKind</a></td>
  64. <td class='docblock-short'>
  65. <p>An enum containing either a <code>String</code> or one of several other error types.</p>
  66. </td>
  67. </tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
  68. <table>
  69. <tr class=' module-item'>
  70. <td><a class="type" href="type.Result.html"
  71. title='type ocl::error::Result'>Result</a></td>
  72. <td class='docblock-short'>
  73. </td>
  74. </tr></table></section>
  75. <section id='search' class="content hidden"></section>
  76. <section class="footer"></section>
  77. <aside id="help" class="hidden">
  78. <div>
  79. <h1 class="hidden">Help</h1>
  80. <div class="shortcuts">
  81. <h2>Keyboard Shortcuts</h2>
  82. <dl>
  83. <dt><kbd>?</kbd></dt>
  84. <dd>Show this help dialog</dd>
  85. <dt><kbd>S</kbd></dt>
  86. <dd>Focus the search field</dd>
  87. <dt><kbd>↑</kbd></dt>
  88. <dd>Move up in search results</dd>
  89. <dt><kbd>↓</kbd></dt>
  90. <dd>Move down in search results</dd>
  91. <dt><kbd>↹</kbd></dt>
  92. <dd>Switch tab</dd>
  93. <dt><kbd>&#9166;</kbd></dt>
  94. <dd>Go to active search result</dd>
  95. <dt><kbd>+</kbd></dt>
  96. <dd>Expand all sections</dd>
  97. <dt><kbd>-</kbd></dt>
  98. <dd>Collapse all sections</dd>
  99. </dl>
  100. </div>
  101. <div class="infos">
  102. <h2>Search Tricks</h2>
  103. <p>
  104. Prefix searches with a type followed by a colon (e.g.
  105. <code>fn:</code>) to restrict the search to a given type.
  106. </p>
  107. <p>
  108. Accepted types are: <code>fn</code>, <code>mod</code>,
  109. <code>struct</code>, <code>enum</code>,
  110. <code>trait</code>, <code>type</code>, <code>macro</code>,
  111. and <code>const</code>.
  112. </p>
  113. <p>
  114. Search functions by type signature (e.g.
  115. <code>vec -> usize</code> or <code>* -> vec</code>)
  116. </p>
  117. </div>
  118. </div>
  119. </aside>
  120. <script>
  121. window.rootPath = "../../";
  122. window.currentCrate = "ocl";
  123. </script>
  124. <script src="../../main.js"></script>
  125. <script defer src="../../search-index.js"></script>
  126. </body>
  127. </html>