| <!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="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/tonic-0.6.2/src/transport/server/conn.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>conn.rs - source</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="../../../../source-script.js"></script><script defer src="../../../../source-files.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 source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><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></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../../tonic/index.html"> |
| <img src="https://raw.githubusercontent.com/tokio-rs/website/master/public/img/icons/tonic.svg" alt="logo"></a><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="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> |
| <span id="2">2</span> |
| <span id="3">3</span> |
| <span id="4">4</span> |
| <span id="5">5</span> |
| <span id="6">6</span> |
| <span id="7">7</span> |
| <span id="8">8</span> |
| <span id="9">9</span> |
| <span id="10">10</span> |
| <span id="11">11</span> |
| <span id="12">12</span> |
| <span id="13">13</span> |
| <span id="14">14</span> |
| <span id="15">15</span> |
| <span id="16">16</span> |
| <span id="17">17</span> |
| <span id="18">18</span> |
| <span id="19">19</span> |
| <span id="20">20</span> |
| <span id="21">21</span> |
| <span id="22">22</span> |
| <span id="23">23</span> |
| <span id="24">24</span> |
| <span id="25">25</span> |
| <span id="26">26</span> |
| <span id="27">27</span> |
| <span id="28">28</span> |
| <span id="29">29</span> |
| <span id="30">30</span> |
| <span id="31">31</span> |
| <span id="32">32</span> |
| <span id="33">33</span> |
| <span id="34">34</span> |
| <span id="35">35</span> |
| <span id="36">36</span> |
| <span id="37">37</span> |
| <span id="38">38</span> |
| <span id="39">39</span> |
| <span id="40">40</span> |
| <span id="41">41</span> |
| <span id="42">42</span> |
| <span id="43">43</span> |
| <span id="44">44</span> |
| <span id="45">45</span> |
| <span id="46">46</span> |
| <span id="47">47</span> |
| <span id="48">48</span> |
| <span id="49">49</span> |
| <span id="50">50</span> |
| <span id="51">51</span> |
| <span id="52">52</span> |
| <span id="53">53</span> |
| <span id="54">54</span> |
| <span id="55">55</span> |
| <span id="56">56</span> |
| <span id="57">57</span> |
| <span id="58">58</span> |
| <span id="59">59</span> |
| <span id="60">60</span> |
| <span id="61">61</span> |
| <span id="62">62</span> |
| <span id="63">63</span> |
| <span id="64">64</span> |
| <span id="65">65</span> |
| <span id="66">66</span> |
| <span id="67">67</span> |
| <span id="68">68</span> |
| <span id="69">69</span> |
| <span id="70">70</span> |
| <span id="71">71</span> |
| <span id="72">72</span> |
| <span id="73">73</span> |
| <span id="74">74</span> |
| <span id="75">75</span> |
| <span id="76">76</span> |
| <span id="77">77</span> |
| <span id="78">78</span> |
| <span id="79">79</span> |
| <span id="80">80</span> |
| <span id="81">81</span> |
| <span id="82">82</span> |
| <span id="83">83</span> |
| <span id="84">84</span> |
| <span id="85">85</span> |
| <span id="86">86</span> |
| <span id="87">87</span> |
| <span id="88">88</span> |
| <span id="89">89</span> |
| <span id="90">90</span> |
| <span id="91">91</span> |
| <span id="92">92</span> |
| <span id="93">93</span> |
| <span id="94">94</span> |
| <span id="95">95</span> |
| <span id="96">96</span> |
| <span id="97">97</span> |
| <span id="98">98</span> |
| <span id="99">99</span> |
| <span id="100">100</span> |
| <span id="101">101</span> |
| <span id="102">102</span> |
| <span id="103">103</span> |
| <span id="104">104</span> |
| <span id="105">105</span> |
| <span id="106">106</span> |
| <span id="107">107</span> |
| <span id="108">108</span> |
| <span id="109">109</span> |
| <span id="110">110</span> |
| <span id="111">111</span> |
| <span id="112">112</span> |
| <span id="113">113</span> |
| <span id="114">114</span> |
| <span id="115">115</span> |
| <span id="116">116</span> |
| <span id="117">117</span> |
| <span id="118">118</span> |
| <span id="119">119</span> |
| <span id="120">120</span> |
| <span id="121">121</span> |
| <span id="122">122</span> |
| <span id="123">123</span> |
| <span id="124">124</span> |
| <span id="125">125</span> |
| <span id="126">126</span> |
| <span id="127">127</span> |
| <span id="128">128</span> |
| <span id="129">129</span> |
| <span id="130">130</span> |
| <span id="131">131</span> |
| <span id="132">132</span> |
| <span id="133">133</span> |
| <span id="134">134</span> |
| <span id="135">135</span> |
| <span id="136">136</span> |
| <span id="137">137</span> |
| <span id="138">138</span> |
| <span id="139">139</span> |
| <span id="140">140</span> |
| <span id="141">141</span> |
| <span id="142">142</span> |
| <span id="143">143</span> |
| <span id="144">144</span> |
| <span id="145">145</span> |
| <span id="146">146</span> |
| <span id="147">147</span> |
| <span id="148">148</span> |
| <span id="149">149</span> |
| <span id="150">150</span> |
| <span id="151">151</span> |
| <span id="152">152</span> |
| <span id="153">153</span> |
| <span id="154">154</span> |
| <span id="155">155</span> |
| <span id="156">156</span> |
| <span id="157">157</span> |
| <span id="158">158</span> |
| <span id="159">159</span> |
| <span id="160">160</span> |
| <span id="161">161</span> |
| <span id="162">162</span> |
| <span id="163">163</span> |
| <span id="164">164</span> |
| </pre><pre class="rust"><code><span class="kw">use </span>hyper::server::conn::AddrStream; |
| <span class="kw">use </span>std::net::SocketAddr; |
| <span class="kw">use </span>tokio::net::TcpStream; |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"tls"</span>)] |
| </span><span class="kw">use </span><span class="kw">crate</span>::transport::Certificate; |
| <span class="attribute">#[cfg(feature = <span class="string">"tls"</span>)] |
| </span><span class="kw">use </span>std::sync::Arc; |
| <span class="attribute">#[cfg(feature = <span class="string">"tls"</span>)] |
| </span><span class="kw">use </span>tokio_rustls::{rustls::Session, server::TlsStream}; |
| |
| <span class="doccomment">/// Trait that connected IO resources implement and use to produce info about the connection. |
| /// |
| /// The goal for this trait is to allow users to implement |
| /// custom IO types that can still provide the same connection |
| /// metadata. |
| /// |
| /// # Example |
| /// |
| /// The `ConnectInfo` returned will be accessible through [request extensions][ext]: |
| /// |
| /// ``` |
| /// use tonic::{Request, transport::server::Connected}; |
| /// |
| /// // A `Stream` that yields connections |
| /// struct MyConnector {} |
| /// |
| /// // Return metadata about the connection as `MyConnectInfo` |
| /// impl Connected for MyConnector { |
| /// type ConnectInfo = MyConnectInfo; |
| /// |
| /// fn connect_info(&self) -> Self::ConnectInfo { |
| /// MyConnectInfo {} |
| /// } |
| /// } |
| /// |
| /// #[derive(Clone)] |
| /// struct MyConnectInfo { |
| /// // Metadata about your connection |
| /// } |
| /// |
| /// // The connect info can be accessed through request extensions: |
| /// # fn foo(request: Request<()>) { |
| /// let connect_info: &MyConnectInfo = request |
| /// .extensions() |
| /// .get::<MyConnectInfo>() |
| /// .expect("bug in tonic"); |
| /// # } |
| /// ``` |
| /// |
| /// [ext]: crate::Request::extensions |
| </span><span class="kw">pub trait </span>Connected { |
| <span class="doccomment">/// The connection info type the IO resources generates. |
| </span><span class="comment">// all these bounds are necessary to set this as a request extension |
| </span><span class="kw">type </span>ConnectInfo: Clone + Send + Sync + <span class="lifetime">'static</span>; |
| |
| <span class="doccomment">/// Create type holding information about the connection. |
| </span><span class="kw">fn </span>connect_info(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="self">Self</span>::ConnectInfo; |
| } |
| |
| <span class="doccomment">/// Connection info for standard TCP streams. |
| /// |
| /// This type will be accessible through [request extensions][ext] if you're using the default |
| /// non-TLS connector. |
| /// |
| /// See [`Connected`] for more details. |
| /// |
| /// [ext]: crate::Request::extensions |
| </span><span class="attribute">#[derive(Debug, Clone)] |
| </span><span class="kw">pub struct </span>TcpConnectInfo { |
| remote_addr: <span class="prelude-ty">Option</span><SocketAddr>, |
| } |
| |
| <span class="kw">impl </span>TcpConnectInfo { |
| <span class="doccomment">/// Return the remote address the IO resource is connected too. |
| </span><span class="kw">pub fn </span>remote_addr(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><SocketAddr> { |
| <span class="self">self</span>.remote_addr |
| } |
| } |
| |
| <span class="kw">impl </span>Connected <span class="kw">for </span>AddrStream { |
| <span class="kw">type </span>ConnectInfo = TcpConnectInfo; |
| |
| <span class="kw">fn </span>connect_info(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="self">Self</span>::ConnectInfo { |
| TcpConnectInfo { |
| remote_addr: <span class="prelude-val">Some</span>(<span class="self">self</span>.remote_addr()), |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>Connected <span class="kw">for </span>TcpStream { |
| <span class="kw">type </span>ConnectInfo = TcpConnectInfo; |
| |
| <span class="kw">fn </span>connect_info(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="self">Self</span>::ConnectInfo { |
| TcpConnectInfo { |
| remote_addr: <span class="self">self</span>.peer_addr().ok(), |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>Connected <span class="kw">for </span>tokio::io::DuplexStream { |
| <span class="kw">type </span>ConnectInfo = (); |
| |
| <span class="kw">fn </span>connect_info(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="self">Self</span>::ConnectInfo {} |
| } |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"tls"</span>)] |
| </span><span class="kw">impl</span><T> Connected <span class="kw">for </span>TlsStream<T> |
| <span class="kw">where |
| </span>T: Connected, |
| { |
| <span class="kw">type </span>ConnectInfo = TlsConnectInfo<T::ConnectInfo>; |
| |
| <span class="kw">fn </span>connect_info(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="self">Self</span>::ConnectInfo { |
| <span class="kw">let </span>(inner, session) = <span class="self">self</span>.get_ref(); |
| <span class="kw">let </span>inner = inner.connect_info(); |
| |
| <span class="kw">let </span>certs = <span class="kw">if let </span><span class="prelude-val">Some</span>(certs) = session.get_peer_certificates() { |
| <span class="kw">let </span>certs = certs |
| .into_iter() |
| .map(|c| Certificate::from_pem(c.<span class="number">0</span>)) |
| .collect(); |
| <span class="prelude-val">Some</span>(Arc::new(certs)) |
| } <span class="kw">else </span>{ |
| <span class="prelude-val">None |
| </span>}; |
| |
| TlsConnectInfo { inner, certs } |
| } |
| } |
| |
| <span class="doccomment">/// Connection info for TLS streams. |
| /// |
| /// This type will be accessible through [request extensions][ext] if you're using a TLS connector. |
| /// |
| /// See [`Connected`] for more details. |
| /// |
| /// [ext]: crate::Request::extensions |
| </span><span class="attribute">#[cfg(feature = <span class="string">"tls"</span>)] |
| #[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"tls"</span>)))] |
| #[derive(Debug, Clone)] |
| </span><span class="kw">pub struct </span>TlsConnectInfo<T> { |
| inner: T, |
| certs: <span class="prelude-ty">Option</span><Arc<Vec<Certificate>>>, |
| } |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"tls"</span>)] |
| #[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"tls"</span>)))] |
| </span><span class="kw">impl</span><T> TlsConnectInfo<T> { |
| <span class="doccomment">/// Get a reference to the underlying connection info. |
| </span><span class="kw">pub fn </span>get_ref(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>T { |
| <span class="kw-2">&</span><span class="self">self</span>.inner |
| } |
| |
| <span class="doccomment">/// Get a mutable reference to the underlying connection info. |
| </span><span class="kw">pub fn </span>get_mut(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="kw-2">&mut </span>T { |
| <span class="kw-2">&mut </span><span class="self">self</span>.inner |
| } |
| |
| <span class="doccomment">/// Return the set of connected peer TLS certificates. |
| </span><span class="kw">pub fn </span>peer_certs(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><Arc<Vec<Certificate>>> { |
| <span class="self">self</span>.certs.clone() |
| } |
| } |
| </code></pre></div> |
| </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> |
