mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-28 04:41:02 +01:00
43 lines
6.6 KiB
HTML
43 lines
6.6 KiB
HTML
<!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 `try_lock` crate."><meta name="keywords" content="rust, rustlang, rust-lang, try_lock"><title>try_lock - 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">☰</div><a href='../try_lock/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class="location">Crate try_lock</p><div class="block version"><p>Version 0.2.3</p></div><div class="sidebar-elems"><a id="all-types" href="all.html"><p>See all try_lock's items</p></a><div class="block items"><ul><li><a href="#structs">Structs</a></li></ul></div><p class="location"></p><div id="sidebar-vars" data-name="try_lock" 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="">try_lock</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/try_lock/lib.rs.html#1-271" title="goto source code">[src]</a></span></h1><div class="docblock"><p>A light-weight lock guarded by an atomic boolean.</p>
|
||
<p>Most efficient when contention is low, acquiring the lock is a single
|
||
atomic swap, and releasing it just 1 more atomic swap.</p>
|
||
<h1 id="example" class="section-header"><a href="#example">Example</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">Arc</span>;
|
||
<span class="kw">use</span> <span class="ident">try_lock</span>::<span class="ident">TryLock</span>;
|
||
|
||
<span class="comment">// a thing we want to share</span>
|
||
<span class="kw">struct</span> <span class="ident">Widget</span> {
|
||
<span class="ident">name</span>: <span class="ident">String</span>,
|
||
}
|
||
|
||
<span class="comment">// lock it up!</span>
|
||
<span class="kw">let</span> <span class="ident">widget1</span> <span class="op">=</span> <span class="ident">Arc</span>::<span class="ident">new</span>(<span class="ident">TryLock</span>::<span class="ident">new</span>(<span class="ident">Widget</span> {
|
||
<span class="ident">name</span>: <span class="string">"Spanner"</span>.<span class="ident">into</span>(),
|
||
}));
|
||
|
||
<span class="kw">let</span> <span class="ident">widget2</span> <span class="op">=</span> <span class="ident">widget1</span>.<span class="ident">clone</span>();
|
||
|
||
|
||
<span class="comment">// mutate the widget</span>
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">locked</span> <span class="op">=</span> <span class="ident">widget1</span>.<span class="ident">try_lock</span>().<span class="ident">expect</span>(<span class="string">"example isn't locked yet"</span>);
|
||
<span class="ident">locked</span>.<span class="ident">name</span>.<span class="ident">push_str</span>(<span class="string">" Bundle"</span>);
|
||
|
||
<span class="comment">// hands off, buddy</span>
|
||
<span class="kw">let</span> <span class="ident">not_locked</span> <span class="op">=</span> <span class="ident">widget2</span>.<span class="ident">try_lock</span>();
|
||
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">not_locked</span>.<span class="ident">is_none</span>(), <span class="string">"widget1 has the lock"</span>);
|
||
|
||
<span class="comment">// ok, you can have it</span>
|
||
<span class="ident">drop</span>(<span class="ident">locked</span>);
|
||
|
||
<span class="kw">let</span> <span class="ident">locked2</span> <span class="op">=</span> <span class="ident">widget2</span>.<span class="ident">try_lock</span>().<span class="ident">expect</span>(<span class="string">"widget1 lock is released"</span>);
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">locked2</span>.<span class="ident">name</span>, <span class="string">"Spanner Bundle"</span>);</pre></div>
|
||
</div><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2>
|
||
<table><tr class="module-item"><td><a class="struct" href="struct.Locked.html" title="try_lock::Locked struct">Locked</a></td><td class="docblock-short"><p>A locked value acquired from a <code>TryLock</code>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TryLock.html" title="try_lock::TryLock struct">TryLock</a></td><td class="docblock-short"><p>A light-weight lock guarded by an atomic boolean.</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="try_lock"></div>
|
||
<script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |