|
|
<!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 `RwLock` struct in crate `lock_api`."><meta name="keywords" content="rust, rustlang, rust-lang, RwLock"><title>lock_api::RwLock - 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><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><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='../lock_api/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Struct RwLock</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.force_unlock_read">force_unlock_read</a><a href="#method.force_unlock_read_fair">force_unlock_read_fair</a><a href="#method.force_unlock_write">force_unlock_write</a><a href="#method.force_unlock_write_fair">force_unlock_write_fair</a><a href="#method.get_mut">get_mut</a><a href="#method.into_inner">into_inner</a><a href="#method.new">new</a><a href="#method.raw">raw</a><a href="#method.read">read</a><a href="#method.read_recursive">read_recursive</a><a href="#method.try_read">try_read</a><a href="#method.try_read_for">try_read_for</a><a href="#method.try_read_recursive">try_read_recursive</a><a href="#method.try_read_recursive_for">try_read_recursive_for</a><a href="#method.try_read_recursive_until">try_read_recursive_until</a><a href="#method.try_read_until">try_read_until</a><a href="#method.try_upgradable_read">try_upgradable_read</a><a href="#method.try_upgradable_read_for">try_upgradable_read_for</a><a href="#method.try_upgradable_read_until">try_upgradable_read_until</a><a href="#method.try_write">try_write</a><a href="#method.try_write_for">try_write_for</a><a href="#method.try_write_until">try_write_until</a><a href="#method.upgradable_read">upgradable_read</a><a href="#method.write">write</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-Default">Default</a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</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-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-Erased">Erased</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'>lock_api</a></p><script>window.sidebarCurrent = {name: 'RwLock', 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"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><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='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/lock_api/rwlock.rs.html#228-231' title='goto source code'>[src]</a></span><span class='in-band'>Struct <a href='index.html'>lock_api</a>::<wbr><a class="struct" href=''>RwLock</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust struct'>pub struct RwLock<R: <a class="trait" href="../lock_api/trait.RawRwLock.html" title="trait lock_api::RawRwLock">RawRwLock</a>, T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> { /* fields omitted */ }</pre></div><div class='docblock'><p>A reader-writer lock</p>
|
|
|
<p>This type of lock allows a number of readers or at most one writer at any
|
|
|
point in time. The write portion of this lock typically allows modification
|
|
|
of the underlying data (exclusive access) and the read portion of this lock
|
|
|
typically allows for read-only access (shared access).</p>
|
|
|
<p>The type parameter <code>T</code> represents the data that this lock protects. It is
|
|
|
required that <code>T</code> satisfies <code>Send</code> to be shared across threads and <code>Sync</code> to
|
|
|
allow concurrent access through readers. The RAII guards returned from the
|
|
|
locking methods implement <code>Deref</code> (and <code>DerefMut</code> for the <code>write</code> methods)
|
|
|
to allow access to the contained of the lock.</p>
|
|
|
</div><h2 id='methods' class='small-section-header'>Methods<a href='#methods' class='anchor'></a></h2><h3 id='impl' class='impl'><code class='in-band'>impl<R: <a class="trait" href="../lock_api/trait.RawRwLock.html" title="trait lock_api::RawRwLock">RawRwLock</a>, T> <a class="struct" href="../lock_api/struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a><R, T></code><a href='#impl' class='anchor'></a><a class='srclink' href='../src/lock_api/rwlock.rs.html#236-263' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.new' class="method"><code id='new.v'>pub fn <a href='#method.new' class='fnname'>new</a>(val: T) -> <a class="struct" href="../lock_api/struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a><R, T></code><a class='srclink' href='../src/lock_api/rwlock.rs.html#250-255' title='goto source code'>[src]</a></h4><div class='docblock'><p>Creates a new instance of an <code>RwLock<T></code> which is unlocked.</p>
|
|
|
</div><h4 id='method.into_inner' class="method"><code id='into_inner.v'>pub fn <a href='#method.into_inner' class='fnname'>into_inner</a>(self) -> T</code><a class='srclink' href='../src/lock_api/rwlock.rs.html#260-262' title='goto source code'>[src]</a></h4><div class='docblock'><p>Consumes this <code>RwLock</code>, returning the underlying data.</p>
|
|
|
</div></div><h3 id='impl-1' class='impl'><code class='in-band'>impl<R: <a class="trait" href="../lock_api/trait.RawRwLock.html" title="trait lock_api::RawRwLock">RawRwLock</a>, T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="struct" href="../lock_api/struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a><R, T></code><a href='#impl-1' class='anchor'></a><a class='srclink' href='../src/lock_api/rwlock.rs.html#265-400' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.read' class="method"><code id='read.v'>pub fn <a href='#method.read' class='fnname'>read</a>(&self) -> <a class="struct" href="../lock_api/struct.RwLockReadGuard.html" title="struct lock_api::RwLockReadGuard">RwLockReadGuard</a><R, T></code><a class='srclink' href='../src/lock_api/rwlock.rs.html#295-298' title='goto source code'>[src]</a></h4><div class='docblock'><p>Locks this <code>RwLock</code> with shared read access, blocking the current thread
|
|
|
until it can be acquired.</p>
|
|
|
<p>The calling thread will be blocked until there are no more writers which
|
|
|
hold the lock. There may be other readers currently inside the lock when
|
|
|
this method returns.</p>
|
|
|
<p>Note that attempts to recursively acquire a read lock on a <code>RwLock</code> when
|
|
|
the current thread already holds one may result in a deadlock.</p>
|
|
|
<p>Returns an RAII guard which will release this thread's shared access
|
|
|
once it is dropped.</p>
|
|
|
</div><h4 id='method.try_read' class="method"><code id='try_read.v'>pub fn <a href='#method.try_read' class='fnname'>try_read</a>(&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="struct" href="../lock_api/struct.RwLockReadGuard.html" title="struct lock_api::RwLockReadGuard">RwLockReadGuard</a><R, T>></code><a class='srclink' href='../src/lock_api/rwlock.rs.html#308-314' title='goto source code'>[src]</a></h4><div class='docblock'><p>Attempts to acquire this <code>RwLock</code> with shared read access.</p>
|
|
|
<p>If the access could not be granted at this time, then <code>None</code> is returned.
|
|
|
Otherwise, an RAII guard is returned which will release the shared access
|
|
|
when it is dropped.</p>
|
|
|
<p>This function does not block.</p>
|
|
|
</div><h4 id='method.write' class="method"><code id='write.v'>pub fn <a href='#method.write' class='fnname'>write</a>(&self) -> <a class="struct" href="../lock_api/struct.RwLockWriteGuard.html" title="struct lock_api::RwLockWriteGuard">RwLockWriteGuard</a><R, T></code><a class='srclink' href='../src/lock_api/rwlock.rs.html#325-328' title='goto source code'>[src]</a></h4><div class='docblock'><p>Locks this <code>RwLock</code> with exclusive write access, blocking the current
|
|
|
thread until it can be acquired.</p>
|
|
|
<p>This function will not return while other writers or other readers
|
|
|
currently have access to the lock.</p>
|
|
|
<p>Returns an RAII guard which will drop the write access of this <code>RwLock</code>
|
|
|
when dropped.</p>
|
|
|
</div><h4 id='method.try_write' class="method"><code id='try_write.v'>pub fn <a href='#method.try_write' class='fnname'>try_write</a>(&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="struct" href="../lock_api/struct.RwLockWriteGuard.html" title="struct lock_api::RwLockWriteGuard">RwLockWriteGuard</a><R, T>></code><a class='srclink' href='../src/lock_api/rwlock.rs.html#338-344' title='goto source code'>[src]</a></h4><div class='docblock'><p>Attempts to lock this <code>RwLock</code> with exclusive write access.</p>
|
|
|
<p>If the lock could not be acquired at this time, then <code>None</code> is returned.
|
|
|
Otherwise, an RAII guard is returned which will release the lock when
|
|
|
it is dropped.</p>
|
|
|
<p>This function does not block.</p>
|
|
|
</div><h4 id='method.get_mut' class="method"><code id='get_mut.v'>pub fn <a href='#method.get_mut' class='fnname'>get_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code><a class='srclink' href='../src/lock_api/rwlock.rs.html#351-353' title='goto source code'>[src]</a></h4><div class='docblock'><p>Returns a mutable reference to the underlying data.</p>
|
|
|
<p>Since this call borrows the <code>RwLock</code> mutably, no actual locking needs to
|
|
|
take place---the mutable borrow statically guarantees no locks exist.</p>
|
|
|
</div><h4 id='method.force_unlock_read' class="method"><code id='force_unlock_read.v'>pub unsafe fn <a href='#method.force_unlock_read' class='fnname'>force_unlock_read</a>(&self)</code><a class='srclink' href='../src/lock_api/rwlock.rs.html#367-369' title='goto source code'>[src]</a></h4><div class='docblock'><p>Forcibly unlocks a read lock.</p>
|
|
|
<p>This is useful when combined with <code>mem::forget</code> to hold a lock without
|
|
|
the need to maintain a <code>RwLockReadGuard</code> object alive, for example when
|
|
|
dealing with FFI.</p>
|
|
|
<h1 id="safety" class="section-header"><a href="#safety">Safety</a></h1>
|
|
|
<p>This method must only be called if the current thread logically owns a
|
|
|
<code>RwLockReadGuard</code> but that guard has be discarded using <code>mem::forget</code>.
|
|
|
Behavior is undefined if a rwlock is read-unlocked when not read-locked.</p>
|
|
|
</div><h4 id='method.force_unlock_write' class="method"><code id='force_unlock_write.v'>pub unsafe fn <a href='#method.force_unlock_write' class='fnname'>force_unlock_write</a>(&self)</code><a class='srclink' href='../src/lock_api/rwlock.rs.html#383-385' title='goto source code'>[src]</a></h4><div class='docblock'><p>Forcibly unlocks a write lock.</p>
|
|
|
<p>This is useful when combined with <code>mem::forget</code> to hold a lock without
|
|
|
the need to maintain a <code>RwLockWriteGuard</code> object alive, for example when
|
|
|
dealing with FFI.</p>
|
|
|
<h1 id="safety-1" class="section-header"><a href="#safety-1">Safety</a></h1>
|
|
|
<p>This method must only be called if the current thread logically owns a
|
|
|
<code>RwLockWriteGuard</code> but that guard has be discarded using <code>mem::forget</code>.
|
|
|
Behavior is undefined if a rwlock is write-unlocked when not write-locked.</p>
|
|
|
</div><h4 id='method.raw' class="method"><code id='raw.v'>pub unsafe fn <a href='#method.raw' class='fnname'>raw</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>R</code><a class='srclink' href='../src/lock_api/rwlock.rs.html#397-399' title='goto source code'>[src]</a></h4><div class='docblock'><p>Returns the underlying raw reader-writer lock object.</p>
|
|
|
<p>Note that you will most likely need to import the <code>RawRwLock</code> trait from
|
|
|
<code>lock_api</code> to be able to call functions on the raw
|
|
|
reader-writer lock.</p>
|
|
|
<h1 id="safety-2" class="section-header"><a href="#safety-2">Safety</a></h1>
|
|
|
<p>This method is unsafe because it allows unlocking a mutex while
|
|
|
still holding a reference to a lock guard.</p>
|
|
|
</div></div><h3 id='impl-2' class='impl'><code class='in-band'>impl<R: <a class="trait" href="../lock_api/trait.RawRwLockFair.html" title="trait lock_api::RawRwLockFair">RawRwLockFair</a>, T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="struct" href="../lock_api/struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a><R, T></code><a href='#impl-2' class='anchor'></a><a class='srclink' href='../src/lock_api/rwlock.rs.html#402-434' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.force_unlock_read_fair' class="method"><code id='force_unlock_read_fair.v'>pub unsafe fn <a href='#method.force_unlock_read_fair' class='fnname'>force_unlock_read_fair</a>(&self)</code><a class='srclink' href='../src/lock_api/rwlock.rs.html#415-417' title='goto source code'>[src]</a></h4><div class='docblock'><p>Forcibly unlocks a read lock using a fair unlock procotol.</p>
|
|
|
<p>This is useful when combined with <code>mem::forget</code> to hold a lock without
|
|
|
the need to maintain a <code>RwLockReadGuard</code> object alive, for example when
|
|
|
dealing with FFI.</p>
|
|
|
<h1 id="safety-3" class="section-header"><a href="#safety-3">Safety</a></h1>
|
|
|
<p>This method must only be called if the current thread logically owns a
|
|
|
<code>RwLockReadGuard</code> but that guard has be discarded using <code>mem::forget</code>.
|
|
|
Behavior is undefined if a rwlock is read-unlocked when not read-locked.</p>
|
|
|
</div><h4 id='method.force_unlock_write_fair' class="method"><code id='force_unlock_write_fair.v'>pub unsafe fn <a href='#method.force_unlock_write_fair' class='fnname'>force_unlock_write_fair</a>(&self)</code><a class='srclink' href='../src/lock_api/rwlock.rs.html#431-433' title='goto source code'>[src]</a></h4><div class='docblock'><p>Forcibly unlocks a write lock using a fair unlock procotol.</p>
|
|
|
<p>This is useful when combined with <code>mem::forget</code> to hold a lock without
|
|
|
the need to maintain a <code>RwLockWriteGuard</code> object alive, for example when
|
|
|
dealing with FFI.</p>
|
|
|
<h1 id="safety-4" class="section-header"><a href="#safety-4">Safety</a></h1>
|
|
|
<p>This method must only be called if the current thread logically owns a
|
|
|
<code>RwLockWriteGuard</code> but that guard has be discarded using <code>mem::forget</code>.
|
|
|
Behavior is undefined if a rwlock is write-unlocked when not write-locked.</p>
|
|
|
</div></div><h3 id='impl-3' class='impl'><code class='in-band'>impl<R: <a class="trait" href="../lock_api/trait.RawRwLockTimed.html" title="trait lock_api::RawRwLockTimed">RawRwLockTimed</a>, T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="struct" href="../lock_api/struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a><R, T></code><a href='#impl-3' class='anchor'></a><a class='srclink' href='../src/lock_api/rwlock.rs.html#436-496' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.try_read_for' class="method"><code id='try_read_for.v'>pub fn <a href='#method.try_read_for' class='fnname'>try_read_for</a>(<br> &self, <br> timeout: R::<a class="type" href="../lock_api/trait.RawRwLockTimed.html#associatedtype.Duration" title="type lock_api::RawRwLockTimed::Duration">Duration</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../lock_api/struct.RwLockReadGuard.html" title="struct lock_api::RwLockReadGuard">RwLockReadGuard</a><R, T>></code><a class='srclink' href='../src/lock_api/rwlock.rs.html#444-450' title='goto source code'>[src]</a></h4><div class='docblock'><p>Attempts to acquire this <code>RwLock</code> with shared read access until a timeout
|
|
|
is reached.</p>
|
|
|
<p>If the access could not be granted before the timeout expires, then
|
|
|
<code>None</code> is returned. Otherwise, an RAII guard is returned which will
|
|
|
release the shared access when it is dropped.</p>
|
|
|
</div><h4 id='method.try_read_until' class="method"><code id='try_read_until.v'>pub fn <a href='#method.try_read_until' class='fnname'>try_read_until</a>(<br> &self, <br> timeout: R::<a class="type" href="../lock_api/trait.RawRwLockTimed.html#associatedtype.Instant" title="type lock_api::RawRwLockTimed::Instant">Instant</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../lock_api/struct.RwLockReadGuard.html" title="struct lock_api::RwLockReadGuard">RwLockReadGuard</a><R, T>></code><a class='srclink' href='../src/lock_api/rwlock.rs.html#459-465' title='goto source code'>[src]</a></h4><div class='docblock'><p>Attempts to acquire this <code>RwLock</code> with shared read access until a timeout
|
|
|
is reached.</p>
|
|
|
<p>If the access could not be granted before the timeout expires, then
|
|
|
<code>None</code> is returned. Otherwise, an RAII guard is returned which will
|
|
|
release the shared access when it is dropped.</p>
|
|
|
</div><h4 id='method.try_write_for' class="method"><code id='try_write_for.v'>pub fn <a href='#method.try_write_for' class='fnname'>try_write_for</a>(<br> &self, <br> timeout: R::<a class="type" href="../lock_api/trait.RawRwLockTimed.html#associatedtype.Duration" title="type lock_api::RawRwLockTimed::Duration">Duration</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../lock_api/struct.RwLockWriteGuard.html" title="struct lock_api::RwLockWriteGuard">RwLockWriteGuard</a><R, T>></code><a class='srclink' href='../src/lock_api/rwlock.rs.html#474-480' title='goto source code'>[src]</a></h4><div class='docblock'><p>Attempts to acquire this <code>RwLock</code> with exclusive write access until a
|
|
|
timeout is reached.</p>
|
|
|
<p>If the access could not be granted before the timeout expires, then
|
|
|
<code>None</code> is returned. Otherwise, an RAII guard is returned which will
|
|
|
release the exclusive access when it is dropped.</p>
|
|
|
</div><h4 id='method.try_write_until' class="method"><code id='try_write_until.v'>pub fn <a href='#method.try_write_until' class='fnname'>try_write_until</a>(<br> &self, <br> timeout: R::<a class="type" href="../lock_api/trait.RawRwLockTimed.html#associatedtype.Instant" title="type lock_api::RawRwLockTimed::Instant">Instant</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../lock_api/struct.RwLockWriteGuard.html" title="struct lock_api::RwLockWriteGuard">RwLockWriteGuard</a><R, T>></code><a class='srclink' href='../src/lock_api/rwlock.rs.html#489-495' title='goto source code'>[src]</a></h4><div class='docblock'><p>Attempts to acquire this <code>RwLock</code> with exclusive write access until a
|
|
|
timeout is reached.</p>
|
|
|
<p>If the access could not be granted before the timeout expires, then
|
|
|
<code>None</code> is returned. Otherwise, an RAII guard is returned which will
|
|
|
release the exclusive access when it is dropped.</p>
|
|
|
</div></div><h3 id='impl-4' class='impl'><code class='in-band'>impl<R: <a class="trait" href="../lock_api/trait.RawRwLockRecursive.html" title="trait lock_api::RawRwLockRecursive">RawRwLockRecursive</a>, T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="struct" href="../lock_api/struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a><R, T></code><a href='#impl-4' class='anchor'></a><a class='srclink' href='../src/lock_api/rwlock.rs.html#498-538' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.read_recursive' class="method"><code id='read_recursive.v'>pub fn <a href='#method.read_recursive' class='fnname'>read_recursive</a>(&self) -> <a class="struct" href="../lock_api/struct.RwLockReadGuard.html" title="struct lock_api::RwLockReadGuard">RwLockReadGuard</a><R, T></code><a class='srclink' href='../src/lock_api/rwlock.rs.html#515-518' title='goto source code'>[src]</a></h4><div class='docblock'><p>Locks this <code>RwLock</code> with shared read access, blocking the current thread
|
|
|
until it can be acquired.</p>
|
|
|
<p>The calling thread will be blocked until there are no more writers which
|
|
|
hold the lock. There may be other readers currently inside the lock when
|
|
|
this method returns.</p>
|
|
|
<p>Unlike <code>read</code>, this method is guaranteed to succeed without blocking if
|
|
|
another read lock is held at the time of the call. This allows a thread
|
|
|
to recursively lock a <code>RwLock</code>. However using this method can cause
|
|
|
writers to starve since readers no longer block if a writer is waiting
|
|
|
for the lock.</p>
|
|
|
<p>Returns an RAII guard which will release this thread's shared access
|
|
|
once it is dropped.</p>
|
|
|
</div><h4 id='method.try_read_recursive' class="method"><code id='try_read_recursive.v'>pub fn <a href='#method.try_read_recursive' class='fnname'>try_read_recursive</a>(&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="struct" href="../lock_api/struct.RwLockReadGuard.html" title="struct lock_api::RwLockReadGuard">RwLockReadGuard</a><R, T>></code><a class='srclink' href='../src/lock_api/rwlock.rs.html#531-537' title='goto source code'>[src]</a></h4><div class='docblock'><p>Attempts to acquire this <code>RwLock</code> with shared read access.</p>
|
|
|
<p>If the access could not be granted at this time, then <code>None</code> is returned.
|
|
|
Otherwise, an RAII guard is returned which will release the shared access
|
|
|
when it is dropped.</p>
|
|
|
<p>This method is guaranteed to succeed if another read lock is held at the
|
|
|
time of the call. See the documentation for <code>read_recursive</code> for details.</p>
|
|
|
<p>This function does not block.</p>
|
|
|
</div></div><h3 id='impl-5' class='impl'><code class='in-band'>impl<R: <a class="trait" href="../lock_api/trait.RawRwLockRecursiveTimed.html" title="trait lock_api::RawRwLockRecursiveTimed">RawRwLockRecursiveTimed</a>, T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="struct" href="../lock_api/struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a><R, T></code><a href='#impl-5' class='anchor'></a><a class='srclink' href='../src/lock_api/rwlock.rs.html#540-574' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.try_read_recursive_for' class="method"><code id='try_read_recursive_for.v'>pub fn <a href='#method.try_read_recursive_for' class='fnname'>try_read_recursive_for</a>(<br> &self, <br> timeout: R::<a class="type" href="../lock_api/trait.RawRwLockTimed.html#associatedtype.Duration" title="type lock_api::RawRwLockTimed::Duration">Duration</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../lock_api/struct.RwLockReadGuard.html" title="struct lock_api::RwLockReadGuard">RwLockReadGuard</a><R, T>></code><a class='srclink' href='../src/lock_api/rwlock.rs.html#552-558' title='goto source code'>[src]</a></h4><div class='docblock'><p>Attempts to acquire this <code>RwLock</code> with shared read access until a timeout
|
|
|
is reached.</p>
|
|
|
<p>If the access could not be granted before the timeout expires, then
|
|
|
<code>None</code> is returned. Otherwise, an RAII guard is returned which will
|
|
|
release the shared access when it is dropped.</p>
|
|
|
<p>This method is guaranteed to succeed without blocking if another read
|
|
|
lock is held at the time of the call. See the documentation for
|
|
|
<code>read_recursive</code> for details.</p>
|
|
|
</div><h4 id='method.try_read_recursive_until' class="method"><code id='try_read_recursive_until.v'>pub fn <a href='#method.try_read_recursive_until' class='fnname'>try_read_recursive_until</a>(<br> &self, <br> timeout: R::<a class="type" href="../lock_api/trait.RawRwLockTimed.html#associatedtype.Instant" title="type lock_api::RawRwLockTimed::Instant">Instant</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../lock_api/struct.RwLockReadGuard.html" title="struct lock_api::RwLockReadGuard">RwLockReadGuard</a><R, T>></code><a class='srclink' href='../src/lock_api/rwlock.rs.html#567-573' title='goto source code'>[src]</a></h4><div class='docblock'><p>Attempts to acquire this <code>RwLock</code> with shared read access until a timeout
|
|
|
is reached.</p>
|
|
|
<p>If the access could not be granted before the timeout expires, then
|
|
|
<code>None</code> is returned. Otherwise, an RAII guard is returned which will
|
|
|
release the shared access when it is dropped.</p>
|
|
|
</div></div><h3 id='impl-6' class='impl'><code class='in-band'>impl<R: <a class="trait" href="../lock_api/trait.RawRwLockUpgrade.html" title="trait lock_api::RawRwLockUpgrade">RawRwLockUpgrade</a>, T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="struct" href="../lock_api/struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a><R, T></code><a href='#impl-6' class='anchor'></a><a class='srclink' href='../src/lock_api/rwlock.rs.html#576-615' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.upgradable_read' class="method"><code id='upgradable_read.v'>pub fn <a href='#method.upgradable_read' class='fnname'>upgradable_read</a>(&self) -> <a class="struct" href="../lock_api/struct.RwLockUpgradableReadGuard.html" title="struct lock_api::RwLockUpgradableReadGuard">RwLockUpgradableReadGuard</a><R, T></code><a class='srclink' href='../src/lock_api/rwlock.rs.html#595-598' title='goto source code'>[src]</a></h4><div class='docblock'><p>Locks this <code>RwLock</code> with upgradable read access, blocking the current thread
|
|
|
until it can be acquired.</p>
|
|
|
<p>The calling thread will be blocked until there are no more writers or other
|
|
|
upgradable reads which hold the lock. There may be other readers currently
|
|
|
inside the lock when this method returns.</p>
|
|
|
<p>Returns an RAII guard which will release this thread's shared access
|
|
|
once it is dropped.</p>
|
|
|
</div><h4 id='method.try_upgradable_read' class="method"><code id='try_upgradable_read.v'>pub fn <a href='#method.try_upgradable_read' class='fnname'>try_upgradable_read</a>(&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="struct" href="../lock_api/struct.RwLockUpgradableReadGuard.html" title="struct lock_api::RwLockUpgradableReadGuard">RwLockUpgradableReadGuard</a><R, T>></code><a class='srclink' href='../src/lock_api/rwlock.rs.html#608-614' title='goto source code'>[src]</a></h4><div class='docblock'><p>Attempts to acquire this <code>RwLock</code> with upgradable read access.</p>
|
|
|
<p>If the access could not be granted at this time, then <code>None</code> is returned.
|
|
|
Otherwise, an RAII guard is returned which will release the shared access
|
|
|
when it is dropped.</p>
|
|
|
<p>This function does not block.</p>
|
|
|
</div></div><h3 id='impl-7' class='impl'><code class='in-band'>impl<R: <a class="trait" href="../lock_api/trait.RawRwLockUpgradeTimed.html" title="trait lock_api::RawRwLockUpgradeTimed">RawRwLockUpgradeTimed</a>, T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="struct" href="../lock_api/struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a><R, T></code><a href='#impl-7' class='anchor'></a><a class='srclink' href='../src/lock_api/rwlock.rs.html#617-653' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.try_upgradable_read_for' class="method"><code id='try_upgradable_read_for.v'>pub fn <a href='#method.try_upgradable_read_for' class='fnname'>try_upgradable_read_for</a>(<br> &self, <br> timeout: R::<a class="type" href="../lock_api/trait.RawRwLockTimed.html#associatedtype.Duration" title="type lock_api::RawRwLockTimed::Duration">Duration</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../lock_api/struct.RwLockUpgradableReadGuard.html" title="struct lock_api::RwLockUpgradableReadGuard">RwLockUpgradableReadGuard</a><R, T>></code><a class='srclink' href='../src/lock_api/rwlock.rs.html#625-634' title='goto source code'>[src]</a></h4><div class='docblock'><p>Attempts to acquire this <code>RwLock</code> with upgradable read access until a timeout
|
|
|
is reached.</p>
|
|
|
<p>If the access could not be granted before the timeout expires, then
|
|
|
<code>None</code> is returned. Otherwise, an RAII guard is returned which will
|
|
|
release the shared access when it is dropped.</p>
|
|
|
</div><h4 id='method.try_upgradable_read_until' class="method"><code id='try_upgradable_read_until.v'>pub fn <a href='#method.try_upgradable_read_until' class='fnname'>try_upgradable_read_until</a>(<br> &self, <br> timeout: R::<a class="type" href="../lock_api/trait.RawRwLockTimed.html#associatedtype.Instant" title="type lock_api::RawRwLockTimed::Instant">Instant</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../lock_api/struct.RwLockUpgradableReadGuard.html" title="struct lock_api::RwLockUpgradableReadGuard">RwLockUpgradableReadGuard</a><R, T>></code><a class='srclink' href='../src/lock_api/rwlock.rs.html#643-652' title='goto source code'>[src]</a></h4><div class='docblock'><p>Attempts to acquire this <code>RwLock</code> with upgradable read access until a timeout
|
|
|
is reached.</p>
|
|
|
<p>If the access could not be granted before the timeout expires, then
|
|
|
<code>None</code> is returned. Otherwise, an RAII guard is returned which will
|
|
|
release the shared access when it is dropped.</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-From%3CT%3E' class='impl'><code class='in-band'>impl<R: <a class="trait" href="../lock_api/trait.RawRwLock.html" title="trait lock_api::RawRwLock">RawRwLock</a>, 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="../lock_api/struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a><R, T></code><a href='#impl-From%3CT%3E' class='anchor'></a><a class='srclink' href='../src/lock_api/rwlock.rs.html#662-667' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.from' class="method hidden"><code id='from.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(t: T) -> <a class="struct" href="../lock_api/struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a><R, T></code><a class='srclink' href='../src/lock_api/rwlock.rs.html#664-666' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
|
|
</div></div><h3 id='impl-Debug' class='impl'><code class='in-band'>impl<R: <a class="trait" href="../lock_api/trait.RawRwLock.html" title="trait lock_api::RawRwLock">RawRwLock</a>, T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <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="../lock_api/struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a><R, T></code><a href='#impl-Debug' class='anchor'></a><a class='srclink' href='../src/lock_api/rwlock.rs.html#669-676' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.fmt' class="method hidden"><code id='fmt.v'>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/lock_api/rwlock.rs.html#670-675' 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><h3 id='impl-Send' class='impl'><code class='in-band'>impl<R: <a class="trait" href="../lock_api/trait.RawRwLock.html" title="trait lock_api::RawRwLock">RawRwLock</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>> <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="../lock_api/struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a><R, T></code><a href='#impl-Send' class='anchor'></a><a class='srclink' href='../src/lock_api/rwlock.rs.html#233' title='goto source code'>[src]</a></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><code class='in-band'>impl<R: <a class="trait" href="../lock_api/trait.RawRwLock.html" title="trait lock_api::RawRwLock">RawRwLock</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>, T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>> <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="../lock_api/struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a><R, T></code><a href='#impl-Sync' class='anchor'></a><a class='srclink' href='../src/lock_api/rwlock.rs.html#234' title='goto source code'>[src]</a></h3><div class='impl-items'></div><h3 id='impl-Default' class='impl'><code class='in-band'>impl<R: <a class="trait" href="../lock_api/trait.RawRwLock.html" title="trait lock_api::RawRwLock">RawRwLock</a>, T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="../lock_api/struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a><R, T></code><a href='#impl-Default' class='anchor'></a><a class='srclink' href='../src/lock_api/rwlock.rs.html#655-660' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.default' class="method hidden"><code id='default.v'>fn <a href='https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default' class='fnname'>default</a>() -> <a class="struct" href="../lock_api/struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a><R, T></code><a class='srclink' href='../src/lock_api/rwlock.rs.html#657-659' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns the "default value" for a type. <a href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default">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-Unpin' class='impl'><code class='in-band'>impl<R, T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <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="../lock_api/struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a><R, T> <span class="where fmt-newline">where<br> R: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>, </span></code><a href='#impl-Unpin' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-UnwindSafe' class='impl'><code class='in-band'>impl<R, T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <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="../lock_api/struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a><R, T> <span class="where fmt-newline">where<br> R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a>,<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a>, </span></code><a href='#impl-UnwindSafe' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-RefUnwindSafe' class='impl'><code class='in-band'>impl<R, T> !<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="../lock_api/struct.RwLock.html" title="struct lock_api::RwLock">RwLock</a><R, T></code><a href='#impl-RefUnwindSafe' class='anchor'></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-From%3CT%3E-1' 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-1' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#553-555' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.from-1' class="method hidden"><code id='from.v-1'>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.rs.html#554' 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.rs.html#572-578' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error' class="type"><code id='Error.t'>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 id='try_from.v'>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.rs.html#575-577' 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.rs.html#544-549' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.into' class="method hidden"><code id='into.v'>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.rs.html#546-548' 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.rs.html#560-567' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error-1' class="type"><code id='Error.t-1'>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 id='try_into.v'>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.rs.html#564-566' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</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#213-215' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow' class="method hidden"><code id='borrow.v'>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</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#214' 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#218-220' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow_mut' class="method hidden"><code id='borrow_mut.v'>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</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#219' 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-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#100-102' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.type_id' class="method hidden"><code id='type_id.v'>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#101' 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-Erased' class='impl'><code class='in-band'>impl<T> <a class="trait" href="../owning_ref/trait.Erased.html" title="trait owning_ref::Erased">Erased</a> for T</code><a href='#impl-Erased' class='anchor'></a><a class='srclink' href='../src/owning_ref/lib.rs.html#281' title='goto source code'>[src]</a></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 = "lock_api";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |
