| <!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 that connected IO resources implement and use to produce info about the connection."><meta name="keywords" content="rust, rustlang, rust-lang, Connected"><title>Connected in tonic::transport::server - 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="#">Connected</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.ConnectInfo">ConnectInfo</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.connect_info">connect_info</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-Connected-for-AddrStream">AddrStream</a></li><li><a href="#impl-Connected-for-DuplexStream">DuplexStream</a></li><li><a href="#impl-Connected-for-TcpStream">TcpStream</a></li><li><a href="#impl-Connected-for-TlsStream%3CT%3E">TlsStream<T></a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In tonic::transport::server</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 href="../index.html">transport</a>::<wbr><a href="index.html">server</a>::<wbr><a class="trait" href="#">Connected</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/transport/server/conn.rs.html#52-59">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 Connected { |
| type <a href="#associatedtype.ConnectInfo" class="associatedtype">ConnectInfo</a>: Clone + Send + Sync + 'static; |
| |
| fn <a href="#tymethod.connect_info" class="fnname">connect_info</a>(&self) -> Self::<a class="associatedtype" href="trait.Connected.html#associatedtype.ConnectInfo" title="type tonic::transport::server::Connected::ConnectInfo">ConnectInfo</a>; |
| }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Trait that connected IO resources implement and use to produce info about the connection.</p> |
| <p>The goal for this trait is to allow users to implement |
| custom IO types that can still provide the same connection |
| metadata.</p> |
| <h2 id="example"><a href="#example">Example</a></h2> |
| <p>The <code>ConnectInfo</code> returned will be accessible through <a href="../../struct.Request.html#method.extensions">request extensions</a>:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tonic::{Request, transport::server::Connected}; |
| |
| <span class="comment">// A `Stream` that yields connections |
| </span><span class="kw">struct </span>MyConnector {} |
| |
| <span class="comment">// Return metadata about the connection as `MyConnectInfo` |
| </span><span class="kw">impl </span>Connected <span class="kw">for </span>MyConnector { |
| <span class="kw">type </span>ConnectInfo = MyConnectInfo; |
| |
| <span class="kw">fn </span>connect_info(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="self">Self</span>::ConnectInfo { |
| MyConnectInfo {} |
| } |
| } |
| |
| <span class="attribute">#[derive(Clone)] |
| </span><span class="kw">struct </span>MyConnectInfo { |
| <span class="comment">// Metadata about your connection |
| </span>} |
| |
| <span class="comment">// The connect info can be accessed through request extensions: |
| </span><span class="kw">let </span>connect_info: <span class="kw-2">&</span>MyConnectInfo = request |
| .extensions() |
| .get::<MyConnectInfo>() |
| .expect(<span class="string">"bug in tonic"</span>);</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.ConnectInfo" class="method has-srclink"><a class="srclink rightside" href="../../../src/tonic/transport/server/conn.rs.html#55">source</a><h4 class="code-header">type <a href="#associatedtype.ConnectInfo" class="associatedtype">ConnectInfo</a>: Clone + Send + Sync + 'static</h4></section></summary><div class="docblock"><p>The connection info type the IO resources generates.</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.connect_info" class="method has-srclink"><a class="srclink rightside" href="../../../src/tonic/transport/server/conn.rs.html#58">source</a><h4 class="code-header">fn <a href="#tymethod.connect_info" class="fnname">connect_info</a>(&self) -> Self::<a class="associatedtype" href="trait.Connected.html#associatedtype.ConnectInfo" title="type tonic::transport::server::Connected::ConnectInfo">ConnectInfo</a></h4></section></summary><div class="docblock"><p>Create type holding information about the connection.</p> |
| </div></details></div><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor"></a></h2><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Connected-for-AddrStream" class="impl has-srclink"><a class="srclink rightside" href="../../../src/tonic/transport/server/conn.rs.html#81-89">source</a><a href="#impl-Connected-for-AddrStream" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.Connected.html" title="trait tonic::transport::server::Connected">Connected</a> for <a class="struct" href="../../../hyper/server/tcp/addr_stream/struct.AddrStream.html" title="struct hyper::server::tcp::addr_stream::AddrStream">AddrStream</a></h3></section></summary><div class="impl-items"><section id="associatedtype.ConnectInfo-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.ConnectInfo-1" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.ConnectInfo" class="associatedtype">ConnectInfo</a> = <a class="struct" href="struct.TcpConnectInfo.html" title="struct tonic::transport::server::TcpConnectInfo">TcpConnectInfo</a></h4></section><section id="method.connect_info" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/tonic/transport/server/conn.rs.html#84-88">source</a><a href="#method.connect_info" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.connect_info" class="fnname">connect_info</a>(&self) -> Self::<a class="associatedtype" href="trait.Connected.html#associatedtype.ConnectInfo" title="type tonic::transport::server::Connected::ConnectInfo">ConnectInfo</a></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Connected-for-TcpStream" class="impl has-srclink"><a class="srclink rightside" href="../../../src/tonic/transport/server/conn.rs.html#91-99">source</a><a href="#impl-Connected-for-TcpStream" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.Connected.html" title="trait tonic::transport::server::Connected">Connected</a> for <a class="struct" href="../../../tokio/net/tcp/stream/struct.TcpStream.html" title="struct tokio::net::tcp::stream::TcpStream">TcpStream</a></h3></section></summary><div class="impl-items"><section id="associatedtype.ConnectInfo-2" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.ConnectInfo-2" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.ConnectInfo" class="associatedtype">ConnectInfo</a> = <a class="struct" href="struct.TcpConnectInfo.html" title="struct tonic::transport::server::TcpConnectInfo">TcpConnectInfo</a></h4></section><section id="method.connect_info-1" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/tonic/transport/server/conn.rs.html#94-98">source</a><a href="#method.connect_info-1" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.connect_info" class="fnname">connect_info</a>(&self) -> Self::<a class="associatedtype" href="trait.Connected.html#associatedtype.ConnectInfo" title="type tonic::transport::server::Connected::ConnectInfo">ConnectInfo</a></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Connected-for-DuplexStream" class="impl has-srclink"><a class="srclink rightside" href="../../../src/tonic/transport/server/conn.rs.html#101-105">source</a><a href="#impl-Connected-for-DuplexStream" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.Connected.html" title="trait tonic::transport::server::Connected">Connected</a> for <a class="struct" href="../../../tokio/io/util/mem/struct.DuplexStream.html" title="struct tokio::io::util::mem::DuplexStream">DuplexStream</a></h3></section></summary><div class="impl-items"><section id="associatedtype.ConnectInfo-3" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.ConnectInfo-3" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.ConnectInfo" class="associatedtype">ConnectInfo</a> = ()</h4></section><section id="method.connect_info-2" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/tonic/transport/server/conn.rs.html#104">source</a><a href="#method.connect_info-2" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.connect_info" class="fnname">connect_info</a>(&self) -> Self::<a class="associatedtype" href="trait.Connected.html#associatedtype.ConnectInfo" title="type tonic::transport::server::Connected::ConnectInfo">ConnectInfo</a></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Connected-for-TlsStream%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../../src/tonic/transport/server/conn.rs.html#108-130">source</a><a href="#impl-Connected-for-TlsStream%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="trait.Connected.html" title="trait tonic::transport::server::Connected">Connected</a> for <a class="struct" href="../../../tokio_rustls/server/struct.TlsStream.html" title="struct tokio_rustls::server::TlsStream">TlsStream</a><T><span class="where fmt-newline">where<br> T: <a class="trait" href="trait.Connected.html" title="trait tonic::transport::server::Connected">Connected</a>,</span></h3></section></summary><div class="impl-items"><section id="associatedtype.ConnectInfo-4" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.ConnectInfo-4" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.ConnectInfo" class="associatedtype">ConnectInfo</a> = <a class="struct" href="struct.TlsConnectInfo.html" title="struct tonic::transport::server::TlsConnectInfo">TlsConnectInfo</a><<T as <a class="trait" href="trait.Connected.html" title="trait tonic::transport::server::Connected">Connected</a>>::<a class="associatedtype" href="trait.Connected.html#associatedtype.ConnectInfo" title="type tonic::transport::server::Connected::ConnectInfo">ConnectInfo</a>></h4></section><section id="method.connect_info-3" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/tonic/transport/server/conn.rs.html#114-129">source</a><a href="#method.connect_info-3" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.connect_info" class="fnname">connect_info</a>(&self) -> Self::<a class="associatedtype" href="trait.Connected.html#associatedtype.ConnectInfo" title="type tonic::transport::server::Connected::ConnectInfo">ConnectInfo</a></h4></section></div></details><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div id="implementors-list"></div><script src="../../../implementors/tonic/transport/server/conn/trait.Connected.js" data-ignore-extern-crates="hyper,tokio_rustls,tokio" 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> |
