struct.BufferSink.html 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185
  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 `BufferSink` struct in crate `ocl`.">
  8. <meta name="keywords" content="rust, rustlang, rust-lang, BufferSink">
  9. <title>ocl::async::BufferSink - 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 struct">
  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'>Struct BufferSink</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a><a href="#method.from_buffer">from_buffer</a><a href="#method.read">read</a><a href="#method.write">write</a><a href="#method.flush">flush</a><a href="#method.buffer">buffer</a><a href="#method.memory">memory</a><a href="#method.default_offset">default_offset</a><a href="#method.default_len">default_len</a><a href="#method.as_mut_slice">as_mut_slice</a><a href="#method.id">id</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-Debug">Debug</a><a href="#impl-From%3COrderLock%3CInner%3CT%3E%3E%3E">From&lt;OrderLock&lt;Inner&lt;T&gt;&gt;&gt;</a></div></div><p class='location'><a href='../index.html'>ocl</a>::<wbr><a href='index.html'>async</a></p><script>window.sidebarCurrent = {name: 'BufferSink', ty: 'struct', 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'>Struct <a href='../index.html'>ocl</a>::<wbr><a href='index.html'>async</a>::<wbr><a class="struct" href=''>BufferSink</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/async/buffer_sink.rs.html#247-249' title='goto source code'>[src]</a></span></h1>
  50. <pre class='rust struct'>pub struct BufferSink&lt;T:&nbsp;<a class="trait" href="../../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>&gt; { /* fields omitted */ }</pre><div class='docblock'><p>Represents mapped memory and allows frames of data to be 'flushed'
  51. (written) from host-accessible mapped memory region into its associated
  52. device-visible buffer in a repeated fashion.</p>
  53. <p>This represents the fastest possible method for continuously writing
  54. frames of data to a device.</p>
  55. </div>
  56. <h2 id='methods' class='small-section-header'>
  57. Methods<a href='#methods' class='anchor'></a>
  58. </h2>
  59. <h3 id='impl' class='impl'><span class='in-band'><code>impl&lt;T:&nbsp;<a class="trait" href="../../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>&gt; <a class="struct" href="../../ocl/async/struct.BufferSink.html" title="struct ocl::async::BufferSink">BufferSink</a>&lt;T&gt;</code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/buffer_sink.rs.html#251-370' title='goto source code'>[src]</a></span></h3>
  60. <div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>pub fn <a href='#method.new' class='fnname'>new</a>(queue: <a class="struct" href="../../ocl/struct.Queue.html" title="struct ocl::Queue">Queue</a>, len: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -&gt; <a class="type" href="../../ocl/error/type.Result.html" title="type ocl::error::Result">OclResult</a>&lt;<a class="struct" href="../../ocl/async/struct.BufferSink.html" title="struct ocl::async::BufferSink">BufferSink</a>&lt;T&gt;&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/buffer_sink.rs.html#256-265' title='goto source code'>[src]</a></span></h4>
  61. <div class='docblock'><p>Returns a new <code>BufferSink</code>.</p>
  62. <p>The current thread will be blocked while the buffer is initialized
  63. upon calling this function.</p>
  64. </div><h4 id='method.from_buffer' class="method"><span id='from_buffer.v' class='invisible'><code>pub unsafe fn <a href='#method.from_buffer' class='fnname'>from_buffer</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;buffer: <a class="struct" href="../../ocl/struct.Buffer.html" title="struct ocl::Buffer">Buffer</a>&lt;T&gt;, <br>&nbsp;&nbsp;&nbsp;&nbsp;queue: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../../ocl/struct.Queue.html" title="struct ocl::Queue">Queue</a>&gt;, <br>&nbsp;&nbsp;&nbsp;&nbsp;default_offset: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;default_len: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a><br>) -&gt; <a class="type" href="../../ocl/error/type.Result.html" title="type ocl::error::Result">OclResult</a>&lt;<a class="struct" href="../../ocl/async/struct.BufferSink.html" title="struct ocl::async::BufferSink">BufferSink</a>&lt;T&gt;&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/buffer_sink.rs.html#273-308' title='goto source code'>[src]</a></span></h4>
  65. <div class='docblock'><p>Returns a new <code>BufferSink</code>.</p>
  66. <h2 id="safety" class="section-header"><a href="#safety">Safety</a></h2>
  67. <p><code>buffer</code> must not have the same region mapped more than once.</p>
  68. </div><h4 id='method.read' class="method"><span id='read.v' class='invisible'><code>pub fn <a href='#method.read' class='fnname'>read</a>(self) -&gt; <a class="struct" href="../../ocl/async/struct.FutureGuard.html" title="struct ocl::async::FutureGuard">FutureGuard</a>&lt;<a class="struct" href="../../ocl/async/struct.BufferSinkInner.html" title="struct ocl::async::BufferSinkInner">Inner</a>&lt;T&gt;, <a class="struct" href="../../ocl/struct.ReadGuard.html" title="struct ocl::ReadGuard">ReadGuard</a>&lt;<a class="struct" href="../../ocl/async/struct.BufferSinkInner.html" title="struct ocl::async::BufferSinkInner">Inner</a>&lt;T&gt;&gt;&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/buffer_sink.rs.html#311-314' title='goto source code'>[src]</a></span></h4>
  69. <div class='docblock'><p>Returns a new <code>FutureGuard</code> which will resolve into a a <code>ReadGuard</code>.</p>
  70. </div><h4 id='method.write' class="method"><span id='write.v' class='invisible'><code>pub fn <a href='#method.write' class='fnname'>write</a>(self) -&gt; <a class="struct" href="../../ocl/async/struct.FutureGuard.html" title="struct ocl::async::FutureGuard">FutureGuard</a>&lt;<a class="struct" href="../../ocl/async/struct.BufferSinkInner.html" title="struct ocl::async::BufferSinkInner">Inner</a>&lt;T&gt;, <a class="struct" href="../../ocl/struct.WriteGuard.html" title="struct ocl::WriteGuard">WriteGuard</a>&lt;<a class="struct" href="../../ocl/async/struct.BufferSinkInner.html" title="struct ocl::async::BufferSinkInner">Inner</a>&lt;T&gt;&gt;&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/buffer_sink.rs.html#317-319' title='goto source code'>[src]</a></span></h4>
  71. <div class='docblock'><p>Returns a new <code>FutureGuard</code> which will resolve into a a <code>WriteGuard</code>.</p>
  72. </div><h4 id='method.flush' class="method"><span id='flush.v' class='invisible'><code>pub fn <a href='#method.flush' class='fnname'>flush</a>&lt;'c&gt;(self) -&gt; FlushCmd&lt;'c, T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/buffer_sink.rs.html#323-325' title='goto source code'>[src]</a></span></h4>
  73. <div class='docblock'><p>Returns a command builder which, once enqueued, will flush data from
  74. the mapped memory region to the device.</p>
  75. </div><h4 id='method.buffer' class="method"><span id='buffer.v' class='invisible'><code>pub fn <a href='#method.buffer' class='fnname'>buffer</a>(&amp;self) -&gt; &amp;<a class="struct" href="../../ocl/struct.Buffer.html" title="struct ocl::Buffer">Buffer</a>&lt;T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/buffer_sink.rs.html#329-331' title='goto source code'>[src]</a></span></h4>
  76. <div class='docblock'><p>Returns a reference to the internal buffer.</p>
  77. </div><h4 id='method.memory' class="method"><span id='memory.v' class='invisible'><code>pub fn <a href='#method.memory' class='fnname'>memory</a>(&amp;self) -&gt; &amp;<a class="struct" href="../../ocl_core/types/abs/struct.MemMap.html" title="struct ocl_core::types::abs::MemMap">MemMapCore</a>&lt;T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/buffer_sink.rs.html#335-337' title='goto source code'>[src]</a></span></h4>
  78. <div class='docblock'><p>Returns a reference to the internal memory mapping.</p>
  79. </div><h4 id='method.default_offset' class="method"><span id='default_offset.v' class='invisible'><code>pub fn <a href='#method.default_offset' class='fnname'>default_offset</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/buffer_sink.rs.html#341-343' title='goto source code'>[src]</a></span></h4>
  80. <div class='docblock'><p>Returns a reference to the internal offset.</p>
  81. </div><h4 id='method.default_len' class="method"><span id='default_len.v' class='invisible'><code>pub fn <a href='#method.default_len' class='fnname'>default_len</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/buffer_sink.rs.html#347-349' title='goto source code'>[src]</a></span></h4>
  82. <div class='docblock'><p>Returns the length of the memory region.</p>
  83. </div><h4 id='method.as_mut_slice' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></h3><code class="content"><span class="where fmt-newline">impl&lt;'a&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></span><span class="where fmt-newline">impl&lt;'a&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;'a mut [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></span></code></div></div><span id='as_mut_slice.v' class='invisible'><code>pub unsafe fn <a href='#method.as_mut_slice' class='fnname'>as_mut_slice</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;mut [T]</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/buffer_sink.rs.html#359-363' title='goto source code'>[src]</a></span></h4>
  84. <div class='docblock'><p>Returns a mutable slice into the contained memory region.</p>
  85. <p>Used by buffer command builders when preparing future read and write
  86. commands.</p>
  87. <p>Do not use unless you are 100% certain that there will be no other
  88. reads or writes for the entire access duration (only possible if
  89. manually manipulating the lock status).</p>
  90. </div><h4 id='method.id' class="method"><span id='id.v' class='invisible'><code>pub fn <a href='#method.id' class='fnname'>id</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/buffer_sink.rs.html#367-369' title='goto source code'>[src]</a></span></h4>
  91. <div class='docblock'><p>Returns a pointer address to the internal memory region, usable as a
  92. unique identifier.</p>
  93. </div></div>
  94. <h2 id='implementations' class='small-section-header'>
  95. Trait Implementations<a href='#implementations' class='anchor'></a>
  96. </h2>
  97. <h3 id='impl-Clone' class='impl'><span class='in-band'><code>impl&lt;T:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> + <a class="trait" href="../../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../../ocl/async/struct.BufferSink.html" title="struct ocl::async::BufferSink">BufferSink</a>&lt;T&gt;</code><a href='#impl-Clone' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/buffer_sink.rs.html#246' title='goto source code'>[src]</a></span></h3>
  98. <div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&amp;self) -&gt; <a class="struct" href="../../ocl/async/struct.BufferSink.html" title="struct ocl::async::BufferSink">BufferSink</a>&lt;T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/buffer_sink.rs.html#246' title='goto source code'>[src]</a></span></h4>
  99. <div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
  100. </div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&amp;mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Self)</code></span><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#112-114' title='goto source code'>[src]</a></span></h4>
  101. <div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
  102. </div></div><h3 id='impl-Debug' class='impl'><span class='in-band'><code>impl&lt;T:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + <a class="trait" href="../../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>&gt; <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="struct" href="../../ocl/async/struct.BufferSink.html" title="struct ocl::async::BufferSink">BufferSink</a>&lt;T&gt;</code><a href='#impl-Debug' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/buffer_sink.rs.html#246' title='goto source code'>[src]</a></span></h3>
  103. <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.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, __arg_0: &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="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/buffer_sink.rs.html#246' title='goto source code'>[src]</a></span></h4>
  104. <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>
  105. </div></div><h3 id='impl-From%3COrderLock%3CInner%3CT%3E%3E%3E' class='impl'><span class='in-band'><code>impl&lt;T:&nbsp;<a class="trait" href="../../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>&gt; <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="struct" href="../../ocl/async/struct.OrderLock.html" title="struct ocl::async::OrderLock">OrderLock</a>&lt;<a class="struct" href="../../ocl/async/struct.BufferSinkInner.html" title="struct ocl::async::BufferSinkInner">Inner</a>&lt;T&gt;&gt;&gt; for <a class="struct" href="../../ocl/async/struct.BufferSink.html" title="struct ocl::async::BufferSink">BufferSink</a>&lt;T&gt;</code><a href='#impl-From%3COrderLock%3CInner%3CT%3E%3E%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/buffer_sink.rs.html#372-376' title='goto source code'>[src]</a></span></h3>
  106. <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>(order_lock: <a class="struct" href="../../ocl/async/struct.OrderLock.html" title="struct ocl::async::OrderLock">OrderLock</a>&lt;<a class="struct" href="../../ocl/async/struct.BufferSinkInner.html" title="struct ocl::async::BufferSinkInner">Inner</a>&lt;T&gt;&gt;) -&gt; <a class="struct" href="../../ocl/async/struct.BufferSink.html" title="struct ocl::async::BufferSink">BufferSink</a>&lt;T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/buffer_sink.rs.html#373-375' title='goto source code'>[src]</a></span></h4>
  107. <div class='docblock'><p>Performs the conversion.</p>
  108. </div></div></section>
  109. <section id='search' class="content hidden"></section>
  110. <section class="footer"></section>
  111. <aside id="help" class="hidden">
  112. <div>
  113. <h1 class="hidden">Help</h1>
  114. <div class="shortcuts">
  115. <h2>Keyboard Shortcuts</h2>
  116. <dl>
  117. <dt><kbd>?</kbd></dt>
  118. <dd>Show this help dialog</dd>
  119. <dt><kbd>S</kbd></dt>
  120. <dd>Focus the search field</dd>
  121. <dt><kbd>↑</kbd></dt>
  122. <dd>Move up in search results</dd>
  123. <dt><kbd>↓</kbd></dt>
  124. <dd>Move down in search results</dd>
  125. <dt><kbd>↹</kbd></dt>
  126. <dd>Switch tab</dd>
  127. <dt><kbd>&#9166;</kbd></dt>
  128. <dd>Go to active search result</dd>
  129. <dt><kbd>+</kbd></dt>
  130. <dd>Expand all sections</dd>
  131. <dt><kbd>-</kbd></dt>
  132. <dd>Collapse all sections</dd>
  133. </dl>
  134. </div>
  135. <div class="infos">
  136. <h2>Search Tricks</h2>
  137. <p>
  138. Prefix searches with a type followed by a colon (e.g.
  139. <code>fn:</code>) to restrict the search to a given type.
  140. </p>
  141. <p>
  142. Accepted types are: <code>fn</code>, <code>mod</code>,
  143. <code>struct</code>, <code>enum</code>,
  144. <code>trait</code>, <code>type</code>, <code>macro</code>,
  145. and <code>const</code>.
  146. </p>
  147. <p>
  148. Search functions by type signature (e.g.
  149. <code>vec -> usize</code> or <code>* -> vec</code>)
  150. </p>
  151. </div>
  152. </div>
  153. </aside>
  154. <script>
  155. window.rootPath = "../../";
  156. window.currentCrate = "ocl";
  157. </script>
  158. <script src="../../main.js"></script>
  159. <script defer src="../../search-index.js"></script>
  160. </body>
  161. </html>