mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-02-23 15:49:49 +01:00
93 lines
38 KiB
HTML
93 lines
38 KiB
HTML
<!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 `Semaphore` struct in crate `tokio`."><meta name="keywords" content="rust, rustlang, rust-lang, Semaphore"><title>tokio::sync::Semaphore - 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="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc struct"><!--[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><a href='../../tokio/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Struct Semaphore</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#implementations">Methods</a><div class="sidebar-links"><a href="#method.acquire">acquire</a><a href="#method.acquire_many">acquire_many</a><a href="#method.acquire_many_owned">acquire_many_owned</a><a href="#method.acquire_owned">acquire_owned</a><a href="#method.add_permits">add_permits</a><a href="#method.available_permits">available_permits</a><a href="#method.close">close</a><a href="#method.new">new</a><a href="#method.try_acquire">try_acquire</a><a href="#method.try_acquire_many">try_acquire_many</a><a href="#method.try_acquire_many_owned">try_acquire_many_owned</a><a href="#method.try_acquire_owned">try_acquire_owned</a></div><a class="sidebar-title" href="#trait-implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-RefUnwindSafe">!RefUnwindSafe</a><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">UnwindSafe</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><p class="location"><a href="../index.html">tokio</a>::<wbr><a href="index.html">sync</a></p><div id="sidebar-vars" data-name="Semaphore" data-ty="struct" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Struct <a href="../index.html">tokio</a>::<wbr><a href="index.html">sync</a>::<wbr><a class="struct" href="">Semaphore</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/tokio/sync/semaphore.rs.html#22-25" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust struct">pub struct Semaphore { /* fields omitted */ }</pre></div><div class="docblock"><p>Counting semaphore performing asynchronous permit acquisition.</p>
|
||
<p>A semaphore maintains a set of permits. Permits are used to synchronize
|
||
access to a shared resource. A semaphore differs from a mutex in that it
|
||
can allow more than one concurrent caller to access the shared resource at a
|
||
time.</p>
|
||
<p>When <code>acquire</code> is called and the semaphore has remaining permits, the
|
||
function immediately returns a permit. However, if no remaining permits are
|
||
available, <code>acquire</code> (asynchronously) waits until an outstanding permit is
|
||
dropped. At this point, the freed permit is assigned to the caller.</p>
|
||
<p>To use the <code>Semaphore</code> in a poll function, you can use the <a href="https://docs.rs/tokio-util/0.6/tokio_util/sync/struct.PollSemaphore.html"><code>PollSemaphore</code></a>
|
||
utility.</p>
|
||
</div><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><h3 id="impl" class="impl"><code class="in-band">impl <a class="struct" href="../../tokio/sync/struct.Semaphore.html" title="struct tokio::sync::Semaphore">Semaphore</a></code><a href="#impl" class="anchor"></a><a class="srclink" href="../../src/tokio/sync/semaphore.rs.html#66-283" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.new" class="method"><code>pub fn <a href="#method.new" class="fnname">new</a>(permits: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> Self</code><a class="srclink" href="../../src/tokio/sync/semaphore.rs.html#68-72" title="goto source code">[src]</a></h4><div class="docblock"><p>Creates a new semaphore with the initial number of permits.</p>
|
||
</div><h4 id="method.available_permits" class="method"><code>pub fn <a href="#method.available_permits" class="fnname">available_permits</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a class="srclink" href="../../src/tokio/sync/semaphore.rs.html#84-86" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns the current number of available permits.</p>
|
||
</div><h4 id="method.add_permits" class="method"><code>pub fn <a href="#method.add_permits" class="fnname">add_permits</a>(&self, n: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>)</code><a class="srclink" href="../../src/tokio/sync/semaphore.rs.html#91-93" title="goto source code">[src]</a></h4><div class="docblock"><p>Adds <code>n</code> new permits to the semaphore.</p>
|
||
<p>The maximum number of permits is <code>usize::MAX >> 3</code>, and this function will panic if the limit is exceeded.</p>
|
||
</div><h4 id="method.acquire" class="method"><code>pub async fn <a href="#method.acquire" class="fnname">acquire</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../../tokio/sync/struct.SemaphorePermit.html" title="struct tokio::sync::SemaphorePermit">SemaphorePermit</a><'_>, <a class="struct" href="../../tokio/sync/struct.AcquireError.html" title="struct tokio::sync::AcquireError">AcquireError</a>></code><a class="srclink" href="../../src/tokio/sync/semaphore.rs.html#103-109" title="goto source code">[src]</a></h4><div class="docblock"><p>Acquires a permit from the semaphore.</p>
|
||
<p>If the semaphore has been closed, this returns an <a href="../../tokio/sync/struct.AcquireError.html"><code>AcquireError</code></a>.
|
||
Otherwise, this returns a <a href="../../tokio/sync/struct.SemaphorePermit.html"><code>SemaphorePermit</code></a> representing the
|
||
acquired permit.</p>
|
||
</div><h4 id="method.acquire_many" class="method"><code>pub async fn <a href="#method.acquire_many" class="fnname">acquire_many</a>(<br> &self, <br> n: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../../tokio/sync/struct.SemaphorePermit.html" title="struct tokio::sync::SemaphorePermit">SemaphorePermit</a><'_>, <a class="struct" href="../../tokio/sync/struct.AcquireError.html" title="struct tokio::sync::AcquireError">AcquireError</a>></code><a class="srclink" href="../../src/tokio/sync/semaphore.rs.html#119-125" title="goto source code">[src]</a></h4><div class="docblock"><p>Acquires <code>n</code> permits from the semaphore.</p>
|
||
<p>If the semaphore has been closed, this returns an <a href="../../tokio/sync/struct.AcquireError.html"><code>AcquireError</code></a>.
|
||
Otherwise, this returns a <a href="../../tokio/sync/struct.SemaphorePermit.html"><code>SemaphorePermit</code></a> representing the
|
||
acquired permits.</p>
|
||
</div><h4 id="method.try_acquire" class="method"><code>pub fn <a href="#method.try_acquire" class="fnname">try_acquire</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../../tokio/sync/struct.SemaphorePermit.html" title="struct tokio::sync::SemaphorePermit">SemaphorePermit</a><'_>, <a class="enum" href="../../tokio/sync/enum.TryAcquireError.html" title="enum tokio::sync::TryAcquireError">TryAcquireError</a>></code><a class="srclink" href="../../src/tokio/sync/semaphore.rs.html#136-144" title="goto source code">[src]</a></h4><div class="docblock"><p>Tries to acquire a permit from the semaphore.</p>
|
||
<p>If the semaphore has been closed, this returns a <a href="../../tokio/sync/enum.TryAcquireError.html#variant.Closed"><code>TryAcquireError::Closed</code></a>
|
||
and a <a href="../../tokio/sync/enum.TryAcquireError.html#variant.NoPermits"><code>TryAcquireError::NoPermits</code></a> if there are no permits left. Otherwise,
|
||
this returns a <a href="../../tokio/sync/struct.SemaphorePermit.html"><code>SemaphorePermit</code></a> representing the acquired permits.</p>
|
||
</div><h4 id="method.try_acquire_many" class="method"><code>pub fn <a href="#method.try_acquire_many" class="fnname">try_acquire_many</a>(<br> &self, <br> n: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../../tokio/sync/struct.SemaphorePermit.html" title="struct tokio::sync::SemaphorePermit">SemaphorePermit</a><'_>, <a class="enum" href="../../tokio/sync/enum.TryAcquireError.html" title="enum tokio::sync::TryAcquireError">TryAcquireError</a>></code><a class="srclink" href="../../src/tokio/sync/semaphore.rs.html#155-163" title="goto source code">[src]</a></h4><div class="docblock"><p>Tries to acquire <code>n</code> permits from the semaphore.</p>
|
||
<p>If the semaphore has been closed, this returns a <a href="../../tokio/sync/enum.TryAcquireError.html#variant.Closed"><code>TryAcquireError::Closed</code></a>
|
||
and a <a href="../../tokio/sync/enum.TryAcquireError.html#variant.NoPermits"><code>TryAcquireError::NoPermits</code></a> if there are no permits left. Otherwise,
|
||
this returns a <a href="../../tokio/sync/struct.SemaphorePermit.html"><code>SemaphorePermit</code></a> representing the acquired permits.</p>
|
||
</div><h4 id="method.acquire_owned" class="method"><code>pub async fn <a href="#method.acquire_owned" class="fnname">acquire_owned</a>(<br> self: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><Self><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../../tokio/sync/struct.OwnedSemaphorePermit.html" title="struct tokio::sync::OwnedSemaphorePermit">OwnedSemaphorePermit</a>, <a class="struct" href="../../tokio/sync/struct.AcquireError.html" title="struct tokio::sync::AcquireError">AcquireError</a>></code><a class="srclink" href="../../src/tokio/sync/semaphore.rs.html#175-181" title="goto source code">[src]</a></h4><div class="docblock"><p>Acquires a permit from the semaphore.</p>
|
||
<p>The semaphore must be wrapped in an <a href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html"><code>Arc</code></a> to call this method.
|
||
If the semaphore has been closed, this returns an <a href="../../tokio/sync/struct.AcquireError.html"><code>AcquireError</code></a>.
|
||
Otherwise, this returns a <a href="../../tokio/sync/struct.OwnedSemaphorePermit.html"><code>OwnedSemaphorePermit</code></a> representing the
|
||
acquired permit.</p>
|
||
</div><h4 id="method.acquire_many_owned" class="method"><code>pub async fn <a href="#method.acquire_many_owned" class="fnname">acquire_many_owned</a>(<br> self: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><Self>, <br> n: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../../tokio/sync/struct.OwnedSemaphorePermit.html" title="struct tokio::sync::OwnedSemaphorePermit">OwnedSemaphorePermit</a>, <a class="struct" href="../../tokio/sync/struct.AcquireError.html" title="struct tokio::sync::AcquireError">AcquireError</a>></code><a class="srclink" href="../../src/tokio/sync/semaphore.rs.html#193-202" title="goto source code">[src]</a></h4><div class="docblock"><p>Acquires <code>n</code> permits from the semaphore.</p>
|
||
<p>The semaphore must be wrapped in an <a href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html"><code>Arc</code></a> to call this method.
|
||
If the semaphore has been closed, this returns an <a href="../../tokio/sync/struct.AcquireError.html"><code>AcquireError</code></a>.
|
||
Otherwise, this returns a <a href="../../tokio/sync/struct.OwnedSemaphorePermit.html"><code>OwnedSemaphorePermit</code></a> representing the
|
||
acquired permit.</p>
|
||
</div><h4 id="method.try_acquire_owned" class="method"><code>pub fn <a href="#method.try_acquire_owned" class="fnname">try_acquire_owned</a>(<br> self: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><Self><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../../tokio/sync/struct.OwnedSemaphorePermit.html" title="struct tokio::sync::OwnedSemaphorePermit">OwnedSemaphorePermit</a>, <a class="enum" href="../../tokio/sync/enum.TryAcquireError.html" title="enum tokio::sync::TryAcquireError">TryAcquireError</a>></code><a class="srclink" href="../../src/tokio/sync/semaphore.rs.html#216-224" title="goto source code">[src]</a></h4><div class="docblock"><p>Tries to acquire a permit from the semaphore.</p>
|
||
<p>The semaphore must be wrapped in an <a href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html"><code>Arc</code></a> to call this method. If
|
||
the semaphore has been closed, this returns a <a href="../../tokio/sync/enum.TryAcquireError.html#variant.Closed"><code>TryAcquireError::Closed</code></a>
|
||
and a <a href="../../tokio/sync/enum.TryAcquireError.html#variant.NoPermits"><code>TryAcquireError::NoPermits</code></a> if there are no permits left.
|
||
Otherwise, this returns a <a href="../../tokio/sync/struct.OwnedSemaphorePermit.html"><code>OwnedSemaphorePermit</code></a> representing the
|
||
acquired permit.</p>
|
||
</div><h4 id="method.try_acquire_many_owned" class="method"><code>pub fn <a href="#method.try_acquire_many_owned" class="fnname">try_acquire_many_owned</a>(<br> self: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><Self>, <br> n: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../../tokio/sync/struct.OwnedSemaphorePermit.html" title="struct tokio::sync::OwnedSemaphorePermit">OwnedSemaphorePermit</a>, <a class="enum" href="../../tokio/sync/enum.TryAcquireError.html" title="enum tokio::sync::TryAcquireError">TryAcquireError</a>></code><a class="srclink" href="../../src/tokio/sync/semaphore.rs.html#238-249" title="goto source code">[src]</a></h4><div class="docblock"><p>Tries to acquire <code>n</code> permits from the semaphore.</p>
|
||
<p>The semaphore must be wrapped in an <a href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html"><code>Arc</code></a> to call this method. If
|
||
the semaphore has been closed, this returns a <a href="../../tokio/sync/enum.TryAcquireError.html#variant.Closed"><code>TryAcquireError::Closed</code></a>
|
||
and a <a href="../../tokio/sync/enum.TryAcquireError.html#variant.NoPermits"><code>TryAcquireError::NoPermits</code></a> if there are no permits left.
|
||
Otherwise, this returns a <a href="../../tokio/sync/struct.OwnedSemaphorePermit.html"><code>OwnedSemaphorePermit</code></a> representing the
|
||
acquired permit.</p>
|
||
</div><h4 id="method.close" class="method"><code>pub fn <a href="#method.close" class="fnname">close</a>(&self)</code><a class="srclink" href="../../src/tokio/sync/semaphore.rs.html#280-282" title="goto source code">[src]</a></h4><div class="docblock"><p>Closes the semaphore.</p>
|
||
<p>This prevents the semaphore from issuing new permits and notifies all pending waiters.</p>
|
||
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">tokio</span>::<span class="ident">sync</span>::<span class="ident">Semaphore</span>;
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">Arc</span>;
|
||
<span class="kw">use</span> <span class="ident">tokio</span>::<span class="ident">sync</span>::<span class="ident">TryAcquireError</span>;
|
||
|
||
<span class="attribute">#[<span class="ident">tokio</span>::<span class="ident">main</span>]</span>
|
||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">main</span>() {
|
||
<span class="kw">let</span> <span class="ident">semaphore</span> <span class="op">=</span> <span class="ident">Arc</span>::<span class="ident">new</span>(<span class="ident">Semaphore</span>::<span class="ident">new</span>(<span class="number">1</span>));
|
||
<span class="kw">let</span> <span class="ident">semaphore2</span> <span class="op">=</span> <span class="ident">semaphore</span>.<span class="ident">clone</span>();
|
||
|
||
<span class="ident">tokio</span>::<span class="ident">spawn</span>(<span class="kw">async</span> <span class="kw">move</span> {
|
||
<span class="kw">let</span> <span class="ident">permit</span> <span class="op">=</span> <span class="ident">semaphore</span>.<span class="ident">acquire_many</span>(<span class="number">2</span>).<span class="kw">await</span>;
|
||
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">permit</span>.<span class="ident">is_err</span>());
|
||
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"waiter received error"</span>);
|
||
});
|
||
|
||
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"closing semaphore"</span>);
|
||
<span class="ident">semaphore2</span>.<span class="ident">close</span>();
|
||
|
||
<span class="comment">// Cannot obtain more permits</span>
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">semaphore2</span>.<span class="ident">try_acquire</span>().<span class="ident">err</span>(), <span class="prelude-val">Some</span>(<span class="ident">TryAcquireError</span>::<span class="ident">Closed</span>))
|
||
}</pre></div>
|
||
</div></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><h3 id="impl-Debug" class="impl"><code class="in-band">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="../../tokio/sync/struct.Semaphore.html" title="struct tokio::sync::Semaphore">Semaphore</a></code><a href="#impl-Debug" class="anchor"></a><a class="srclink" href="../../src/tokio/sync/semaphore.rs.html#21" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.fmt" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt" class="fnname">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code><a class="srclink" href="../../src/tokio/sync/semaphore.rs.html#21" title="goto source code">[src]</a></h4><div class='docblock hidden'><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>
|
||
</div></div></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><h3 id="impl-RefUnwindSafe" class="impl"><code class="in-band">impl !<a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="../../tokio/sync/struct.Semaphore.html" title="struct tokio::sync::Semaphore">Semaphore</a></code><a href="#impl-RefUnwindSafe" class="anchor"></a><a class="srclink" href="../../src/tokio/lib.rs.html#1" title="goto source code">[src]</a></h3><div class="impl-items"></div><h3 id="impl-Send" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../tokio/sync/struct.Semaphore.html" title="struct tokio::sync::Semaphore">Semaphore</a></code><a href="#impl-Send" class="anchor"></a><a class="srclink" href="../../src/tokio/lib.rs.html#1" title="goto source code">[src]</a></h3><div class="impl-items"></div><h3 id="impl-Sync" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../tokio/sync/struct.Semaphore.html" title="struct tokio::sync::Semaphore">Semaphore</a></code><a href="#impl-Sync" class="anchor"></a><a class="srclink" href="../../src/tokio/lib.rs.html#1" title="goto source code">[src]</a></h3><div class="impl-items"></div><h3 id="impl-Unpin" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="../../tokio/sync/struct.Semaphore.html" title="struct tokio::sync::Semaphore">Semaphore</a></code><a href="#impl-Unpin" class="anchor"></a><a class="srclink" href="../../src/tokio/lib.rs.html#1" title="goto source code">[src]</a></h3><div class="impl-items"></div><h3 id="impl-UnwindSafe" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a> for <a class="struct" href="../../tokio/sync/struct.Semaphore.html" title="struct tokio::sync::Semaphore">Semaphore</a></code><a href="#impl-UnwindSafe" class="anchor"></a><a class="srclink" href="../../src/tokio/lib.rs.html#1" title="goto source code">[src]</a></h3><div class="impl-items"></div></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><h3 id="impl-Any" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Any" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#131-135" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.type_id" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#132" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
||
</div></div><h3 id="impl-Borrow%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Borrow%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#207-211" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T<span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<div class="notable-traits-tooltiptext"><span class="docblock"><h3 class="notable">Notable traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'_ mut </a>F</h3><code class="content"><span class="where fmt-newline">impl<'_, F> <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'_ mut </a>F <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline"> type <a href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" class="type">Output</a> = <F as <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>;</span></code></span></div></span></span></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#208" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
||
</div></div><h3 id="impl-BorrowMut%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-BorrowMut%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#214-218" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow_mut" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T<span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<div class="notable-traits-tooltiptext"><span class="docblock"><h3 class="notable">Notable traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'_ mut </a>F</h3><code class="content"><span class="where fmt-newline">impl<'_, F> <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'_ mut </a>F <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline"> type <a href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" class="type">Output</a> = <F as <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>;</span></code></span></div></span></span></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#215" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
||
</div></div><h3 id="impl-From%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</code><a href="#impl-From%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#545-549" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#546" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
</div></div><h3 id="impl-Into%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></code><a href="#impl-Into%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#534-541" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.into" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> U</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#538" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
</div></div><h3 id="impl-TryFrom%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></code><a href="#impl-TryFrom%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#582-591" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" class="type">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div><h4 id="method.try_from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#588" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
</div></div><h3 id="impl-TryInto%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></code><a href="#impl-TryInto%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#568-577" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error-1" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error" class="type">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div><h4 id="method.try_into" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into" class="fnname">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#574" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
</div></div></div></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="tokio"></div>
|
||
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |