<!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 `qutex` crate.">
<meta name="keywords" content="rust, rustlang, rust-lang, qutex">
<title>qutex - Rust</title>
<link rel="stylesheet" type="text/css" href="../normalize.css">
<link rel="stylesheet" type="text/css" href="../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../main.css">
</head>
<body class="rustdoc mod">
<nav class="sidebar">
<p class='location'></p><script>window.sidebarCurrent = {name: 'qutex', ty: 'mod', relpath: '../'};</script>
</nav>
<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'>Crate <a class="mod" href=''>qutex</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/qutex/lib.rs.html#1-17' title='goto source code'>[src]</a></span></h1>
<div class='docblock'><p>A collection of locking data structures, both thread-safe and
single-thread-optimized, which use Rust futures instead of
thread-blocking.</p>
<p><a href="https://github.com/cogciprocate/qutex"><img src="https://img.shields.io/badge/github-qutex-blue.svg" alt="" /></a> <a href="https://crates.io/crates/qutex"><img src="http://meritbadge.herokuapp.com/qutex" alt="" /></a></p>
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table>
<tr class=' module-item'>
<td><a class="struct" href="struct.FutureGuard.html"
title='struct qutex::FutureGuard'>FutureGuard</a></td>
<td class='docblock-short'>
<p>A future which resolves to a <code>Guard</code>.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.FutureReadGuard.html"
title='struct qutex::FutureReadGuard'>FutureReadGuard</a></td>
<td class='docblock-short'>
<p>A future which resolves to a <code>ReadGuard</code>.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.FutureWriteGuard.html"
title='struct qutex::FutureWriteGuard'>FutureWriteGuard</a></td>
<td class='docblock-short'>
<p>A future which resolves to a <code>WriteGuard</code>.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Guard.html"
title='struct qutex::Guard'>Guard</a></td>
<td class='docblock-short'>
<p>Allows access to the data contained within a lock just like a mutex guard.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.QrwLock.html"
title='struct qutex::QrwLock'>QrwLock</a></td>
<td class='docblock-short'>
<p>A queue-backed read/write data lock.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.QrwRequest.html"
title='struct qutex::QrwRequest'>QrwRequest</a></td>
<td class='docblock-short'>
<p>A request to lock the lock for either read or write access.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Qutex.html"
title='struct qutex::Qutex'>Qutex</a></td>
<td class='docblock-short'>
<p>A lock-free-queue-backed exclusive data lock.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.ReadGuard.html"
title='struct qutex::ReadGuard'>ReadGuard</a></td>
<td class='docblock-short'>
<p>Allows read-only access to the data contained within a lock.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Request.html"
title='struct qutex::Request'>Request</a></td>
<td class='docblock-short'>
<p>A request to lock the qutex for exclusive access.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.WriteGuard.html"
title='struct qutex::WriteGuard'>WriteGuard</a></td>
<td class='docblock-short'>
<p>Allows read or write access to the data contained within a lock.</p>
</td>
</tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
<table>
<tr class=' module-item'>
<td><a class="enum" href="enum.RequestKind.html"
title='enum qutex::RequestKind'>RequestKind</a></td>
<td class='docblock-short'>
<p>Specifies whether a <code>QrwRequest</code> is a read or write request.</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>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>⇤</dt>
<dd>Move up in search results</dd>
<dt>⇥</dt>
<dd>Move down in search results</dd>
<dt>⏎</dt>
<dd>Go to active search result</dd>
<dt>+</dt>
<dd>Collapse/expand 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 = "qutex";
</script>
<script src="../jquery.js"></script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>