| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051 |
- <!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" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script></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><p class='location'>Struct QrwLock</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a><a href="#method.read">read</a><a href="#method.write">write</a><a href="#method.enqueue_lock_request">enqueue_lock_request</a><a href="#method.get_mut">get_mut</a><a href="#method.as_ptr">as_ptr</a><a href="#method.as_mut_ptr">as_mut_ptr</a><a href="#method.process_queues">process_queues</a><a href="#method.upgrade_read_lock">upgrade_read_lock</a><a href="#method.downgrade_write_lock">downgrade_write_lock</a><a href="#method.release_read_lock">release_read_lock</a><a href="#method.release_write_lock">release_write_lock</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Clone">Clone</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a></div></div><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></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"><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'>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#461-463' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct QrwLock<T> { /* fields omitted */ }</pre></div><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' class='small-section-header'>
- Methods<a href='#methods' class='anchor'></a>
- </h2>
- <h3 id='impl' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<T> <a class="struct" href="../qutex/struct.QrwLock.html" title="struct qutex::QrwLock">QrwLock</a><T></code><a href='#impl' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/qutex/qrw_lock.rs.html#465-872' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub 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></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/qutex/qrw_lock.rs.html#468-472' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Creates and returns a new <code>QrwLock</code>.</p>
- </div><h4 id='method.read' class="method"><span id='read.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub 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></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/qutex/qrw_lock.rs.html#477-483' title='goto source code'>[src]</a></td></tr></tbody></table></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'><table class='table-display'><tbody><tr><td><code>pub 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></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/qutex/qrw_lock.rs.html#488-494' title='goto source code'>[src]</a></td></tr></tbody></table></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.enqueue_lock_request' class="method"><span id='enqueue_lock_request.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub unsafe fn <a href='#method.enqueue_lock_request' class='fnname'>enqueue_lock_request</a>(&self, req: <a class="struct" href="../qutex/struct.QrwRequest.html" title="struct qutex::QrwRequest">QrwRequest</a>)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/qutex/qrw_lock.rs.html#503-505' title='goto source code'>[src]</a></td></tr></tbody></table></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'><table class='table-display'><tbody><tr><td><code>pub 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><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/qutex/qrw_lock.rs.html#514-516' title='goto source code'>[src]</a></td></tr></tbody></table></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'><table class='table-display'><tbody><tr><td><code>pub 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></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/qutex/qrw_lock.rs.html#521-523' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a reference to the inner value.</p>
- </div><h4 id='method.as_mut_ptr' class="method"><span id='as_mut_ptr.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub 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></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/qutex/qrw_lock.rs.html#528-530' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a mutable reference to the inner value.</p>
- </div><h4 id='method.process_queues' class="method"><span id='process_queues.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub unsafe fn <a href='#method.process_queues' class='fnname'>process_queues</a>(&self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/qutex/qrw_lock.rs.html#699-744' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Pops the next lock request in the queue if possible.</p>
- </div><h4 id='method.upgrade_read_lock' class="method"><span id='upgrade_read_lock.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub 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.unit.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.unit.html">()</a>>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/qutex/qrw_lock.rs.html#767-790' title='goto source code'>[src]</a></td></tr></tbody></table></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'><table class='table-display'><tbody><tr><td><code>pub unsafe fn <a href='#method.downgrade_write_lock' class='fnname'>downgrade_write_lock</a>(&self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/qutex/qrw_lock.rs.html#797-812' title='goto source code'>[src]</a></td></tr></tbody></table></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'><table class='table-display'><tbody><tr><td><code>pub unsafe fn <a href='#method.release_read_lock' class='fnname'>release_read_lock</a>(&self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/qutex/qrw_lock.rs.html#823-841' title='goto source code'>[src]</a></td></tr></tbody></table></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'><table class='table-display'><tbody><tr><td><code>pub unsafe fn <a href='#method.release_write_lock' class='fnname'>release_write_lock</a>(&self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/qutex/qrw_lock.rs.html#848-871' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Unlocks this (the caller's) lock and unparks the next requester task
- in the queue if possible.</p>
- </div></div>
- <h2 id='implementations' class='small-section-header'>
- Trait Implementations<a href='#implementations' class='anchor'></a>
- </h2>
- <div id='implementations-list'><h3 id='impl-Debug' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><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><a href='#impl-Debug' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/qutex/qrw_lock.rs.html#460' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><table class='table-display'><tbody><tr><td><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></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/qutex/qrw_lock.rs.html#460' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><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><h3 id='impl-From%3CT%3E' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><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><a href='#impl-From%3CT%3E' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/qutex/qrw_lock.rs.html#874-879' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.from' class="method"><span id='from.v' class='invisible'><table class='table-display'><tbody><tr><td><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></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/qutex/qrw_lock.rs.html#876-878' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs the conversion.</p>
- </div></div><h3 id='impl-Clone' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><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><a href='#impl-Clone' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/qutex/qrw_lock.rs.html#882-889' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><table class='table-display'><tbody><tr><td><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></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/qutex/qrw_lock.rs.html#884-888' title='goto source code'>[src]</a></td></tr></tbody></table></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'><table class='table-display'><tbody><tr><td><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: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#130-132' title='goto source code'>[src]</a></td></tr></tbody></table></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></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-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<T> <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="../qutex/struct.QrwLock.html" title="struct qutex::QrwLock">QrwLock</a><T> <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, </span></code><a href='#impl-Send' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<T> <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="../qutex/struct.QrwLock.html" title="struct qutex::QrwLock">QrwLock</a><T> <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, </span></code><a href='#impl-Sync' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></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><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><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "qutex";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>
|
