struct.Event.html 87 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360
  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 `Event` struct in crate `ocl`.">
  8. <meta name="keywords" content="rust, rustlang, rust-lang, Event">
  9. <title>ocl::Event - 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 Event</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.empty">empty</a><a href="#method.user">user</a><a href="#method.is_empty">is_empty</a><a href="#method.set_unpark_callback">set_unpark_callback</a><a href="#method.register_event_relay">register_event_relay</a><a href="#method.info">info</a><a href="#method.profiling_info">profiling_info</a><a href="#method.queue_core">queue_core</a><a href="#method.as_core">as_core</a><a href="#method.into_raw">into_raw</a><a href="#method.from_raw">from_raw</a></div><a class="sidebar-title" href="#deref-methods">Methods from Deref&lt;Target=EventCore&gt;</a><div class="sidebar-links"><a href="#method.set_complete">set_complete</a><a href="#method.is_complete">is_complete</a><a href="#method.wait_for">wait_for</a><a href="#method.is_null">is_null</a><a href="#method.is_valid">is_valid</a><a href="#method.set_callback">set_callback</a><a href="#method.context">context</a><a href="#method.as_ptr_ref">as_ptr_ref</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-Hash">Hash</a><a href="#impl-PartialEq">PartialEq</a><a href="#impl-Eq">Eq</a><a href="#impl-From%3CEventCore%3E">From&lt;EventCore&gt;</a><a href="#impl-From%3CEvent%3E">From&lt;Event&gt;</a><a href="#impl-Default">Default</a><a href="#impl-Deref">Deref</a><a href="#impl-DerefMut">DerefMut</a><a href="#impl-AsRef%3CEventCore%3E">AsRef&lt;EventCore&gt;</a><a href="#impl-Display">Display</a><a href="#impl-ClEventPtrRef%3C%27e%3E">ClEventPtrRef&lt;&#39;e&gt;</a><a href="#impl-ClNullEventPtr">ClNullEventPtr</a><a href="#impl-ClWaitListPtr">ClWaitListPtr</a><a href="#impl-Future">Future</a><a href="#impl-From%3C%26%27a%20Event%3E">From&lt;&amp;&#39;a Event&gt;</a><a href="#impl-From%3C%26%27a%20mut%20Event%3E">From&lt;&amp;&#39;a mut Event&gt;</a></div></div><p class='location'><a href='index.html'>ocl</a></p><script>window.sidebarCurrent = {name: 'Event', 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 class="struct" href=''>Event</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/standard/event.rs.html#44' title='goto source code'>[src]</a></span></h1>
  50. <pre class='rust struct'><div class="docblock attributes">#[repr(C)]
  51. #[must_use = "futures do nothing unless polled"]
  52. </div>pub struct Event(_);</pre><div class='docblock'><p>An event representing a command or user created event.</p>
  53. </div>
  54. <h2 id='methods' class='small-section-header'>
  55. Methods<a href='#methods' class='anchor'></a>
  56. </h2>
  57. <h3 id='impl' class='impl'><span class='in-band'><code>impl <a class="struct" href="../ocl/struct.Event.html" title="struct ocl::Event">Event</a></code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/event.rs.html#46-172' title='goto source code'>[src]</a></span></h3>
  58. <div class='impl-items'><h4 id='method.empty' class="method"><span id='empty.v' class='invisible'><code>pub fn <a href='#method.empty' class='fnname'>empty</a>() -&gt; <a class="struct" href="../ocl/struct.Event.html" title="struct ocl::Event">Event</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/event.rs.html#49-51' title='goto source code'>[src]</a></span></h4>
  59. <div class='docblock'><p>Creates a new, empty (null) event which must be filled by a command,
  60. associating the event with it.</p>
  61. </div><h4 id='method.user' class="method"><span id='user.v' class='invisible'><code>pub fn <a href='#method.user' class='fnname'>user</a>&lt;C:&nbsp;<a class="trait" href="../ocl_core/types/abs/trait.ClContextPtr.html" title="trait ocl_core::types::abs::ClContextPtr">ClContextPtr</a>&gt;(context: C) -&gt; <a class="type" href="../ocl_core/error/type.Result.html" title="type ocl_core::error::Result">OclCoreResult</a>&lt;<a class="struct" href="../ocl/struct.Event.html" title="struct ocl::Event">Event</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/event.rs.html#55-57' title='goto source code'>[src]</a></span></h4>
  62. <div class='docblock'><p>Creates a new, empty event which must be filled by a newly initiated
  63. command, associating the event with it.</p>
  64. </div><h4 id='method.is_empty' class="method"><span id='is_empty.v' class='invisible'><code>pub fn <a href='#method.is_empty' class='fnname'>is_empty</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/event.rs.html#63-65' title='goto source code'>[src]</a></span></h4>
  65. <div class='docblock'><p>Returns true if this event is 'empty' and has not yet been associated
  66. with a command.</p>
  67. </div><h4 id='method.set_unpark_callback' class="method"><span id='set_unpark_callback.v' class='invisible'><code>pub fn <a href='#method.set_unpark_callback' class='fnname'>set_unpark_callback</a>(&amp;self) -&gt; <a class="type" href="../ocl_core/error/type.Result.html" title="type ocl_core::error::Result">OclCoreResult</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/event.rs.html#78-81' title='goto source code'>[src]</a></span></h4>
  68. <div class='docblock'><p>Sets a callback function to trigger upon completion of this event
  69. which will unpark the current task.</p>
  70. <p>To be used within the context of a futures task.</p>
  71. <h2 id="panics" class="section-header"><a href="#panics">Panics</a></h2>
  72. <p>This function will panic if a task is not currently being executed.
  73. That is, this method can be dangerous to call outside of an
  74. implementation of poll.</p>
  75. </div><h4 id='method.register_event_relay' class="method"><span id='register_event_relay.v' class='invisible'><code>pub unsafe fn <a href='#method.register_event_relay' class='fnname'>register_event_relay</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;user_event: <a class="struct" href="../ocl/struct.Event.html" title="struct ocl::Event">Event</a><br>) -&gt; <a class="type" href="../ocl_core/error/type.Result.html" title="type ocl_core::error::Result">OclCoreResult</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/event.rs.html#104-107' title='goto source code'>[src]</a></span></h4>
  76. <div class='docblock'><p>Registers a user event to have its status set to complete
  77. (<code>CommandExecutionStatus::Complete</code>) immediately upon completion of
  78. this event.</p>
  79. <h2 id="deadlocks" class="section-header"><a href="#deadlocks">Deadlocks</a></h2>
  80. <p>Due to the nature of OpenCL queue implementations, care must be taken
  81. when using this function. OpenCL queue deadlocks may occur.</p>
  82. <p>OpenCL queues generally use one thread per queue for the purposes of
  83. callbacks, etc. As a rule of thumb, ensure that any OpenCL commands
  84. preceding the causation/source event (<code>self</code>) are in a separate queue
  85. from any commands with the dependent/target event (<code>user_event</code>).</p>
  86. <h2 id="safety" class="section-header"><a href="#safety">Safety</a></h2>
  87. <p>The caller must ensure that <code>user_event</code> was created with
  88. <code>Event::user()</code> and that it's status is
  89. <code>CommandExecutionStatus::Submitted</code> (the default upon creation).</p>
  90. </div><h4 id='method.info' class="method"><span id='info.v' class='invisible'><code>pub fn <a href='#method.info' class='fnname'>info</a>(&amp;self, info_kind: <a class="enum" href="../ocl/enums/enum.EventInfo.html" title="enum ocl::enums::EventInfo">EventInfo</a>) -&gt; <a class="type" href="../ocl_core/error/type.Result.html" title="type ocl_core::error::Result">OclCoreResult</a>&lt;<a class="enum" href="../ocl/enums/enum.EventInfoResult.html" title="enum ocl::enums::EventInfoResult">EventInfoResult</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/event.rs.html#110-112' title='goto source code'>[src]</a></span></h4>
  91. <div class='docblock'><p>Returns info about the event.</p>
  92. </div><h4 id='method.profiling_info' class="method"><span id='profiling_info.v' class='invisible'><code>pub fn <a href='#method.profiling_info' class='fnname'>profiling_info</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;info_kind: <a class="enum" href="../ocl/enums/enum.ProfilingInfo.html" title="enum ocl::enums::ProfilingInfo">ProfilingInfo</a><br>) -&gt; <a class="type" href="../ocl_core/error/type.Result.html" title="type ocl_core::error::Result">OclCoreResult</a>&lt;<a class="enum" href="../ocl/enums/enum.ProfilingInfoResult.html" title="enum ocl::enums::ProfilingInfoResult">ProfilingInfoResult</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/event.rs.html#115-117' title='goto source code'>[src]</a></span></h4>
  93. <div class='docblock'><p>Returns info about the event.</p>
  94. </div><h4 id='method.queue_core' class="method"><span id='queue_core.v' class='invisible'><code>pub fn <a href='#method.queue_core' class='fnname'>queue_core</a>(&amp;self) -&gt; <a class="type" href="../ocl_core/error/type.Result.html" title="type ocl_core::error::Result">OclCoreResult</a>&lt;<a class="struct" href="../ocl_core/types/abs/struct.CommandQueue.html" title="struct ocl_core::types::abs::CommandQueue">CommandQueueCore</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/event.rs.html#120-125' title='goto source code'>[src]</a></span></h4>
  95. <div class='docblock'><p>Returns this event's associated command queue.</p>
  96. </div><h4 id='method.as_core' class="method"><span id='as_core.v' class='invisible'><code>pub fn <a href='#method.as_core' class='fnname'>as_core</a>(&amp;self) -&gt; &amp;<a class="struct" href="../ocl_core/types/abs/struct.Event.html" title="struct ocl_core::types::abs::Event">EventCore</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/event.rs.html#131-133' title='goto source code'>[src]</a></span></h4>
  97. <div class='docblock'><p>Returns a reference to the core pointer wrapper, usable by functions in
  98. the <code>core</code> module.</p>
  99. </div><h4 id='method.into_raw' class="method"><span id='into_raw.v' class='invisible'><code>pub fn <a href='#method.into_raw' class='fnname'>into_raw</a>(self) -&gt; <a class="type" href="../cl_sys/cl_h/type.cl_event.html" title="type cl_sys::cl_h::cl_event">cl_event</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/event.rs.html#143-145' title='goto source code'>[src]</a></span></h4>
  100. <div class='docblock'><p>Consumes the <code>Event</code>, returning the wrapped <code>cl_event</code> pointer.</p>
  101. <p>To avoid a memory leak the pointer must be converted back to an <code>Event</code> using
  102. <a href="struct.Event.html#method.from_raw"><code>Event::from_raw</code></a>.</p>
  103. </div><h4 id='method.from_raw' class="method"><span id='from_raw.v' class='invisible'><code>pub unsafe fn <a href='#method.from_raw' class='fnname'>from_raw</a>(ptr: <a class="type" href="../cl_sys/cl_h/type.cl_event.html" title="type cl_sys::cl_h::cl_event">cl_event</a>) -&gt; <a class="struct" href="../ocl/struct.Event.html" title="struct ocl::Event">Event</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/event.rs.html#154-156' title='goto source code'>[src]</a></span></h4>
  104. <div class='docblock'><p>Constructs an <code>Event</code> from a raw <code>cl_event</code> pointer.</p>
  105. <p>The raw pointer must have been previously returned by a call to a
  106. <a href="struct.Event.html#method.into_raw"><code>Event::into_raw</code></a>.</p>
  107. </div></div>
  108. <h2 id='deref-methods' class='small-section-header'>
  109. Methods from <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a>&lt;Target = <a class="struct" href="../ocl_core/types/abs/struct.Event.html" title="struct ocl_core::types::abs::Event">EventCore</a>&gt;<a href='#deref-methods' class='anchor'></a>
  110. </h2>
  111. <div class='impl-items'><h4 id='method.set_complete' class="method"><span id='set_complete.v' class='invisible'><code>pub fn <a href='#method.set_complete' class='fnname'>set_complete</a>(&amp;self) -&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="../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/abs.rs.html#991-993' title='goto source code'>[src]</a></span></h4>
  112. <div class='docblock'><p>Sets this user created event to <code>CommandExecutionStatus::Complete</code>.</p>
  113. <p>Will return an error if this event is not a 'user' event (created
  114. with <code>::user()</code>).</p>
  115. </div><h4 id='method.is_complete' class="method"><span id='is_complete.v' class='invisible'><code>pub fn <a href='#method.is_complete' class='fnname'>is_complete</a>(&amp;self) -&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.bool.html">bool</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/abs.rs.html#1001-1003' title='goto source code'>[src]</a></span></h4>
  116. <div class='docblock'><p>Queries the command status associated with this event and returns true
  117. if it is complete, false if incomplete or upon error.</p>
  118. <p>This is the fastest possible way to determine event status.</p>
  119. </div><h4 id='method.wait_for' class="method"><span id='wait_for.v' class='invisible'><code>pub fn <a href='#method.wait_for' class='fnname'>wait_for</a>(&amp;self) -&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="../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/abs.rs.html#1007-1009' title='goto source code'>[src]</a></span></h4>
  120. <div class='docblock'><p>Causes the command queue to wait until this event is complete before returning.</p>
  121. </div><h4 id='method.is_null' class="method"><span id='is_null.v' class='invisible'><code>pub fn <a href='#method.is_null' class='fnname'>is_null</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl_core/types/abs.rs.html#1014-1016' title='goto source code'>[src]</a></span></h4>
  122. <div class='docblock'><p>Returns whether or not this event is associated with a command or is a
  123. user event.</p>
  124. </div><h4 id='method.is_valid' class="method"><span id='is_valid.v' class='invisible'><code>pub fn <a href='#method.is_valid' class='fnname'>is_valid</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl_core/types/abs.rs.html#1025-1027' title='goto source code'>[src]</a></span></h4>
  125. <div class='docblock'><p>[FIXME]: ADD VALIDITY CHECK BY CALLING '_INFO' OR SOMETHING:
  126. NULL CHECK IS NOT ENOUGH</p>
  127. <p>This still leads to crazy segfaults when non-event pointers (random
  128. whatever addresses) are passed. Need better check.</p>
  129. </div><h4 id='method.set_callback' class="method"><span id='set_callback.v' class='invisible'><code>pub unsafe fn <a href='#method.set_callback' class='fnname'>set_callback</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;callback_receiver: extern &quot;C&quot; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.fn.html">fn</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="enum" href="../libc/enum.c_void.html" title="enum libc::c_void">c_void</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="enum" href="../libc/enum.c_void.html" title="enum libc::c_void">c_void</a>), <br>&nbsp;&nbsp;&nbsp;&nbsp;user_data_ptr: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="enum" href="../libc/enum.c_void.html" title="enum libc::c_void">c_void</a><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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</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/abs.rs.html#1046-1058' title='goto source code'>[src]</a></span></h4>
  130. <div class='docblock'><p>Sets a callback function, <code>callback_receiver</code>, to trigger upon
  131. completion of this event with an optional pointer to user data.</p>
  132. <p>The callback function must have a signature matching:
  133. <code>extern &quot;C&quot; fn (ffi::cl_event, i32, *mut libc::c_void)</code></p>
  134. <h1 id="safety-1" class="section-header"><a href="#safety-1">Safety</a></h1>
  135. <p><code>user_data</code> must be guaranteed to still exist if and when <code>callback_receiver</code>
  136. is ever called.</p>
  137. <p>TODO: Create a safer type wrapper for <code>callback_receiver</code> (using an
  138. <code>Arc</code>?, etc.) within <code>ocl</code>.</p>
  139. </div><h4 id='method.context' class="method"><span id='context.v' class='invisible'><code>pub fn <a href='#method.context' class='fnname'>context</a>(&amp;self) -&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="struct" href="../ocl_core/types/abs/struct.Context.html" title="struct ocl_core::types::abs::Context">Context</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/abs.rs.html#1062-1068' title='goto source code'>[src]</a></span></h4>
  140. <div class='docblock'><p>Returns the <code>Context</code> associated with this event.</p>
  141. </div><h4 id='method.as_ptr_ref' class="method"><span id='as_ptr_ref.v' class='invisible'><code>pub unsafe fn <a href='#method.as_ptr_ref' class='fnname'>as_ptr_ref</a>(&amp;self) -&gt; &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="enum" href="../libc/enum.c_void.html" title="enum libc::c_void">c_void</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl_core/types/abs.rs.html#1084-1086' title='goto source code'>[src]</a></span></h4>
  142. <div class='docblock'><p>Returns an immutable reference to a pointer, do not deref and store it unless
  143. you will manage its associated reference count carefully.</p>
  144. <h3 id="warning" class="section-header"><a href="#warning">Warning</a></h3>
  145. <p>DO NOT store this pointer.</p>
  146. <p>DO NOT send this pointer across threads unless you are incrementing
  147. the reference count before sending and decrementing after sending.</p>
  148. <p>Use <code>::into_raw</code> for these purposes. Thank you.</p>
  149. </div><h4 id='method.as_ptr_mut' class="method"><span id='as_ptr_mut.v' class='invisible'><code>pub unsafe fn <a href='#method.as_ptr_mut' class='fnname'>as_ptr_mut</a>(&amp;mut self) -&gt; &amp;mut <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="enum" href="../libc/enum.c_void.html" title="enum libc::c_void">c_void</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl_core/types/abs.rs.html#1102-1104' title='goto source code'>[src]</a></span></h4>
  150. <div class='docblock'><p>Returns a mutable reference to a pointer, do not deref then modify or store it
  151. unless you will manage its associated reference count carefully.</p>
  152. <h3 id="warning-1" class="section-header"><a href="#warning-1">Warning</a></h3>
  153. <p>DO NOT store this pointer.</p>
  154. <p>DO NOT send this pointer across threads unless you are incrementing
  155. the reference count before sending and decrementing after sending.</p>
  156. <p>Use <code>::into_raw</code> for these purposes. Thank you.</p>
  157. </div></div>
  158. <h2 id='implementations' class='small-section-header'>
  159. Trait Implementations<a href='#implementations' class='anchor'></a>
  160. </h2>
  161. <h3 id='impl-Clone' class='impl'><span class='in-band'><code>impl <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/struct.Event.html" title="struct ocl::Event">Event</a></code><a href='#impl-Clone' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/event.rs.html#41' title='goto source code'>[src]</a></span></h3>
  162. <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/struct.Event.html" title="struct ocl::Event">Event</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/event.rs.html#41' title='goto source code'>[src]</a></span></h4>
  163. <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>
  164. </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>
  165. <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>
  166. </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="struct" href="../ocl/struct.Event.html" title="struct ocl::Event">Event</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/standard/event.rs.html#41' title='goto source code'>[src]</a></span></h3>
  167. <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/standard/event.rs.html#41' title='goto source code'>[src]</a></span></h4>
  168. <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>
  169. </div></div><h3 id='impl-Hash' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> for <a class="struct" href="../ocl/struct.Event.html" title="struct ocl::Event">Event</a></code><a href='#impl-Hash' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/event.rs.html#41' title='goto source code'>[src]</a></span></h3>
  170. <div class='impl-items'><h4 id='method.hash' class="method"><span id='hash.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html#tymethod.hash' class='fnname'>hash</a>&lt;__H:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hasher.html" title="trait core::hash::Hasher">Hasher</a>&gt;(&amp;self, __arg_0: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>__H)</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/event.rs.html#41' title='goto source code'>[src]</a></span></h4>
  171. <div class='docblock'><p>Feeds this value into the given [<code>Hasher</code>]. <a href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html#tymethod.hash">Read more</a></p>
  172. </div><h4 id='method.hash_slice' class="method"><span id='hash_slice.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html#method.hash_slice' class='fnname'>hash_slice</a>&lt;H&gt;(data: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;[Self]</a>, state: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>H) <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;H: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hasher.html" title="trait core::hash::Hasher">Hasher</a>,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.3.0'>1.3.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/hash/mod.rs.html#202-208' title='goto source code'>[src]</a></span></h4>
  173. <div class='docblock'><p>Feeds a slice of this type into the given [<code>Hasher</code>]. <a href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html#method.hash_slice">Read more</a></p>
  174. </div></div><h3 id='impl-PartialEq' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a> for <a class="struct" href="../ocl/struct.Event.html" title="struct ocl::Event">Event</a></code><a href='#impl-PartialEq' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/event.rs.html#41' title='goto source code'>[src]</a></span></h3>
  175. <div class='impl-items'><h4 id='method.eq' class="method"><span id='eq.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq' class='fnname'>eq</a>(&amp;self, __arg_0: &amp;<a class="struct" href="../ocl/struct.Event.html" title="struct ocl::Event">Event</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/event.rs.html#41' title='goto source code'>[src]</a></span></h4>
  176. <div class='docblock'><p>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used by <code>==</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p>
  177. </div><h4 id='method.ne' class="method"><span id='ne.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne' class='fnname'>ne</a>(&amp;self, __arg_0: &amp;<a class="struct" href="../ocl/struct.Event.html" title="struct ocl::Event">Event</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/event.rs.html#41' title='goto source code'>[src]</a></span></h4>
  178. <div class='docblock'><p>This method tests for <code>!=</code>.</p>
  179. </div></div><h3 id='impl-Eq' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> for <a class="struct" href="../ocl/struct.Event.html" title="struct ocl::Event">Event</a></code><a href='#impl-Eq' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/event.rs.html#41' title='goto source code'>[src]</a></span></h3>
  180. <div class='impl-items'></div><h3 id='impl-From%3CEventCore%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="struct" href="../ocl_core/types/abs/struct.Event.html" title="struct ocl_core::types::abs::Event">EventCore</a>&gt; for <a class="struct" href="../ocl/struct.Event.html" title="struct ocl::Event">Event</a></code><a href='#impl-From%3CEventCore%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/event.rs.html#174-183' title='goto source code'>[src]</a></span></h3>
  181. <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>(ev: <a class="struct" href="../ocl_core/types/abs/struct.Event.html" title="struct ocl_core::types::abs::Event">EventCore</a>) -&gt; <a class="struct" href="../ocl/struct.Event.html" title="struct ocl::Event">Event</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/event.rs.html#176-182' title='goto source code'>[src]</a></span></h4>
  182. <div class='docblock'><p>Performs the conversion.</p>
  183. </div></div><h3 id='impl-From%3CEvent%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="struct" href="../ocl/struct.Event.html" title="struct ocl::Event">Event</a>&gt; for <a class="struct" href="../ocl_core/types/abs/struct.Event.html" title="struct ocl_core::types::abs::Event">EventCore</a></code><a href='#impl-From%3CEvent%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/event.rs.html#185-194' title='goto source code'>[src]</a></span></h3>
  184. <div class='impl-items'><h4 id='method.from-1' class="method"><span id='from.v-1' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(ev: <a class="struct" href="../ocl/struct.Event.html" title="struct ocl::Event">Event</a>) -&gt; <a class="struct" href="../ocl_core/types/abs/struct.Event.html" title="struct ocl_core::types::abs::Event">EventCore</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/event.rs.html#187-193' title='goto source code'>[src]</a></span></h4>
  185. <div class='docblock'><p>Performs the conversion.</p>
  186. </div></div><h3 id='impl-Default' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="../ocl/struct.Event.html" title="struct ocl::Event">Event</a></code><a href='#impl-Default' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/event.rs.html#196-200' title='goto source code'>[src]</a></span></h3>
  187. <div class='impl-items'><h4 id='method.default' class="method"><span id='default.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default' class='fnname'>default</a>() -&gt; <a class="struct" href="../ocl/struct.Event.html" title="struct ocl::Event">Event</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/event.rs.html#197-199' title='goto source code'>[src]</a></span></h4>
  188. <div class='docblock'><p>Returns the &quot;default value&quot; for a type. <a href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default">Read more</a></p>
  189. </div></div><h3 id='impl-Deref' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a> for <a class="struct" href="../ocl/struct.Event.html" title="struct ocl::Event">Event</a></code><a href='#impl-Deref' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/event.rs.html#202-208' title='goto source code'>[src]</a></span></h3>
  190. <div class='impl-items'><h4 id='associatedtype.Target' class="type"><span id='Target.t' class='invisible'><code>type <a href='https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html#associatedtype.Target' class="type">Target</a> = <a class="struct" href="../ocl_core/types/abs/struct.Event.html" title="struct ocl_core::types::abs::Event">EventCore</a></code></span></h4>
  191. <div class='docblock'><p>The resulting type after dereferencing.</p>
  192. </div><h4 id='method.deref' class="method"><span id='deref.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html#tymethod.deref' class='fnname'>deref</a>(&amp;self) -&gt; &amp;<a class="struct" href="../ocl_core/types/abs/struct.Event.html" title="struct ocl_core::types::abs::Event">EventCore</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/event.rs.html#205-207' title='goto source code'>[src]</a></span></h4>
  193. <div class='docblock'><p>Dereferences the value.</p>
  194. </div></div><h3 id='impl-DerefMut' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.DerefMut.html" title="trait core::ops::deref::DerefMut">DerefMut</a> for <a class="struct" href="../ocl/struct.Event.html" title="struct ocl::Event">Event</a></code><a href='#impl-DerefMut' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/event.rs.html#210-214' title='goto source code'>[src]</a></span></h3>
  195. <div class='impl-items'><h4 id='method.deref_mut' class="method"><span id='deref_mut.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/ops/deref/trait.DerefMut.html#tymethod.deref_mut' class='fnname'>deref_mut</a>(&amp;mut self) -&gt; &amp;mut <a class="struct" href="../ocl_core/types/abs/struct.Event.html" title="struct ocl_core::types::abs::Event">EventCore</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/event.rs.html#211-213' title='goto source code'>[src]</a></span></h4>
  196. <div class='docblock'><p>Mutably dereferences the value.</p>
  197. </div></div><h3 id='impl-AsRef%3CEventCore%3E' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a>&lt;<a class="struct" href="../ocl_core/types/abs/struct.Event.html" title="struct ocl_core::types::abs::Event">EventCore</a>&gt; for <a class="struct" href="../ocl/struct.Event.html" title="struct ocl::Event">Event</a></code><a href='#impl-AsRef%3CEventCore%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/event.rs.html#216-220' title='goto source code'>[src]</a></span></h3>
  198. <div class='impl-items'><h4 id='method.as_ref' class="method"><span id='as_ref.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html#tymethod.as_ref' class='fnname'>as_ref</a>(&amp;self) -&gt; &amp;<a class="struct" href="../ocl_core/types/abs/struct.Event.html" title="struct ocl_core::types::abs::Event">EventCore</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/event.rs.html#217-219' title='goto source code'>[src]</a></span></h4>
  199. <div class='docblock'><p>Performs the conversion.</p>
  200. </div></div><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="struct" href="../ocl/struct.Event.html" title="struct ocl::Event">Event</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/standard/event.rs.html#223-227' title='goto source code'>[src]</a></span></h3>
  201. <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.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="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/standard/event.rs.html#224-226' title='goto source code'>[src]</a></span></h4>
  202. <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>
  203. </div></div><h3 id='impl-ClEventPtrRef%3C%27e%3E' class='impl'><span class='in-band'><code>impl&lt;'e&gt; <a class="trait" href="../ocl_core/types/abs/trait.ClEventPtrRef.html" title="trait ocl_core::types::abs::ClEventPtrRef">ClEventPtrRef</a>&lt;'e&gt; for <a class="struct" href="../ocl/struct.Event.html" title="struct ocl::Event">Event</a></code><a href='#impl-ClEventPtrRef%3C%27e%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/event.rs.html#229-233' title='goto source code'>[src]</a></span></h3>
  204. <div class='impl-items'><h4 id='method.as_ptr_ref-1' class="method"><span id='as_ptr_ref.v-1' class='invisible'><code>unsafe fn <a href='../ocl_core/types/abs/trait.ClEventPtrRef.html#tymethod.as_ptr_ref' class='fnname'>as_ptr_ref</a>(&amp;'e self) -&gt; &amp;'e <a class="type" href="../cl_sys/cl_h/type.cl_event.html" title="type cl_sys::cl_h::cl_event">cl_event</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/event.rs.html#230-232' title='goto source code'>[src]</a></span></h4>
  205. </div><h3 id='impl-ClNullEventPtr' class='impl'><span class='in-band'><code>impl&lt;'a&gt; <a class="trait" href="../ocl_core/types/abs/trait.ClNullEventPtr.html" title="trait ocl_core::types::abs::ClNullEventPtr">ClNullEventPtr</a> for &amp;'a mut <a class="struct" href="../ocl/struct.Event.html" title="struct ocl::Event">Event</a></code><a href='#impl-ClNullEventPtr' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/event.rs.html#235-241' title='goto source code'>[src]</a></span></h3>
  206. <div class='impl-items'><h4 id='method.alloc_new' class="method"><span id='alloc_new.v' class='invisible'><code>fn <a href='../ocl_core/types/abs/trait.ClNullEventPtr.html#tymethod.alloc_new' class='fnname'>alloc_new</a>(&amp;mut self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="type" href="../cl_sys/cl_h/type.cl_event.html" title="type cl_sys::cl_h::cl_event">cl_event</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/event.rs.html#236' title='goto source code'>[src]</a></span></h4>
  207. <h4 id='method.clone_from-1' class="method"><span id='clone_from.v-1' class='invisible'><code>unsafe fn <a href='../ocl_core/types/abs/trait.ClNullEventPtr.html#tymethod.clone_from' class='fnname'>clone_from</a>&lt;E:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a>&lt;<a class="struct" href="../ocl_core/types/abs/struct.Event.html" title="struct ocl_core::types::abs::Event">EventCore</a>&gt;&gt;(&amp;mut self, ev: E)</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/event.rs.html#238-240' title='goto source code'>[src]</a></span></h4>
  208. </div><h3 id='impl-ClWaitListPtr' class='impl'><span class='in-band'><code>impl <a class="trait" href="../ocl_core/types/abs/trait.ClWaitListPtr.html" title="trait ocl_core::types::abs::ClWaitListPtr">ClWaitListPtr</a> for <a class="struct" href="../ocl/struct.Event.html" title="struct ocl::Event">Event</a></code><a href='#impl-ClWaitListPtr' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/event.rs.html#243-246' title='goto source code'>[src]</a></span></h3>
  209. <div class='impl-items'><h4 id='method.as_ptr_ptr' class="method"><span id='as_ptr_ptr.v' class='invisible'><code>unsafe fn <a href='../ocl_core/types/abs/trait.ClWaitListPtr.html#tymethod.as_ptr_ptr' class='fnname'>as_ptr_ptr</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*const </a><a class="type" href="../cl_sys/cl_h/type.cl_event.html" title="type cl_sys::cl_h::cl_event">cl_event</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/event.rs.html#244' title='goto source code'>[src]</a></span></h4>
  210. <div class='docblock'><p>Returns a pointer to the first pointer in this list.</p>
  211. </div><h4 id='method.count' class="method"><span id='count.v' class='invisible'><code>fn <a href='../ocl_core/types/abs/trait.ClWaitListPtr.html#tymethod.count' class='fnname'>count</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/event.rs.html#245' title='goto source code'>[src]</a></span></h4>
  212. <div class='docblock'><p>Returns the number of items in this wait list.</p>
  213. </div></div><h3 id='impl-ClWaitListPtr-1' class='impl'><span class='in-band'><code>impl&lt;'a&gt; <a class="trait" href="../ocl_core/types/abs/trait.ClWaitListPtr.html" title="trait ocl_core::types::abs::ClWaitListPtr">ClWaitListPtr</a> for &amp;'a <a class="struct" href="../ocl/struct.Event.html" title="struct ocl::Event">Event</a></code><a href='#impl-ClWaitListPtr-1' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/event.rs.html#248-251' title='goto source code'>[src]</a></span></h3>
  214. <div class='impl-items'><h4 id='method.as_ptr_ptr-1' class="method"><span id='as_ptr_ptr.v-1' class='invisible'><code>unsafe fn <a href='../ocl_core/types/abs/trait.ClWaitListPtr.html#tymethod.as_ptr_ptr' class='fnname'>as_ptr_ptr</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*const </a><a class="type" href="../cl_sys/cl_h/type.cl_event.html" title="type cl_sys::cl_h::cl_event">cl_event</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/event.rs.html#249' title='goto source code'>[src]</a></span></h4>
  215. <div class='docblock'><p>Returns a pointer to the first pointer in this list.</p>
  216. </div><h4 id='method.count-1' class="method"><span id='count.v-1' class='invisible'><code>fn <a href='../ocl_core/types/abs/trait.ClWaitListPtr.html#tymethod.count' class='fnname'>count</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/event.rs.html#250' title='goto source code'>[src]</a></span></h4>
  217. <div class='docblock'><p>Returns the number of items in this wait list.</p>
  218. </div></div><h3 id='impl-Future' class='impl'><span class='in-band'><code>impl <a class="trait" href="../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a> for <a class="struct" href="../ocl/struct.Event.html" title="struct ocl::Event">Event</a></code><a href='#impl-Future' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/event.rs.html#253-286' title='goto source code'>[src]</a></span></h3>
  219. <div class='impl-items'><h4 id='associatedtype.Item' class="type"><span id='Item.t' class='invisible'><code>type <a href='../futures/future/trait.Future.html#associatedtype.Item' class="type">Item</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a></code></span></h4>
  220. <div class='docblock'><p>The type of value that this future will resolved with if it is successful. <a href="../futures/future/trait.Future.html#associatedtype.Item">Read more</a></p>
  221. </div><h4 id='associatedtype.Error' class="type"><span id='Error.t' class='invisible'><code>type <a href='../futures/future/trait.Future.html#associatedtype.Error' class="type">Error</a> = <a class="struct" href="../ocl/error/struct.Error.html" title="struct ocl::error::Error">OclError</a></code></span></h4>
  222. <div class='docblock'><p>The type of error that this future will resolve with if it fails in a normal fashion. <a href="../futures/future/trait.Future.html#associatedtype.Error">Read more</a></p>
  223. </div><h4 id='method.poll' class="method"><span id='poll.v' class='invisible'><code>fn <a href='../futures/future/trait.Future.html#tymethod.poll' class='fnname'>poll</a>(&amp;mut self) -&gt; <a class="type" href="../futures/poll/type.Poll.html" title="type futures::poll::Poll">Poll</a>&lt;Self::<a class="type" href="../futures/future/trait.Future.html#associatedtype.Item" title="type futures::future::Future::Item">Item</a>, Self::<a class="type" href="../futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/event.rs.html#264-277' title='goto source code'>[src]</a></span></h4>
  224. <div class='docblock'><p>Query this future to see if its value has become available, registering interest if it is not. <a href="../futures/future/trait.Future.html#tymethod.poll">Read more</a></p>
  225. </div><h4 id='method.wait' class="method"><span id='wait.v' class='invisible'><code>fn <a href='../futures/future/trait.Future.html#method.wait' class='fnname'>wait</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;Self::<a class="type" href="../futures/future/trait.Future.html#associatedtype.Item" title="type futures::future::Future::Item">Item</a>, Self::<a class="type" href="../futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/future/mod.rs.html#296-300' title='goto source code'>[src]</a></span></h4>
  226. <div class='docblock'><p>Block the current thread until this future is resolved. <a href="../futures/future/trait.Future.html#method.wait">Read more</a></p>
  227. </div><h4 id='method.map' class="method"><span id='map.v' class='invisible'><code>fn <a href='../futures/future/trait.Future.html#method.map' class='fnname'>map</a>&lt;F, U&gt;(self, f: F) -&gt; <a class="struct" href="../futures/future/map/struct.Map.html" title="struct futures::future::map::Map">Map</a>&lt;Self, F&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="../futures/future/trait.Future.html#associatedtype.Item" title="type futures::future::Future::Item">Item</a>) -&gt; U,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/future/mod.rs.html#370-375' title='goto source code'>[src]</a></span></h4>
  228. <div class='docblock'><p>Map this future's result to a different type, returning a new future of the resulting type. <a href="../futures/future/trait.Future.html#method.map">Read more</a></p>
  229. </div><h4 id='method.map_err' class="method"><span id='map_err.v' class='invisible'><code>fn <a href='../futures/future/trait.Future.html#method.map_err' class='fnname'>map_err</a>&lt;F, E&gt;(self, f: F) -&gt; <a class="struct" href="../futures/future/map_err/struct.MapErr.html" title="struct futures::future::map_err::MapErr">MapErr</a>&lt;Self, F&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="../futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>) -&gt; E,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/future/mod.rs.html#410-415' title='goto source code'>[src]</a></span></h4>
  230. <div class='docblock'><p>Map this future's error to a different error, returning a new future. <a href="../futures/future/trait.Future.html#method.map_err">Read more</a></p>
  231. </div><h4 id='method.from_err' class="method"><span id='from_err.v' class='invisible'><code>fn <a href='../futures/future/trait.Future.html#method.from_err' class='fnname'>from_err</a>&lt;E&gt;(self) -&gt; <a class="struct" href="../futures/future/from_err/struct.FromErr.html" title="struct futures::future::from_err::FromErr">FromErr</a>&lt;Self, E&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;E: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;Self::<a class="type" href="../futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>&gt;,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/future/mod.rs.html#440-444' title='goto source code'>[src]</a></span></h4>
  232. <div class='docblock'><p>Map this future's error to any error implementing <code>From</code> for this future's <code>Error</code>, returning a new future. <a href="../futures/future/trait.Future.html#method.from_err">Read more</a></p>
  233. </div><h4 id='method.then' class="method"><span id='then.v' class='invisible'><code>fn <a href='../futures/future/trait.Future.html#method.then' class='fnname'>then</a>&lt;F, B&gt;(self, f: F) -&gt; <a class="struct" href="../futures/future/then/struct.Then.html" title="struct futures::future::then::Then">Then</a>&lt;Self, B, F&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;B: <a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;Self::<a class="type" href="../futures/future/trait.Future.html#associatedtype.Item" title="type futures::future::Future::Item">Item</a>, Self::<a class="type" href="../futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>&gt;) -&gt; B,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/future/mod.rs.html#484-490' title='goto source code'>[src]</a></span></h4>
  234. <div class='docblock'><p>Chain on a computation for when a future finished, passing the result of the future to the provided closure <code>f</code>. <a href="../futures/future/trait.Future.html#method.then">Read more</a></p>
  235. </div><h4 id='method.and_then' class="method"><span id='and_then.v' class='invisible'><code>fn <a href='../futures/future/trait.Future.html#method.and_then' class='fnname'>and_then</a>&lt;F, B&gt;(self, f: F) -&gt; <a class="struct" href="../futures/future/and_then/struct.AndThen.html" title="struct futures::future::and_then::AndThen">AndThen</a>&lt;Self, B, F&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;B: <a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>&lt;Error = Self::<a class="type" href="../futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="../futures/future/trait.Future.html#associatedtype.Item" title="type futures::future::Future::Item">Item</a>) -&gt; B,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/future/mod.rs.html#525-531' title='goto source code'>[src]</a></span></h4>
  236. <div class='docblock'><p>Execute another future after this one has resolved successfully. <a href="../futures/future/trait.Future.html#method.and_then">Read more</a></p>
  237. </div><h4 id='method.or_else' class="method"><span id='or_else.v' class='invisible'><code>fn <a href='../futures/future/trait.Future.html#method.or_else' class='fnname'>or_else</a>&lt;F, B&gt;(self, f: F) -&gt; <a class="struct" href="../futures/future/or_else/struct.OrElse.html" title="struct futures::future::or_else::OrElse">OrElse</a>&lt;Self, B, F&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;B: <a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>&lt;Item = Self::<a class="type" href="../futures/future/trait.Future.html#associatedtype.Item" title="type futures::future::Future::Item">Item</a>&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="../futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>) -&gt; B,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/future/mod.rs.html#566-572' title='goto source code'>[src]</a></span></h4>
  238. <div class='docblock'><p>Execute another future if this one resolves with an error. <a href="../futures/future/trait.Future.html#method.or_else">Read more</a></p>
  239. </div><h4 id='method.select' class="method"><span id='select.v' class='invisible'><code>fn <a href='../futures/future/trait.Future.html#method.select' class='fnname'>select</a>&lt;B&gt;(self, other: B) -&gt; <a class="struct" href="../futures/future/select/struct.Select.html" title="struct futures::future::select::Select">Select</a>&lt;Self, &lt;B as <a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>&gt;::<a class="type" href="../futures/future/trait.IntoFuture.html#associatedtype.Future" title="type futures::future::IntoFuture::Future">Future</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;B: <a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>&lt;Item = Self::<a class="type" href="../futures/future/trait.Future.html#associatedtype.Item" title="type futures::future::Future::Item">Item</a>, Error = Self::<a class="type" href="../futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>&gt;,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/future/mod.rs.html#624-631' title='goto source code'>[src]</a></span></h4>
  240. <div class='docblock'><p>Waits for either one of two futures to complete. <a href="../futures/future/trait.Future.html#method.select">Read more</a></p>
  241. </div><h4 id='method.select2' class="method"><span id='select2.v' class='invisible'><code>fn <a href='../futures/future/trait.Future.html#method.select2' class='fnname'>select2</a>&lt;B&gt;(self, other: B) -&gt; <a class="struct" href="../futures/future/select2/struct.Select2.html" title="struct futures::future::select2::Select2">Select2</a>&lt;Self, &lt;B as <a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>&gt;::<a class="type" href="../futures/future/trait.IntoFuture.html#associatedtype.Future" title="type futures::future::IntoFuture::Future">Future</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;B: <a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/future/mod.rs.html#670-674' title='goto source code'>[src]</a></span></h4>
  242. <div class='docblock'><p>Waits for either one of two differently-typed futures to complete. <a href="../futures/future/trait.Future.html#method.select2">Read more</a></p>
  243. </div><h4 id='method.join' class="method"><span id='join.v' class='invisible'><code>fn <a href='../futures/future/trait.Future.html#method.join' class='fnname'>join</a>&lt;B&gt;(self, other: B) -&gt; <a class="struct" href="../futures/future/join/struct.Join.html" title="struct futures::future::join::Join">Join</a>&lt;Self, &lt;B as <a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>&gt;::<a class="type" href="../futures/future/trait.IntoFuture.html#associatedtype.Future" title="type futures::future::IntoFuture::Future">Future</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;B: <a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>&lt;Error = Self::<a class="type" href="../futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>&gt;,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/future/mod.rs.html#715-721' title='goto source code'>[src]</a></span></h4>
  244. <div class='docblock'><p>Joins the result of two futures, waiting for them both to complete. <a href="../futures/future/trait.Future.html#method.join">Read more</a></p>
  245. </div><h4 id='method.join3' class="method"><span id='join3.v' class='invisible'><code>fn <a href='../futures/future/trait.Future.html#method.join3' class='fnname'>join3</a>&lt;B, C&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;b: B, <br>&nbsp;&nbsp;&nbsp;&nbsp;c: C<br>) -&gt; <a class="struct" href="../futures/future/join/struct.Join3.html" title="struct futures::future::join::Join3">Join3</a>&lt;Self, &lt;B as <a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>&gt;::<a class="type" href="../futures/future/trait.IntoFuture.html#associatedtype.Future" title="type futures::future::IntoFuture::Future">Future</a>, &lt;C as <a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>&gt;::<a class="type" href="../futures/future/trait.IntoFuture.html#associatedtype.Future" title="type futures::future::IntoFuture::Future">Future</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;B: <a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>&lt;Error = Self::<a class="type" href="../futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;C: <a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>&lt;Error = Self::<a class="type" href="../futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>&gt;,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/future/mod.rs.html#724-730' title='goto source code'>[src]</a></span></h4>
  246. <div class='docblock'><p>Same as <code>join</code>, but with more futures.</p>
  247. </div><h4 id='method.join4' class="method"><span id='join4.v' class='invisible'><code>fn <a href='../futures/future/trait.Future.html#method.join4' class='fnname'>join4</a>&lt;B, C, D&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;b: B, <br>&nbsp;&nbsp;&nbsp;&nbsp;c: C, <br>&nbsp;&nbsp;&nbsp;&nbsp;d: D<br>) -&gt; <a class="struct" href="../futures/future/join/struct.Join4.html" title="struct futures::future::join::Join4">Join4</a>&lt;Self, &lt;B as <a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>&gt;::<a class="type" href="../futures/future/trait.IntoFuture.html#associatedtype.Future" title="type futures::future::IntoFuture::Future">Future</a>, &lt;C as <a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>&gt;::<a class="type" href="../futures/future/trait.IntoFuture.html#associatedtype.Future" title="type futures::future::IntoFuture::Future">Future</a>, &lt;D as <a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>&gt;::<a class="type" href="../futures/future/trait.IntoFuture.html#associatedtype.Future" title="type futures::future::IntoFuture::Future">Future</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;B: <a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>&lt;Error = Self::<a class="type" href="../futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;C: <a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>&lt;Error = Self::<a class="type" href="../futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;D: <a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>&lt;Error = Self::<a class="type" href="../futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>&gt;,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/future/mod.rs.html#733-741' title='goto source code'>[src]</a></span></h4>
  248. <div class='docblock'><p>Same as <code>join</code>, but with more futures.</p>
  249. </div><h4 id='method.join5' class="method"><span id='join5.v' class='invisible'><code>fn <a href='../futures/future/trait.Future.html#method.join5' class='fnname'>join5</a>&lt;B, C, D, E&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;b: B, <br>&nbsp;&nbsp;&nbsp;&nbsp;c: C, <br>&nbsp;&nbsp;&nbsp;&nbsp;d: D, <br>&nbsp;&nbsp;&nbsp;&nbsp;e: E<br>) -&gt; <a class="struct" href="../futures/future/join/struct.Join5.html" title="struct futures::future::join::Join5">Join5</a>&lt;Self, &lt;B as <a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>&gt;::<a class="type" href="../futures/future/trait.IntoFuture.html#associatedtype.Future" title="type futures::future::IntoFuture::Future">Future</a>, &lt;C as <a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>&gt;::<a class="type" href="../futures/future/trait.IntoFuture.html#associatedtype.Future" title="type futures::future::IntoFuture::Future">Future</a>, &lt;D as <a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>&gt;::<a class="type" href="../futures/future/trait.IntoFuture.html#associatedtype.Future" title="type futures::future::IntoFuture::Future">Future</a>, &lt;E as <a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>&gt;::<a class="type" href="../futures/future/trait.IntoFuture.html#associatedtype.Future" title="type futures::future::IntoFuture::Future">Future</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;B: <a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>&lt;Error = Self::<a class="type" href="../futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;C: <a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>&lt;Error = Self::<a class="type" href="../futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;D: <a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>&lt;Error = Self::<a class="type" href="../futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;E: <a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>&lt;Error = Self::<a class="type" href="../futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>&gt;,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/future/mod.rs.html#744-754' title='goto source code'>[src]</a></span></h4>
  250. <div class='docblock'><p>Same as <code>join</code>, but with more futures.</p>
  251. </div><h4 id='method.into_stream' class="method"><span id='into_stream.v' class='invisible'><code>fn <a href='../futures/future/trait.Future.html#method.into_stream' class='fnname'>into_stream</a>(self) -&gt; <a class="struct" href="../futures/future/into_stream/struct.IntoStream.html" title="struct futures::future::into_stream::IntoStream">IntoStream</a>&lt;Self&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/future/mod.rs.html#777-781' title='goto source code'>[src]</a></span></h4>
  252. <div class='docblock'><p>Convert this future into a single element stream. <a href="../futures/future/trait.Future.html#method.into_stream">Read more</a></p>
  253. </div><h4 id='method.flatten' class="method"><span id='flatten.v' class='invisible'><code>fn <a href='../futures/future/trait.Future.html#method.flatten' class='fnname'>flatten</a>(self) -&gt; <a class="struct" href="../futures/future/flatten/struct.Flatten.html" title="struct futures::future::flatten::Flatten">Flatten</a>&lt;Self&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Self::<a class="type" href="../futures/future/trait.Future.html#associatedtype.Item" title="type futures::future::Future::Item">Item</a>: <a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&lt;Self::<a class="type" href="../futures/future/trait.Future.html#associatedtype.Item" title="type futures::future::Future::Item">Item</a> as <a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>&gt;::<a class="type" href="../futures/future/trait.IntoFuture.html#associatedtype.Error" title="type futures::future::IntoFuture::Error">Error</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;Self::<a class="type" href="../futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>&gt;,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/future/mod.rs.html#819-829' title='goto source code'>[src]</a></span></h4>
  254. <div class='docblock'><p>Flatten the execution of this future when the successful result of this future is itself another future. <a href="../futures/future/trait.Future.html#method.flatten">Read more</a></p>
  255. </div><h4 id='method.flatten_stream' class="method"><span id='flatten_stream.v' class='invisible'><code>fn <a href='../futures/future/trait.Future.html#method.flatten_stream' class='fnname'>flatten_stream</a>(self) -&gt; <a class="struct" href="../futures/future/flatten_stream/struct.FlattenStream.html" title="struct futures::future::flatten_stream::FlattenStream">FlattenStream</a>&lt;Self&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Self::<a class="type" href="../futures/future/trait.Future.html#associatedtype.Item" title="type futures::future::Future::Item">Item</a>: <a class="trait" href="../futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&lt;Self::<a class="type" href="../futures/future/trait.Future.html#associatedtype.Item" title="type futures::future::Future::Item">Item</a> as <a class="trait" href="../futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a>&gt;::<a class="type" href="../futures/stream/trait.Stream.html#associatedtype.Error" title="type futures::stream::Stream::Error">Error</a> == Self::<a class="type" href="../futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/future/mod.rs.html#859-864' title='goto source code'>[src]</a></span></h4>
  256. <div class='docblock'><p>Flatten the execution of this future when the successful result of this future is a stream. <a href="../futures/future/trait.Future.html#method.flatten_stream">Read more</a></p>
  257. </div><h4 id='method.fuse' class="method"><span id='fuse.v' class='invisible'><code>fn <a href='../futures/future/trait.Future.html#method.fuse' class='fnname'>fuse</a>(self) -&gt; <a class="struct" href="../futures/future/fuse/struct.Fuse.html" title="struct futures::future::fuse::Fuse">Fuse</a>&lt;Self&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/future/mod.rs.html#899-904' title='goto source code'>[src]</a></span></h4>
  258. <div class='docblock'><p>Fuse a future such that <code>poll</code> will never again be called once it has completed. <a href="../futures/future/trait.Future.html#method.fuse">Read more</a></p>
  259. </div><h4 id='method.inspect' class="method"><span id='inspect.v' class='invisible'><code>fn <a href='../futures/future/trait.Future.html#method.inspect' class='fnname'>inspect</a>&lt;F&gt;(self, f: F) -&gt; <a class="struct" href="../futures/future/inspect/struct.Inspect.html" title="struct futures::future::inspect::Inspect">Inspect</a>&lt;Self, F&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(&amp;Self::<a class="type" href="../futures/future/trait.Future.html#associatedtype.Item" title="type futures::future::Future::Item">Item</a>),&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/future/mod.rs.html#922-927' title='goto source code'>[src]</a></span></h4>
  260. <div class='docblock'><p>Do something with the item of a future, passing it on. <a href="../futures/future/trait.Future.html#method.inspect">Read more</a></p>
  261. </div><h4 id='method.catch_unwind' class="method"><span id='catch_unwind.v' class='invisible'><code>fn <a href='../futures/future/trait.Future.html#method.catch_unwind' class='fnname'>catch_unwind</a>(self) -&gt; <a class="struct" href="../futures/future/catch_unwind/struct.CatchUnwind.html" title="struct futures::future::catch_unwind::CatchUnwind">CatchUnwind</a>&lt;Self&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Self: <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a>,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/future/mod.rs.html#961-965' title='goto source code'>[src]</a></span></h4>
  262. <div class='docblock'><p>Catches unwinding panics while polling the future. <a href="../futures/future/trait.Future.html#method.catch_unwind">Read more</a></p>
  263. </div><h4 id='method.shared' class="method"><span id='shared.v' class='invisible'><code>fn <a href='../futures/future/trait.Future.html#method.shared' class='fnname'>shared</a>(self) -&gt; <a class="struct" href="../futures/future/shared/struct.Shared.html" title="struct futures::future::shared::Shared">Shared</a>&lt;Self&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/future/mod.rs.html#1010-1014' title='goto source code'>[src]</a></span></h4>
  264. <div class='docblock'><p>Create a cloneable handle to this future where all handles will resolve to the same result. <a href="../futures/future/trait.Future.html#method.shared">Read more</a></p>
  265. </div></div><h3 id='impl-From%3CEvent%3E-1' class='impl'><span class='in-band'><code>impl&lt;'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/struct.Event.html" title="struct ocl::Event">Event</a>&gt; for <a class="struct" href="../ocl/struct.EventArray.html" title="struct ocl::EventArray">EventArray</a></code><a href='#impl-From%3CEvent%3E-1' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/event.rs.html#516-526' title='goto source code'>[src]</a></span></h3>
  266. <div class='impl-items'><h4 id='method.from-2' class="method"><span id='from.v-2' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(event: <a class="struct" href="../ocl/struct.Event.html" title="struct ocl::Event">Event</a>) -&gt; <a class="struct" href="../ocl/struct.EventArray.html" title="struct ocl::EventArray">EventArray</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/event.rs.html#517-525' title='goto source code'>[src]</a></span></h4>
  267. <div class='docblock'><p>Performs the conversion.</p>
  268. </div></div><h3 id='impl-From%3CEvent%3E-2' class='impl'><span class='in-band'><code>impl&lt;'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/struct.Event.html" title="struct ocl::Event">Event</a>&gt; for <a class="struct" href="../ocl/struct.EventList.html" title="struct ocl::EventList">EventList</a></code><a href='#impl-From%3CEvent%3E-2' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/event.rs.html#869-874' title='goto source code'>[src]</a></span></h3>
  269. <div class='impl-items'><h4 id='method.from-3' class="method"><span id='from.v-3' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(event: <a class="struct" href="../ocl/struct.Event.html" title="struct ocl::Event">Event</a>) -&gt; <a class="struct" href="../ocl/struct.EventList.html" title="struct ocl::EventList">EventList</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/event.rs.html#871-873' title='goto source code'>[src]</a></span></h4>
  270. <div class='docblock'><p>Performs the conversion.</p>
  271. </div></div><h3 id='impl-From%3CEvent%3E-3' class='impl'><span class='in-band'><code>impl&lt;'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/struct.Event.html" title="struct ocl::Event">Event</a>&gt; for <a class="enum" href="../ocl/builders/enum.ClWaitListPtrEnum.html" title="enum ocl::builders::ClWaitListPtrEnum">ClWaitListPtrEnum</a>&lt;'a&gt;</code><a href='#impl-From%3CEvent%3E-3' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/mod.rs.html#229-233' title='goto source code'>[src]</a></span></h3>
  272. <div class='impl-items'><h4 id='method.from-4' class="method"><span id='from.v-4' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(e: <a class="struct" href="../ocl/struct.Event.html" title="struct ocl::Event">Event</a>) -&gt; <a class="enum" href="../ocl/builders/enum.ClWaitListPtrEnum.html" title="enum ocl::builders::ClWaitListPtrEnum">ClWaitListPtrEnum</a>&lt;'a&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/mod.rs.html#230-232' title='goto source code'>[src]</a></span></h4>
  273. <div class='docblock'><p>Performs the conversion.</p>
  274. </div></div><h3 id='impl-From%3C%26%27a%20Event%3E' class='impl'><span class='in-band'><code>impl&lt;'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;&amp;'a <a class="struct" href="../ocl/struct.Event.html" title="struct ocl::Event">Event</a>&gt; for <a class="enum" href="../ocl/builders/enum.ClWaitListPtrEnum.html" title="enum ocl::builders::ClWaitListPtrEnum">ClWaitListPtrEnum</a>&lt;'a&gt;</code><a href='#impl-From%3C%26%27a%20Event%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/mod.rs.html#235-239' title='goto source code'>[src]</a></span></h3>
  275. <div class='impl-items'><h4 id='method.from-5' class="method"><span id='from.v-5' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(e: &amp;'a <a class="struct" href="../ocl/struct.Event.html" title="struct ocl::Event">Event</a>) -&gt; <a class="enum" href="../ocl/builders/enum.ClWaitListPtrEnum.html" title="enum ocl::builders::ClWaitListPtrEnum">ClWaitListPtrEnum</a>&lt;'a&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/mod.rs.html#236-238' title='goto source code'>[src]</a></span></h4>
  276. <div class='docblock'><p>Performs the conversion.</p>
  277. </div></div><h3 id='impl-From%3C%26%27a%20mut%20Event%3E' class='impl'><span class='in-band'><code>impl&lt;'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;&amp;'a mut <a class="struct" href="../ocl/struct.Event.html" title="struct ocl::Event">Event</a>&gt; for <a class="enum" href="../ocl/builders/enum.ClWaitListPtrEnum.html" title="enum ocl::builders::ClWaitListPtrEnum">ClWaitListPtrEnum</a>&lt;'a&gt;</code><a href='#impl-From%3C%26%27a%20mut%20Event%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/mod.rs.html#241-245' title='goto source code'>[src]</a></span></h3>
  278. <div class='impl-items'><h4 id='method.from-6' class="method"><span id='from.v-6' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(e: &amp;'a mut <a class="struct" href="../ocl/struct.Event.html" title="struct ocl::Event">Event</a>) -&gt; <a class="enum" href="../ocl/builders/enum.ClWaitListPtrEnum.html" title="enum ocl::builders::ClWaitListPtrEnum">ClWaitListPtrEnum</a>&lt;'a&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/mod.rs.html#242-244' title='goto source code'>[src]</a></span></h4>
  279. <div class='docblock'><p>Performs the conversion.</p>
  280. </div></div><h3 id='impl-From%3C%26%27a%20mut%20Event%3E-1' class='impl'><span class='in-band'><code>impl&lt;'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;&amp;'a mut <a class="struct" href="../ocl/struct.Event.html" title="struct ocl::Event">Event</a>&gt; for <a class="enum" href="../ocl/builders/enum.ClNullEventPtrEnum.html" title="enum ocl::builders::ClNullEventPtrEnum">ClNullEventPtrEnum</a>&lt;'a&gt;</code><a href='#impl-From%3C%26%27a%20mut%20Event%3E-1' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/mod.rs.html#343-347' title='goto source code'>[src]</a></span></h3>
  281. <div class='impl-items'><h4 id='method.from-7' class="method"><span id='from.v-7' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(e: &amp;'a mut <a class="struct" href="../ocl/struct.Event.html" title="struct ocl::Event">Event</a>) -&gt; <a class="enum" href="../ocl/builders/enum.ClNullEventPtrEnum.html" title="enum ocl::builders::ClNullEventPtrEnum">ClNullEventPtrEnum</a>&lt;'a&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/mod.rs.html#344-346' title='goto source code'>[src]</a></span></h4>
  282. <div class='docblock'><p>Performs the conversion.</p>
  283. </div></div></section>
  284. <section id='search' class="content hidden"></section>
  285. <section class="footer"></section>
  286. <aside id="help" class="hidden">
  287. <div>
  288. <h1 class="hidden">Help</h1>
  289. <div class="shortcuts">
  290. <h2>Keyboard Shortcuts</h2>
  291. <dl>
  292. <dt><kbd>?</kbd></dt>
  293. <dd>Show this help dialog</dd>
  294. <dt><kbd>S</kbd></dt>
  295. <dd>Focus the search field</dd>
  296. <dt><kbd>↑</kbd></dt>
  297. <dd>Move up in search results</dd>
  298. <dt><kbd>↓</kbd></dt>
  299. <dd>Move down in search results</dd>
  300. <dt><kbd>↹</kbd></dt>
  301. <dd>Switch tab</dd>
  302. <dt><kbd>&#9166;</kbd></dt>
  303. <dd>Go to active search result</dd>
  304. <dt><kbd>+</kbd></dt>
  305. <dd>Expand all sections</dd>
  306. <dt><kbd>-</kbd></dt>
  307. <dd>Collapse all sections</dd>
  308. </dl>
  309. </div>
  310. <div class="infos">
  311. <h2>Search Tricks</h2>
  312. <p>
  313. Prefix searches with a type followed by a colon (e.g.
  314. <code>fn:</code>) to restrict the search to a given type.
  315. </p>
  316. <p>
  317. Accepted types are: <code>fn</code>, <code>mod</code>,
  318. <code>struct</code>, <code>enum</code>,
  319. <code>trait</code>, <code>type</code>, <code>macro</code>,
  320. and <code>const</code>.
  321. </p>
  322. <p>
  323. Search functions by type signature (e.g.
  324. <code>vec -> usize</code> or <code>* -> vec</code>)
  325. </p>
  326. </div>
  327. </div>
  328. </aside>
  329. <script>
  330. window.rootPath = "../";
  331. window.currentCrate = "ocl";
  332. </script>
  333. <script src="../main.js"></script>
  334. <script defer src="../search-index.js"></script>
  335. </body>
  336. </html>