<!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 `sync` mod in crate `futures`.">
<meta name="keywords" content="rust, rustlang, rust-lang, sync">
<title>futures::sync - 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 mod">
<!--[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'>Module sync</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li></ul></div><p class='location'><a href='../index.html'>futures</a></p><script>window.sidebarCurrent = {name: 'sync', ty: 'mod', 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'>Module <a href='../index.html'>futures</a>::<wbr><a class="mod" href=''>sync</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/futures/sync/mod.rs.html#1-17' title='goto source code'>[src]</a></span></h1>
<div class='docblock'><p>Future-aware synchronization</p>
<p>This module, which is modeled after <code>std::sync</code>, contains user-space
synchronization tools that work with futures, streams and sinks. In
particular, these synchronizers do <em>not</em> block physical OS threads, but
instead work at the task level.</p>
<p>More information and examples of how to use these synchronization primitives
can be found <a href="https://tokio.rs/docs/going-deeper-futures/synchronization/">online at tokio.rs</a>.</p>
</div><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
<table>
<tr class=' module-item'>
<td><a class="mod" href="mpsc/index.html"
title='mod futures::sync::mpsc'>mpsc</a></td>
<td class='docblock-short'>
<p>A multi-producer, single-consumer, futures-aware, FIFO queue with back pressure.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="oneshot/index.html"
title='mod futures::sync::oneshot'>oneshot</a></td>
<td class='docblock-short'>
<p>A one-shot, futures-aware channel</p>
</td>
</tr></table><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table>
<tr class=' module-item'>
<td><a class="struct" href="struct.BiLock.html"
title='struct futures::sync::BiLock'>BiLock</a></td>
<td class='docblock-short'>
<p>A type of futures-powered synchronization primitive which is a mutex between
two possible owners.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.BiLockAcquire.html"
title='struct futures::sync::BiLockAcquire'>BiLockAcquire</a></td>
<td class='docblock-short'>
<p>Future returned by <code>BiLock::lock</code> which will resolve when the lock is
acquired.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.BiLockAcquired.html"
title='struct futures::sync::BiLockAcquired'>BiLockAcquired</a></td>
<td class='docblock-short'>
<p>Resolved value of the <code>BiLockAcquire<T></code> future.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.BiLockGuard.html"
title='struct futures::sync::BiLockGuard'>BiLockGuard</a></td>
<td class='docblock-short'>
<p>Returned RAII guard from the <code>poll_lock</code> method.</p>
</td>
</tr></table></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 = "futures";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>