| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152 |
- <!DOCTYPE html>
- <html lang="en">
- <head>
- <meta charset="utf-8">
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
- <meta name="generator" content="rustdoc">
- <meta name="description" content="API documentation for the Rust `OrderGuard` trait in crate `ocl`.">
- <meta name="keywords" content="rust, rustlang, rust-lang, OrderGuard">
- <title>ocl::async::OrderGuard - Rust</title>
- <link rel="stylesheet" type="text/css" href="../../normalize.css">
- <link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle">
-
- <link rel="stylesheet" type="text/css" href="../../dark.css">
- <link rel="stylesheet" type="text/css" href="../../main.css" id="themeStyle">
- <script src="../../storage.js"></script>
-
-
-
- </head>
- <body class="rustdoc trait">
- <!--[if lte IE 8]>
- <div class="warning">
- This old browser is unsupported and will most likely display funky
- things.
- </div>
- <![endif]-->
-
- <nav class="sidebar">
- <div class="sidebar-menu">☰</div>
-
- <p class='location'>Trait OrderGuard</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.new">new</a><a href="#tymethod.order_lock">order_lock</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.forget">forget</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../index.html'>ocl</a>::<wbr><a href='index.html'>async</a></p><script>window.sidebarCurrent = {name: 'OrderGuard', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script></div>
- </nav>
- <div class="theme-picker">
- <button id="theme-picker" aria-label="Pick another theme!">
- <img src="../../brush.svg" width="18" alt="Pick another theme!">
- </button>
- <div id="theme-choices"></div>
- </div>
- <script src="../../theme.js"></script>
- <nav class="sub">
- <form class="search-form js-only">
- <div class="search-container">
- <input class="search-input" name="search"
- autocomplete="off"
- placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
- type="search">
- </div>
- </form>
- </nav>
- <section id='main' class="content">
- <h1 class='fqn'><span class='in-band'>Trait <a href='../index.html'>ocl</a>::<wbr><a href='index.html'>async</a>::<wbr><a class="trait" href=''>OrderGuard</a></span><span class='out-of-band'><span id='render-detail'>
- <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
- [<span class='inner'>−</span>]
- </a>
- </span><a class='srclink' href='../../src/ocl/async/order_lock.rs.html#47-54' title='goto source code'>[src]</a></span></h1>
- <pre class='rust trait'>pub trait OrderGuard<V> <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span>{
- fn <a href='#tymethod.new' class='fnname'>new</a>(order_lock: <a class="struct" href="../../ocl/async/struct.OrderLock.html" title="struct ocl::async::OrderLock">OrderLock</a><V>, release_event: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../ocl/struct.Event.html" title="struct ocl::Event">Event</a>>) -> Self;
- <div class='item-spacer'></div> fn <a href='#tymethod.order_lock' class='fnname'>order_lock</a>(&self) -> &<a class="struct" href="../../ocl/async/struct.OrderLock.html" title="struct ocl::async::OrderLock">OrderLock</a><V>;
- unsafe fn <a href='#method.forget' class='fnname'>forget</a>(self) { ... }
- }</pre><div class='docblock'><p>A read or write guard for an <code>OrderLock</code>.</p>
- </div>
- <h2 id='required-methods' class='small-section-header'>
- Required Methods<a href='#required-methods' class='anchor'></a>
- </h2>
- <div class='methods'>
- <h3 id='tymethod.new' class='method'><span id='new.v' class='invisible'><code>fn <a href='#tymethod.new' class='fnname'>new</a>(order_lock: <a class="struct" href="../../ocl/async/struct.OrderLock.html" title="struct ocl::async::OrderLock">OrderLock</a><V>, release_event: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../ocl/struct.Event.html" title="struct ocl::Event">Event</a>>) -> Self</code></span></h3><h3 id='tymethod.order_lock' class='method'><span id='order_lock.v' class='invisible'><code>fn <a href='#tymethod.order_lock' class='fnname'>order_lock</a>(&self) -> &<a class="struct" href="../../ocl/async/struct.OrderLock.html" title="struct ocl::async::OrderLock">OrderLock</a><V></code></span></h3></div>
- <h2 id='provided-methods' class='small-section-header'>
- Provided Methods<a href='#provided-methods' class='anchor'></a>
- </h2>
- <div class='methods'>
- <h3 id='method.forget' class='method'><span id='forget.v' class='invisible'><code>unsafe fn <a href='#method.forget' class='fnname'>forget</a>(self)</code></span></h3></div>
- <h2 id='implementors' class='small-section-header'>
- Implementors<a href='#implementors' class='anchor'></a>
- </h2>
- <ul class='item-list' id='implementors-list'>
- <li><div class='out-of-band'><a class='srclink' href='../../src/ocl/async/order_lock.rs.html#151-159' title='goto source code'>[src]</a></div><code>impl<V> OrderGuard<V> for <a class="struct" href="../../ocl/struct.ReadGuard.html" title="struct ocl::ReadGuard">ReadGuard</a><V></code></li>
- <li><div class='out-of-band'><a class='srclink' href='../../src/ocl/async/order_lock.rs.html#238-246' title='goto source code'>[src]</a></div><code>impl<V> OrderGuard<V> for <a class="struct" href="../../ocl/struct.WriteGuard.html" title="struct ocl::WriteGuard">WriteGuard</a><V></code></li>
- </ul><script type="text/javascript" async
- src="../../implementors/ocl/async/trait.OrderGuard.js">
- </script></section>
- <section id='search' class="content hidden"></section>
- <section class="footer"></section>
- <aside id="help" class="hidden">
- <div>
- <h1 class="hidden">Help</h1>
- <div class="shortcuts">
- <h2>Keyboard Shortcuts</h2>
- <dl>
- <dt><kbd>?</kbd></dt>
- <dd>Show this help dialog</dd>
- <dt><kbd>S</kbd></dt>
- <dd>Focus the search field</dd>
- <dt><kbd>↑</kbd></dt>
- <dd>Move up in search results</dd>
- <dt><kbd>↓</kbd></dt>
- <dd>Move down in search results</dd>
- <dt><kbd>↹</kbd></dt>
- <dd>Switch tab</dd>
- <dt><kbd>⏎</kbd></dt>
- <dd>Go to active search result</dd>
- <dt><kbd>+</kbd></dt>
- <dd>Expand all sections</dd>
- <dt><kbd>-</kbd></dt>
- <dd>Collapse all sections</dd>
- </dl>
- </div>
- <div class="infos">
- <h2>Search Tricks</h2>
- <p>
- Prefix searches with a type followed by a colon (e.g.
- <code>fn:</code>) to restrict the search to a given type.
- </p>
- <p>
- Accepted types are: <code>fn</code>, <code>mod</code>,
- <code>struct</code>, <code>enum</code>,
- <code>trait</code>, <code>type</code>, <code>macro</code>,
- and <code>const</code>.
- </p>
- <p>
- Search functions by type signature (e.g.
- <code>vec -> usize</code> or <code>* -> vec</code>)
- </p>
- </div>
- </div>
- </aside>
-
- <script>
- window.rootPath = "../../";
- window.currentCrate = "ocl";
- </script>
- <script src="../../main.js"></script>
- <script defer src="../../search-index.js"></script>
- </body>
- </html>
|
