OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-01-28 21:02:29 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
f4bb79d2d629ee5166f17b80ca2aa0e621d1c837
google-apis-rs/futures_util/index.html
Sebastian Thiel f4bb79d2d6 Update documentation
2024-03-05 21:06:01 +01:00

17 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="Combinators and utilities for working with `Future`s, `Stream`s, `Sink`s, and the `AsyncRead` and `AsyncWrite` traits."><title>futures_util - 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="../crates.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 crate"><!--[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><div class="sidebar-elems"><ul class="block">
<li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#reexports">Re-exports</a></li><li><a href="#modules">Modules</a></li><li><a href="#macros">Macros</a></li></ul></section></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>Crate <a class="mod" href="#">futures_util</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/lib.rs.html#1-337">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>Combinators and utilities for working with <code>Future</code>s, <code>Stream</code>s, <code>Sink</code>s,
and the <code>AsyncRead</code> and <code>AsyncWrite</code> traits.</p>
</div></details><h2 id="reexports" class="section-header"><a href="#reexports">Re-exports</a></h2><ul class="item-table"><li><div class="item-name" id="reexport.Future"><code>pub use crate::future::<a class="trait" href="https://doc.rust-lang.org/1.76.0/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>;</code></div></li><li><div class="item-name" id="reexport.FutureExt"><code>pub use crate::future::<a class="trait" href="future/trait.FutureExt.html" title="trait futures_util::future::FutureExt">FutureExt</a>;</code></div></li><li><div class="item-name" id="reexport.TryFuture"><code>pub use crate::future::<a class="trait" href="future/trait.TryFuture.html" title="trait futures_util::future::TryFuture">TryFuture</a>;</code></div></li><li><div class="item-name" id="reexport.TryFutureExt"><code>pub use crate::future::<a class="trait" href="future/trait.TryFutureExt.html" title="trait futures_util::future::TryFutureExt">TryFutureExt</a>;</code></div></li><li><div class="item-name" id="reexport.Stream"><code>pub use crate::stream::<a class="trait" href="stream/trait.Stream.html" title="trait futures_util::stream::Stream">Stream</a>;</code></div></li><li><div class="item-name" id="reexport.StreamExt"><code>pub use crate::stream::<a class="trait" href="stream/trait.StreamExt.html" title="trait futures_util::stream::StreamExt">StreamExt</a>;</code></div></li><li><div class="item-name" id="reexport.TryStream"><code>pub use crate::stream::<a class="trait" href="stream/trait.TryStream.html" title="trait futures_util::stream::TryStream">TryStream</a>;</code></div></li><li><div class="item-name" id="reexport.TryStreamExt"><code>pub use crate::stream::<a class="trait" href="stream/trait.TryStreamExt.html" title="trait futures_util::stream::TryStreamExt">TryStreamExt</a>;</code></div></li><li><div class="item-name" id="reexport.Sink"><code>pub use crate::sink::<a class="trait" href="sink/trait.Sink.html" title="trait futures_util::sink::Sink">Sink</a>;</code></div></li><li><div class="item-name" id="reexport.SinkExt"><code>pub use crate::sink::<a class="trait" href="sink/trait.SinkExt.html" title="trait futures_util::sink::SinkExt">SinkExt</a>;</code></div></li><li><div class="item-name" id="reexport.AsyncBufRead"><code>pub use crate::io::<a class="trait" href="io/trait.AsyncBufRead.html" title="trait futures_util::io::AsyncBufRead">AsyncBufRead</a>;</code></div></li><li><div class="item-name" id="reexport.AsyncBufReadExt"><code>pub use crate::io::<a class="trait" href="io/trait.AsyncBufReadExt.html" title="trait futures_util::io::AsyncBufReadExt">AsyncBufReadExt</a>;</code></div></li><li><div class="item-name" id="reexport.AsyncRead"><code>pub use crate::io::<a class="trait" href="io/trait.AsyncRead.html" title="trait futures_util::io::AsyncRead">AsyncRead</a>;</code></div></li><li><div class="item-name" id="reexport.AsyncReadExt"><code>pub use crate::io::<a class="trait" href="io/trait.AsyncReadExt.html" title="trait futures_util::io::AsyncReadExt">AsyncReadExt</a>;</code></div></li><li><div class="item-name" id="reexport.AsyncSeek"><code>pub use crate::io::<a class="trait" href="io/trait.AsyncSeek.html" title="trait futures_util::io::AsyncSeek">AsyncSeek</a>;</code></div></li><li><div class="item-name" id="reexport.AsyncSeekExt"><code>pub use crate::io::<a class="trait" href="io/trait.AsyncSeekExt.html" title="trait futures_util::io::AsyncSeekExt">AsyncSeekExt</a>;</code></div></li><li><div class="item-name" id="reexport.AsyncWrite"><code>pub use crate::io::<a class="trait" href="io/trait.AsyncWrite.html" title="trait futures_util::io::AsyncWrite">AsyncWrite</a>;</code></div></li><li><div class="item-name" id="reexport.AsyncWriteExt"><code>pub use crate::io::<a class="trait" href="io/trait.AsyncWriteExt.html" title="trait futures_util::io::AsyncWriteExt">AsyncWriteExt</a>;</code></div></li></ul><h2 id="modules" class="section-header"><a href="#modules">Modules</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="future/index.html" title="mod futures_util::future">future</a></div><div class="desc docblock-short">Asynchronous values.</div></li><li><div class="item-name"><a class="mod" href="io/index.html" title="mod futures_util::io">io</a></div><div class="desc docblock-short">Asynchronous I/O.</div></li><li><div class="item-name"><a class="mod" href="lock/index.html" title="mod futures_util::lock">lock</a></div><div class="desc docblock-short">Futures-powered synchronization primitives.</div></li><li><div class="item-name"><a class="mod" href="never/index.html" title="mod futures_util::never">never</a></div><div class="desc docblock-short">This module contains the <code>Never</code> type.</div></li><li><div class="item-name"><a class="mod" href="sink/index.html" title="mod futures_util::sink">sink</a></div><div class="desc docblock-short">Asynchronous sinks.</div></li><li><div class="item-name"><a class="mod" href="stream/index.html" title="mod futures_util::stream">stream</a></div><div class="desc docblock-short">Asynchronous streams.</div></li><li><div class="item-name"><a class="mod" href="task/index.html" title="mod futures_util::task">task</a></div><div class="desc docblock-short">Tools for working with tasks.</div></li></ul><h2 id="macros" class="section-header"><a href="#macros">Macros</a></h2><ul class="item-table"><li><div class="item-name"><a class="macro" href="macro.join.html" title="macro futures_util::join">join</a></div><div class="desc docblock-short">Polls multiple futures simultaneously, returning a tuple
of all results once complete.</div></li><li><div class="item-name"><a class="macro" href="macro.pending.html" title="macro futures_util::pending">pending</a></div><div class="desc docblock-short">A macro which yields to the event loop once.</div></li><li><div class="item-name"><a class="macro" href="macro.pin_mut.html" title="macro futures_util::pin_mut">pin_mut</a></div><div class="desc docblock-short">Pins a value on the stack.</div></li><li><div class="item-name"><a class="macro" href="macro.poll.html" title="macro futures_util::poll">poll</a></div><div class="desc docblock-short">A macro which returns the result of polling a future once within the
current <code>async</code> context.</div></li><li><div class="item-name"><a class="macro" href="macro.ready.html" title="macro futures_util::ready">ready</a></div><div class="desc docblock-short">Extracts the successful type of a <code>Poll&lt;T&gt;</code>.</div></li><li><div class="item-name"><a class="macro" href="macro.select.html" title="macro futures_util::select">select</a></div><div class="desc docblock-short">Polls multiple futures and streams simultaneously, executing the branch
for the future that finishes first. If multiple futures are ready,
one will be pseudo-randomly selected at runtime. Futures directly
passed to <code>select!</code> must be <code>Unpin</code> and implement <code>FusedFuture</code>.</div></li><li><div class="item-name"><a class="macro" href="macro.select_biased.html" title="macro futures_util::select_biased">select_biased</a></div><div class="desc docblock-short">Polls multiple futures and streams simultaneously, executing the branch
for the future that finishes first. Unlike <a href="macro.select.html"><code>select!</code></a>, if multiple futures are ready,
one will be selected in order of declaration. Futures directly
passed to <code>select_biased!</code> must be <code>Unpin</code> and implement <code>FusedFuture</code>.</div></li><li><div class="item-name"><a class="macro" href="macro.stream_select.html" title="macro futures_util::stream_select">stream_select</a></div><div class="desc docblock-short">Combines several streams, all producing the same <code>Item</code> type, into one stream.
This is similar to <code>select_all</code> but does not require the streams to all be the same type.
It also keeps the streams inline, and does not require <code>Box&lt;dyn Stream&gt;</code>s to be allocated.
Streams passed to this macro must be <code>Unpin</code>.</div></li><li><div class="item-name"><a class="macro" href="macro.try_join.html" title="macro futures_util::try_join">try_join</a></div><div class="desc docblock-short">Polls multiple futures simultaneously, resolving to a <a href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result"><code>Result</code></a> containing
either a tuple of the successful outputs or an error.</div></li></ul></section></div></main></body></html>
Reference in New Issue View Git Blame Copy Permalink