| <!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="Trait implemented by RPC streaming request types."><meta name="keywords" content="rust, rustlang, rust-lang, IntoStreamingRequest"><title>IntoStreamingRequest in tonic - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../normalize.css"><link rel="stylesheet" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../ayu.css" disabled><link rel="stylesheet" href="../dark.css" disabled><link rel="stylesheet" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../tonic/index.html"><div class="logo-container"><img src="https://raw.githubusercontent.com/tokio-rs/website/master/public/img/icons/tonic.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../tonic/index.html"><div class="logo-container"> |
| <img src="https://raw.githubusercontent.com/tokio-rs/website/master/public/img/icons/tonic.svg" alt="logo"></div></a><h2 class="location"><a href="#">IntoStreamingRequest</a></h2><div class="sidebar-elems"><section><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Message">Message</a></li><li><a href="#associatedtype.Stream">Stream</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.into_streaming_request">into_streaming_request</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In tonic</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Trait <a href="index.html">tonic</a>::<wbr><a class="trait" href="#">IntoStreamingRequest</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../src/tonic/request.rs.html#87-96">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust trait"><code>pub trait IntoStreamingRequest: Sealed { |
| type <a href="#associatedtype.Stream" class="associatedtype">Stream</a>: <a class="trait" href="../futures_core/stream/trait.Stream.html" title="trait futures_core::stream::Stream">Stream</a><Item = Self::<a class="associatedtype" href="trait.IntoStreamingRequest.html#associatedtype.Message" title="type tonic::IntoStreamingRequest::Message">Message</a>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static; |
| type <a href="#associatedtype.Message" class="associatedtype">Message</a>; |
| |
| fn <a href="#tymethod.into_streaming_request" class="fnname">into_streaming_request</a>(self) -> <a class="struct" href="struct.Request.html" title="struct tonic::Request">Request</a><Self::<a class="associatedtype" href="trait.IntoStreamingRequest.html#associatedtype.Stream" title="type tonic::IntoStreamingRequest::Stream">Stream</a>>; |
| }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Trait implemented by RPC streaming request types.</p> |
| <p>Types implementing this trait can be used as arguments to client streaming |
| RPC methods without explicitly wrapping them into <code>tonic::Request</code>s. The |
| purpose is to make client calls slightly more convenient to write.</p> |
| <p>Tonic’s code generation and blanket implementations handle this for you, |
| so it is not necessary to implement this trait directly.</p> |
| <h2 id="example"><a href="#example">Example</a></h2> |
| <p>Given the following gRPC service method definition:</p> |
| <div class="example-wrap"><pre class="language-proto"><code>rpc RecordRoute(stream Point) returns (RouteSummary) {}</code></pre></div> |
| <p>we can call <code>record_route</code> in two equivalent ways:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tonic::Request; |
| <span class="kw">use </span>futures_util::stream; |
| |
| <span class="kw">let </span>messages = <span class="macro">vec!</span>[Point {}, Point {}]; |
| |
| client.record_route(Request::new(stream::iter(messages.clone()))); |
| client.record_route(stream::iter(messages));</code></pre></div> |
| </div></details><h2 id="required-associated-types" class="small-section-header">Required Associated Types<a href="#required-associated-types" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="associatedtype.Stream" class="method has-srclink"><a class="srclink rightside" href="../src/tonic/request.rs.html#89">source</a><h4 class="code-header">type <a href="#associatedtype.Stream" class="associatedtype">Stream</a>: <a class="trait" href="../futures_core/stream/trait.Stream.html" title="trait futures_core::stream::Stream">Stream</a><Item = Self::<a class="associatedtype" href="trait.IntoStreamingRequest.html#associatedtype.Message" title="type tonic::IntoStreamingRequest::Message">Message</a>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static</h4></section></summary><div class="docblock"><p>The RPC request stream type</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="associatedtype.Message" class="method has-srclink"><a class="srclink rightside" href="../src/tonic/request.rs.html#92">source</a><h4 class="code-header">type <a href="#associatedtype.Message" class="associatedtype">Message</a></h4></section></summary><div class="docblock"><p>The RPC request type</p> |
| </div></details></div><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.into_streaming_request" class="method has-srclink"><a class="srclink rightside" href="../src/tonic/request.rs.html#95">source</a><h4 class="code-header">fn <a href="#tymethod.into_streaming_request" class="fnname">into_streaming_request</a>(self) -> <a class="struct" href="struct.Request.html" title="struct tonic::Request">Request</a><Self::<a class="associatedtype" href="trait.IntoStreamingRequest.html#associatedtype.Stream" title="type tonic::IntoStreamingRequest::Stream">Stream</a>></h4></section></summary><div class="docblock"><p>Wrap the stream of messages in a <code>tonic::Request</code></p> |
| </div></details></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div id="implementors-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-IntoStreamingRequest-for-Request%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/tonic/request.rs.html#370-380">source</a><a href="#impl-IntoStreamingRequest-for-Request%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="trait.IntoStreamingRequest.html" title="trait tonic::IntoStreamingRequest">IntoStreamingRequest</a> for <a class="struct" href="struct.Request.html" title="struct tonic::Request">Request</a><T><span class="where fmt-newline">where<br> T: <a class="trait" href="../futures_core/stream/trait.Stream.html" title="trait futures_core::stream::Stream">Stream</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static,</span></h3></section></summary><div class="impl-items"><section id="associatedtype.Stream-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Stream-1" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Stream" class="associatedtype">Stream</a> = T</h4></section><section id="associatedtype.Message-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Message-1" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Message" class="associatedtype">Message</a> = <T as <a class="trait" href="../futures_core/stream/trait.Stream.html" title="trait futures_core::stream::Stream">Stream</a>>::<a class="associatedtype" href="../futures_core/stream/trait.Stream.html#associatedtype.Item" title="type futures_core::stream::Stream::Item">Item</a></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-IntoStreamingRequest-for-T" class="impl has-srclink"><a class="srclink rightside" href="../src/tonic/request.rs.html#358-368">source</a><a href="#impl-IntoStreamingRequest-for-T" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="trait.IntoStreamingRequest.html" title="trait tonic::IntoStreamingRequest">IntoStreamingRequest</a> for T<span class="where fmt-newline">where<br> T: <a class="trait" href="../futures_core/stream/trait.Stream.html" title="trait futures_core::stream::Stream">Stream</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static,</span></h3></section></summary><div class="impl-items"><section id="associatedtype.Stream-2" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Stream-2" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Stream" class="associatedtype">Stream</a> = T</h4></section><section id="associatedtype.Message-2" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Message-2" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Message" class="associatedtype">Message</a> = <T as <a class="trait" href="../futures_core/stream/trait.Stream.html" title="trait futures_core::stream::Stream">Stream</a>>::<a class="associatedtype" href="../futures_core/stream/trait.Stream.html#associatedtype.Item" title="type futures_core::stream::Stream::Item">Item</a></h4></section></div></details></div><script src="../implementors/tonic/request/trait.IntoStreamingRequest.js" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="tonic" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
