blob: 9ab17dbde9ab402e440d1cf8fd009d3fe4e18de8 [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/util/boxed_clone.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>boxed_clone.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>
</pre><pre class="rust"><code><span class="kw">use </span><span class="kw">super</span>::ServiceExt;
<span class="kw">use </span>futures_util::future::BoxFuture;
<span class="kw">use </span>std::{
fmt,
task::{Context, Poll},
};
<span class="kw">use </span>tower_layer::{layer_fn, LayerFn};
<span class="kw">use </span>tower_service::Service;
<span class="doccomment">/// A [`Clone`] + [`Send`] boxed [`Service`].
///
/// [`BoxCloneService`] turns a service into a trait object, allowing the
/// response future type to be dynamic, and allowing the service to be cloned.
///
/// This is similar to [`BoxService`](super::BoxService) except the resulting
/// service implements [`Clone`].
///
/// # Example
///
/// ```
/// use tower::{Service, ServiceBuilder, BoxError, util::BoxCloneService};
/// use std::time::Duration;
/// #
/// # struct Request;
/// # struct Response;
/// # impl Response {
/// # fn new() -&gt; Self { Self }
/// # }
///
/// // This service has a complex type that is hard to name
/// let service = ServiceBuilder::new()
/// .map_request(|req| {
/// println!(&quot;received request&quot;);
/// req
/// })
/// .map_response(|res| {
/// println!(&quot;response produced&quot;);
/// res
/// })
/// .load_shed()
/// .concurrency_limit(64)
/// .timeout(Duration::from_secs(10))
/// .service_fn(|req: Request| async {
/// Ok::&lt;_, BoxError&gt;(Response::new())
/// });
/// # let service = assert_service(service);
///
/// // `BoxCloneService` will erase the type so it&#39;s nameable
/// let service: BoxCloneService&lt;Request, Response, BoxError&gt; = BoxCloneService::new(service);
/// # let service = assert_service(service);
///
/// // And we can still clone the service
/// let cloned_service = service.clone();
/// #
/// # fn assert_service&lt;S, R&gt;(svc: S) -&gt; S
/// # where S: Service&lt;R&gt; { svc }
/// ```
</span><span class="kw">pub struct </span>BoxCloneService&lt;T, U, E&gt;(
Box&lt;
<span class="kw">dyn </span>CloneService&lt;T, Response = U, Error = E, Future = BoxFuture&lt;<span class="lifetime">&#39;static</span>, <span class="prelude-ty">Result</span>&lt;U, E&gt;&gt;&gt;
+ Send,
&gt;,
);
<span class="kw">impl</span>&lt;T, U, E&gt; BoxCloneService&lt;T, U, E&gt; {
<span class="doccomment">/// Create a new `BoxCloneService`.
</span><span class="kw">pub fn </span>new&lt;S&gt;(inner: S) -&gt; <span class="self">Self
</span><span class="kw">where
</span>S: Service&lt;T, Response = U, Error = E&gt; + Clone + Send + <span class="lifetime">&#39;static</span>,
S::Future: Send + <span class="lifetime">&#39;static</span>,
{
<span class="kw">let </span>inner = inner.map_future(|f| Box::pin(f) <span class="kw">as _</span>);
BoxCloneService(Box::new(inner))
}
<span class="doccomment">/// Returns a [`Layer`] for wrapping a [`Service`] in a [`BoxCloneService`]
/// middleware.
///
/// [`Layer`]: crate::Layer
</span><span class="kw">pub fn </span>layer&lt;S&gt;() -&gt; LayerFn&lt;<span class="kw">fn</span>(S) -&gt; <span class="self">Self</span>&gt;
<span class="kw">where
</span>S: Service&lt;T, Response = U, Error = E&gt; + Clone + Send + <span class="lifetime">&#39;static</span>,
S::Future: Send + <span class="lifetime">&#39;static</span>,
{
layer_fn(<span class="self">Self</span>::new)
}
}
<span class="kw">impl</span>&lt;T, U, E&gt; Service&lt;T&gt; <span class="kw">for </span>BoxCloneService&lt;T, U, E&gt; {
<span class="kw">type </span>Response = U;
<span class="kw">type </span>Error = E;
<span class="kw">type </span>Future = BoxFuture&lt;<span class="lifetime">&#39;static</span>, <span class="prelude-ty">Result</span>&lt;U, E&gt;&gt;;
<span class="attribute">#[inline]
</span><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;(), E&gt;&gt; {
<span class="self">self</span>.<span class="number">0</span>.poll_ready(cx)
}
<span class="attribute">#[inline]
</span><span class="kw">fn </span>call(<span class="kw-2">&amp;mut </span><span class="self">self</span>, request: T) -&gt; <span class="self">Self</span>::Future {
<span class="self">self</span>.<span class="number">0</span>.call(request)
}
}
<span class="kw">impl</span>&lt;T, U, E&gt; Clone <span class="kw">for </span>BoxCloneService&lt;T, U, E&gt; {
<span class="kw">fn </span>clone(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="self">Self </span>{
<span class="self">Self</span>(<span class="self">self</span>.<span class="number">0</span>.clone_box())
}
}
<span class="kw">trait </span>CloneService&lt;R&gt;: Service&lt;R&gt; {
<span class="kw">fn </span>clone_box(
<span class="kw-2">&amp;</span><span class="self">self</span>,
) -&gt; Box&lt;
<span class="kw">dyn </span>CloneService&lt;R, Response = <span class="self">Self</span>::Response, Error = <span class="self">Self</span>::Error, Future = <span class="self">Self</span>::Future&gt;
+ Send,
&gt;;
}
<span class="kw">impl</span>&lt;R, T&gt; CloneService&lt;R&gt; <span class="kw">for </span>T
<span class="kw">where
</span>T: Service&lt;R&gt; + Send + Clone + <span class="lifetime">&#39;static</span>,
{
<span class="kw">fn </span>clone_box(
<span class="kw-2">&amp;</span><span class="self">self</span>,
) -&gt; Box&lt;<span class="kw">dyn </span>CloneService&lt;R, Response = T::Response, Error = T::Error, Future = T::Future&gt; + Send&gt;
{
Box::new(<span class="self">self</span>.clone())
}
}
<span class="kw">impl</span>&lt;T, U, E&gt; fmt::Debug <span class="kw">for </span>BoxCloneService&lt;T, U, E&gt; {
<span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, fmt: <span class="kw-2">&amp;mut </span>fmt::Formatter) -&gt; fmt::Result {
fmt.debug_struct(<span class="string">&quot;BoxCloneService&quot;</span>).finish()
}
}
</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>