servius/rapr-rs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
fcf47cbac9b86ef7feb4c292e8d25ffba479a33a
rapr-rs/docs/parking_lot/index.html
T
Uttarayan Mondal d5ecda4c73 Initial docs commit
2021-03-15 01:27:34 +05:30

54 lines
12 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!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="This library provides implementations of `Mutex`, `RwLock`, `Condvar` and `Once` that are smaller, faster and more flexible than those in the Rust standard library. It also provides a `ReentrantMutex` type."><meta name="keywords" content="rust, rustlang, rust-lang, parking_lot"><title>parking_lot - 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="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
<link rel="alternate icon" type="image/png" href="../favicon-16x16.png">
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../parking_lot/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class="location">Crate parking_lot</p><div class="block version"><p>Version 0.11.1</p></div><div class="sidebar-elems"><a id="all-types" href="all.html"><p>See all parking_lot's items</p></a><div class="block items"><ul><li><a href="#reexports">Re-exports</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#functions">Functions</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class="location"></p><div id="sidebar-vars" data-name="parking_lot" data-ty="mod" data-relpath="../"></div></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
<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">Crate <a class="mod" href="">parking_lot</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">&#x2212;</span>]</a></span><a class="srclink" href="../src/parking_lot/lib.rs.html#8-57" title="goto source code">[src]</a></span></h1><div class="docblock"><p>This library provides implementations of <code>Mutex</code>, <code>RwLock</code>, <code>Condvar</code> and
<code>Once</code> that are smaller, faster and more flexible than those in the Rust
standard library. It also provides a <code>ReentrantMutex</code> type.</p>
</div><h2 id="reexports" class="section-header"><a href="#reexports">Re-exports</a></h2>
<table><tr><td><code>pub use <a class="mod" href="../lock_api/index.html" title="mod lock_api">lock_api</a>;</code></td></tr></table><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2>
<table><tr class="module-item"><td><a class="struct" href="struct.Condvar.html" title="parking_lot::Condvar struct">Condvar</a></td><td class="docblock-short"><p>A Condition Variable</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Once.html" title="parking_lot::Once struct">Once</a></td><td class="docblock-short"><p>A synchronization primitive which can be used to run a one-time
initialization. Useful for one-time initialization for globals, FFI or
related functionality.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.RawFairMutex.html" title="parking_lot::RawFairMutex struct">RawFairMutex</a></td><td class="docblock-short"><p>Raw fair mutex type backed by the parking lot.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.RawMutex.html" title="parking_lot::RawMutex struct">RawMutex</a></td><td class="docblock-short"><p>Raw mutex type backed by the parking lot.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.RawRwLock.html" title="parking_lot::RawRwLock struct">RawRwLock</a></td><td class="docblock-short"><p>Raw reader-writer lock type backed by the parking lot.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.RawThreadId.html" title="parking_lot::RawThreadId struct">RawThreadId</a></td><td class="docblock-short"><p>Implementation of the <code>GetThreadId</code> trait for <code>lock_api::ReentrantMutex</code>.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.WaitTimeoutResult.html" title="parking_lot::WaitTimeoutResult struct">WaitTimeoutResult</a></td><td class="docblock-short"><p>A type indicating whether a timed wait on a condition variable returned
due to a time out or not.</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.OnceState.html" title="parking_lot::OnceState enum">OnceState</a></td><td class="docblock-short"><p>Current state of a <code>Once</code>.</p>
</td></tr></table><h2 id="functions" class="section-header"><a href="#functions">Functions</a></h2>
<table><tr class="module-item"><td><a class="fn" href="fn.const_fair_mutex.html" title="parking_lot::const_fair_mutex fn">const_fair_mutex</a></td><td class="docblock-short"><p>Creates a new fair mutex in an unlocked state ready for use.</p>
</td></tr><tr class="module-item"><td><a class="fn" href="fn.const_mutex.html" title="parking_lot::const_mutex fn">const_mutex</a></td><td class="docblock-short"><p>Creates a new mutex in an unlocked state ready for use.</p>
</td></tr><tr class="module-item"><td><a class="fn" href="fn.const_reentrant_mutex.html" title="parking_lot::const_reentrant_mutex fn">const_reentrant_mutex</a></td><td class="docblock-short"><p>Creates a new reentrant mutex in an unlocked state ready for use.</p>
</td></tr><tr class="module-item"><td><a class="fn" href="fn.const_rwlock.html" title="parking_lot::const_rwlock fn">const_rwlock</a></td><td class="docblock-short"><p>Creates a new instance of an <code>RwLock&lt;T&gt;</code> which is unlocked.</p>
</td></tr></table><h2 id="types" class="section-header"><a href="#types">Type Definitions</a></h2>
<table><tr class="module-item"><td><a class="type" href="type.FairMutex.html" title="parking_lot::FairMutex type">FairMutex</a></td><td class="docblock-short"><p>A mutual exclusive primitive that is always fair, useful for protecting shared data</p>
</td></tr><tr class="module-item"><td><a class="type" href="type.FairMutexGuard.html" title="parking_lot::FairMutexGuard type">FairMutexGuard</a></td><td class="docblock-short"><p>An RAII implementation of a “scoped lock” of a mutex. When this structure is
dropped (falls out of scope), the lock will be unlocked.</p>
</td></tr><tr class="module-item"><td><a class="type" href="type.MappedFairMutexGuard.html" title="parking_lot::MappedFairMutexGuard type">MappedFairMutexGuard</a></td><td class="docblock-short"><p>An RAII mutex guard returned by <code>FairMutexGuard::map</code>, which can point to a
subfield of the protected data.</p>
</td></tr><tr class="module-item"><td><a class="type" href="type.MappedMutexGuard.html" title="parking_lot::MappedMutexGuard type">MappedMutexGuard</a></td><td class="docblock-short"><p>An RAII mutex guard returned by <code>MutexGuard::map</code>, which can point to a
subfield of the protected data.</p>
</td></tr><tr class="module-item"><td><a class="type" href="type.MappedReentrantMutexGuard.html" title="parking_lot::MappedReentrantMutexGuard type">MappedReentrantMutexGuard</a></td><td class="docblock-short"><p>An RAII mutex guard returned by <code>ReentrantMutexGuard::map</code>, which can point to a
subfield of the protected data.</p>
</td></tr><tr class="module-item"><td><a class="type" href="type.MappedRwLockReadGuard.html" title="parking_lot::MappedRwLockReadGuard type">MappedRwLockReadGuard</a></td><td class="docblock-short"><p>An RAII read lock guard returned by <code>RwLockReadGuard::map</code>, which can point to a
subfield of the protected data.</p>
</td></tr><tr class="module-item"><td><a class="type" href="type.MappedRwLockWriteGuard.html" title="parking_lot::MappedRwLockWriteGuard type">MappedRwLockWriteGuard</a></td><td class="docblock-short"><p>An RAII write lock guard returned by <code>RwLockWriteGuard::map</code>, which can point to a
subfield of the protected data.</p>
</td></tr><tr class="module-item"><td><a class="type" href="type.Mutex.html" title="parking_lot::Mutex type">Mutex</a></td><td class="docblock-short"><p>A mutual exclusion primitive useful for protecting shared data</p>
</td></tr><tr class="module-item"><td><a class="type" href="type.MutexGuard.html" title="parking_lot::MutexGuard type">MutexGuard</a></td><td class="docblock-short"><p>An RAII implementation of a “scoped lock” of a mutex. When this structure is
dropped (falls out of scope), the lock will be unlocked.</p>
</td></tr><tr class="module-item"><td><a class="type" href="type.ReentrantMutex.html" title="parking_lot::ReentrantMutex type">ReentrantMutex</a></td><td class="docblock-short"><p>A mutex which can be recursively locked by a single thread.</p>
</td></tr><tr class="module-item"><td><a class="type" href="type.ReentrantMutexGuard.html" title="parking_lot::ReentrantMutexGuard type">ReentrantMutexGuard</a></td><td class="docblock-short"><p>An RAII implementation of a “scoped lock” of a reentrant mutex. When this structure
is dropped (falls out of scope), the lock will be unlocked.</p>
</td></tr><tr class="module-item"><td><a class="type" href="type.RwLock.html" title="parking_lot::RwLock type">RwLock</a></td><td class="docblock-short"><p>A reader-writer lock</p>
</td></tr><tr class="module-item"><td><a class="type" href="type.RwLockReadGuard.html" title="parking_lot::RwLockReadGuard type">RwLockReadGuard</a></td><td class="docblock-short"><p>RAII structure used to release the shared read access of a lock when
dropped.</p>
</td></tr><tr class="module-item"><td><a class="type" href="type.RwLockUpgradableReadGuard.html" title="parking_lot::RwLockUpgradableReadGuard type">RwLockUpgradableReadGuard</a></td><td class="docblock-short"><p>RAII structure used to release the upgradable read access of a lock when
dropped.</p>
</td></tr><tr class="module-item"><td><a class="type" href="type.RwLockWriteGuard.html" title="parking_lot::RwLockWriteGuard type">RwLockWriteGuard</a></td><td class="docblock-short"><p>RAII structure used to release the exclusive write access of a lock when
dropped.</p>
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../" data-current-crate="parking_lot"></div>
<script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>
Reference in New Issue View Git Blame Copy Permalink