Files
google-apis-rs/futures_util/lock/index.html
2024-03-05 21:06:01 +01:00

10 lines
6.2 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="Futures-powered synchronization primitives."><title>futures_util::lock - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-ac92e1bbe349e143.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="futures_util" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../futures_util/index.html">futures_util</a><span class="version">0.3.28</span></h2></div><h2 class="location"><a href="#">Module lock</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li></ul></section><h2><a href="../index.html">In crate futures_util</a></h2></div></nav><div class="sidebar-resizer"></div>
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../futures_util/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press S to search, ? for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../index.html">futures_util</a>::<wbr><a class="mod" href="#">lock</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../src/futures_util/lock/mod.rs.html#1-27">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Futures-powered synchronization primitives.</p>
<p>This module is only available when the <code>std</code> or <code>alloc</code> feature of this
library is activated, and it is activated by default.</p>
</div></details><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.MappedMutexGuard.html" title="struct futures_util::lock::MappedMutexGuard">MappedMutexGuard</a></div><div class="desc docblock-short">An RAII guard returned by the <code>MutexGuard::map</code> and <code>MappedMutexGuard::map</code> methods.
When this structure is dropped (falls out of scope), the lock will be unlocked.</div></li><li><div class="item-name"><a class="struct" href="struct.Mutex.html" title="struct futures_util::lock::Mutex">Mutex</a></div><div class="desc docblock-short">A futures-aware mutex.</div></li><li><div class="item-name"><a class="struct" href="struct.MutexGuard.html" title="struct futures_util::lock::MutexGuard">MutexGuard</a></div><div class="desc docblock-short">An RAII guard returned by the <code>lock</code> and <code>try_lock</code> methods.
When this structure is dropped (falls out of scope), the lock will be
unlocked.</div></li><li><div class="item-name"><a class="struct" href="struct.MutexLockFuture.html" title="struct futures_util::lock::MutexLockFuture">MutexLockFuture</a></div><div class="desc docblock-short">A future which resolves when the target mutex has been successfully acquired.</div></li><li><div class="item-name"><a class="struct" href="struct.OwnedMutexGuard.html" title="struct futures_util::lock::OwnedMutexGuard">OwnedMutexGuard</a></div><div class="desc docblock-short">An RAII guard returned by the <code>lock_owned</code> and <code>try_lock_owned</code> methods.
When this structure is dropped (falls out of scope), the lock will be
unlocked.</div></li><li><div class="item-name"><a class="struct" href="struct.OwnedMutexLockFuture.html" title="struct futures_util::lock::OwnedMutexLockFuture">OwnedMutexLockFuture</a></div><div class="desc docblock-short">A future which resolves when the target mutex has been successfully acquired, owned version.</div></li></ul></section></div></main></body></html>