| <!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="Synchronization primitives"><meta name="keywords" content="rust, rustlang, rust-lang, sync"><title>tokio_util::sync - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.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">☰</button><a class="sidebar-logo" href="../../tokio_util/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../tokio_util/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Module sync</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Module <a href="../index.html">tokio_util</a>::<wbr><a class="mod" href="#">sync</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/tokio_util/sync/mod.rs.html#1-15">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Synchronization primitives</p> |
| </div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.CancellationToken.html" title="tokio_util::sync::CancellationToken struct">CancellationToken</a></div><div class="item-right docblock-short">A token which can be used to signal a cancellation request to one or more |
| tasks.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.DropGuard.html" title="tokio_util::sync::DropGuard struct">DropGuard</a></div><div class="item-right docblock-short">A wrapper for cancellation token which automatically cancels |
| it on drop. It is created using <code>drop_guard</code> method on the <code>CancellationToken</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.PollSemaphore.html" title="tokio_util::sync::PollSemaphore struct">PollSemaphore</a></div><div class="item-right docblock-short">A wrapper around <a href="../../tokio/sync/semaphore/struct.Semaphore.html"><code>Semaphore</code></a> that provides a <code>poll_acquire</code> method.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.PollSendError.html" title="tokio_util::sync::PollSendError struct">PollSendError</a></div><div class="item-right docblock-short">Error returned by the <code>PollSender</code> when the channel is closed.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.PollSender.html" title="tokio_util::sync::PollSender struct">PollSender</a></div><div class="item-right docblock-short">A wrapper around <a href="../../tokio/sync/mpsc/bounded/struct.Sender.html"><code>mpsc::Sender</code></a> that can be polled.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ReusableBoxFuture.html" title="tokio_util::sync::ReusableBoxFuture struct">ReusableBoxFuture</a></div><div class="item-right docblock-short">A reusable <code>Pin<Box<dyn Future<Output = T> + Send + 'a>></code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.WaitForCancellationFuture.html" title="tokio_util::sync::WaitForCancellationFuture struct">WaitForCancellationFuture</a></div><div class="item-right docblock-short">A Future that is resolved once the corresponding <a href="struct.CancellationToken.html" title="CancellationToken"><code>CancellationToken</code></a> |
| is cancelled.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.WaitForCancellationFutureOwned.html" title="tokio_util::sync::WaitForCancellationFutureOwned struct">WaitForCancellationFutureOwned</a></div><div class="item-right docblock-short">A Future that is resolved once the corresponding <a href="struct.CancellationToken.html" title="CancellationToken"><code>CancellationToken</code></a> |
| is cancelled.</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="tokio_util" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
