Google Git
Sign in
apache / incubator-teaclave-website / refs/heads/asf-site / . / api-docs / crates-app / src / tower / make / make_service / shared.rs.html
blob: 160aede7b97638de5d08c9154bdfdb539b1e53f8 [file] [log] [blame]
<!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/tower-0.4.13/src/make/make_service/shared.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>shared.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="../../../../tower/index.html"><div class="logo-container"><img class="rust-logo" src="../../../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../../tower/index.html"><img class="rust-logo" src="../../../../rust-logo.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>
</pre><pre class="rust"><code><span class="kw">use </span>std::convert::Infallible;
<span class="kw">use </span>std::task::{Context, Poll};
<span class="kw">use </span>tower_service::Service;
<span class="doccomment">/// A [`MakeService`] that produces services by cloning an inner service.
///
/// [`MakeService`]: super::MakeService
///
/// # Example
///
/// ```
/// # use std::task::{Context, Poll};
/// # use std::pin::Pin;
/// # use std::convert::Infallible;
/// use tower::make::{MakeService, Shared};
/// use tower::buffer::Buffer;
/// use tower::Service;
/// use futures::future::{Ready, ready};
///
/// // An example connection type
/// struct Connection {}
///
/// // An example request type
/// struct Request {}
///
/// // An example response type
/// struct Response {}
///
/// // Some service that doesn&#39;t implement `Clone`
/// struct MyService;
///
/// impl Service&lt;Request&gt; for MyService {
/// type Response = Response;
/// type Error = Infallible;
/// type Future = Ready&lt;Result&lt;Response, Infallible&gt;&gt;;
///
/// fn poll_ready(&amp;mut self, _cx: &amp;mut Context&lt;&#39;_&gt;) -&gt; Poll&lt;Result&lt;(), Self::Error&gt;&gt; {
/// Poll::Ready(Ok(()))
/// }
///
/// fn call(&amp;mut self, req: Request) -&gt; Self::Future {
/// ready(Ok(Response {}))
/// }
/// }
///
/// // Example function that runs a service by accepting new connections and using
/// // `Make` to create new services that might be bound to the connection.
/// //
/// // This is similar to what you might find in hyper.
/// async fn serve_make_service&lt;Make&gt;(make: Make)
/// where
/// Make: MakeService&lt;Connection, Request&gt;
/// {
/// // ...
/// }
///
/// # async {
/// // Our service
/// let svc = MyService;
///
/// // Make it `Clone` by putting a channel in front
/// let buffered = Buffer::new(svc, 1024);
///
/// // Convert it into a `MakeService`
/// let make = Shared::new(buffered);
///
/// // Run the service and just ignore the `Connection`s as `MyService` doesn&#39;t need them
/// serve_make_service(make).await;
/// # };
/// ```
</span><span class="attribute">#[derive(Debug, Clone, Copy)]
</span><span class="kw">pub struct </span>Shared&lt;S&gt; {
service: S,
}
<span class="kw">impl</span>&lt;S&gt; Shared&lt;S&gt; {
<span class="doccomment">/// Create a new [`Shared`] from a service.
</span><span class="kw">pub fn </span>new(service: S) -&gt; <span class="self">Self </span>{
<span class="self">Self </span>{ service }
}
}
<span class="kw">impl</span>&lt;S, T&gt; Service&lt;T&gt; <span class="kw">for </span>Shared&lt;S&gt;
<span class="kw">where
</span>S: Clone,
{
<span class="kw">type </span>Response = S;
<span class="kw">type </span>Error = Infallible;
<span class="kw">type </span>Future = SharedFuture&lt;S&gt;;
<span class="kw">fn </span>poll_ready(<span class="kw-2">&amp;mut </span><span class="self">self</span>, _cx: <span class="kw-2">&amp;mut </span>Context&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; Poll&lt;<span class="prelude-ty">Result</span>&lt;(), <span class="self">Self</span>::Error&gt;&gt; {
Poll::Ready(<span class="prelude-val">Ok</span>(()))
}
<span class="kw">fn </span>call(<span class="kw-2">&amp;mut </span><span class="self">self</span>, _target: T) -&gt; <span class="self">Self</span>::Future {
SharedFuture::new(futures_util::future::ready(<span class="prelude-val">Ok</span>(<span class="self">self</span>.service.clone())))
}
}
<span class="macro">opaque_future! </span>{
<span class="doccomment">/// Response future from [`Shared`] services.
</span><span class="kw">pub type </span>SharedFuture&lt;S&gt; = futures_util::future::Ready&lt;<span class="prelude-ty">Result</span>&lt;S, Infallible&gt;&gt;;
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="kw">use super</span>::<span class="kw-2">*</span>;
<span class="kw">use </span><span class="kw">crate</span>::make::MakeService;
<span class="kw">use </span><span class="kw">crate</span>::service_fn;
<span class="kw">use </span>futures::future::poll_fn;
<span class="kw">async fn </span>echo&lt;R&gt;(req: R) -&gt; <span class="prelude-ty">Result</span>&lt;R, Infallible&gt; {
<span class="prelude-val">Ok</span>(req)
}
<span class="attribute">#[tokio::test]
</span><span class="kw">async fn </span>as_make_service() {
<span class="kw">let </span><span class="kw-2">mut </span>shared = Shared::new(service_fn(echo::&lt;<span class="kw-2">&amp;</span><span class="lifetime">&#39;static </span>str&gt;));
poll_fn(|cx| MakeService::&lt;(), <span class="kw">_</span>&gt;::poll_ready(<span class="kw-2">&amp;mut </span>shared, cx))
.<span class="kw">await
</span>.unwrap();
<span class="kw">let </span><span class="kw-2">mut </span>svc = shared.make_service(()).<span class="kw">await</span>.unwrap();
poll_fn(|cx| svc.poll_ready(cx)).<span class="kw">await</span>.unwrap();
<span class="kw">let </span>res = svc.call(<span class="string">&quot;foo&quot;</span>).<span class="kw">await</span>.unwrap();
<span class="macro">assert_eq!</span>(res, <span class="string">&quot;foo&quot;</span>);
}
<span class="attribute">#[tokio::test]
</span><span class="kw">async fn </span>as_make_service_into_service() {
<span class="kw">let </span>shared = Shared::new(service_fn(echo::&lt;<span class="kw-2">&amp;</span><span class="lifetime">&#39;static </span>str&gt;));
<span class="kw">let </span><span class="kw-2">mut </span>shared = MakeService::&lt;(), <span class="kw">_</span>&gt;::into_service(shared);
poll_fn(|cx| Service::&lt;()&gt;::poll_ready(<span class="kw-2">&amp;mut </span>shared, cx))
.<span class="kw">await
</span>.unwrap();
<span class="kw">let </span><span class="kw-2">mut </span>svc = shared.call(()).<span class="kw">await</span>.unwrap();
poll_fn(|cx| svc.poll_ready(cx)).<span class="kw">await</span>.unwrap();
<span class="kw">let </span>res = svc.call(<span class="string">&quot;foo&quot;</span>).<span class="kw">await</span>.unwrap();
<span class="macro">assert_eq!</span>(res, <span class="string">&quot;foo&quot;</span>);
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../../../" data-current-crate="tower" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>