<!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 `QrwLock` struct in crate `qutex`.">
<meta name="keywords" content="rust, rustlang, rust-lang, QrwLock">
<title>qutex::QrwLock - 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 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">
<p class='location'><a href='index.html'>qutex</a></p><script>window.sidebarCurrent = {name: 'QrwLock', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></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'>Struct <a href='index.html'>qutex</a>::<wbr><a class="struct" href=''>QrwLock</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/qrw_lock.rs.html#376-378' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct QrwLock<T> { /* fields omitted */ }</pre><div class='docblock'><p>A queue-backed read/write data lock.</p>
<p>As with any queue-backed system, deadlocks must be carefully avoided when
interoperating with other queues.</p>
</div><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl<T> <a class="struct" href="../qutex/struct.QrwLock.html" title="struct qutex::QrwLock">QrwLock</a><T></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/qutex/qrw_lock.rs.html#380-775' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>fn <a href='#method.new' class='fnname'>new</a>(val: T) -> <a class="struct" href="../qutex/struct.QrwLock.html" title="struct qutex::QrwLock">QrwLock</a><T></code></span></h4>
<div class='docblock'><p>Creates and returns a new <code>QrwLock</code>.</p>
</div><h4 id='method.request_read' class="method"><span id='request_read.v' class='invisible'><code>fn <a href='#method.request_read' class='fnname'>request_read</a>(self) -> <a class="struct" href="../qutex/struct.FutureReadGuard.html" title="struct qutex::FutureReadGuard">FutureReadGuard</a><T></code></span></h4>
<div class='stability'><div class='stab deprecated'>Deprecated since 0.0.9<p>: please use <code>::read</code> instead</p>
</div></div><div class='docblock'><p>Returns a new <code>FutureReadGuard</code> which can be used as a future and will
resolve into a <code>ReadGuard</code>.</p>
</div><h4 id='method.request_write' class="method"><span id='request_write.v' class='invisible'><code>fn <a href='#method.request_write' class='fnname'>request_write</a>(self) -> <a class="struct" href="../qutex/struct.FutureWriteGuard.html" title="struct qutex::FutureWriteGuard">FutureWriteGuard</a><T></code></span></h4>
<div class='stability'><div class='stab deprecated'>Deprecated since 0.0.9<p>: please use <code>::write</code> instead</p>
</div></div><div class='docblock'><p>Returns a new <code>FutureWriteGuard</code> which can be used as a future and will
resolve into a <code>WriteGuard</code>.</p>
</div><h4 id='method.read' class="method"><span id='read.v' class='invisible'><code>fn <a href='#method.read' class='fnname'>read</a>(self) -> <a class="struct" href="../qutex/struct.FutureReadGuard.html" title="struct qutex::FutureReadGuard">FutureReadGuard</a><T></code></span></h4>
<div class='docblock'><p>Returns a new <code>FutureReadGuard</code> which can be used as a future and will
resolve into a <code>ReadGuard</code>.</p>
</div><h4 id='method.write' class="method"><span id='write.v' class='invisible'><code>fn <a href='#method.write' class='fnname'>write</a>(self) -> <a class="struct" href="../qutex/struct.FutureWriteGuard.html" title="struct qutex::FutureWriteGuard">FutureWriteGuard</a><T></code></span></h4>
<div class='docblock'><p>Returns a new <code>FutureWriteGuard</code> which can be used as a future and will
resolve into a <code>WriteGuard</code>.</p>
</div><h4 id='method.push_request' class="method"><span id='push_request.v' class='invisible'><code>unsafe fn <a href='#method.push_request' class='fnname'>push_request</a>(&self, req: <a class="struct" href="../qutex/struct.QrwRequest.html" title="struct qutex::QrwRequest">QrwRequest</a>)</code></span></h4>
<div class='docblock'><p>Pushes a lock request onto the queue.</p>
</div><h4 id='method.get_mut' class="method"><span id='get_mut.v' class='invisible'><code>fn <a href='#method.get_mut' class='fnname'>get_mut</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&mut T></code></span></h4>
<div class='docblock'><p>Returns a mutable reference to the inner <code>Vec</code> if there are currently
no other copies of this <code>QrwLock</code>.</p>
<p>Since this call borrows the inner lock mutably, no actual locking needs to
take place---the mutable borrow statically guarantees no locks exist.</p>
</div><h4 id='method.as_ptr' class="method"><span id='as_ptr.v' class='invisible'><code>fn <a href='#method.as_ptr' class='fnname'>as_ptr</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*const T</a></code></span></h4>
<div class='docblock'><p>Returns a reference to the inner value.</p>
<p>This is fraught with potential peril.</p>
</div><h4 id='method.as_mut_ptr' class="method"><span id='as_mut_ptr.v' class='invisible'><code>fn <a href='#method.as_mut_ptr' class='fnname'>as_mut_ptr</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut T</a></code></span></h4>
<div class='docblock'><p>Returns a mutable reference to the inner value.</p>
<p>Drinking water from the tap in 1850's London would be safer.</p>
</div><h4 id='method.process_queue' class="method"><span id='process_queue.v' class='invisible'><code>unsafe fn <a href='#method.process_queue' class='fnname'>process_queue</a>(&self)</code></span></h4>
<div class='docblock'><p>Pops the next lock request in the queue if possible.</p>
<p>If this lock is released, read or write-locks this lock and unparks
the next requester task in the queue.</p>
<p>If this lock is write-locked, this function does nothing.</p>
<p>If this lock is read-locked and the next request or consecutive
requests in the queue are read requests, those requests will be
fulfilled, unparking their respective tasks and incrementing the
read-lock count appropriately.</p>
</div><h4 id='method.upgrade_read_lock' class="method"><span id='upgrade_read_lock.v' class='invisible'><code>unsafe fn <a href='#method.upgrade_read_lock' class='fnname'>upgrade_read_lock</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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">()</a>, <a class="struct" href="../futures/sync/oneshot/struct.Receiver.html" title="struct futures::sync::oneshot::Receiver">Receiver</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">()</a>>></code></span></h4>
<div class='docblock'><p>Converts a single read lock (read count of '1') into a write lock.</p>
<p>Returns an error containing a oneshot receiver if there is currently
more than one read lock. When the read count reaches one, the receiver
channel will be completed (i.e. poll it).</p>
<p>Panics if there are no read locks.</p>
<p>Do not call this method directly unless you are using a custom guard
or are otherwise managing the lock state manually. Use
<code>ReadGuard::upgrade</code> instead.</p>
</div><h4 id='method.downgrade_write_lock' class="method"><span id='downgrade_write_lock.v' class='invisible'><code>unsafe fn <a href='#method.downgrade_write_lock' class='fnname'>downgrade_write_lock</a>(&self)</code></span></h4>
<div class='docblock'><p>Converts a write lock into a read lock then processes the queue,
allowing additional read requests to acquire locks.</p>
<p>Use <code>WriteGuard::downgrade</code> rather than calling this directly.</p>
</div><h4 id='method.release_read_lock' class="method"><span id='release_read_lock.v' class='invisible'><code>unsafe fn <a href='#method.release_read_lock' class='fnname'>release_read_lock</a>(&self)</code></span></h4>
<div class='docblock'><p>Decreases the reader count by one and unparks the next requester task
in the queue if possible.</p>
<p>If a reader is waiting to be upgraded and the read lock count reaches
1, the upgrade sender will be completed.</p>
</div><h4 id='method.release_write_lock' class="method"><span id='release_write_lock.v' class='invisible'><code>unsafe fn <a href='#method.release_write_lock' class='fnname'>release_write_lock</a>(&self)</code></span></h4>
<div class='docblock'><p>Unlocks this lock and unparks the next requester task in the queue if
possible.</p>
</div></div><h2 id='implementations'>Trait Implementations</h2><h3 class='impl'><span class='in-band'><code>impl<T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>> <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="../qutex/struct.QrwLock.html" title="struct qutex::QrwLock">QrwLock</a><T></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/qutex/qrw_lock.rs.html#375' title='goto source code'>[src]</a></span></h3>
<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>(&self, __arg_0: &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></span></h4>
<div class='docblock'><p>Formats the value using the given formatter.</p>
</div></div><h3 class='impl'><span class='in-band'><code>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 <a class="struct" href="../qutex/struct.QrwLock.html" title="struct qutex::QrwLock">QrwLock</a><T></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/qutex/qrw_lock.rs.html#777-782' title='goto source code'>[src]</a></span></h3>
<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>(val: T) -> <a class="struct" href="../qutex/struct.QrwLock.html" title="struct qutex::QrwLock">QrwLock</a><T></code></span></h4>
<div class='docblock'><p>Performs the conversion.</p>
</div></div><h3 class='impl'><span class='in-band'><code>impl<T> <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="../qutex/struct.QrwLock.html" title="struct qutex::QrwLock">QrwLock</a><T></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/qutex/qrw_lock.rs.html#785-792' title='goto source code'>[src]</a></span></h3>
<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>(&self) -> <a class="struct" href="../qutex/struct.QrwLock.html" title="struct qutex::QrwLock">QrwLock</a><T></code></span></h4>
<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>
</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>(&mut self, source: &Self)</code><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div></span></h4>
<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>
</div></div></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>