mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-29 05:12:45 +01:00
273 lines
106 KiB
HTML
273 lines
106 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 `TryFutureExt` trait in crate `futures`."><meta name="keywords" content="rust, rustlang, rust-lang, TryFutureExt"><title>futures::future::TryFutureExt - 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 trait"><!--[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/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Trait TryFutureExt</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.and_then">and_then</a><a href="#method.err_into">err_into</a><a href="#method.map_err">map_err</a><a href="#method.into_future">into_future</a><a href="#method.try_flatten">try_flatten</a><a href="#method.or_else">or_else</a><a href="#method.flatten_sink">flatten_sink</a><a href="#method.map_ok">map_ok</a><a href="#method.map_ok_or_else">map_ok_or_else</a><a href="#method.ok_into">ok_into</a><a href="#method.inspect_ok">inspect_ok</a><a href="#method.inspect_err">inspect_err</a><a href="#method.try_flatten_stream">try_flatten_stream</a><a href="#method.unwrap_or_else">unwrap_or_else</a><a href="#method.try_poll_unpin">try_poll_unpin</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class="location"><a href="../index.html">futures</a>::<wbr><a href="index.html">future</a></p><div id="sidebar-vars" data-name="TryFutureExt" data-ty="trait" data-relpath=""></div><script defer src="sidebar-items.js"></script></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">Trait <a href="../index.html">futures</a>::<wbr><a href="index.html">future</a>::<wbr><a class="trait" href="">TryFutureExt</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/future/try_future/mod.rs.html#137-619" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub trait TryFutureExt: <a class="trait" href="../../futures/future/trait.TryFuture.html" title="trait futures::future::TryFuture">TryFuture</a> {
|
||
pub fn <a href="#method.flatten_sink" class="fnname">flatten_sink</a><Item>(self) -> <a class="struct" href="../../futures/future/struct.FlattenSink.html" title="struct futures::future::FlattenSink">FlattenSink</a><Self, Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Ok" title="type futures::future::TryFuture::Ok">Ok</a>><br> <span class="where">where<br> Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Ok" title="type futures::future::TryFuture::Ok">Ok</a>: <a class="trait" href="../../futures/sink/trait.Sink.html" title="trait futures::sink::Sink">Sink</a><Item>,<br> <Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Ok" title="type futures::future::TryFuture::Ok">Ok</a> as <a class="trait" href="../../futures/sink/trait.Sink.html" title="trait futures::sink::Sink">Sink</a><Item>>::<a class="type" href="../../futures/sink/trait.Sink.html#associatedtype.Error" title="type futures::sink::Sink::Error">Error</a> == Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Error" title="type futures::future::TryFuture::Error">Error</a></span>,
|
||
{ ... }
|
||
<div class="item-spacer"></div> pub fn <a href="#method.map_ok" class="fnname">map_ok</a><T, F>(self, f: F) -> <a class="struct" href="../../futures/future/struct.MapOk.html" title="struct futures::future::MapOk">MapOk</a><Self, F><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<div class="notable-traits-tooltiptext"><span class="docblock"><h3 class="notable">Notable traits for <a class="struct" href="../../futures/future/struct.MapOk.html" title="struct futures::future::MapOk">MapOk</a><Fut, F></h3><code class="content"><span class="where fmt-newline">impl<Fut, F> <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a> for <a class="struct" href="../../futures/future/struct.MapOk.html" title="struct futures::future::MapOk">MapOk</a><Fut, F> <span class="where fmt-newline">where<br> <a class="struct" href="../../futures/future/struct.Map.html" title="struct futures::future::Map">Map</a><<a class="struct" href="../../futures/future/struct.IntoFuture.html" title="struct futures::future::IntoFuture">IntoFuture</a><Fut>, MapOkFn<F>>: <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a>, </span></span><span class="where fmt-newline"> type <a href="../../futures/future/trait.Future.html#associatedtype.Output" class="type">Output</a> = <<a class="struct" href="../../futures/future/struct.Map.html" title="struct futures::future::Map">Map</a><<a class="struct" href="../../futures/future/struct.IntoFuture.html" title="struct futures::future::IntoFuture">IntoFuture</a><Fut>, MapOkFn<F>> as <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a>>::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Output" title="type futures::future::Future::Output">Output</a>;</span></code></span></div></span></span><br> <span class="where">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Ok" title="type futures::future::TryFuture::Ok">Ok</a>) -> T</span>,
|
||
{ ... }
|
||
<div class="item-spacer"></div> pub fn <a href="#method.map_ok_or_else" class="fnname">map_ok_or_else</a><T, E, F>(self, e: E, f: F) -> <a class="struct" href="../../futures/future/struct.MapOkOrElse.html" title="struct futures::future::MapOkOrElse">MapOkOrElse</a><Self, F, E><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<div class="notable-traits-tooltiptext"><span class="docblock"><h3 class="notable">Notable traits for <a class="struct" href="../../futures/future/struct.MapOkOrElse.html" title="struct futures::future::MapOkOrElse">MapOkOrElse</a><Fut, F, G></h3><code class="content"><span class="where fmt-newline">impl<Fut, F, G> <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a> for <a class="struct" href="../../futures/future/struct.MapOkOrElse.html" title="struct futures::future::MapOkOrElse">MapOkOrElse</a><Fut, F, G> <span class="where fmt-newline">where<br> <a class="struct" href="../../futures/future/struct.Map.html" title="struct futures::future::Map">Map</a><<a class="struct" href="../../futures/future/struct.IntoFuture.html" title="struct futures::future::IntoFuture">IntoFuture</a><Fut>, ChainFn<MapOkFn<F>, ChainFn<MapErrFn<G>, MergeResultFn>>>: <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a>, </span></span><span class="where fmt-newline"> type <a href="../../futures/future/trait.Future.html#associatedtype.Output" class="type">Output</a> = <<a class="struct" href="../../futures/future/struct.Map.html" title="struct futures::future::Map">Map</a><<a class="struct" href="../../futures/future/struct.IntoFuture.html" title="struct futures::future::IntoFuture">IntoFuture</a><Fut>, ChainFn<MapOkFn<F>, ChainFn<MapErrFn<G>, MergeResultFn>>> as <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a>>::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Output" title="type futures::future::Future::Output">Output</a>;</span></code></span></div></span></span><br> <span class="where">where<br> E: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Error" title="type futures::future::TryFuture::Error">Error</a>) -> T,<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Ok" title="type futures::future::TryFuture::Ok">Ok</a>) -> T</span>,
|
||
{ ... }
|
||
<div class="item-spacer"></div> pub fn <a href="#method.map_err" class="fnname">map_err</a><E, F>(self, f: F) -> <a class="struct" href="../../futures/future/struct.MapErr.html" title="struct futures::future::MapErr">MapErr</a><Self, F><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<div class="notable-traits-tooltiptext"><span class="docblock"><h3 class="notable">Notable traits for <a class="struct" href="../../futures/future/struct.MapErr.html" title="struct futures::future::MapErr">MapErr</a><Fut, F></h3><code class="content"><span class="where fmt-newline">impl<Fut, F> <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a> for <a class="struct" href="../../futures/future/struct.MapErr.html" title="struct futures::future::MapErr">MapErr</a><Fut, F> <span class="where fmt-newline">where<br> <a class="struct" href="../../futures/future/struct.Map.html" title="struct futures::future::Map">Map</a><<a class="struct" href="../../futures/future/struct.IntoFuture.html" title="struct futures::future::IntoFuture">IntoFuture</a><Fut>, MapErrFn<F>>: <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a>, </span></span><span class="where fmt-newline"> type <a href="../../futures/future/trait.Future.html#associatedtype.Output" class="type">Output</a> = <<a class="struct" href="../../futures/future/struct.Map.html" title="struct futures::future::Map">Map</a><<a class="struct" href="../../futures/future/struct.IntoFuture.html" title="struct futures::future::IntoFuture">IntoFuture</a><Fut>, MapErrFn<F>> as <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a>>::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Output" title="type futures::future::Future::Output">Output</a>;</span></code></span></div></span></span><br> <span class="where">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Error" title="type futures::future::TryFuture::Error">Error</a>) -> E</span>,
|
||
{ ... }
|
||
<div class="item-spacer"></div> pub fn <a href="#method.err_into" class="fnname">err_into</a><E>(self) -> <a class="struct" href="../../futures/future/struct.ErrInto.html" title="struct futures::future::ErrInto">ErrInto</a><Self, E><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<div class="notable-traits-tooltiptext"><span class="docblock"><h3 class="notable">Notable traits for <a class="struct" href="../../futures/future/struct.ErrInto.html" title="struct futures::future::ErrInto">ErrInto</a><Fut, E></h3><code class="content"><span class="where fmt-newline">impl<Fut, E> <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a> for <a class="struct" href="../../futures/future/struct.ErrInto.html" title="struct futures::future::ErrInto">ErrInto</a><Fut, E> <span class="where fmt-newline">where<br> <a class="struct" href="../../futures/future/struct.MapErr.html" title="struct futures::future::MapErr">MapErr</a><Fut, IntoFn<E>>: <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a>, </span></span><span class="where fmt-newline"> type <a href="../../futures/future/trait.Future.html#associatedtype.Output" class="type">Output</a> = <<a class="struct" href="../../futures/future/struct.MapErr.html" title="struct futures::future::MapErr">MapErr</a><Fut, IntoFn<E>> as <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a>>::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Output" title="type futures::future::Future::Output">Output</a>;</span></code></span></div></span></span><br> <span class="where">where<br> Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Error" title="type futures::future::TryFuture::Error">Error</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><E></span>,
|
||
{ ... }
|
||
<div class="item-spacer"></div> pub fn <a href="#method.ok_into" class="fnname">ok_into</a><U>(self) -> <a class="struct" href="../../futures/future/struct.OkInto.html" title="struct futures::future::OkInto">OkInto</a><Self, U><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<div class="notable-traits-tooltiptext"><span class="docblock"><h3 class="notable">Notable traits for <a class="struct" href="../../futures/future/struct.OkInto.html" title="struct futures::future::OkInto">OkInto</a><Fut, E></h3><code class="content"><span class="where fmt-newline">impl<Fut, E> <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a> for <a class="struct" href="../../futures/future/struct.OkInto.html" title="struct futures::future::OkInto">OkInto</a><Fut, E> <span class="where fmt-newline">where<br> <a class="struct" href="../../futures/future/struct.MapOk.html" title="struct futures::future::MapOk">MapOk</a><Fut, IntoFn<E>>: <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a>, </span></span><span class="where fmt-newline"> type <a href="../../futures/future/trait.Future.html#associatedtype.Output" class="type">Output</a> = <<a class="struct" href="../../futures/future/struct.MapOk.html" title="struct futures::future::MapOk">MapOk</a><Fut, IntoFn<E>> as <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a>>::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Output" title="type futures::future::Future::Output">Output</a>;</span></code></span></div></span></span><br> <span class="where">where<br> Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Ok" title="type futures::future::TryFuture::Ok">Ok</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U></span>,
|
||
{ ... }
|
||
<div class="item-spacer"></div> pub fn <a href="#method.and_then" class="fnname">and_then</a><Fut, F>(self, f: F) -> <a class="struct" href="../../futures/future/struct.AndThen.html" title="struct futures::future::AndThen">AndThen</a><Self, Fut, F><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<div class="notable-traits-tooltiptext"><span class="docblock"><h3 class="notable">Notable traits for <a class="struct" href="../../futures/future/struct.AndThen.html" title="struct futures::future::AndThen">AndThen</a><Fut1, Fut2, F></h3><code class="content"><span class="where fmt-newline">impl<Fut1, Fut2, F> <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a> for <a class="struct" href="../../futures/future/struct.AndThen.html" title="struct futures::future::AndThen">AndThen</a><Fut1, Fut2, F> <span class="where fmt-newline">where<br> <a class="struct" href="../../futures/future/struct.TryFlatten.html" title="struct futures::future::TryFlatten">TryFlatten</a><<a class="struct" href="../../futures/future/struct.MapOk.html" title="struct futures::future::MapOk">MapOk</a><Fut1, F>, Fut2>: <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a>, </span></span><span class="where fmt-newline"> type <a href="../../futures/future/trait.Future.html#associatedtype.Output" class="type">Output</a> = <<a class="struct" href="../../futures/future/struct.TryFlatten.html" title="struct futures::future::TryFlatten">TryFlatten</a><<a class="struct" href="../../futures/future/struct.MapOk.html" title="struct futures::future::MapOk">MapOk</a><Fut1, F>, Fut2> as <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a>>::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Output" title="type futures::future::Future::Output">Output</a>;</span></code></span></div></span></span><br> <span class="where">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Ok" title="type futures::future::TryFuture::Ok">Ok</a>) -> Fut,<br> Fut: <a class="trait" href="../../futures/future/trait.TryFuture.html" title="trait futures::future::TryFuture">TryFuture</a><Error = Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Error" title="type futures::future::TryFuture::Error">Error</a>></span>,
|
||
{ ... }
|
||
<div class="item-spacer"></div> pub fn <a href="#method.or_else" class="fnname">or_else</a><Fut, F>(self, f: F) -> <a class="struct" href="../../futures/future/struct.OrElse.html" title="struct futures::future::OrElse">OrElse</a><Self, Fut, F><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<div class="notable-traits-tooltiptext"><span class="docblock"><h3 class="notable">Notable traits for <a class="struct" href="../../futures/future/struct.OrElse.html" title="struct futures::future::OrElse">OrElse</a><Fut1, Fut2, F></h3><code class="content"><span class="where fmt-newline">impl<Fut1, Fut2, F> <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a> for <a class="struct" href="../../futures/future/struct.OrElse.html" title="struct futures::future::OrElse">OrElse</a><Fut1, Fut2, F> <span class="where fmt-newline">where<br> TryFlattenErr<<a class="struct" href="../../futures/future/struct.MapErr.html" title="struct futures::future::MapErr">MapErr</a><Fut1, F>, Fut2>: <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a>, </span></span><span class="where fmt-newline"> type <a href="../../futures/future/trait.Future.html#associatedtype.Output" class="type">Output</a> = <TryFlattenErr<<a class="struct" href="../../futures/future/struct.MapErr.html" title="struct futures::future::MapErr">MapErr</a><Fut1, F>, Fut2> as <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a>>::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Output" title="type futures::future::Future::Output">Output</a>;</span></code></span></div></span></span><br> <span class="where">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Error" title="type futures::future::TryFuture::Error">Error</a>) -> Fut,<br> Fut: <a class="trait" href="../../futures/future/trait.TryFuture.html" title="trait futures::future::TryFuture">TryFuture</a><Ok = Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Ok" title="type futures::future::TryFuture::Ok">Ok</a>></span>,
|
||
{ ... }
|
||
<div class="item-spacer"></div> pub fn <a href="#method.inspect_ok" class="fnname">inspect_ok</a><F>(self, f: F) -> <a class="struct" href="../../futures/future/struct.InspectOk.html" title="struct futures::future::InspectOk">InspectOk</a><Self, F><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<div class="notable-traits-tooltiptext"><span class="docblock"><h3 class="notable">Notable traits for <a class="struct" href="../../futures/future/struct.InspectOk.html" title="struct futures::future::InspectOk">InspectOk</a><Fut, F></h3><code class="content"><span class="where fmt-newline">impl<Fut, F> <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a> for <a class="struct" href="../../futures/future/struct.InspectOk.html" title="struct futures::future::InspectOk">InspectOk</a><Fut, F> <span class="where fmt-newline">where<br> <a class="struct" href="../../futures/future/struct.Inspect.html" title="struct futures::future::Inspect">Inspect</a><<a class="struct" href="../../futures/future/struct.IntoFuture.html" title="struct futures::future::IntoFuture">IntoFuture</a><Fut>, InspectOkFn<F>>: <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a>, </span></span><span class="where fmt-newline"> type <a href="../../futures/future/trait.Future.html#associatedtype.Output" class="type">Output</a> = <<a class="struct" href="../../futures/future/struct.Inspect.html" title="struct futures::future::Inspect">Inspect</a><<a class="struct" href="../../futures/future/struct.IntoFuture.html" title="struct futures::future::IntoFuture">IntoFuture</a><Fut>, InspectOkFn<F>> as <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a>>::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Output" title="type futures::future::Future::Output">Output</a>;</span></code></span></div></span></span><br> <span class="where">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(&Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Ok" title="type futures::future::TryFuture::Ok">Ok</a>)</span>,
|
||
{ ... }
|
||
<div class="item-spacer"></div> pub fn <a href="#method.inspect_err" class="fnname">inspect_err</a><F>(self, f: F) -> <a class="struct" href="../../futures/future/struct.InspectErr.html" title="struct futures::future::InspectErr">InspectErr</a><Self, F><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<div class="notable-traits-tooltiptext"><span class="docblock"><h3 class="notable">Notable traits for <a class="struct" href="../../futures/future/struct.InspectErr.html" title="struct futures::future::InspectErr">InspectErr</a><Fut, F></h3><code class="content"><span class="where fmt-newline">impl<Fut, F> <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a> for <a class="struct" href="../../futures/future/struct.InspectErr.html" title="struct futures::future::InspectErr">InspectErr</a><Fut, F> <span class="where fmt-newline">where<br> <a class="struct" href="../../futures/future/struct.Inspect.html" title="struct futures::future::Inspect">Inspect</a><<a class="struct" href="../../futures/future/struct.IntoFuture.html" title="struct futures::future::IntoFuture">IntoFuture</a><Fut>, InspectErrFn<F>>: <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a>, </span></span><span class="where fmt-newline"> type <a href="../../futures/future/trait.Future.html#associatedtype.Output" class="type">Output</a> = <<a class="struct" href="../../futures/future/struct.Inspect.html" title="struct futures::future::Inspect">Inspect</a><<a class="struct" href="../../futures/future/struct.IntoFuture.html" title="struct futures::future::IntoFuture">IntoFuture</a><Fut>, InspectErrFn<F>> as <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a>>::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Output" title="type futures::future::Future::Output">Output</a>;</span></code></span></div></span></span><br> <span class="where">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(&Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Error" title="type futures::future::TryFuture::Error">Error</a>)</span>,
|
||
{ ... }
|
||
<div class="item-spacer"></div> pub fn <a href="#method.try_flatten" class="fnname">try_flatten</a>(self) -> <a class="struct" href="../../futures/future/struct.TryFlatten.html" title="struct futures::future::TryFlatten">TryFlatten</a><Self, Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Ok" title="type futures::future::TryFuture::Ok">Ok</a>><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<div class="notable-traits-tooltiptext"><span class="docblock"><h3 class="notable">Notable traits for <a class="struct" href="../../futures/future/struct.TryFlatten.html" title="struct futures::future::TryFlatten">TryFlatten</a><Fut1, Fut2></h3><code class="content"><span class="where fmt-newline">impl<Fut1, Fut2> <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a> for <a class="struct" href="../../futures/future/struct.TryFlatten.html" title="struct futures::future::TryFlatten">TryFlatten</a><Fut1, Fut2> <span class="where fmt-newline">where<br> TryFlatten<Fut1, Fut2>: <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a>, </span></span><span class="where fmt-newline"> type <a href="../../futures/future/trait.Future.html#associatedtype.Output" class="type">Output</a> = <TryFlatten<Fut1, Fut2> as <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a>>::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Output" title="type futures::future::Future::Output">Output</a>;</span></code></span></div></span></span><br> <span class="where">where<br> Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Ok" title="type futures::future::TryFuture::Ok">Ok</a>: <a class="trait" href="../../futures/future/trait.TryFuture.html" title="trait futures::future::TryFuture">TryFuture</a>,<br> <Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Ok" title="type futures::future::TryFuture::Ok">Ok</a> as <a class="trait" href="../../futures/future/trait.TryFuture.html" title="trait futures::future::TryFuture">TryFuture</a>>::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Error" title="type futures::future::TryFuture::Error">Error</a> == Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Error" title="type futures::future::TryFuture::Error">Error</a></span>,
|
||
{ ... }
|
||
<div class="item-spacer"></div> pub fn <a href="#method.try_flatten_stream" class="fnname">try_flatten_stream</a>(self) -> <a class="struct" href="../../futures/future/struct.TryFlattenStream.html" title="struct futures::future::TryFlattenStream">TryFlattenStream</a><Self><br> <span class="where">where<br> Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Ok" title="type futures::future::TryFuture::Ok">Ok</a>: <a class="trait" href="../../futures/stream/trait.TryStream.html" title="trait futures::stream::TryStream">TryStream</a>,<br> <Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Ok" title="type futures::future::TryFuture::Ok">Ok</a> as <a class="trait" href="../../futures/stream/trait.TryStream.html" title="trait futures::stream::TryStream">TryStream</a>>::<a class="type" href="../../futures/stream/trait.TryStream.html#associatedtype.Error" title="type futures::stream::TryStream::Error">Error</a> == Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Error" title="type futures::future::TryFuture::Error">Error</a></span>,
|
||
{ ... }
|
||
<div class="item-spacer"></div> pub fn <a href="#method.unwrap_or_else" class="fnname">unwrap_or_else</a><F>(self, f: F) -> <a class="struct" href="../../futures/future/struct.UnwrapOrElse.html" title="struct futures::future::UnwrapOrElse">UnwrapOrElse</a><Self, F><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<div class="notable-traits-tooltiptext"><span class="docblock"><h3 class="notable">Notable traits for <a class="struct" href="../../futures/future/struct.UnwrapOrElse.html" title="struct futures::future::UnwrapOrElse">UnwrapOrElse</a><Fut, F></h3><code class="content"><span class="where fmt-newline">impl<Fut, F> <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a> for <a class="struct" href="../../futures/future/struct.UnwrapOrElse.html" title="struct futures::future::UnwrapOrElse">UnwrapOrElse</a><Fut, F> <span class="where fmt-newline">where<br> <a class="struct" href="../../futures/future/struct.Map.html" title="struct futures::future::Map">Map</a><<a class="struct" href="../../futures/future/struct.IntoFuture.html" title="struct futures::future::IntoFuture">IntoFuture</a><Fut>, UnwrapOrElseFn<F>>: <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a>, </span></span><span class="where fmt-newline"> type <a href="../../futures/future/trait.Future.html#associatedtype.Output" class="type">Output</a> = <<a class="struct" href="../../futures/future/struct.Map.html" title="struct futures::future::Map">Map</a><<a class="struct" href="../../futures/future/struct.IntoFuture.html" title="struct futures::future::IntoFuture">IntoFuture</a><Fut>, UnwrapOrElseFn<F>> as <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a>>::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Output" title="type futures::future::Future::Output">Output</a>;</span></code></span></div></span></span><br> <span class="where">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Error" title="type futures::future::TryFuture::Error">Error</a>) -> Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Ok" title="type futures::future::TryFuture::Ok">Ok</a></span>,
|
||
{ ... }
|
||
<div class="item-spacer"></div> pub fn <a href="#method.into_future" class="fnname">into_future</a>(self) -> <a class="struct" href="../../futures/future/struct.IntoFuture.html" title="struct futures::future::IntoFuture">IntoFuture</a><Self><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<div class="notable-traits-tooltiptext"><span class="docblock"><h3 class="notable">Notable traits for <a class="struct" href="../../futures/future/struct.IntoFuture.html" title="struct futures::future::IntoFuture">IntoFuture</a><Fut></h3><code class="content"><span class="where fmt-newline">impl<Fut> <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a> for <a class="struct" href="../../futures/future/struct.IntoFuture.html" title="struct futures::future::IntoFuture">IntoFuture</a><Fut> <span class="where fmt-newline">where<br> Fut: <a class="trait" href="../../futures/future/trait.TryFuture.html" title="trait futures::future::TryFuture">TryFuture</a>, </span></span><span class="where fmt-newline"> type <a href="../../futures/future/trait.Future.html#associatedtype.Output" class="type">Output</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<Fut as <a class="trait" href="../../futures/future/trait.TryFuture.html" title="trait futures::future::TryFuture">TryFuture</a>>::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Ok" title="type futures::future::TryFuture::Ok">Ok</a>, <Fut as <a class="trait" href="../../futures/future/trait.TryFuture.html" title="trait futures::future::TryFuture">TryFuture</a>>::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Error" title="type futures::future::TryFuture::Error">Error</a>>;</span></code></span></div></span></span> { ... }
|
||
<div class="item-spacer"></div> pub fn <a href="#method.try_poll_unpin" class="fnname">try_poll_unpin</a>(<br> &mut self, <br> cx: &mut <a class="struct" href="../../futures/task/struct.Context.html" title="struct futures::task::Context">Context</a><'_><br> ) -> <a class="enum" href="../../futures/task/enum.Poll.html" title="enum futures::task::Poll">Poll</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Ok" title="type futures::future::TryFuture::Ok">Ok</a>, Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Error" title="type futures::future::TryFuture::Error">Error</a>>><br> <span class="where">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a></span>,
|
||
{ ... }
|
||
}</pre></div><div class="docblock"><p>Adapters specific to <a href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="Result"><code>Result</code></a>-returning futures</p>
|
||
</div><h2 id="provided-methods" class="small-section-header">Provided methods<a href="#provided-methods" class="anchor"></a></h2><div class="methods"><h3 id="method.flatten_sink" class="method"><code>pub fn <a href="#method.flatten_sink" class="fnname">flatten_sink</a><Item>(self) -> <a class="struct" href="../../futures/future/struct.FlattenSink.html" title="struct futures::future::FlattenSink">FlattenSink</a><Self, Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Ok" title="type futures::future::TryFuture::Ok">Ok</a>> <span class="where fmt-newline">where<br> Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Ok" title="type futures::future::TryFuture::Ok">Ok</a>: <a class="trait" href="../../futures/sink/trait.Sink.html" title="trait futures::sink::Sink">Sink</a><Item>,<br> <Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Ok" title="type futures::future::TryFuture::Ok">Ok</a> as <a class="trait" href="../../futures/sink/trait.Sink.html" title="trait futures::sink::Sink">Sink</a><Item>>::<a class="type" href="../../futures/sink/trait.Sink.html#associatedtype.Error" title="type futures::sink::Sink::Error">Error</a> == Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Error" title="type futures::future::TryFuture::Error">Error</a>, </span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#171-174" title="goto source code">[src]</a></h3><div class="docblock"><p>Flattens the execution of this future when the successful result of this
|
||
future is a <a href="../../futures/sink/trait.Sink.html" title="Sink"><code>Sink</code></a>.</p>
|
||
<p>This can be useful when sink initialization is deferred, and it is
|
||
convenient to work with that sink as if the sink was available at the
|
||
call site.</p>
|
||
<p>Note that this function consumes this future and returns a wrapped
|
||
version of it.</p>
|
||
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">futures</span>::<span class="ident">future</span>::{<span class="ident">Future</span>, <span class="ident">TryFutureExt</span>};
|
||
<span class="kw">use</span> <span class="ident">futures</span>::<span class="ident">sink</span>::<span class="ident">Sink</span>;
|
||
|
||
<span class="kw">fn</span> <span class="ident">make_sink_async</span>() <span class="op">-</span><span class="op">></span> <span class="kw">impl</span> <span class="ident">Future</span><span class="op"><</span><span class="ident">Output</span> <span class="op">=</span> <span class="prelude-ty">Result</span><span class="op"><</span>
|
||
<span class="kw">impl</span> <span class="ident">Sink</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">Error</span> <span class="op">=</span> <span class="ident">E</span><span class="op">></span>,
|
||
<span class="ident">E</span>,
|
||
<span class="op">></span><span class="op">></span> { <span class="comment">// ... }</span>
|
||
<span class="kw">fn</span> <span class="ident">take_sink</span>(<span class="ident">sink</span>: <span class="kw">impl</span> <span class="ident">Sink</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">Error</span> <span class="op">=</span> <span class="ident">E</span><span class="op">></span>) { <span class="comment">/* ... */</span> }
|
||
|
||
<span class="kw">let</span> <span class="ident">fut</span> <span class="op">=</span> <span class="ident">make_sink_async</span>();
|
||
<span class="ident">take_sink</span>(<span class="ident">fut</span>.<span class="ident">flatten_sink</span>())</pre></div>
|
||
</div><h3 id="method.map_ok" class="method"><code>pub fn <a href="#method.map_ok" class="fnname">map_ok</a><T, F>(self, f: F) -> <a class="struct" href="../../futures/future/struct.MapOk.html" title="struct futures::future::MapOk">MapOk</a><Self, F><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<div class="notable-traits-tooltiptext"><span class="docblock"><h3 class="notable">Notable traits for <a class="struct" href="../../futures/future/struct.MapOk.html" title="struct futures::future::MapOk">MapOk</a><Fut, F></h3><code class="content"><span class="where fmt-newline">impl<Fut, F> <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a> for <a class="struct" href="../../futures/future/struct.MapOk.html" title="struct futures::future::MapOk">MapOk</a><Fut, F> <span class="where fmt-newline">where<br> <a class="struct" href="../../futures/future/struct.Map.html" title="struct futures::future::Map">Map</a><<a class="struct" href="../../futures/future/struct.IntoFuture.html" title="struct futures::future::IntoFuture">IntoFuture</a><Fut>, MapOkFn<F>>: <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a>, </span></span><span class="where fmt-newline"> type <a href="../../futures/future/trait.Future.html#associatedtype.Output" class="type">Output</a> = <<a class="struct" href="../../futures/future/struct.Map.html" title="struct futures::future::Map">Map</a><<a class="struct" href="../../futures/future/struct.IntoFuture.html" title="struct futures::future::IntoFuture">IntoFuture</a><Fut>, MapOkFn<F>> as <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a>>::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Output" title="type futures::future::Future::Output">Output</a>;</span></code></span></div></span></span> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Ok" title="type futures::future::TryFuture::Ok">Ok</a>) -> T, </span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#217-220" title="goto source code">[src]</a></h3><div class="docblock"><p>Maps this future's success value to a different value.</p>
|
||
<p>This method can be used to change the <a href="../../futures/future/trait.TryFuture.html#associatedtype.Ok"><code>Ok</code></a> type of the
|
||
future into a different type. It is similar to the <a href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html#method.map" title="Result::map"><code>Result::map</code></a>
|
||
method. You can use this method to chain along a computation once the
|
||
future has been resolved.</p>
|
||
<p>The provided closure <code>f</code> will only be called if this future is resolved
|
||
to an <a href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html#variant.Ok" title="Ok"><code>Ok</code></a>. If it resolves to an <a href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html#variant.Err" title="Err"><code>Err</code></a>, panics, or is dropped, then
|
||
the provided closure will never be invoked.</p>
|
||
<p>Note that this method consumes the future it is called on and returns a
|
||
wrapped version of it.</p>
|
||
<h1 id="examples-1" class="section-header"><a href="#examples-1">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">futures</span>::<span class="ident">future</span>::<span class="ident">TryFutureExt</span>;
|
||
|
||
<span class="kw">let</span> <span class="ident">future</span> <span class="op">=</span> <span class="kw">async</span> { <span class="prelude-val">Ok</span>::<span class="op"><</span><span class="ident">i32</span>, <span class="ident">i32</span><span class="op">></span>(<span class="number">1</span>) };
|
||
<span class="kw">let</span> <span class="ident">future</span> <span class="op">=</span> <span class="ident">future</span>.<span class="ident">map_ok</span>(<span class="op">|</span><span class="ident">x</span><span class="op">|</span> <span class="ident">x</span> <span class="op">+</span> <span class="number">3</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">future</span>.<span class="kw">await</span>, <span class="prelude-val">Ok</span>(<span class="number">4</span>));</pre></div>
|
||
<p>Calling <a href="../../futures/future/trait.TryFutureExt.html#method.map_ok"><code>map_ok</code></a> on an errored future has no
|
||
effect:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">futures</span>::<span class="ident">future</span>::<span class="ident">TryFutureExt</span>;
|
||
|
||
<span class="kw">let</span> <span class="ident">future</span> <span class="op">=</span> <span class="kw">async</span> { <span class="prelude-val">Err</span>::<span class="op"><</span><span class="ident">i32</span>, <span class="ident">i32</span><span class="op">></span>(<span class="number">1</span>) };
|
||
<span class="kw">let</span> <span class="ident">future</span> <span class="op">=</span> <span class="ident">future</span>.<span class="ident">map_ok</span>(<span class="op">|</span><span class="ident">x</span><span class="op">|</span> <span class="ident">x</span> <span class="op">+</span> <span class="number">3</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">future</span>.<span class="kw">await</span>, <span class="prelude-val">Err</span>(<span class="number">1</span>));</pre></div>
|
||
</div><h3 id="method.map_ok_or_else" class="method"><code>pub fn <a href="#method.map_ok_or_else" class="fnname">map_ok_or_else</a><T, E, F>(self, e: E, f: F) -> <a class="struct" href="../../futures/future/struct.MapOkOrElse.html" title="struct futures::future::MapOkOrElse">MapOkOrElse</a><Self, F, E><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<div class="notable-traits-tooltiptext"><span class="docblock"><h3 class="notable">Notable traits for <a class="struct" href="../../futures/future/struct.MapOkOrElse.html" title="struct futures::future::MapOkOrElse">MapOkOrElse</a><Fut, F, G></h3><code class="content"><span class="where fmt-newline">impl<Fut, F, G> <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a> for <a class="struct" href="../../futures/future/struct.MapOkOrElse.html" title="struct futures::future::MapOkOrElse">MapOkOrElse</a><Fut, F, G> <span class="where fmt-newline">where<br> <a class="struct" href="../../futures/future/struct.Map.html" title="struct futures::future::Map">Map</a><<a class="struct" href="../../futures/future/struct.IntoFuture.html" title="struct futures::future::IntoFuture">IntoFuture</a><Fut>, ChainFn<MapOkFn<F>, ChainFn<MapErrFn<G>, MergeResultFn>>>: <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a>, </span></span><span class="where fmt-newline"> type <a href="../../futures/future/trait.Future.html#associatedtype.Output" class="type">Output</a> = <<a class="struct" href="../../futures/future/struct.Map.html" title="struct futures::future::Map">Map</a><<a class="struct" href="../../futures/future/struct.IntoFuture.html" title="struct futures::future::IntoFuture">IntoFuture</a><Fut>, ChainFn<MapOkFn<F>, ChainFn<MapErrFn<G>, MergeResultFn>>> as <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a>>::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Output" title="type futures::future::Future::Output">Output</a>;</span></code></span></div></span></span> <span class="where fmt-newline">where<br> E: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Error" title="type futures::future::TryFuture::Error">Error</a>) -> T,<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Ok" title="type futures::future::TryFuture::Ok">Ok</a>) -> T, </span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#257-261" title="goto source code">[src]</a></h3><div class="docblock"><p>Maps this future's success value to a different value, and permits for error handling resulting in the same type.</p>
|
||
<p>This method can be used to coalesce your <a href="../../futures/future/trait.TryFuture.html#associatedtype.Ok"><code>Ok</code></a> type and <a href="../../futures/future/trait.TryFuture.html#associatedtype.Error"><code>Error</code></a> into another type,
|
||
where that type is the same for both outcomes.</p>
|
||
<p>The provided closure <code>f</code> will only be called if this future is resolved
|
||
to an <a href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html#variant.Ok" title="Ok"><code>Ok</code></a>. If it resolves to an <a href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html#variant.Err" title="Err"><code>Err</code></a>, panics, or is dropped, then
|
||
the provided closure will never be invoked.</p>
|
||
<p>The provided closure <code>e</code> will only be called if this future is resolved
|
||
to an <a href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html#variant.Err" title="Err"><code>Err</code></a>. If it resolves to an <a href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html#variant.Ok" title="Ok"><code>Ok</code></a>, panics, or is dropped, then
|
||
the provided closure will never be invoked.</p>
|
||
<p>Note that this method consumes the future it is called on and returns a
|
||
wrapped version of it.</p>
|
||
<h1 id="examples-2" class="section-header"><a href="#examples-2">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">futures</span>::<span class="ident">future</span>::<span class="ident">TryFutureExt</span>;
|
||
|
||
<span class="kw">let</span> <span class="ident">future</span> <span class="op">=</span> <span class="kw">async</span> { <span class="prelude-val">Ok</span>::<span class="op"><</span><span class="ident">i32</span>, <span class="ident">i32</span><span class="op">></span>(<span class="number">5</span>) };
|
||
<span class="kw">let</span> <span class="ident">future</span> <span class="op">=</span> <span class="ident">future</span>.<span class="ident">map_ok_or_else</span>(<span class="op">|</span><span class="ident">x</span><span class="op">|</span> <span class="ident">x</span> <span class="op">*</span> <span class="number">2</span>, <span class="op">|</span><span class="ident">x</span><span class="op">|</span> <span class="ident">x</span> <span class="op">+</span> <span class="number">3</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">future</span>.<span class="kw">await</span>, <span class="number">8</span>);
|
||
|
||
<span class="kw">let</span> <span class="ident">future</span> <span class="op">=</span> <span class="kw">async</span> { <span class="prelude-val">Err</span>::<span class="op"><</span><span class="ident">i32</span>, <span class="ident">i32</span><span class="op">></span>(<span class="number">5</span>) };
|
||
<span class="kw">let</span> <span class="ident">future</span> <span class="op">=</span> <span class="ident">future</span>.<span class="ident">map_ok_or_else</span>(<span class="op">|</span><span class="ident">x</span><span class="op">|</span> <span class="ident">x</span> <span class="op">*</span> <span class="number">2</span>, <span class="op">|</span><span class="ident">x</span><span class="op">|</span> <span class="ident">x</span> <span class="op">+</span> <span class="number">3</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">future</span>.<span class="kw">await</span>, <span class="number">10</span>);</pre></div>
|
||
</div><h3 id="method.map_err" class="method"><code>pub fn <a href="#method.map_err" class="fnname">map_err</a><E, F>(self, f: F) -> <a class="struct" href="../../futures/future/struct.MapErr.html" title="struct futures::future::MapErr">MapErr</a><Self, F><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<div class="notable-traits-tooltiptext"><span class="docblock"><h3 class="notable">Notable traits for <a class="struct" href="../../futures/future/struct.MapErr.html" title="struct futures::future::MapErr">MapErr</a><Fut, F></h3><code class="content"><span class="where fmt-newline">impl<Fut, F> <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a> for <a class="struct" href="../../futures/future/struct.MapErr.html" title="struct futures::future::MapErr">MapErr</a><Fut, F> <span class="where fmt-newline">where<br> <a class="struct" href="../../futures/future/struct.Map.html" title="struct futures::future::Map">Map</a><<a class="struct" href="../../futures/future/struct.IntoFuture.html" title="struct futures::future::IntoFuture">IntoFuture</a><Fut>, MapErrFn<F>>: <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a>, </span></span><span class="where fmt-newline"> type <a href="../../futures/future/trait.Future.html#associatedtype.Output" class="type">Output</a> = <<a class="struct" href="../../futures/future/struct.Map.html" title="struct futures::future::Map">Map</a><<a class="struct" href="../../futures/future/struct.IntoFuture.html" title="struct futures::future::IntoFuture">IntoFuture</a><Fut>, MapErrFn<F>> as <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a>>::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Output" title="type futures::future::Future::Output">Output</a>;</span></code></span></div></span></span> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Error" title="type futures::future::TryFuture::Error">Error</a>) -> E, </span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#305-308" title="goto source code">[src]</a></h3><div class="docblock"><p>Maps this future's error value to a different value.</p>
|
||
<p>This method can be used to change the <a href="../../futures/future/trait.TryFuture.html#associatedtype.Error"><code>Error</code></a> type
|
||
of the future into a different type. It is similar to the
|
||
<a href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html#method.map_err" title="Result::map_err"><code>Result::map_err</code></a> method. You can use this method for example to
|
||
ensure that futures have the same <a href="../../futures/future/trait.TryFuture.html#associatedtype.Error"><code>Error</code></a> type when
|
||
using <a href="../../futures/macro.select.html" title="select!"><code>select!</code></a> or <a href="../../futures/macro.join.html" title="join!"><code>join!</code></a>.</p>
|
||
<p>The provided closure <code>f</code> will only be called if this future is resolved
|
||
to an <a href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html#variant.Err" title="Err"><code>Err</code></a>. If it resolves to an <a href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html#variant.Ok" title="Ok"><code>Ok</code></a>, panics, or is dropped, then
|
||
the provided closure will never be invoked.</p>
|
||
<p>Note that this method consumes the future it is called on and returns a
|
||
wrapped version of it.</p>
|
||
<h1 id="examples-3" class="section-header"><a href="#examples-3">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">futures</span>::<span class="ident">future</span>::<span class="ident">TryFutureExt</span>;
|
||
|
||
<span class="kw">let</span> <span class="ident">future</span> <span class="op">=</span> <span class="kw">async</span> { <span class="prelude-val">Err</span>::<span class="op"><</span><span class="ident">i32</span>, <span class="ident">i32</span><span class="op">></span>(<span class="number">1</span>) };
|
||
<span class="kw">let</span> <span class="ident">future</span> <span class="op">=</span> <span class="ident">future</span>.<span class="ident">map_err</span>(<span class="op">|</span><span class="ident">x</span><span class="op">|</span> <span class="ident">x</span> <span class="op">+</span> <span class="number">3</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">future</span>.<span class="kw">await</span>, <span class="prelude-val">Err</span>(<span class="number">4</span>));</pre></div>
|
||
<p>Calling <a href="../../futures/future/trait.TryFutureExt.html#method.map_err"><code>map_err</code></a> on a successful future has
|
||
no effect:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">futures</span>::<span class="ident">future</span>::<span class="ident">TryFutureExt</span>;
|
||
|
||
<span class="kw">let</span> <span class="ident">future</span> <span class="op">=</span> <span class="kw">async</span> { <span class="prelude-val">Ok</span>::<span class="op"><</span><span class="ident">i32</span>, <span class="ident">i32</span><span class="op">></span>(<span class="number">1</span>) };
|
||
<span class="kw">let</span> <span class="ident">future</span> <span class="op">=</span> <span class="ident">future</span>.<span class="ident">map_err</span>(<span class="op">|</span><span class="ident">x</span><span class="op">|</span> <span class="ident">x</span> <span class="op">+</span> <span class="number">3</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">future</span>.<span class="kw">await</span>, <span class="prelude-val">Ok</span>(<span class="number">1</span>));</pre></div>
|
||
</div><h3 id="method.err_into" class="method"><code>pub fn <a href="#method.err_into" class="fnname">err_into</a><E>(self) -> <a class="struct" href="../../futures/future/struct.ErrInto.html" title="struct futures::future::ErrInto">ErrInto</a><Self, E><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<div class="notable-traits-tooltiptext"><span class="docblock"><h3 class="notable">Notable traits for <a class="struct" href="../../futures/future/struct.ErrInto.html" title="struct futures::future::ErrInto">ErrInto</a><Fut, E></h3><code class="content"><span class="where fmt-newline">impl<Fut, E> <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a> for <a class="struct" href="../../futures/future/struct.ErrInto.html" title="struct futures::future::ErrInto">ErrInto</a><Fut, E> <span class="where fmt-newline">where<br> <a class="struct" href="../../futures/future/struct.MapErr.html" title="struct futures::future::MapErr">MapErr</a><Fut, IntoFn<E>>: <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a>, </span></span><span class="where fmt-newline"> type <a href="../../futures/future/trait.Future.html#associatedtype.Output" class="type">Output</a> = <<a class="struct" href="../../futures/future/struct.MapErr.html" title="struct futures::future::MapErr">MapErr</a><Fut, IntoFn<E>> as <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a>>::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Output" title="type futures::future::Future::Output">Output</a>;</span></code></span></div></span></span> <span class="where fmt-newline">where<br> Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Error" title="type futures::future::TryFuture::Error">Error</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><E>, </span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#335-338" title="goto source code">[src]</a></h3><div class="docblock"><p>Maps this future's <a href="../../futures/future/trait.TryFuture.html#associatedtype.Error"><code>Error</code></a> to a new error type
|
||
using the <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html"><code>Into</code></a> trait.</p>
|
||
<p>This method does for futures what the <code>?</code>-operator does for
|
||
<a href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="Result"><code>Result</code></a>: It lets the compiler infer the type of the resulting
|
||
error. Just as <a href="../../futures/future/trait.TryFutureExt.html#method.map_err"><code>map_err</code></a>, this is useful for
|
||
example to ensure that futures have the same <a href="../../futures/future/trait.TryFuture.html#associatedtype.Error"><code>Error</code></a>
|
||
type when using <a href="../../futures/macro.select.html" title="select!"><code>select!</code></a> or <a href="../../futures/macro.join.html" title="join!"><code>join!</code></a>.</p>
|
||
<p>Note that this method consumes the future it is called on and returns a
|
||
wrapped version of it.</p>
|
||
<h1 id="examples-4" class="section-header"><a href="#examples-4">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">futures</span>::<span class="ident">future</span>::<span class="ident">TryFutureExt</span>;
|
||
|
||
<span class="kw">let</span> <span class="ident">future_err_u8</span> <span class="op">=</span> <span class="kw">async</span> { <span class="prelude-val">Err</span>::<span class="op"><</span>(), <span class="ident">u8</span><span class="op">></span>(<span class="number">1</span>) };
|
||
<span class="kw">let</span> <span class="ident">future_err_i32</span> <span class="op">=</span> <span class="ident">future_err_u8</span>.<span class="ident">err_into</span>::<span class="op"><</span><span class="ident">i32</span><span class="op">></span>();</pre></div>
|
||
</div><h3 id="method.ok_into" class="method"><code>pub fn <a href="#method.ok_into" class="fnname">ok_into</a><U>(self) -> <a class="struct" href="../../futures/future/struct.OkInto.html" title="struct futures::future::OkInto">OkInto</a><Self, U><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<div class="notable-traits-tooltiptext"><span class="docblock"><h3 class="notable">Notable traits for <a class="struct" href="../../futures/future/struct.OkInto.html" title="struct futures::future::OkInto">OkInto</a><Fut, E></h3><code class="content"><span class="where fmt-newline">impl<Fut, E> <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a> for <a class="struct" href="../../futures/future/struct.OkInto.html" title="struct futures::future::OkInto">OkInto</a><Fut, E> <span class="where fmt-newline">where<br> <a class="struct" href="../../futures/future/struct.MapOk.html" title="struct futures::future::MapOk">MapOk</a><Fut, IntoFn<E>>: <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a>, </span></span><span class="where fmt-newline"> type <a href="../../futures/future/trait.Future.html#associatedtype.Output" class="type">Output</a> = <<a class="struct" href="../../futures/future/struct.MapOk.html" title="struct futures::future::MapOk">MapOk</a><Fut, IntoFn<E>> as <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a>>::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Output" title="type futures::future::Future::Output">Output</a>;</span></code></span></div></span></span> <span class="where fmt-newline">where<br> Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Ok" title="type futures::future::TryFuture::Ok">Ok</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U>, </span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#345-348" title="goto source code">[src]</a></h3><div class="docblock"><p>Maps this future's <a href="../../futures/future/trait.TryFuture.html#associatedtype.Ok"><code>Ok</code></a> to a new type
|
||
using the <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html"><code>Into</code></a> trait.</p>
|
||
</div><h3 id="method.and_then" class="method"><code>pub fn <a href="#method.and_then" class="fnname">and_then</a><Fut, F>(self, f: F) -> <a class="struct" href="../../futures/future/struct.AndThen.html" title="struct futures::future::AndThen">AndThen</a><Self, Fut, F><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<div class="notable-traits-tooltiptext"><span class="docblock"><h3 class="notable">Notable traits for <a class="struct" href="../../futures/future/struct.AndThen.html" title="struct futures::future::AndThen">AndThen</a><Fut1, Fut2, F></h3><code class="content"><span class="where fmt-newline">impl<Fut1, Fut2, F> <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a> for <a class="struct" href="../../futures/future/struct.AndThen.html" title="struct futures::future::AndThen">AndThen</a><Fut1, Fut2, F> <span class="where fmt-newline">where<br> <a class="struct" href="../../futures/future/struct.TryFlatten.html" title="struct futures::future::TryFlatten">TryFlatten</a><<a class="struct" href="../../futures/future/struct.MapOk.html" title="struct futures::future::MapOk">MapOk</a><Fut1, F>, Fut2>: <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a>, </span></span><span class="where fmt-newline"> type <a href="../../futures/future/trait.Future.html#associatedtype.Output" class="type">Output</a> = <<a class="struct" href="../../futures/future/struct.TryFlatten.html" title="struct futures::future::TryFlatten">TryFlatten</a><<a class="struct" href="../../futures/future/struct.MapOk.html" title="struct futures::future::MapOk">MapOk</a><Fut1, F>, Fut2> as <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a>>::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Output" title="type futures::future::Future::Output">Output</a>;</span></code></span></div></span></span> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Ok" title="type futures::future::TryFuture::Ok">Ok</a>) -> Fut,<br> Fut: <a class="trait" href="../../futures/future/trait.TryFuture.html" title="trait futures::future::TryFuture">TryFuture</a><Error = Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Error" title="type futures::future::TryFuture::Error">Error</a>>, </span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#389-393" title="goto source code">[src]</a></h3><div class="docblock"><p>Executes another future after this one resolves successfully. The
|
||
success value is passed to a closure to create this subsequent future.</p>
|
||
<p>The provided closure <code>f</code> will only be called if this future is resolved
|
||
to an <a href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html#variant.Ok" title="Ok"><code>Ok</code></a>. If this future resolves to an <a href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html#variant.Err" title="Err"><code>Err</code></a>, panics, or is
|
||
dropped, then the provided closure will never be invoked. The
|
||
<a href="../../futures/future/trait.TryFuture.html#associatedtype.Error"><code>Error</code></a> type of this future and the future
|
||
returned by <code>f</code> have to match.</p>
|
||
<p>Note that this method consumes the future it is called on and returns a
|
||
wrapped version of it.</p>
|
||
<h1 id="examples-5" class="section-header"><a href="#examples-5">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">futures</span>::<span class="ident">future</span>::<span class="ident">TryFutureExt</span>;
|
||
|
||
<span class="kw">let</span> <span class="ident">future</span> <span class="op">=</span> <span class="kw">async</span> { <span class="prelude-val">Ok</span>::<span class="op"><</span><span class="ident">i32</span>, <span class="ident">i32</span><span class="op">></span>(<span class="number">1</span>) };
|
||
<span class="kw">let</span> <span class="ident">future</span> <span class="op">=</span> <span class="ident">future</span>.<span class="ident">and_then</span>(<span class="op">|</span><span class="ident">x</span><span class="op">|</span> <span class="kw">async</span> <span class="kw">move</span> { <span class="prelude-val">Ok</span>::<span class="op"><</span><span class="ident">i32</span>, <span class="ident">i32</span><span class="op">></span>(<span class="ident">x</span> <span class="op">+</span> <span class="number">3</span>) });
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">future</span>.<span class="kw">await</span>, <span class="prelude-val">Ok</span>(<span class="number">4</span>));</pre></div>
|
||
<p>Calling <a href="../../futures/future/trait.TryFutureExt.html#method.and_then"><code>and_then</code></a> on an errored future has no
|
||
effect:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">futures</span>::<span class="ident">future</span>::<span class="ident">TryFutureExt</span>;
|
||
|
||
<span class="kw">let</span> <span class="ident">future</span> <span class="op">=</span> <span class="kw">async</span> { <span class="prelude-val">Err</span>::<span class="op"><</span><span class="ident">i32</span>, <span class="ident">i32</span><span class="op">></span>(<span class="number">1</span>) };
|
||
<span class="kw">let</span> <span class="ident">future</span> <span class="op">=</span> <span class="ident">future</span>.<span class="ident">and_then</span>(<span class="op">|</span><span class="ident">x</span><span class="op">|</span> <span class="kw">async</span> <span class="kw">move</span> { <span class="prelude-val">Err</span>::<span class="op"><</span><span class="ident">i32</span>, <span class="ident">i32</span><span class="op">></span>(<span class="ident">x</span> <span class="op">+</span> <span class="number">3</span>) });
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">future</span>.<span class="kw">await</span>, <span class="prelude-val">Err</span>(<span class="number">1</span>));</pre></div>
|
||
</div><h3 id="method.or_else" class="method"><code>pub fn <a href="#method.or_else" class="fnname">or_else</a><Fut, F>(self, f: F) -> <a class="struct" href="../../futures/future/struct.OrElse.html" title="struct futures::future::OrElse">OrElse</a><Self, Fut, F><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<div class="notable-traits-tooltiptext"><span class="docblock"><h3 class="notable">Notable traits for <a class="struct" href="../../futures/future/struct.OrElse.html" title="struct futures::future::OrElse">OrElse</a><Fut1, Fut2, F></h3><code class="content"><span class="where fmt-newline">impl<Fut1, Fut2, F> <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a> for <a class="struct" href="../../futures/future/struct.OrElse.html" title="struct futures::future::OrElse">OrElse</a><Fut1, Fut2, F> <span class="where fmt-newline">where<br> TryFlattenErr<<a class="struct" href="../../futures/future/struct.MapErr.html" title="struct futures::future::MapErr">MapErr</a><Fut1, F>, Fut2>: <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a>, </span></span><span class="where fmt-newline"> type <a href="../../futures/future/trait.Future.html#associatedtype.Output" class="type">Output</a> = <TryFlattenErr<<a class="struct" href="../../futures/future/struct.MapErr.html" title="struct futures::future::MapErr">MapErr</a><Fut1, F>, Fut2> as <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a>>::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Output" title="type futures::future::Future::Output">Output</a>;</span></code></span></div></span></span> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Error" title="type futures::future::TryFuture::Error">Error</a>) -> Fut,<br> Fut: <a class="trait" href="../../futures/future/trait.TryFuture.html" title="trait futures::future::TryFuture">TryFuture</a><Ok = Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Ok" title="type futures::future::TryFuture::Ok">Ok</a>>, </span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#434-438" title="goto source code">[src]</a></h3><div class="docblock"><p>Executes another future if this one resolves to an error. The
|
||
error value is passed to a closure to create this subsequent future.</p>
|
||
<p>The provided closure <code>f</code> will only be called if this future is resolved
|
||
to an <a href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html#variant.Err" title="Err"><code>Err</code></a>. If this future resolves to an <a href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html#variant.Ok" title="Ok"><code>Ok</code></a>, panics, or is
|
||
dropped, then the provided closure will never be invoked. The
|
||
<a href="../../futures/future/trait.TryFuture.html#associatedtype.Ok"><code>Ok</code></a> type of this future and the future returned by <code>f</code>
|
||
have to match.</p>
|
||
<p>Note that this method consumes the future it is called on and returns a
|
||
wrapped version of it.</p>
|
||
<h1 id="examples-6" class="section-header"><a href="#examples-6">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">futures</span>::<span class="ident">future</span>::<span class="ident">TryFutureExt</span>;
|
||
|
||
<span class="kw">let</span> <span class="ident">future</span> <span class="op">=</span> <span class="kw">async</span> { <span class="prelude-val">Err</span>::<span class="op"><</span><span class="ident">i32</span>, <span class="ident">i32</span><span class="op">></span>(<span class="number">1</span>) };
|
||
<span class="kw">let</span> <span class="ident">future</span> <span class="op">=</span> <span class="ident">future</span>.<span class="ident">or_else</span>(<span class="op">|</span><span class="ident">x</span><span class="op">|</span> <span class="kw">async</span> <span class="kw">move</span> { <span class="prelude-val">Err</span>::<span class="op"><</span><span class="ident">i32</span>, <span class="ident">i32</span><span class="op">></span>(<span class="ident">x</span> <span class="op">+</span> <span class="number">3</span>) });
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">future</span>.<span class="kw">await</span>, <span class="prelude-val">Err</span>(<span class="number">4</span>));</pre></div>
|
||
<p>Calling <a href="../../futures/future/trait.TryFutureExt.html#method.or_else"><code>or_else</code></a> on a successful future has
|
||
no effect:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">futures</span>::<span class="ident">future</span>::<span class="ident">TryFutureExt</span>;
|
||
|
||
<span class="kw">let</span> <span class="ident">future</span> <span class="op">=</span> <span class="kw">async</span> { <span class="prelude-val">Ok</span>::<span class="op"><</span><span class="ident">i32</span>, <span class="ident">i32</span><span class="op">></span>(<span class="number">1</span>) };
|
||
<span class="kw">let</span> <span class="ident">future</span> <span class="op">=</span> <span class="ident">future</span>.<span class="ident">or_else</span>(<span class="op">|</span><span class="ident">x</span><span class="op">|</span> <span class="kw">async</span> <span class="kw">move</span> { <span class="prelude-val">Ok</span>::<span class="op"><</span><span class="ident">i32</span>, <span class="ident">i32</span><span class="op">></span>(<span class="ident">x</span> <span class="op">+</span> <span class="number">3</span>) });
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">future</span>.<span class="kw">await</span>, <span class="prelude-val">Ok</span>(<span class="number">1</span>));</pre></div>
|
||
</div><h3 id="method.inspect_ok" class="method"><code>pub fn <a href="#method.inspect_ok" class="fnname">inspect_ok</a><F>(self, f: F) -> <a class="struct" href="../../futures/future/struct.InspectOk.html" title="struct futures::future::InspectOk">InspectOk</a><Self, F><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<div class="notable-traits-tooltiptext"><span class="docblock"><h3 class="notable">Notable traits for <a class="struct" href="../../futures/future/struct.InspectOk.html" title="struct futures::future::InspectOk">InspectOk</a><Fut, F></h3><code class="content"><span class="where fmt-newline">impl<Fut, F> <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a> for <a class="struct" href="../../futures/future/struct.InspectOk.html" title="struct futures::future::InspectOk">InspectOk</a><Fut, F> <span class="where fmt-newline">where<br> <a class="struct" href="../../futures/future/struct.Inspect.html" title="struct futures::future::Inspect">Inspect</a><<a class="struct" href="../../futures/future/struct.IntoFuture.html" title="struct futures::future::IntoFuture">IntoFuture</a><Fut>, InspectOkFn<F>>: <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a>, </span></span><span class="where fmt-newline"> type <a href="../../futures/future/trait.Future.html#associatedtype.Output" class="type">Output</a> = <<a class="struct" href="../../futures/future/struct.Inspect.html" title="struct futures::future::Inspect">Inspect</a><<a class="struct" href="../../futures/future/struct.IntoFuture.html" title="struct futures::future::IntoFuture">IntoFuture</a><Fut>, InspectOkFn<F>> as <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a>>::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Output" title="type futures::future::Future::Output">Output</a>;</span></code></span></div></span></span> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(&Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Ok" title="type futures::future::TryFuture::Ok">Ok</a>), </span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#461-464" title="goto source code">[src]</a></h3><div class="docblock"><p>Do something with the success value of a future before passing it on.</p>
|
||
<p>When using futures, you'll often chain several of them together. While
|
||
working on such code, you might want to check out what's happening at
|
||
various parts in the pipeline, without consuming the intermediate
|
||
value. To do that, insert a call to <code>inspect_ok</code>.</p>
|
||
<h1 id="examples-7" class="section-header"><a href="#examples-7">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">futures</span>::<span class="ident">future</span>::<span class="ident">TryFutureExt</span>;
|
||
|
||
<span class="kw">let</span> <span class="ident">future</span> <span class="op">=</span> <span class="kw">async</span> { <span class="prelude-val">Ok</span>::<span class="op"><</span><span class="kw">_</span>, ()<span class="op">></span>(<span class="number">1</span>) };
|
||
<span class="kw">let</span> <span class="ident">new_future</span> <span class="op">=</span> <span class="ident">future</span>.<span class="ident">inspect_ok</span>(<span class="op">|</span><span class="kw-2">&</span><span class="ident">x</span><span class="op">|</span> <span class="macro">println</span><span class="macro">!</span>(<span class="string">"about to resolve: {}"</span>, <span class="ident">x</span>));
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">new_future</span>.<span class="kw">await</span>, <span class="prelude-val">Ok</span>(<span class="number">1</span>));</pre></div>
|
||
</div><h3 id="method.inspect_err" class="method"><code>pub fn <a href="#method.inspect_err" class="fnname">inspect_err</a><F>(self, f: F) -> <a class="struct" href="../../futures/future/struct.InspectErr.html" title="struct futures::future::InspectErr">InspectErr</a><Self, F><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<div class="notable-traits-tooltiptext"><span class="docblock"><h3 class="notable">Notable traits for <a class="struct" href="../../futures/future/struct.InspectErr.html" title="struct futures::future::InspectErr">InspectErr</a><Fut, F></h3><code class="content"><span class="where fmt-newline">impl<Fut, F> <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a> for <a class="struct" href="../../futures/future/struct.InspectErr.html" title="struct futures::future::InspectErr">InspectErr</a><Fut, F> <span class="where fmt-newline">where<br> <a class="struct" href="../../futures/future/struct.Inspect.html" title="struct futures::future::Inspect">Inspect</a><<a class="struct" href="../../futures/future/struct.IntoFuture.html" title="struct futures::future::IntoFuture">IntoFuture</a><Fut>, InspectErrFn<F>>: <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a>, </span></span><span class="where fmt-newline"> type <a href="../../futures/future/trait.Future.html#associatedtype.Output" class="type">Output</a> = <<a class="struct" href="../../futures/future/struct.Inspect.html" title="struct futures::future::Inspect">Inspect</a><<a class="struct" href="../../futures/future/struct.IntoFuture.html" title="struct futures::future::IntoFuture">IntoFuture</a><Fut>, InspectErrFn<F>> as <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a>>::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Output" title="type futures::future::Future::Output">Output</a>;</span></code></span></div></span></span> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(&Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Error" title="type futures::future::TryFuture::Error">Error</a>), </span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#487-490" title="goto source code">[src]</a></h3><div class="docblock"><p>Do something with the error value of a future before passing it on.</p>
|
||
<p>When using futures, you'll often chain several of them together. While
|
||
working on such code, you might want to check out what's happening at
|
||
various parts in the pipeline, without consuming the intermediate
|
||
value. To do that, insert a call to <code>inspect_err</code>.</p>
|
||
<h1 id="examples-8" class="section-header"><a href="#examples-8">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">futures</span>::<span class="ident">future</span>::<span class="ident">TryFutureExt</span>;
|
||
|
||
<span class="kw">let</span> <span class="ident">future</span> <span class="op">=</span> <span class="kw">async</span> { <span class="prelude-val">Err</span>::<span class="op"><</span>(), <span class="kw">_</span><span class="op">></span>(<span class="number">1</span>) };
|
||
<span class="kw">let</span> <span class="ident">new_future</span> <span class="op">=</span> <span class="ident">future</span>.<span class="ident">inspect_err</span>(<span class="op">|</span><span class="kw-2">&</span><span class="ident">x</span><span class="op">|</span> <span class="macro">println</span><span class="macro">!</span>(<span class="string">"about to error: {}"</span>, <span class="ident">x</span>));
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">new_future</span>.<span class="kw">await</span>, <span class="prelude-val">Err</span>(<span class="number">1</span>));</pre></div>
|
||
</div><h3 id="method.try_flatten" class="method"><code>pub fn <a href="#method.try_flatten" class="fnname">try_flatten</a>(self) -> <a class="struct" href="../../futures/future/struct.TryFlatten.html" title="struct futures::future::TryFlatten">TryFlatten</a><Self, Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Ok" title="type futures::future::TryFuture::Ok">Ok</a>><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<div class="notable-traits-tooltiptext"><span class="docblock"><h3 class="notable">Notable traits for <a class="struct" href="../../futures/future/struct.TryFlatten.html" title="struct futures::future::TryFlatten">TryFlatten</a><Fut1, Fut2></h3><code class="content"><span class="where fmt-newline">impl<Fut1, Fut2> <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a> for <a class="struct" href="../../futures/future/struct.TryFlatten.html" title="struct futures::future::TryFlatten">TryFlatten</a><Fut1, Fut2> <span class="where fmt-newline">where<br> TryFlatten<Fut1, Fut2>: <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a>, </span></span><span class="where fmt-newline"> type <a href="../../futures/future/trait.Future.html#associatedtype.Output" class="type">Output</a> = <TryFlatten<Fut1, Fut2> as <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a>>::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Output" title="type futures::future::Future::Output">Output</a>;</span></code></span></div></span></span> <span class="where fmt-newline">where<br> Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Ok" title="type futures::future::TryFuture::Ok">Ok</a>: <a class="trait" href="../../futures/future/trait.TryFuture.html" title="trait futures::future::TryFuture">TryFuture</a>,<br> <Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Ok" title="type futures::future::TryFuture::Ok">Ok</a> as <a class="trait" href="../../futures/future/trait.TryFuture.html" title="trait futures::future::TryFuture">TryFuture</a>>::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Error" title="type futures::future::TryFuture::Error">Error</a> == Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Error" title="type futures::future::TryFuture::Error">Error</a>, </span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#499-502" title="goto source code">[src]</a></h3><div class="docblock"><p>Flatten the execution of this future when the successful result of this
|
||
future is another future.</p>
|
||
<p>This is equivalent to <code>future.and_then(|x| x)</code>.</p>
|
||
</div><h3 id="method.try_flatten_stream" class="method"><code>pub fn <a href="#method.try_flatten_stream" class="fnname">try_flatten_stream</a>(self) -> <a class="struct" href="../../futures/future/struct.TryFlattenStream.html" title="struct futures::future::TryFlattenStream">TryFlattenStream</a><Self> <span class="where fmt-newline">where<br> Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Ok" title="type futures::future::TryFuture::Ok">Ok</a>: <a class="trait" href="../../futures/stream/trait.TryStream.html" title="trait futures::stream::TryStream">TryStream</a>,<br> <Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Ok" title="type futures::future::TryFuture::Ok">Ok</a> as <a class="trait" href="../../futures/stream/trait.TryStream.html" title="trait futures::stream::TryStream">TryStream</a>>::<a class="type" href="../../futures/stream/trait.TryStream.html#associatedtype.Error" title="type futures::stream::TryStream::Error">Error</a> == Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Error" title="type futures::future::TryFuture::Error">Error</a>, </span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#532-535" title="goto source code">[src]</a></h3><div class="docblock"><p>Flatten the execution of this future when the successful result of this
|
||
future is a stream.</p>
|
||
<p>This can be useful when stream initialization is deferred, and it is
|
||
convenient to work with that stream as if stream was available at the
|
||
call site.</p>
|
||
<p>Note that this function consumes this future and returns a wrapped
|
||
version of it.</p>
|
||
<h1 id="examples-9" class="section-header"><a href="#examples-9">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">futures</span>::<span class="ident">future</span>::<span class="ident">TryFutureExt</span>;
|
||
<span class="kw">use</span> <span class="ident">futures</span>::<span class="ident">stream</span>::{<span class="self">self</span>, <span class="ident">TryStreamExt</span>};
|
||
|
||
<span class="kw">let</span> <span class="ident">stream_items</span> <span class="op">=</span> <span class="macro">vec</span><span class="macro">!</span>[<span class="number">17</span>, <span class="number">18</span>, <span class="number">19</span>].<span class="ident">into_iter</span>().<span class="ident">map</span>(<span class="prelude-val">Ok</span>);
|
||
<span class="kw">let</span> <span class="ident">future_of_a_stream</span> <span class="op">=</span> <span class="kw">async</span> { <span class="prelude-val">Ok</span>::<span class="op"><</span><span class="kw">_</span>, ()<span class="op">></span>(<span class="ident">stream</span>::<span class="ident">iter</span>(<span class="ident">stream_items</span>)) };
|
||
|
||
<span class="kw">let</span> <span class="ident">stream</span> <span class="op">=</span> <span class="ident">future_of_a_stream</span>.<span class="ident">try_flatten_stream</span>();
|
||
<span class="kw">let</span> <span class="ident">list</span> <span class="op">=</span> <span class="ident">stream</span>.<span class="ident">try_collect</span>::<span class="op"><</span><span class="ident">Vec</span><span class="op"><</span><span class="kw">_</span><span class="op">></span><span class="op">></span>().<span class="kw">await</span>;
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">list</span>, <span class="prelude-val">Ok</span>(<span class="macro">vec</span><span class="macro">!</span>[<span class="number">17</span>, <span class="number">18</span>, <span class="number">19</span>]));</pre></div>
|
||
</div><h3 id="method.unwrap_or_else" class="method"><code>pub fn <a href="#method.unwrap_or_else" class="fnname">unwrap_or_else</a><F>(self, f: F) -> <a class="struct" href="../../futures/future/struct.UnwrapOrElse.html" title="struct futures::future::UnwrapOrElse">UnwrapOrElse</a><Self, F><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<div class="notable-traits-tooltiptext"><span class="docblock"><h3 class="notable">Notable traits for <a class="struct" href="../../futures/future/struct.UnwrapOrElse.html" title="struct futures::future::UnwrapOrElse">UnwrapOrElse</a><Fut, F></h3><code class="content"><span class="where fmt-newline">impl<Fut, F> <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a> for <a class="struct" href="../../futures/future/struct.UnwrapOrElse.html" title="struct futures::future::UnwrapOrElse">UnwrapOrElse</a><Fut, F> <span class="where fmt-newline">where<br> <a class="struct" href="../../futures/future/struct.Map.html" title="struct futures::future::Map">Map</a><<a class="struct" href="../../futures/future/struct.IntoFuture.html" title="struct futures::future::IntoFuture">IntoFuture</a><Fut>, UnwrapOrElseFn<F>>: <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a>, </span></span><span class="where fmt-newline"> type <a href="../../futures/future/trait.Future.html#associatedtype.Output" class="type">Output</a> = <<a class="struct" href="../../futures/future/struct.Map.html" title="struct futures::future::Map">Map</a><<a class="struct" href="../../futures/future/struct.IntoFuture.html" title="struct futures::future::IntoFuture">IntoFuture</a><Fut>, UnwrapOrElseFn<F>> as <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a>>::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Output" title="type futures::future::Future::Output">Output</a>;</span></code></span></div></span></span> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Error" title="type futures::future::TryFuture::Error">Error</a>) -> Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Ok" title="type futures::future::TryFuture::Ok">Ok</a>, </span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#564-567" title="goto source code">[src]</a></h3><div class="docblock"><p>Unwraps this future's output, producing a future with this future's
|
||
<a href="../../futures/future/trait.TryFuture.html#associatedtype.Ok"><code>Ok</code></a> type as its
|
||
<a href="../../futures/future/trait.Future.html#associatedtype.Output"><code>Output</code></a> type.</p>
|
||
<p>If this future is resolved successfully, the returned future will
|
||
contain the original future's success value as output. Otherwise, the
|
||
closure <code>f</code> is called with the error value to produce an alternate
|
||
success value.</p>
|
||
<p>This method is similar to the <a href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html#method.unwrap_or_else" title="Result::unwrap_or_else"><code>Result::unwrap_or_else</code></a> method.</p>
|
||
<h1 id="examples-10" class="section-header"><a href="#examples-10">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">futures</span>::<span class="ident">future</span>::<span class="ident">TryFutureExt</span>;
|
||
|
||
<span class="kw">let</span> <span class="ident">future</span> <span class="op">=</span> <span class="kw">async</span> { <span class="prelude-val">Err</span>::<span class="op"><</span>(), <span class="kw-2">&</span><span class="ident">str</span><span class="op">></span>(<span class="string">"Boom!"</span>) };
|
||
<span class="kw">let</span> <span class="ident">future</span> <span class="op">=</span> <span class="ident">future</span>.<span class="ident">unwrap_or_else</span>(<span class="op">|</span><span class="kw">_</span><span class="op">|</span> ());
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">future</span>.<span class="kw">await</span>, ());</pre></div>
|
||
</div><h3 id="method.into_future" class="method"><code>pub fn <a href="#method.into_future" class="fnname">into_future</a>(self) -> <a class="struct" href="../../futures/future/struct.IntoFuture.html" title="struct futures::future::IntoFuture">IntoFuture</a><Self><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<div class="notable-traits-tooltiptext"><span class="docblock"><h3 class="notable">Notable traits for <a class="struct" href="../../futures/future/struct.IntoFuture.html" title="struct futures::future::IntoFuture">IntoFuture</a><Fut></h3><code class="content"><span class="where fmt-newline">impl<Fut> <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a> for <a class="struct" href="../../futures/future/struct.IntoFuture.html" title="struct futures::future::IntoFuture">IntoFuture</a><Fut> <span class="where fmt-newline">where<br> Fut: <a class="trait" href="../../futures/future/trait.TryFuture.html" title="trait futures::future::TryFuture">TryFuture</a>, </span></span><span class="where fmt-newline"> type <a href="../../futures/future/trait.Future.html#associatedtype.Output" class="type">Output</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<Fut as <a class="trait" href="../../futures/future/trait.TryFuture.html" title="trait futures::future::TryFuture">TryFuture</a>>::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Ok" title="type futures::future::TryFuture::Ok">Ok</a>, <Fut as <a class="trait" href="../../futures/future/trait.TryFuture.html" title="trait futures::future::TryFuture">TryFuture</a>>::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Error" title="type futures::future::TryFuture::Error">Error</a>>;</span></code></span></div></span></span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#604-606" title="goto source code">[src]</a></h3><div class="docblock"><p>Wraps a <a href="../../futures/future/trait.TryFuture.html" title="TryFuture"><code>TryFuture</code></a> into a type that implements
|
||
<a href="../../futures/future/trait.Future.html"><code>Future</code></a>.</p>
|
||
<p><a href="../../futures/future/trait.TryFuture.html" title="TryFuture"><code>TryFuture</code></a>s currently do not implement the
|
||
<a href="../../futures/future/trait.Future.html"><code>Future</code></a> trait due to limitations of the
|
||
compiler.</p>
|
||
<h1 id="examples-11" class="section-header"><a href="#examples-11">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">futures</span>::<span class="ident">future</span>::{<span class="ident">Future</span>, <span class="ident">TryFuture</span>, <span class="ident">TryFutureExt</span>};
|
||
|
||
<span class="kw">fn</span> <span class="ident">make_try_future</span>() <span class="op">-</span><span class="op">></span> <span class="kw">impl</span> <span class="ident">TryFuture</span><span class="op"><</span><span class="prelude-val">Ok</span> <span class="op">=</span> <span class="ident">T</span>, <span class="ident">Error</span> <span class="op">=</span> <span class="ident">E</span><span class="op">></span> { <span class="comment">// ... }</span>
|
||
<span class="kw">fn</span> <span class="ident">take_future</span>(<span class="ident">future</span>: <span class="kw">impl</span> <span class="ident">Future</span><span class="op"><</span><span class="ident">Output</span> <span class="op">=</span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">E</span><span class="op">></span><span class="op">></span>) { <span class="comment">/* ... */</span> }
|
||
|
||
<span class="ident">take_future</span>(<span class="ident">make_try_future</span>().<span class="ident">into_future</span>());</pre></div>
|
||
</div><h3 id="method.try_poll_unpin" class="method"><code>pub fn <a href="#method.try_poll_unpin" class="fnname">try_poll_unpin</a>(<br> &mut self, <br> cx: &mut <a class="struct" href="../../futures/task/struct.Context.html" title="struct futures::task::Context">Context</a><'_><br>) -> <a class="enum" href="../../futures/task/enum.Poll.html" title="enum futures::task::Poll">Poll</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Ok" title="type futures::future::TryFuture::Ok">Ok</a>, Self::<a class="type" href="../../futures/future/trait.TryFuture.html#associatedtype.Error" title="type futures::future::TryFuture::Error">Error</a>>> <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>, </span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#613-615" title="goto source code">[src]</a></h3><div class="docblock"><p>A convenience method for calling <a href="../../futures/future/trait.TryFuture.html#tymethod.try_poll" title="TryFuture::try_poll"><code>TryFuture::try_poll</code></a> on <a href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="Unpin"><code>Unpin</code></a>
|
||
future types.</p>
|
||
</div></div><span class="loading-content">Loading content...</span><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"><h3 id="impl-TryFutureExt" class="impl"><code class="in-band">impl<Fut> TryFutureExt for Fut <span class="where fmt-newline">where<br> Fut: <a class="trait" href="../../futures/future/trait.TryFuture.html" title="trait futures::future::TryFuture">TryFuture</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-TryFutureExt" class="anchor"></a><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#134" title="goto source code">[src]</a></h3><div class="impl-items"></div></div><span class="loading-content">Loading content...</span><script type="text/javascript" src="../../implementors/futures_util/future/try_future/trait.TryFutureExt.js" async></script></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="futures"></div>
|
||
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |