Auto Generated Documentation
This commit is contained in:
github-actions[bot]
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -1,7 +1,7 @@
|
||||
<!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 `futures_util` crate."><meta name="keywords" content="rust, rustlang, rust-lang, futures_util"><title>futures_util - 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='../futures_util/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class="location">Crate futures_util</p><div class="block version"><p>Version 0.3.13</p></div><div class="sidebar-elems"><a id="all-types" href="all.html"><p>See all futures_util's items</p></a><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#macros">Macros</a></li></ul></div><p class="location"></p><div id="sidebar-vars" data-name="futures_util" 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="">futures_util</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/futures_util/lib.rs.html#1-346" title="goto source code">[src]</a></span></h1><div class="docblock"><p>Combinators and utilities for working with <code>Future</code>s, <code>Stream</code>s, <code>Sink</code>s,
|
||||
<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='../futures_util/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class="location">Crate futures_util</p><div class="block version"><p>Version 0.3.14</p></div><div class="sidebar-elems"><a id="all-types" href="all.html"><p>See all futures_util's items</p></a><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#macros">Macros</a></li></ul></div><p class="location"></p><div id="sidebar-vars" data-name="futures_util" 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="">futures_util</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/futures_util/lib.rs.html#1-349" title="goto source code">[src]</a></span></h1><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><h2 id="modules" class="section-header"><a href="#modules">Modules</a></h2>
|
||||
<table><tr class="module-item"><td><a class="mod" href="future/index.html" title="futures_util::future mod">future</a></td><td class="docblock-short"><p>Asynchronous values.</p>
|
||||
|
||||
@@ -36,9 +36,11 @@ stream from an iterator.</li>
|
||||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.MapErr.html" title="futures_util::stream::MapErr struct">MapErr</a></td><td class="docblock-short"><p>Stream for the <a href="../../futures_util/stream/trait.TryStreamExt.html#method.map_err"><code>map_err</code></a> method.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.MapOk.html" title="futures_util::stream::MapOk struct">MapOk</a></td><td class="docblock-short"><p>Stream for the <a href="../../futures_util/stream/trait.TryStreamExt.html#method.map_ok"><code>map_ok</code></a> method.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Next.html" title="futures_util::stream::Next struct">Next</a></td><td class="docblock-short"><p>Future for the <a href="../../futures_util/stream/trait.StreamExt.html#method.next"><code>next</code></a> method.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.NextIf.html" title="futures_util::stream::NextIf struct">NextIf</a></td><td class="docblock-short"><p>Future for the <a href="../../futures_util/stream/struct.Peekable.html#method.next_if"><code>Peekable::next_if</code></a> method.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.NextIfEq.html" title="futures_util::stream::NextIfEq struct">NextIfEq</a></td><td class="docblock-short"><p>Future for the <a href="../../futures_util/stream/struct.Peekable.html#method.next_if_eq"><code>Peekable::next_if_eq</code></a> method.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Once.html" title="futures_util::stream::Once struct">Once</a></td><td class="docblock-short"><p>A stream which emits single element and then EOF.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.OrElse.html" title="futures_util::stream::OrElse struct">OrElse</a></td><td class="docblock-short"><p>Stream for the <a href="../../futures_util/stream/trait.TryStreamExt.html#method.or_else"><code>or_else</code></a> method.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Peek.html" title="futures_util::stream::Peek struct">Peek</a></td><td class="docblock-short"><p>Future for the <a href="../../futures_util/stream/struct.Peekable.html#method.peek"><code>Peekable::peek()</code></a> function from <a href="../../futures_util/stream/struct.Peekable.html" title="Peekable"><code>Peekable</code></a></p>
|
||||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Peek.html" title="futures_util::stream::Peek struct">Peek</a></td><td class="docblock-short"><p>Future for the <a href="../../futures_util/stream/struct.Peekable.html#method.peek"><code>Peekable::peek</code></a> method.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Peekable.html" title="futures_util::stream::Peekable struct">Peekable</a></td><td class="docblock-short"><p>A <code>Stream</code> that implements a <code>peek</code> method.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Pending.html" title="futures_util::stream::Pending struct">Pending</a></td><td class="docblock-short"><p>Stream for the <a href="../../futures_util/stream/fn.pending.html" title="pending()"><code>pending()</code></a> function.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PollFn.html" title="futures_util::stream::PollFn struct">PollFn</a></td><td class="docblock-short"><p>Stream for the <a href="../../futures_util/stream/fn.poll_fn.html" title="poll_fn"><code>poll_fn</code></a> function.</p>
|
||||
|
||||
@@ -1 +1 @@
|
||||
initSidebarItems({"fn":[["empty","Creates a stream which contains no elements."],["iter","Converts an `Iterator` into a `Stream` which is always ready to yield the next value."],["once","Creates a stream of a single element."],["pending","Creates a stream which never returns any elements."],["poll_fn","Creates a new stream wrapping a function returning `Poll<Option<T>>`."],["repeat","Create a stream which produces the same item repeatedly."],["repeat_with","Creates a new stream that repeats elements of type `A` endlessly by applying the provided closure, the repeater, `F: FnMut() -> A`."],["select","This function will attempt to pull items from both streams. Each stream will be polled in a round-robin fashion, and whenever a stream is ready to yield an item that item is yielded."],["try_unfold","Creates a `TryStream` from a seed and a closure returning a `TryFuture`."],["unfold","Creates a `Stream` from a seed and a closure returning a `Future`."]],"struct":[["AndThen","Stream for the `and_then` method."],["Chain","Stream for the `chain` method."],["Collect","Future for the `collect` method."],["Concat","Future for the `concat` method."],["Cycle","Stream for the `cycle` method."],["Empty","Stream for the [`empty`] function."],["Enumerate","Stream for the `enumerate` method."],["ErrInto","Stream for the `err_into` method."],["Filter","Stream for the `filter` method."],["FilterMap","Stream for the `filter_map` method."],["FlatMap","Stream for the `flat_map` method."],["Flatten","Stream for the `flatten` method."],["Fold","Future for the `fold` method."],["ForEach","Future for the `for_each` method."],["Fuse","Stream for the `fuse` method."],["Inspect","Stream for the `inspect` method."],["InspectErr","Stream for the `inspect_err` method."],["InspectOk","Stream for the `inspect_ok` method."],["IntoStream","Stream for the `into_stream` method."],["Iter","Stream for the [`iter`] function."],["Map","Stream for the `map` method."],["MapErr","Stream for the `map_err` method."],["MapOk","Stream for the `map_ok` method."],["Next","Future for the `next` method."],["Once","A stream which emits single element and then EOF."],["OrElse","Stream for the `or_else` method."],["Peek","Future for the `Peekable::peek()` function from [`Peekable`]"],["Peekable","A `Stream` that implements a `peek` method."],["Pending","Stream for the [`pending()`] function."],["PollFn","Stream for the [`poll_fn`] function."],["Repeat","Stream for the [`repeat`] function."],["RepeatWith","An stream that repeats elements of type `A` endlessly by applying the provided closure `F: FnMut() -> A`."],["Scan","Stream for the `scan` method."],["Select","Stream for the [`select()`] function."],["SelectNextSome","Future for the `select_next_some` method."],["Skip","Stream for the `skip` method."],["SkipWhile","Stream for the `skip_while` method."],["StreamFuture","Future for the `into_future` method."],["Take","Stream for the `take` method."],["TakeUntil","Stream for the `take_until` method."],["TakeWhile","Stream for the `take_while` method."],["Then","Stream for the `then` method."],["TryCollect","Future for the `try_collect` method."],["TryConcat","Future for the `try_concat` method."],["TryFilter","Stream for the `try_filter` method."],["TryFilterMap","Stream for the `try_filter_map` method."],["TryFlatten","Stream for the `try_flatten` method."],["TryFold","Future for the `try_fold` method."],["TryForEach","Future for the `try_for_each` method."],["TryNext","Future for the `try_next` method."],["TrySkipWhile","Stream for the `try_skip_while` method."],["TryTakeWhile","Stream for the `try_take_while` method."],["TryUnfold","Stream for the [`try_unfold`] function."],["Unfold","Stream for the [`unfold`] function."],["Unzip","Future for the `unzip` method."],["Zip","Stream for the `zip` method."]],"trait":[["FusedStream","A stream which tracks whether or not the underlying stream should no longer be polled."],["Stream","A stream of values produced asynchronously."],["StreamExt","An extension trait for `Stream`s that provides a variety of convenient combinator functions."],["TryStream","A convenience for streams that return `Result` values that includes a variety of adapters tailored to such futures."],["TryStreamExt","Adapters specific to `Result`-returning streams"]]});
|
||||
initSidebarItems({"fn":[["empty","Creates a stream which contains no elements."],["iter","Converts an `Iterator` into a `Stream` which is always ready to yield the next value."],["once","Creates a stream of a single element."],["pending","Creates a stream which never returns any elements."],["poll_fn","Creates a new stream wrapping a function returning `Poll<Option<T>>`."],["repeat","Create a stream which produces the same item repeatedly."],["repeat_with","Creates a new stream that repeats elements of type `A` endlessly by applying the provided closure, the repeater, `F: FnMut() -> A`."],["select","This function will attempt to pull items from both streams. Each stream will be polled in a round-robin fashion, and whenever a stream is ready to yield an item that item is yielded."],["try_unfold","Creates a `TryStream` from a seed and a closure returning a `TryFuture`."],["unfold","Creates a `Stream` from a seed and a closure returning a `Future`."]],"struct":[["AndThen","Stream for the `and_then` method."],["Chain","Stream for the `chain` method."],["Collect","Future for the `collect` method."],["Concat","Future for the `concat` method."],["Cycle","Stream for the `cycle` method."],["Empty","Stream for the [`empty`] function."],["Enumerate","Stream for the `enumerate` method."],["ErrInto","Stream for the `err_into` method."],["Filter","Stream for the `filter` method."],["FilterMap","Stream for the `filter_map` method."],["FlatMap","Stream for the `flat_map` method."],["Flatten","Stream for the `flatten` method."],["Fold","Future for the `fold` method."],["ForEach","Future for the `for_each` method."],["Fuse","Stream for the `fuse` method."],["Inspect","Stream for the `inspect` method."],["InspectErr","Stream for the `inspect_err` method."],["InspectOk","Stream for the `inspect_ok` method."],["IntoStream","Stream for the `into_stream` method."],["Iter","Stream for the [`iter`] function."],["Map","Stream for the `map` method."],["MapErr","Stream for the `map_err` method."],["MapOk","Stream for the `map_ok` method."],["Next","Future for the `next` method."],["NextIf","Future for the `Peekable::next_if` method."],["NextIfEq","Future for the `Peekable::next_if_eq` method."],["Once","A stream which emits single element and then EOF."],["OrElse","Stream for the `or_else` method."],["Peek","Future for the `Peekable::peek` method."],["Peekable","A `Stream` that implements a `peek` method."],["Pending","Stream for the [`pending()`] function."],["PollFn","Stream for the [`poll_fn`] function."],["Repeat","Stream for the [`repeat`] function."],["RepeatWith","An stream that repeats elements of type `A` endlessly by applying the provided closure `F: FnMut() -> A`."],["Scan","Stream for the `scan` method."],["Select","Stream for the [`select()`] function."],["SelectNextSome","Future for the `select_next_some` method."],["Skip","Stream for the `skip` method."],["SkipWhile","Stream for the `skip_while` method."],["StreamFuture","Future for the `into_future` method."],["Take","Stream for the `take` method."],["TakeUntil","Stream for the `take_until` method."],["TakeWhile","Stream for the `take_while` method."],["Then","Stream for the `then` method."],["TryCollect","Future for the `try_collect` method."],["TryConcat","Future for the `try_concat` method."],["TryFilter","Stream for the `try_filter` method."],["TryFilterMap","Stream for the `try_filter_map` method."],["TryFlatten","Stream for the `try_flatten` method."],["TryFold","Future for the `try_fold` method."],["TryForEach","Future for the `try_for_each` method."],["TryNext","Future for the `try_next` method."],["TrySkipWhile","Stream for the `try_skip_while` method."],["TryTakeWhile","Stream for the `try_take_while` method."],["TryUnfold","Stream for the [`try_unfold`] function."],["Unfold","Stream for the [`unfold`] function."],["Unzip","Future for the `unzip` method."],["Zip","Stream for the `zip` method."]],"trait":[["FusedStream","A stream which tracks whether or not the underlying stream should no longer be polled."],["Stream","A stream of values produced asynchronously."],["StreamExt","An extension trait for `Stream`s that provides a variety of convenient combinator functions."],["TryStream","A convenience for streams that return `Result` values that includes a variety of adapters tailored to such futures."],["TryStreamExt","Adapters specific to `Result`-returning streams"]]});
|
||||
@@ -0,0 +1,10 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../../futures_util/stream/struct.NextIf.html">
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../../futures_util/stream/struct.NextIf.html">../../../../futures_util/stream/struct.NextIf.html</a>...</p>
|
||||
<script>location.replace("../../../../futures_util/stream/struct.NextIf.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,10 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../../futures_util/stream/struct.NextIfEq.html">
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../../futures_util/stream/struct.NextIfEq.html">../../../../futures_util/stream/struct.NextIfEq.html</a>...</p>
|
||||
<script>location.replace("../../../../futures_util/stream/struct.NextIfEq.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
Reference in New Issue
Block a user