enum.KernelArgInfoResult.html 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168
  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 `KernelArgInfoResult` enum in crate `ocl`.">
  8. <meta name="keywords" content="rust, rustlang, rust-lang, KernelArgInfoResult">
  9. <title>ocl::enums::KernelArgInfoResult - 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 enum">
  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'>Enum KernelArgInfoResult</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#variants">Variants</a><div class="sidebar-links"><a href="#variant.AddressQualifier">AddressQualifier</a><a href="#variant.AccessQualifier">AccessQualifier</a><a href="#variant.TypeName">TypeName</a><a href="#variant.TypeQualifier">TypeQualifier</a><a href="#variant.Name">Name</a></div><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.from_bytes">from_bytes</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Display">Display</a><a href="#impl-From%3CKernelArgInfoResult%3E">From&lt;KernelArgInfoResult&gt;</a><a href="#impl-Fail">Fail</a><a href="#impl-Debug">Debug</a></div></div><p class='location'><a href='../index.html'>ocl</a>::<wbr><a href='index.html'>enums</a></p><script>window.sidebarCurrent = {name: 'KernelArgInfoResult', ty: 'enum', 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'>Enum <a href='../index.html'>ocl</a>::<wbr><a href='index.html'>enums</a>::<wbr><a class="enum" href=''>KernelArgInfoResult</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_core/types/enums.rs.html#1576-1582' title='goto source code'>[src]</a></span></h1>
  50. <pre class='rust enum'>pub enum KernelArgInfoResult {
  51. AddressQualifier(<a class="enum" href="../../ocl/enums/enum.KernelArgAddressQualifier.html" title="enum ocl::enums::KernelArgAddressQualifier">KernelArgAddressQualifier</a>),
  52. AccessQualifier(<a class="enum" href="../../ocl/enums/enum.KernelArgAccessQualifier.html" title="enum ocl::enums::KernelArgAccessQualifier">KernelArgAccessQualifier</a>),
  53. TypeName(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>),
  54. TypeQualifier(<a class="struct" href="../../ocl/flags/struct.KernelArgTypeQualifier.html" title="struct ocl::flags::KernelArgTypeQualifier">KernelArgTypeQualifier</a>),
  55. Name(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>),
  56. }</pre><div class='docblock'><p>A kernel arg info result.</p>
  57. </div><h2 id='variants' class='variants small-section-header'>
  58. Variants<a href='#variants' class='anchor'></a></h2>
  59. <span id="variant.AddressQualifier" class="variant small-section-header"><a href="#variant.AddressQualifier" class="anchor field"></a><span id='AddressQualifier.v' class='invisible'><code>AddressQualifier(<a class="enum" href="../../ocl/enums/enum.KernelArgAddressQualifier.html" title="enum ocl::enums::KernelArgAddressQualifier">KernelArgAddressQualifier</a>)</code></span></span><span id="variant.AccessQualifier" class="variant small-section-header"><a href="#variant.AccessQualifier" class="anchor field"></a><span id='AccessQualifier.v' class='invisible'><code>AccessQualifier(<a class="enum" href="../../ocl/enums/enum.KernelArgAccessQualifier.html" title="enum ocl::enums::KernelArgAccessQualifier">KernelArgAccessQualifier</a>)</code></span></span><span id="variant.TypeName" class="variant small-section-header"><a href="#variant.TypeName" class="anchor field"></a><span id='TypeName.v' class='invisible'><code>TypeName(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>)</code></span></span><span id="variant.TypeQualifier" class="variant small-section-header"><a href="#variant.TypeQualifier" class="anchor field"></a><span id='TypeQualifier.v' class='invisible'><code>TypeQualifier(<a class="struct" href="../../ocl/flags/struct.KernelArgTypeQualifier.html" title="struct ocl::flags::KernelArgTypeQualifier">KernelArgTypeQualifier</a>)</code></span></span><span id="variant.Name" class="variant small-section-header"><a href="#variant.Name" class="anchor field"></a><span id='Name.v' class='invisible'><code>Name(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>)</code></span></span>
  60. <h2 id='methods' class='small-section-header'>
  61. Methods<a href='#methods' class='anchor'></a>
  62. </h2>
  63. <h3 id='impl' class='impl'><span class='in-band'><code>impl <a class="enum" href="../../ocl/enums/enum.KernelArgInfoResult.html" title="enum ocl::enums::KernelArgInfoResult">KernelArgInfoResult</a></code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl_core/types/enums.rs.html#1584-1626' title='goto source code'>[src]</a></span></h3>
  64. <div class='impl-items'><h4 id='method.from_bytes' class="method"><span id='from_bytes.v' class='invisible'><code>pub fn <a href='#method.from_bytes' class='fnname'>from_bytes</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;request: <a class="enum" href="../../ocl/enums/enum.KernelArgInfo.html" title="enum ocl::enums::KernelArgInfo">KernelArgInfo</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;result: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>&gt;<br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="enum" href="../../ocl/enums/enum.KernelArgInfoResult.html" title="enum ocl::enums::KernelArgInfoResult">KernelArgInfoResult</a>, <a class="struct" href="../../ocl_core/error/struct.Error.html" title="struct ocl_core::error::Error">Error</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl_core/types/enums.rs.html#1585-1625' title='goto source code'>[src]</a></span></h4>
  65. </div>
  66. <h2 id='implementations' class='small-section-header'>
  67. Trait Implementations<a href='#implementations' class='anchor'></a>
  68. </h2>
  69. <h3 id='impl-Display' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> for <a class="enum" href="../../ocl/enums/enum.KernelArgInfoResult.html" title="enum ocl::enums::KernelArgInfoResult">KernelArgInfoResult</a></code><a href='#impl-Display' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl_core/types/enums.rs.html#1634-1644' title='goto source code'>[src]</a></span></h3>
  70. <div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, f: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Error.html" title="struct core::fmt::Error">Error</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl_core/types/enums.rs.html#1635-1643' title='goto source code'>[src]</a></span></h4>
  71. <div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt">Read more</a></p>
  72. </div></div><h3 id='impl-From%3CKernelArgInfoResult%3E' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;<a class="enum" href="../../ocl/enums/enum.KernelArgInfoResult.html" title="enum ocl::enums::KernelArgInfoResult">KernelArgInfoResult</a>&gt; for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></code><a href='#impl-From%3CKernelArgInfoResult%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl_core/types/enums.rs.html#1646-1650' title='goto source code'>[src]</a></span></h3>
  73. <div class='impl-items'><h4 id='method.from' class="method"><span id='from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(ir: <a class="enum" href="../../ocl/enums/enum.KernelArgInfoResult.html" title="enum ocl::enums::KernelArgInfoResult">KernelArgInfoResult</a>) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl_core/types/enums.rs.html#1647-1649' title='goto source code'>[src]</a></span></h4>
  74. <div class='docblock'><p>Performs the conversion.</p>
  75. </div></div><h3 id='impl-Fail' class='impl'><span class='in-band'><code>impl <a class="trait" href="../../failure/trait.Fail.html" title="trait failure::Fail">Fail</a> for <a class="enum" href="../../ocl/enums/enum.KernelArgInfoResult.html" title="enum ocl::enums::KernelArgInfoResult">KernelArgInfoResult</a></code><a href='#impl-Fail' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl_core/types/enums.rs.html#1653' title='goto source code'>[src]</a></span></h3>
  76. <div class='impl-items'><h4 id='method.cause' class="method"><span id='cause.v' class='invisible'><code>fn <a href='../../failure/trait.Fail.html#method.cause' class='fnname'>cause</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;&amp;(<a class="trait" href="../../failure/trait.Fail.html" title="trait failure::Fail">Fail</a> + 'static)&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/failure/lib.rs.html#97-99' title='goto source code'>[src]</a></span></h4>
  77. <div class='docblock'><p>Returns a reference to the underlying cause of this failure, if it is an error that wraps other errors. <a href="../../failure/trait.Fail.html#method.cause">Read more</a></p>
  78. </div><h4 id='method.backtrace' class="method"><span id='backtrace.v' class='invisible'><code>fn <a href='../../failure/trait.Fail.html#method.backtrace' class='fnname'>backtrace</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;&amp;<a class="struct" href="../../failure/backtrace/struct.Backtrace.html" title="struct failure::backtrace::Backtrace">Backtrace</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/failure/lib.rs.html#106-108' title='goto source code'>[src]</a></span></h4>
  79. <div class='docblock'><p>Returns a reference to the <code>Backtrace</code> carried by this failure, if it carries one. <a href="../../failure/trait.Fail.html#method.backtrace">Read more</a></p>
  80. </div><h4 id='method.context' class="method"><span id='context.v' class='invisible'><code>fn <a href='../../failure/trait.Fail.html#method.context' class='fnname'>context</a>&lt;D&gt;(self, context: D) -&gt; <a class="struct" href="../../failure/context/struct.Context.html" title="struct failure::context::Context">Context</a>&lt;D&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;D: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + 'static,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/failure/lib.rs.html#123-128' title='goto source code'>[src]</a></span></h4>
  81. <div class='docblock'><p>Provides context for this failure. <a href="../../failure/trait.Fail.html#method.context">Read more</a></p>
  82. </div><h4 id='method.compat' class="method"><span id='compat.v' class='invisible'><code>fn <a href='../../failure/trait.Fail.html#method.compat' class='fnname'>compat</a>(self) -&gt; <a class="struct" href="../../failure/compat/struct.Compat.html" title="struct failure::compat::Compat">Compat</a>&lt;Self&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/failure/lib.rs.html#135-139' title='goto source code'>[src]</a></span></h4>
  83. <div class='docblock'><p>Wraps this failure in a compatibility wrapper that implements <code>std::error::Error</code>. <a href="../../failure/trait.Fail.html#method.compat">Read more</a></p>
  84. </div><h4 id='method.causes' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="../../failure/struct.Causes.html" title="struct failure::Causes">Causes</a>&lt;'f&gt;</span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="../../failure/struct.Causes.html" title="struct failure::Causes">Causes</a>&lt;'f&gt;</h3><code class="content"><span class="where fmt-newline">impl&lt;'f&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="struct" href="../../failure/struct.Causes.html" title="struct failure::Causes">Causes</a>&lt;'f&gt;</span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = &amp;'f (<a class="trait" href="../../failure/trait.Fail.html" title="trait failure::Fail">Fail</a> + 'static);</span></code></div></div><span id='causes.v' class='invisible'><code>fn <a href='../../failure/trait.Fail.html#method.causes' class='fnname'>causes</a>(&amp;self) -&gt; <a class="struct" href="../../failure/struct.Causes.html" title="struct failure::Causes">Causes</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/failure/lib.rs.html#143-145' title='goto source code'>[src]</a></span></h4>
  85. <div class='docblock'><p>Returns a iterator over the causes of this <code>Fail</code> with itself as the first item and the <code>root_cause</code> as the final item. <a href="../../failure/trait.Fail.html#method.causes">Read more</a></p>
  86. </div><h4 id='method.root_cause' class="method"><span id='root_cause.v' class='invisible'><code>fn <a href='../../failure/trait.Fail.html#method.root_cause' class='fnname'>root_cause</a>(&amp;self) -&gt; &amp;(<a class="trait" href="../../failure/trait.Fail.html" title="trait failure::Fail">Fail</a> + 'static)</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/failure/lib.rs.html#152-156' title='goto source code'>[src]</a></span></h4>
  87. <div class='docblock'><p>Returns the &quot;root cause&quot; of this <code>Fail</code> - the last value in the cause chain which does not return an underlying <code>cause</code>. <a href="../../failure/trait.Fail.html#method.root_cause">Read more</a></p>
  88. </div></div><h3 id='impl-Debug' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="enum" href="../../ocl/enums/enum.KernelArgInfoResult.html" title="enum ocl::enums::KernelArgInfoResult">KernelArgInfoResult</a></code><a href='#impl-Debug' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl_core/types/enums.rs.html#1628-1632' title='goto source code'>[src]</a></span></h3>
  89. <div class='impl-items'><h4 id='method.fmt-1' class="method"><span id='fmt.v-1' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, f: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Error.html" title="struct core::fmt::Error">Error</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl_core/types/enums.rs.html#1629-1631' title='goto source code'>[src]</a></span></h4>
  90. <div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
  91. </div></div></section>
  92. <section id='search' class="content hidden"></section>
  93. <section class="footer"></section>
  94. <aside id="help" class="hidden">
  95. <div>
  96. <h1 class="hidden">Help</h1>
  97. <div class="shortcuts">
  98. <h2>Keyboard Shortcuts</h2>
  99. <dl>
  100. <dt><kbd>?</kbd></dt>
  101. <dd>Show this help dialog</dd>
  102. <dt><kbd>S</kbd></dt>
  103. <dd>Focus the search field</dd>
  104. <dt><kbd>↑</kbd></dt>
  105. <dd>Move up in search results</dd>
  106. <dt><kbd>↓</kbd></dt>
  107. <dd>Move down in search results</dd>
  108. <dt><kbd>↹</kbd></dt>
  109. <dd>Switch tab</dd>
  110. <dt><kbd>&#9166;</kbd></dt>
  111. <dd>Go to active search result</dd>
  112. <dt><kbd>+</kbd></dt>
  113. <dd>Expand all sections</dd>
  114. <dt><kbd>-</kbd></dt>
  115. <dd>Collapse all sections</dd>
  116. </dl>
  117. </div>
  118. <div class="infos">
  119. <h2>Search Tricks</h2>
  120. <p>
  121. Prefix searches with a type followed by a colon (e.g.
  122. <code>fn:</code>) to restrict the search to a given type.
  123. </p>
  124. <p>
  125. Accepted types are: <code>fn</code>, <code>mod</code>,
  126. <code>struct</code>, <code>enum</code>,
  127. <code>trait</code>, <code>type</code>, <code>macro</code>,
  128. and <code>const</code>.
  129. </p>
  130. <p>
  131. Search functions by type signature (e.g.
  132. <code>vec -> usize</code> or <code>* -> vec</code>)
  133. </p>
  134. </div>
  135. </div>
  136. </aside>
  137. <script>
  138. window.rootPath = "../../";
  139. window.currentCrate = "ocl";
  140. </script>
  141. <script src="../../main.js"></script>
  142. <script defer src="../../search-index.js"></script>
  143. </body>
  144. </html>