347 lines
79 KiB
HTML
347 lines
79 KiB
HTML
<!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="Declaratively construct `Service` values."><title>ServiceBuilder in tower - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="tower" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">ServiceBuilder</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../tower/index.html">tower</a><span class="version">0.5.3</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Service<wbr>Builder</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#service" title="Service">Service</a></li><li><a href="#order" title="Order">Order</a></li><li><a href="#examples" title="Examples">Examples</a></li></ul><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.and_then" title="and_then">and_then</a></li><li><a href="#method.boxed" title="boxed">boxed</a></li><li><a href="#method.boxed_clone" title="boxed_clone">boxed_clone</a></li><li><a href="#method.boxed_clone_sync" title="boxed_clone_sync">boxed_clone_sync</a></li><li><a href="#method.check_clone" title="check_clone">check_clone</a></li><li><a href="#method.check_service" title="check_service">check_service</a></li><li><a href="#method.check_service_clone" title="check_service_clone">check_service_clone</a></li><li><a href="#method.into_inner" title="into_inner">into_inner</a></li><li><a href="#method.layer" title="layer">layer</a></li><li><a href="#method.layer_fn" title="layer_fn">layer_fn</a></li><li><a href="#method.map_err" title="map_err">map_err</a></li><li><a href="#method.map_future" title="map_future">map_future</a></li><li><a href="#method.map_request" title="map_request">map_request</a></li><li><a href="#method.map_response" title="map_response">map_response</a></li><li><a href="#method.map_result" title="map_result">map_result</a></li><li><a href="#method.new" title="new">new</a></li><li><a href="#method.option_layer" title="option_layer">option_layer</a></li><li><a href="#method.retry" title="retry">retry</a></li><li><a href="#method.service" title="service">service</a></li><li><a href="#method.service_fn" title="service_fn">service_fn</a></li><li><a href="#method.then" title="then">then</a></li><li><a href="#method.timeout" title="timeout">timeout</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Clone-for-ServiceBuilder%3CL%3E" title="Clone">Clone</a></li><li><a href="#impl-Debug-for-ServiceBuilder%3CL%3E" title="Debug">Debug</a></li><li><a href="#impl-Default-for-ServiceBuilder%3CIdentity%3E" title="Default">Default</a></li><li><a href="#impl-Layer%3CS%3E-for-ServiceBuilder%3CL%3E" title="Layer<S>">Layer<S></a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Freeze-for-ServiceBuilder%3CL%3E" title="Freeze">Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-ServiceBuilder%3CL%3E" title="RefUnwindSafe">RefUnwindSafe</a></li><li><a href="#impl-Send-for-ServiceBuilder%3CL%3E" title="Send">Send</a></li><li><a href="#impl-Sync-for-ServiceBuilder%3CL%3E" title="Sync">Sync</a></li><li><a href="#impl-Unpin-for-ServiceBuilder%3CL%3E" title="Unpin">Unpin</a></li><li><a href="#impl-UnwindSafe-for-ServiceBuilder%3CL%3E" title="UnwindSafe">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block blanket-implementation"><li><a href="#impl-Any-for-T" title="Any">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-T" title="Borrow<T>">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T" title="BorrowMut<T>">BorrowMut<T></a></li><li><a href="#impl-CloneToUninit-for-T" title="CloneToUninit">CloneToUninit</a></li><li><a href="#impl-From%3CT%3E-for-T" title="From<T>">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-T" title="Into<U>">Into<U></a></li><li><a href="#impl-ToOwned-for-T" title="ToOwned">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-T" title="TryFrom<U>">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-T" title="TryInto<U>">TryInto<U></a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate tower</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="index.html">tower</a></div><h1>Struct <span class="struct">Service<wbr>Builder</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/tower/builder/mod.rs.html#106-108">Source</a> </span></div><pre class="rust item-decl"><code>pub struct ServiceBuilder<L> { <span class="comment">/* private fields */</span> }</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Declaratively construct <a href="trait.Service.html" title="trait tower::Service"><code>Service</code></a> values.</p>
|
||
<p><a href="struct.ServiceBuilder.html" title="struct tower::ServiceBuilder"><code>ServiceBuilder</code></a> provides a <a href="https://doc.rust-lang.org/1.0.0/style/ownership/builders.html">builder-like interface</a> for composing
|
||
layers to be applied to a <a href="trait.Service.html" title="trait tower::Service"><code>Service</code></a>.</p>
|
||
<h2 id="service"><a class="doc-anchor" href="#service">§</a>Service</h2>
|
||
<p>A <a href="trait.Service.html" title="trait tower::Service"><code>Service</code></a> is a trait representing an asynchronous function of a request
|
||
to a response. It is similar to <code>async fn(Request) -> Result<Response, Error></code>.</p>
|
||
<p>A <a href="trait.Service.html" title="trait tower::Service"><code>Service</code></a> is typically bound to a single transport, such as a TCP
|
||
connection. It defines how <em>all</em> inbound or outbound requests are handled
|
||
by that connection.</p>
|
||
<h2 id="order"><a class="doc-anchor" href="#order">§</a>Order</h2>
|
||
<p>The order in which layers are added impacts how requests are handled. Layers
|
||
that are added first will be called with the request first. The argument to
|
||
<code>service</code> will be last to see the request.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code>ServiceBuilder::new()
|
||
.buffer(<span class="number">100</span>)
|
||
.concurrency_limit(<span class="number">10</span>)
|
||
.service(svc)</code></pre></div>
|
||
<p>In the above example, the buffer layer receives the request first followed
|
||
by <code>concurrency_limit</code>. <code>buffer</code> enables up to 100 request to be in-flight
|
||
<strong>on top of</strong> the requests that have already been forwarded to the next
|
||
layer. Combined with <code>concurrency_limit</code>, this allows up to 110 requests to be
|
||
in-flight.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code>ServiceBuilder::new()
|
||
.concurrency_limit(<span class="number">10</span>)
|
||
.buffer(<span class="number">100</span>)
|
||
.service(svc)</code></pre></div>
|
||
<p>The above example is similar, but the order of layers is reversed. Now,
|
||
<code>concurrency_limit</code> applies first and only allows 10 requests to be in-flight
|
||
total.</p>
|
||
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
|
||
<p>A <a href="trait.Service.html" title="trait tower::Service"><code>Service</code></a> stack with a single layer:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code>ServiceBuilder::new()
|
||
.concurrency_limit(<span class="number">5</span>)
|
||
.service(svc);</code></pre></div>
|
||
<p>A <a href="trait.Service.html" title="trait tower::Service"><code>Service</code></a> stack with <em>multiple</em> layers that contain rate limiting,
|
||
in-flight request limits, and a channel-backed, clonable <a href="trait.Service.html" title="trait tower::Service"><code>Service</code></a>:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code>ServiceBuilder::new()
|
||
.buffer(<span class="number">5</span>)
|
||
.concurrency_limit(<span class="number">5</span>)
|
||
.rate_limit(<span class="number">5</span>, Duration::from_secs(<span class="number">1</span>))
|
||
.service(svc);</code></pre></div></div></details><h2 id="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-ServiceBuilder%3CIdentity%3E" class="impl"><a class="src rightside" href="../src/tower/builder/mod.rs.html#116-123">Source</a><a href="#impl-ServiceBuilder%3CIdentity%3E" class="anchor">§</a><h3 class="code-header">impl <a class="struct" href="struct.ServiceBuilder.html" title="struct tower::ServiceBuilder">ServiceBuilder</a><<a class="struct" href="layer/util/struct.Identity.html" title="struct tower::layer::util::Identity">Identity</a>></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.new" class="method"><a class="src rightside" href="../src/tower/builder/mod.rs.html#118-122">Source</a><h4 class="code-header">pub const fn <a href="#method.new" class="fn">new</a>() -> Self</h4></section></summary><div class="docblock"><p>Create a new <a href="struct.ServiceBuilder.html" title="struct tower::ServiceBuilder"><code>ServiceBuilder</code></a>.</p>
|
||
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-ServiceBuilder%3CL%3E" class="impl"><a class="src rightside" href="../src/tower/builder/mod.rs.html#125-854">Source</a><a href="#impl-ServiceBuilder%3CL%3E" class="anchor">§</a><h3 class="code-header">impl<L> <a class="struct" href="struct.ServiceBuilder.html" title="struct tower::ServiceBuilder">ServiceBuilder</a><L></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.layer" class="method"><a class="src rightside" href="../src/tower/builder/mod.rs.html#132-136">Source</a><h4 class="code-header">pub fn <a href="#method.layer" class="fn">layer</a><T>(self, layer: T) -> <a class="struct" href="struct.ServiceBuilder.html" title="struct tower::ServiceBuilder">ServiceBuilder</a><<a class="struct" href="layer/util/struct.Stack.html" title="struct tower::layer::util::Stack">Stack</a><T, L>></h4></section></summary><div class="docblock"><p>Add a new layer <code>T</code> into the <a href="struct.ServiceBuilder.html" title="struct tower::ServiceBuilder"><code>ServiceBuilder</code></a>.</p>
|
||
<p>This wraps the inner service with the service provided by a user-defined
|
||
<a href="trait.Layer.html" title="trait tower::Layer"><code>Layer</code></a>. The provided layer must implement the <a href="trait.Layer.html" title="trait tower::Layer"><code>Layer</code></a> trait.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.option_layer" class="method"><a class="src rightside" href="../src/tower/builder/mod.rs.html#155-160">Source</a><h4 class="code-header">pub fn <a href="#method.option_layer" class="fn">option_layer</a><T>(
|
||
self,
|
||
layer: <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><T>,
|
||
) -> <a class="struct" href="struct.ServiceBuilder.html" title="struct tower::ServiceBuilder">ServiceBuilder</a><<a class="struct" href="layer/util/struct.Stack.html" title="struct tower::layer::util::Stack">Stack</a><<a class="enum" href="util/enum.Either.html" title="enum tower::util::Either">Either</a><T, <a class="struct" href="layer/util/struct.Identity.html" title="struct tower::layer::util::Identity">Identity</a>>, L>></h4></section></summary><div class="docblock"><p>Optionally add a new layer <code>T</code> into the <a href="struct.ServiceBuilder.html" title="struct tower::ServiceBuilder"><code>ServiceBuilder</code></a>.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="comment">// Apply a timeout if configured
|
||
</span>ServiceBuilder::new()
|
||
.option_layer(timeout.map(TimeoutLayer::new))
|
||
.service(svc)</code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.layer_fn" class="method"><a class="src rightside" href="../src/tower/builder/mod.rs.html#167-169">Source</a><h4 class="code-header">pub fn <a href="#method.layer_fn" class="fn">layer_fn</a><F>(self, f: F) -> <a class="struct" href="struct.ServiceBuilder.html" title="struct tower::ServiceBuilder">ServiceBuilder</a><<a class="struct" href="layer/util/struct.Stack.html" title="struct tower::layer::util::Stack">Stack</a><<a class="struct" href="layer/struct.LayerFn.html" title="struct tower::layer::LayerFn">LayerFn</a><F>, L>></h4></section></summary><div class="docblock"><p>Add a <a href="trait.Layer.html" title="trait tower::Layer"><code>Layer</code></a> built from a function that accepts a service and returns another service.</p>
|
||
<p>See the documentation for <a href="layer/fn.layer_fn.html" title="fn tower::layer::layer_fn"><code>layer_fn</code></a> for more details.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.retry" class="method"><a class="src rightside" href="../src/tower/builder/mod.rs.html#249-251">Source</a><h4 class="code-header">pub fn <a href="#method.retry" class="fn">retry</a><P>(self, policy: P) -> <a class="struct" href="struct.ServiceBuilder.html" title="struct tower::ServiceBuilder">ServiceBuilder</a><<a class="struct" href="layer/util/struct.Stack.html" title="struct tower::layer::util::Stack">Stack</a><<a class="struct" href="retry/struct.RetryLayer.html" title="struct tower::retry::RetryLayer">RetryLayer</a><P>, L>></h4></section></summary><div class="docblock"><p>Retry failed requests according to the given <a href="retry/trait.Policy.html" title="trait tower::retry::Policy">retry policy</a>.</p>
|
||
<p><code>policy</code> determines which failed requests will be retried. It must
|
||
implement the <a href="retry/trait.Policy.html" title="trait tower::retry::Policy"><code>retry::Policy</code></a> trait.</p>
|
||
<p>This wraps the inner service with an instance of the <a href="retry/index.html" title="mod tower::retry"><code>Retry</code></a>
|
||
middleware.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.timeout" class="method"><a class="src rightside" href="../src/tower/builder/mod.rs.html#263-268">Source</a><h4 class="code-header">pub fn <a href="#method.timeout" class="fn">timeout</a>(
|
||
self,
|
||
timeout: <a class="struct" href="https://doc.rust-lang.org/1.93.1/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</a>,
|
||
) -> <a class="struct" href="struct.ServiceBuilder.html" title="struct tower::ServiceBuilder">ServiceBuilder</a><<a class="struct" href="layer/util/struct.Stack.html" title="struct tower::layer::util::Stack">Stack</a><<a class="struct" href="timeout/struct.TimeoutLayer.html" title="struct tower::timeout::TimeoutLayer">TimeoutLayer</a>, L>></h4></section></summary><div class="docblock"><p>Fail requests that take longer than <code>timeout</code>.</p>
|
||
<p>If the next layer takes more than <code>timeout</code> to respond to a request,
|
||
processing is terminated and an error is returned.</p>
|
||
<p>This wraps the inner service with an instance of the <a href="timeout/index.html" title="mod tower::timeout"><code>timeout</code></a>
|
||
middleware.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.map_request" class="method"><a class="src rightside" href="../src/tower/builder/mod.rs.html#365-373">Source</a><h4 class="code-header">pub fn <a href="#method.map_request" class="fn">map_request</a><F, R1, R2>(
|
||
self,
|
||
f: F,
|
||
) -> <a class="struct" href="struct.ServiceBuilder.html" title="struct tower::ServiceBuilder">ServiceBuilder</a><<a class="struct" href="layer/util/struct.Stack.html" title="struct tower::layer::util::Stack">Stack</a><<a class="struct" href="util/struct.MapRequestLayer.html" title="struct tower::util::MapRequestLayer">MapRequestLayer</a><F>, L>><div class="where">where
|
||
F: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(R1) -> R2 + <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</div></h4></section></summary><div class="docblock"><p>Map one request type to another.</p>
|
||
<p>This wraps the inner service with an instance of the <a href="util/struct.MapRequest.html" title="struct tower::util::MapRequest"><code>MapRequest</code></a>
|
||
middleware.</p>
|
||
<h5 id="examples-1"><a class="doc-anchor" href="#examples-1">§</a>Examples</h5>
|
||
<p>Changing the type of a request:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tower::ServiceBuilder;
|
||
<span class="kw">use </span>tower::ServiceExt;
|
||
|
||
<span class="comment">// Suppose we have some `Service` whose request type is `String`:
|
||
</span><span class="kw">let </span>string_svc = tower::service_fn(|request: String| <span class="kw">async move </span>{
|
||
<span class="macro">println!</span>(<span class="string">"request: {}"</span>, request);
|
||
<span class="prelude-val">Ok</span>(())
|
||
});
|
||
|
||
<span class="comment">// ...but we want to call that service with a `usize`. What do we do?
|
||
|
||
</span><span class="kw">let </span>usize_svc = ServiceBuilder::new()
|
||
<span class="comment">// Add a middleware that converts the request type to a `String`:
|
||
</span>.map_request(|request: usize| <span class="macro">format!</span>(<span class="string">"{}"</span>, request))
|
||
<span class="comment">// ...and wrap the string service with that middleware:
|
||
</span>.service(string_svc);
|
||
|
||
<span class="comment">// Now, we can call that service with a `usize`:
|
||
</span>usize_svc.oneshot(<span class="number">42</span>).<span class="kw">await</span><span class="question-mark">?</span>;</code></pre></div>
|
||
<p>Modifying the request value:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tower::ServiceBuilder;
|
||
<span class="kw">use </span>tower::ServiceExt;
|
||
|
||
<span class="comment">// A service that takes a number and returns it:
|
||
</span><span class="kw">let </span>svc = tower::service_fn(|request: usize| <span class="kw">async move </span>{
|
||
<span class="prelude-val">Ok</span>(request)
|
||
});
|
||
|
||
<span class="kw">let </span>svc = ServiceBuilder::new()
|
||
<span class="comment">// Add a middleware that adds 1 to each request
|
||
</span>.map_request(|request: usize| request + <span class="number">1</span>)
|
||
.service(svc);
|
||
|
||
<span class="kw">let </span>response = svc.oneshot(<span class="number">1</span>).<span class="kw">await</span><span class="question-mark">?</span>;
|
||
<span class="macro">assert_eq!</span>(response, <span class="number">2</span>);</code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.map_response" class="method"><a class="src rightside" href="../src/tower/builder/mod.rs.html#385-390">Source</a><h4 class="code-header">pub fn <a href="#method.map_response" class="fn">map_response</a><F>(
|
||
self,
|
||
f: F,
|
||
) -> <a class="struct" href="struct.ServiceBuilder.html" title="struct tower::ServiceBuilder">ServiceBuilder</a><<a class="struct" href="layer/util/struct.Stack.html" title="struct tower::layer::util::Stack">Stack</a><<a class="struct" href="util/struct.MapResponseLayer.html" title="struct tower::util::MapResponseLayer">MapResponseLayer</a><F>, L>></h4></section></summary><div class="docblock"><p>Map one response type to another.</p>
|
||
<p>This wraps the inner service with an instance of the <a href="util/struct.MapResponse.html" title="struct tower::util::MapResponse"><code>MapResponse</code></a>
|
||
middleware.</p>
|
||
<p>See the documentation for the <a href="trait.ServiceExt.html#method.map_response" title="method tower::ServiceExt::map_response"><code>map_response</code> combinator</a> for details.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.map_err" class="method"><a class="src rightside" href="../src/tower/builder/mod.rs.html#402-404">Source</a><h4 class="code-header">pub fn <a href="#method.map_err" class="fn">map_err</a><F>(self, f: F) -> <a class="struct" href="struct.ServiceBuilder.html" title="struct tower::ServiceBuilder">ServiceBuilder</a><<a class="struct" href="layer/util/struct.Stack.html" title="struct tower::layer::util::Stack">Stack</a><<a class="struct" href="util/struct.MapErrLayer.html" title="struct tower::util::MapErrLayer">MapErrLayer</a><F>, L>></h4></section></summary><div class="docblock"><p>Map one error type to another.</p>
|
||
<p>This wraps the inner service with an instance of the <a href="util/struct.MapErr.html" title="struct tower::util::MapErr"><code>MapErr</code></a>
|
||
middleware.</p>
|
||
<p>See the documentation for the <a href="trait.ServiceExt.html#method.map_err" title="method tower::ServiceExt::map_err"><code>map_err</code> combinator</a> for details.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.map_future" class="method"><a class="src rightside" href="../src/tower/builder/mod.rs.html#415-417">Source</a><h4 class="code-header">pub fn <a href="#method.map_future" class="fn">map_future</a><F>(self, f: F) -> <a class="struct" href="struct.ServiceBuilder.html" title="struct tower::ServiceBuilder">ServiceBuilder</a><<a class="struct" href="layer/util/struct.Stack.html" title="struct tower::layer::util::Stack">Stack</a><<a class="struct" href="util/struct.MapFutureLayer.html" title="struct tower::util::MapFutureLayer">MapFutureLayer</a><F>, L>></h4></section></summary><div class="docblock"><p>Composes a function that transforms futures produced by the service.</p>
|
||
<p>This wraps the inner service with an instance of the <a href="util/struct.MapFutureLayer.html" title="struct tower::util::MapFutureLayer"><code>MapFutureLayer</code></a> middleware.</p>
|
||
<p>See the documentation for the <a href="trait.ServiceExt.html#method.map_future" title="method tower::ServiceExt::map_future"><code>map_future</code></a> combinator for details.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.then" class="method"><a class="src rightside" href="../src/tower/builder/mod.rs.html#438-440">Source</a><h4 class="code-header">pub fn <a href="#method.then" class="fn">then</a><F>(self, f: F) -> <a class="struct" href="struct.ServiceBuilder.html" title="struct tower::ServiceBuilder">ServiceBuilder</a><<a class="struct" href="layer/util/struct.Stack.html" title="struct tower::layer::util::Stack">Stack</a><<a class="struct" href="util/struct.ThenLayer.html" title="struct tower::util::ThenLayer">ThenLayer</a><F>, L>></h4></section></summary><div class="docblock"><p>Apply an asynchronous function after the service, regardless of whether the future
|
||
succeeds or fails.</p>
|
||
<p>This wraps the inner service with an instance of the <a href="util/struct.Then.html" title="struct tower::util::Then"><code>Then</code></a>
|
||
middleware.</p>
|
||
<p>This is similar to the <a href="struct.ServiceBuilder.html#method.map_response" title="method tower::ServiceBuilder::map_response"><code>map_response</code></a> and <a href="struct.ServiceBuilder.html#method.map_err" title="method tower::ServiceBuilder::map_err"><code>map_err</code></a> functions,
|
||
except that the <em>same</em> function is invoked when the service’s future
|
||
completes, whether it completes successfully or fails. This function
|
||
takes the <a href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result"><code>Result</code></a> returned by the service’s future, and returns a
|
||
<a href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result"><code>Result</code></a>.</p>
|
||
<p>See the documentation for the <a href="trait.ServiceExt.html#method.then" title="method tower::ServiceExt::then"><code>then</code> combinator</a> for details.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.and_then" class="method"><a class="src rightside" href="../src/tower/builder/mod.rs.html#459-461">Source</a><h4 class="code-header">pub fn <a href="#method.and_then" class="fn">and_then</a><F>(self, f: F) -> <a class="struct" href="struct.ServiceBuilder.html" title="struct tower::ServiceBuilder">ServiceBuilder</a><<a class="struct" href="layer/util/struct.Stack.html" title="struct tower::layer::util::Stack">Stack</a><<a class="struct" href="util/struct.AndThenLayer.html" title="struct tower::util::AndThenLayer">AndThenLayer</a><F>, L>></h4></section></summary><div class="docblock"><p>Executes a new future after this service’s future resolves. This does
|
||
not alter the behaviour of the <a href="trait.Service.html#tymethod.poll_ready" title="method tower::Service::poll_ready"><code>poll_ready</code></a> method.</p>
|
||
<p>This method can be used to change the <a href="trait.Service.html#associatedtype.Response" title="associated type tower::Service::Response"><code>Response</code></a> type of the service
|
||
into a different type. You can use this method to chain along a computation once the
|
||
service’s response has been resolved.</p>
|
||
<p>This wraps the inner service with an instance of the <a href="util/struct.AndThen.html" title="struct tower::util::AndThen"><code>AndThen</code></a>
|
||
middleware.</p>
|
||
<p>See the documentation for the <a href="trait.ServiceExt.html#method.and_then" title="method tower::ServiceExt::and_then"><code>and_then</code> combinator</a> for details.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.map_result" class="method"><a class="src rightside" href="../src/tower/builder/mod.rs.html#475-477">Source</a><h4 class="code-header">pub fn <a href="#method.map_result" class="fn">map_result</a><F>(self, f: F) -> <a class="struct" href="struct.ServiceBuilder.html" title="struct tower::ServiceBuilder">ServiceBuilder</a><<a class="struct" href="layer/util/struct.Stack.html" title="struct tower::layer::util::Stack">Stack</a><<a class="struct" href="util/struct.MapResultLayer.html" title="struct tower::util::MapResultLayer">MapResultLayer</a><F>, L>></h4></section></summary><div class="docblock"><p>Maps this service’s result type (<code>Result<Self::Response, Self::Error></code>)
|
||
to a different value, regardless of whether the future succeeds or
|
||
fails.</p>
|
||
<p>This wraps the inner service with an instance of the <a href="util/struct.MapResult.html" title="struct tower::util::MapResult"><code>MapResult</code></a>
|
||
middleware.</p>
|
||
<p>See the documentation for the <a href="trait.ServiceExt.html#method.map_result" title="method tower::ServiceExt::map_result"><code>map_result</code> combinator</a> for details.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.into_inner" class="method"><a class="src rightside" href="../src/tower/builder/mod.rs.html#480-482">Source</a><h4 class="code-header">pub fn <a href="#method.into_inner" class="fn">into_inner</a>(self) -> L</h4></section></summary><div class="docblock"><p>Returns the underlying <code>Layer</code> implementation.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.service" class="method"><a class="src rightside" href="../src/tower/builder/mod.rs.html#489-494">Source</a><h4 class="code-header">pub fn <a href="#method.service" class="fn">service</a><S>(&self, service: S) -> L::<a class="associatedtype" href="trait.Layer.html#associatedtype.Service" title="type tower::Layer::Service">Service</a><div class="where">where
|
||
L: <a class="trait" href="trait.Layer.html" title="trait tower::Layer">Layer</a><S>,</div></h4></section></summary><div class="docblock"><p>Wrap the service <code>S</code> with the middleware provided by this
|
||
<a href="struct.ServiceBuilder.html" title="struct tower::ServiceBuilder"><code>ServiceBuilder</code></a>’s <a href="trait.Layer.html" title="trait tower::Layer"><code>Layer</code></a>’s, returning a new <a href="trait.Service.html" title="trait tower::Service"><code>Service</code></a>.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.service_fn" class="method"><a class="src rightside" href="../src/tower/builder/mod.rs.html#540-545">Source</a><h4 class="code-header">pub fn <a href="#method.service_fn" class="fn">service_fn</a><F>(self, f: F) -> L::<a class="associatedtype" href="trait.Layer.html#associatedtype.Service" title="type tower::Layer::Service">Service</a><div class="where">where
|
||
L: <a class="trait" href="trait.Layer.html" title="trait tower::Layer">Layer</a><<a class="struct" href="util/struct.ServiceFn.html" title="struct tower::util::ServiceFn">ServiceFn</a><F>>,</div></h4></section></summary><div class="docblock"><p>Wrap the async function <code>F</code> with the middleware provided by this <a href="struct.ServiceBuilder.html" title="struct tower::ServiceBuilder"><code>ServiceBuilder</code></a>’s
|
||
<a href="trait.Layer.html" title="trait tower::Layer"><code>Layer</code></a>s, returning a new <a href="trait.Service.html" title="trait tower::Service"><code>Service</code></a>.</p>
|
||
<p>This is a convenience method which is equivalent to calling
|
||
<a href="struct.ServiceBuilder.html#method.service" title="method tower::ServiceBuilder::service"><code>ServiceBuilder::service</code></a> with a <a href="fn.service_fn.html" title="fn tower::service_fn"><code>service_fn</code></a>, like this:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code>ServiceBuilder::new()
|
||
<span class="comment">// ...
|
||
</span>.service(service_fn(handler_fn))</code></pre></div><h5 id="example"><a class="doc-anchor" href="#example">§</a>Example</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::time::Duration;
|
||
<span class="kw">use </span>tower::{ServiceBuilder, ServiceExt, BoxError, service_fn};
|
||
|
||
<span class="kw">async fn </span>handle(request: <span class="kw-2">&</span><span class="lifetime">'static </span>str) -> <span class="prelude-ty">Result</span><<span class="kw-2">&</span><span class="lifetime">'static </span>str, BoxError> {
|
||
<span class="prelude-val">Ok</span>(request)
|
||
}
|
||
|
||
<span class="kw">let </span>svc = ServiceBuilder::new()
|
||
.buffer(<span class="number">1024</span>)
|
||
.timeout(Duration::from_secs(<span class="number">10</span>))
|
||
.service_fn(handle);
|
||
|
||
<span class="kw">let </span>response = svc.oneshot(<span class="string">"foo"</span>).<span class="kw">await</span><span class="question-mark">?</span>;
|
||
|
||
<span class="macro">assert_eq!</span>(response, <span class="string">"foo"</span>);</code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.check_clone" class="method"><a class="src rightside" href="../src/tower/builder/mod.rs.html#573-578">Source</a><h4 class="code-header">pub fn <a href="#method.check_clone" class="fn">check_clone</a>(self) -> Self<div class="where">where
|
||
Self: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</div></h4></section></summary><div class="docblock"><p>Check that the builder implements <code>Clone</code>.</p>
|
||
<p>This can be useful when debugging type errors in <code>ServiceBuilder</code>s with lots of layers.</p>
|
||
<p>Doesn’t actually change the builder but serves as a type check.</p>
|
||
<h5 id="example-1"><a class="doc-anchor" href="#example-1">§</a>Example</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tower::ServiceBuilder;
|
||
|
||
<span class="kw">let </span>builder = ServiceBuilder::new()
|
||
<span class="comment">// Do something before processing the request
|
||
</span>.map_request(|request: String| {
|
||
<span class="macro">println!</span>(<span class="string">"got request!"</span>);
|
||
request
|
||
})
|
||
<span class="comment">// Ensure our `ServiceBuilder` can be cloned
|
||
</span>.check_clone()
|
||
<span class="comment">// Do something after processing the request
|
||
</span>.map_response(|response: String| {
|
||
<span class="macro">println!</span>(<span class="string">"got response!"</span>);
|
||
response
|
||
});</code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.check_service_clone" class="method"><a class="src rightside" href="../src/tower/builder/mod.rs.html#610-616">Source</a><h4 class="code-header">pub fn <a href="#method.check_service_clone" class="fn">check_service_clone</a><S>(self) -> Self<div class="where">where
|
||
L: <a class="trait" href="trait.Layer.html" title="trait tower::Layer">Layer</a><S>,
|
||
L::<a class="associatedtype" href="trait.Layer.html#associatedtype.Service" title="type tower::Layer::Service">Service</a>: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</div></h4></section></summary><div class="docblock"><p>Check that the builder when given a service of type <code>S</code> produces a service that implements
|
||
<code>Clone</code>.</p>
|
||
<p>This can be useful when debugging type errors in <code>ServiceBuilder</code>s with lots of layers.</p>
|
||
<p>Doesn’t actually change the builder but serves as a type check.</p>
|
||
<h5 id="example-2"><a class="doc-anchor" href="#example-2">§</a>Example</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tower::ServiceBuilder;
|
||
|
||
<span class="kw">let </span>builder = ServiceBuilder::new()
|
||
<span class="comment">// Do something before processing the request
|
||
</span>.map_request(|request: String| {
|
||
<span class="macro">println!</span>(<span class="string">"got request!"</span>);
|
||
request
|
||
})
|
||
<span class="comment">// Ensure that the service produced when given a `MyService` implements
|
||
</span>.check_service_clone::<MyService>()
|
||
<span class="comment">// Do something after processing the request
|
||
</span>.map_response(|response: String| {
|
||
<span class="macro">println!</span>(<span class="string">"got response!"</span>);
|
||
response
|
||
});</code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.check_service" class="method"><a class="src rightside" href="../src/tower/builder/mod.rs.html#667-673">Source</a><h4 class="code-header">pub fn <a href="#method.check_service" class="fn">check_service</a><S, T, U, E>(self) -> Self<div class="where">where
|
||
L: <a class="trait" href="trait.Layer.html" title="trait tower::Layer">Layer</a><S>,
|
||
L::<a class="associatedtype" href="trait.Layer.html#associatedtype.Service" title="type tower::Layer::Service">Service</a>: <a class="trait" href="trait.Service.html" title="trait tower::Service">Service</a><T, Response = U, Error = E>,</div></h4></section></summary><div class="docblock"><p>Check that the builder when given a service of type <code>S</code> produces a service with the given
|
||
request, response, and error types.</p>
|
||
<p>This can be useful when debugging type errors in <code>ServiceBuilder</code>s with lots of layers.</p>
|
||
<p>Doesn’t actually change the builder but serves as a type check.</p>
|
||
<h5 id="example-3"><a class="doc-anchor" href="#example-3">§</a>Example</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tower::ServiceBuilder;
|
||
<span class="kw">use </span>std::task::{Poll, Context};
|
||
<span class="kw">use </span>tower::{Service, ServiceExt};
|
||
|
||
<span class="comment">// An example service
|
||
</span><span class="kw">struct </span>MyService;
|
||
|
||
<span class="kw">impl </span>Service<Request> <span class="kw">for </span>MyService {
|
||
<span class="kw">type </span>Response = Response;
|
||
<span class="kw">type </span>Error = Error;
|
||
<span class="kw">type </span>Future = std::future::Ready<<span class="prelude-ty">Result</span><Response, Error>>;
|
||
|
||
<span class="kw">fn </span>poll_ready(<span class="kw-2">&mut </span><span class="self">self</span>, cx: <span class="kw-2">&mut </span>Context<<span class="lifetime">'_</span>>) -> Poll<<span class="prelude-ty">Result</span><(), <span class="self">Self</span>::Error>> {
|
||
<span class="comment">// ...
|
||
</span>}
|
||
|
||
<span class="kw">fn </span>call(<span class="kw-2">&mut </span><span class="self">self</span>, request: Request) -> <span class="self">Self</span>::Future {
|
||
<span class="comment">// ...
|
||
</span>}
|
||
}
|
||
|
||
<span class="kw">struct </span>Request;
|
||
<span class="kw">struct </span>Response;
|
||
<span class="kw">struct </span>Error;
|
||
|
||
<span class="kw">struct </span>WrappedResponse(Response);
|
||
|
||
<span class="kw">let </span>builder = ServiceBuilder::new()
|
||
<span class="comment">// At this point in the builder if given a `MyService` it produces a service that
|
||
// accepts `Request`s, produces `Response`s, and fails with `Error`s
|
||
</span>.check_service::<MyService, Request, Response, Error>()
|
||
<span class="comment">// Wrap responses in `WrappedResponse`
|
||
</span>.map_response(|response: Response| WrappedResponse(response))
|
||
<span class="comment">// Now the response type will be `WrappedResponse`
|
||
</span>.check_service::<MyService, <span class="kw">_</span>, WrappedResponse, <span class="kw">_</span>>();</code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.boxed" class="method"><a class="src rightside" href="../src/tower/builder/mod.rs.html#706-728">Source</a><h4 class="code-header">pub fn <a href="#method.boxed" class="fn">boxed</a><S, R>(
|
||
self,
|
||
) -> <a class="struct" href="struct.ServiceBuilder.html" title="struct tower::ServiceBuilder">ServiceBuilder</a><<a class="struct" href="layer/util/struct.Stack.html" title="struct tower::layer::util::Stack">Stack</a><<a class="struct" href="layer/struct.LayerFn.html" title="struct tower::layer::LayerFn">LayerFn</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.fn.html">fn</a>(L::<a class="associatedtype" href="trait.Layer.html#associatedtype.Service" title="type tower::Layer::Service">Service</a>) -> <a class="struct" href="util/struct.BoxService.html" title="struct tower::util::BoxService">BoxService</a><R, <L::<a class="associatedtype" href="trait.Layer.html#associatedtype.Service" title="type tower::Layer::Service">Service</a> as <a class="trait" href="trait.Service.html" title="trait tower::Service">Service</a><R>>::<a class="associatedtype" href="trait.Service.html#associatedtype.Response" title="type tower::Service::Response">Response</a>, <L::<a class="associatedtype" href="trait.Layer.html#associatedtype.Service" title="type tower::Layer::Service">Service</a> as <a class="trait" href="trait.Service.html" title="trait tower::Service">Service</a><R>>::<a class="associatedtype" href="trait.Service.html#associatedtype.Error" title="type tower::Service::Error">Error</a>>>, L>><div class="where">where
|
||
L: <a class="trait" href="trait.Layer.html" title="trait tower::Layer">Layer</a><S>,
|
||
L::<a class="associatedtype" href="trait.Layer.html#associatedtype.Service" title="type tower::Layer::Service">Service</a>: <a class="trait" href="trait.Service.html" title="trait tower::Service">Service</a><R> + <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static,
|
||
<L::<a class="associatedtype" href="trait.Layer.html#associatedtype.Service" title="type tower::Layer::Service">Service</a> as <a class="trait" href="trait.Service.html" title="trait tower::Service">Service</a><R>>::<a class="associatedtype" href="trait.Service.html#associatedtype.Future" title="type tower::Service::Future">Future</a>: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static,</div></h4></section></summary><div class="docblock"><p>This wraps the inner service with the <a href="trait.Layer.html" title="trait tower::Layer"><code>Layer</code></a> returned by <a href="util/struct.BoxService.html#method.layer" title="associated function tower::util::BoxService::layer"><code>BoxService::layer()</code></a>.</p>
|
||
<p>See that method for more details.</p>
|
||
<h5 id="example-4"><a class="doc-anchor" href="#example-4">§</a>Example</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tower::{Service, ServiceBuilder, BoxError, util::BoxService};
|
||
<span class="kw">use </span>std::time::Duration;
|
||
|
||
<span class="kw">let </span>service: BoxService<Request, Response, BoxError> = ServiceBuilder::new()
|
||
.boxed()
|
||
.load_shed()
|
||
.concurrency_limit(<span class="number">64</span>)
|
||
.timeout(Duration::from_secs(<span class="number">10</span>))
|
||
.service_fn(|req: Request| <span class="kw">async </span>{
|
||
<span class="prelude-val">Ok</span>::<<span class="kw">_</span>, BoxError>(Response::new())
|
||
});</code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.boxed_clone" class="method"><a class="src rightside" href="../src/tower/builder/mod.rs.html#769-791">Source</a><h4 class="code-header">pub fn <a href="#method.boxed_clone" class="fn">boxed_clone</a><S, R>(
|
||
self,
|
||
) -> <a class="struct" href="struct.ServiceBuilder.html" title="struct tower::ServiceBuilder">ServiceBuilder</a><<a class="struct" href="layer/util/struct.Stack.html" title="struct tower::layer::util::Stack">Stack</a><<a class="struct" href="layer/struct.LayerFn.html" title="struct tower::layer::LayerFn">LayerFn</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.fn.html">fn</a>(L::<a class="associatedtype" href="trait.Layer.html#associatedtype.Service" title="type tower::Layer::Service">Service</a>) -> <a class="struct" href="util/struct.BoxCloneService.html" title="struct tower::util::BoxCloneService">BoxCloneService</a><R, <L::<a class="associatedtype" href="trait.Layer.html#associatedtype.Service" title="type tower::Layer::Service">Service</a> as <a class="trait" href="trait.Service.html" title="trait tower::Service">Service</a><R>>::<a class="associatedtype" href="trait.Service.html#associatedtype.Response" title="type tower::Service::Response">Response</a>, <L::<a class="associatedtype" href="trait.Layer.html#associatedtype.Service" title="type tower::Layer::Service">Service</a> as <a class="trait" href="trait.Service.html" title="trait tower::Service">Service</a><R>>::<a class="associatedtype" href="trait.Service.html#associatedtype.Error" title="type tower::Service::Error">Error</a>>>, L>><div class="where">where
|
||
L: <a class="trait" href="trait.Layer.html" title="trait tower::Layer">Layer</a><S>,
|
||
L::<a class="associatedtype" href="trait.Layer.html#associatedtype.Service" title="type tower::Layer::Service">Service</a>: <a class="trait" href="trait.Service.html" title="trait tower::Service">Service</a><R> + <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> + <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static,
|
||
<L::<a class="associatedtype" href="trait.Layer.html#associatedtype.Service" title="type tower::Layer::Service">Service</a> as <a class="trait" href="trait.Service.html" title="trait tower::Service">Service</a><R>>::<a class="associatedtype" href="trait.Service.html#associatedtype.Future" title="type tower::Service::Future">Future</a>: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static,</div></h4></section></summary><div class="docblock"><p>This wraps the inner service with the <a href="trait.Layer.html" title="trait tower::Layer"><code>Layer</code></a> returned by <a href="util/struct.BoxCloneService.html#method.layer" title="associated function tower::util::BoxCloneService::layer"><code>BoxCloneService::layer()</code></a>.</p>
|
||
<p>This is similar to the <a href="struct.ServiceBuilder.html#method.boxed" title="method tower::ServiceBuilder::boxed"><code>boxed</code></a> method, but it requires that <code>Self</code> implement
|
||
<a href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html" title="trait core::clone::Clone"><code>Clone</code></a>, and the returned boxed service implements <a href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html" title="trait core::clone::Clone"><code>Clone</code></a>.</p>
|
||
<p>See <a href="util/struct.BoxCloneService.html" title="struct tower::util::BoxCloneService"><code>BoxCloneService</code></a> for more details.</p>
|
||
<h5 id="example-5"><a class="doc-anchor" href="#example-5">§</a>Example</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tower::{Service, ServiceBuilder, BoxError, util::BoxCloneService};
|
||
<span class="kw">use </span>std::time::Duration;
|
||
|
||
<span class="kw">let </span>service: BoxCloneService<Request, Response, BoxError> = ServiceBuilder::new()
|
||
.boxed_clone()
|
||
.load_shed()
|
||
.concurrency_limit(<span class="number">64</span>)
|
||
.timeout(Duration::from_secs(<span class="number">10</span>))
|
||
.service_fn(|req: Request| <span class="kw">async </span>{
|
||
<span class="prelude-val">Ok</span>::<<span class="kw">_</span>, BoxError>(Response::new())
|
||
});
|
||
|
||
<span class="comment">// The boxed service can still be cloned.
|
||
</span>service.clone();</code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.boxed_clone_sync" class="method"><a class="src rightside" href="../src/tower/builder/mod.rs.html#832-853">Source</a><h4 class="code-header">pub fn <a href="#method.boxed_clone_sync" class="fn">boxed_clone_sync</a><S, R>(
|
||
self,
|
||
) -> <a class="struct" href="struct.ServiceBuilder.html" title="struct tower::ServiceBuilder">ServiceBuilder</a><<a class="struct" href="layer/util/struct.Stack.html" title="struct tower::layer::util::Stack">Stack</a><<a class="struct" href="util/struct.BoxCloneSyncServiceLayer.html" title="struct tower::util::BoxCloneSyncServiceLayer">BoxCloneSyncServiceLayer</a><S, R, <L::<a class="associatedtype" href="trait.Layer.html#associatedtype.Service" title="type tower::Layer::Service">Service</a> as <a class="trait" href="trait.Service.html" title="trait tower::Service">Service</a><R>>::<a class="associatedtype" href="trait.Service.html#associatedtype.Response" title="type tower::Service::Response">Response</a>, <L::<a class="associatedtype" href="trait.Layer.html#associatedtype.Service" title="type tower::Layer::Service">Service</a> as <a class="trait" href="trait.Service.html" title="trait tower::Service">Service</a><R>>::<a class="associatedtype" href="trait.Service.html#associatedtype.Error" title="type tower::Service::Error">Error</a>>, <a class="struct" href="layer/util/struct.Identity.html" title="struct tower::layer::util::Identity">Identity</a>>><div class="where">where
|
||
L: <a class="trait" href="trait.Layer.html" title="trait tower::Layer">Layer</a><S> + <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + 'static,
|
||
L::<a class="associatedtype" href="trait.Layer.html#associatedtype.Service" title="type tower::Layer::Service">Service</a>: <a class="trait" href="trait.Service.html" title="trait tower::Service">Service</a><R> + <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> + <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + 'static,
|
||
<L::<a class="associatedtype" href="trait.Layer.html#associatedtype.Service" title="type tower::Layer::Service">Service</a> as <a class="trait" href="trait.Service.html" title="trait tower::Service">Service</a><R>>::<a class="associatedtype" href="trait.Service.html#associatedtype.Future" title="type tower::Service::Future">Future</a>: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + 'static,</div></h4></section></summary><div class="docblock"><p>This wraps the inner service with the <a href="trait.Layer.html" title="trait tower::Layer"><code>Layer</code></a> returned by <a href="util/struct.BoxCloneSyncServiceLayer.html" title="struct tower::util::BoxCloneSyncServiceLayer"><code>BoxCloneSyncServiceLayer</code></a>.</p>
|
||
<p>This is similar to the <a href="struct.ServiceBuilder.html#method.boxed_clone" title="method tower::ServiceBuilder::boxed_clone"><code>boxed_clone</code></a> method, but it requires that <code>Self</code> implement
|
||
<a href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sync.html" title="trait core::marker::Sync"><code>Sync</code></a>, and the returned boxed service implements <a href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sync.html" title="trait core::marker::Sync"><code>Sync</code></a>.</p>
|
||
<p>See <a href="util/struct.BoxCloneSyncService.html" title="struct tower::util::BoxCloneSyncService"><code>BoxCloneSyncService</code></a> for more details.</p>
|
||
<h5 id="example-6"><a class="doc-anchor" href="#example-6">§</a>Example</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tower::{Service, ServiceBuilder, BoxError, util::BoxCloneSyncService};
|
||
<span class="kw">use </span>std::time::Duration;
|
||
|
||
<span class="kw">let </span>service: BoxCloneSyncService<Request, Response, BoxError> = ServiceBuilder::new()
|
||
.load_shed()
|
||
.concurrency_limit(<span class="number">64</span>)
|
||
.timeout(Duration::from_secs(<span class="number">10</span>))
|
||
.boxed_clone_sync()
|
||
.service_fn(|req: Request| <span class="kw">async </span>{
|
||
<span class="prelude-val">Ok</span>::<<span class="kw">_</span>, BoxError>(Response::new())
|
||
});
|
||
|
||
<span class="comment">// The boxed service can still be cloned.
|
||
</span>service.clone();</code></pre></div></div></details></div></details></div><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Clone-for-ServiceBuilder%3CL%3E" class="impl"><a class="src rightside" href="../src/tower/builder/mod.rs.html#105">Source</a><a href="#impl-Clone-for-ServiceBuilder%3CL%3E" class="anchor">§</a><h3 class="code-header">impl<L: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="struct.ServiceBuilder.html" title="struct tower::ServiceBuilder">ServiceBuilder</a><L></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl"><a class="src rightside" href="../src/tower/builder/mod.rs.html#105">Source</a><a href="#method.clone" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html#tymethod.clone" class="fn">clone</a>(&self) -> <a class="struct" href="struct.ServiceBuilder.html" title="struct tower::ServiceBuilder">ServiceBuilder</a><L></h4></section></summary><div class='docblock'>Returns a duplicate of the value. <a href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html#tymethod.clone">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.93.1/src/core/clone.rs.html#245-247">Source</a></span><a href="#method.clone_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html#method.clone_from" class="fn">clone_from</a>(&mut self, source: &Self)</h4></section></summary><div class='docblock'>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html#method.clone_from">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Debug-for-ServiceBuilder%3CL%3E" class="impl"><a class="src rightside" href="../src/tower/builder/mod.rs.html#856-860">Source</a><a href="#impl-Debug-for-ServiceBuilder%3CL%3E" class="anchor">§</a><h3 class="code-header">impl<L: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.ServiceBuilder.html" title="struct tower::ServiceBuilder">ServiceBuilder</a><L></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl"><a class="src rightside" href="../src/tower/builder/mod.rs.html#857-859">Source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.93.1/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.93.1/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.93.1/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Default-for-ServiceBuilder%3CIdentity%3E" class="impl"><a class="src rightside" href="../src/tower/builder/mod.rs.html#110-114">Source</a><a href="#impl-Default-for-ServiceBuilder%3CIdentity%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="struct.ServiceBuilder.html" title="struct tower::ServiceBuilder">ServiceBuilder</a><<a class="struct" href="layer/util/struct.Identity.html" title="struct tower::layer::util::Identity">Identity</a>></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.default" class="method trait-impl"><a class="src rightside" href="../src/tower/builder/mod.rs.html#111-113">Source</a><a href="#method.default" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/default/trait.Default.html#tymethod.default" class="fn">default</a>() -> Self</h4></section></summary><div class='docblock'>Returns the “default value” for a type. <a href="https://doc.rust-lang.org/1.93.1/core/default/trait.Default.html#tymethod.default">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Layer%3CS%3E-for-ServiceBuilder%3CL%3E" class="impl"><a class="src rightside" href="../src/tower/builder/mod.rs.html#862-871">Source</a><a href="#impl-Layer%3CS%3E-for-ServiceBuilder%3CL%3E" class="anchor">§</a><h3 class="code-header">impl<S, L> <a class="trait" href="trait.Layer.html" title="trait tower::Layer">Layer</a><S> for <a class="struct" href="struct.ServiceBuilder.html" title="struct tower::ServiceBuilder">ServiceBuilder</a><L><div class="where">where
|
||
L: <a class="trait" href="trait.Layer.html" title="trait tower::Layer">Layer</a><S>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Service" class="associatedtype trait-impl"><a class="src rightside" href="../src/tower/builder/mod.rs.html#866">Source</a><a href="#associatedtype.Service" class="anchor">§</a><h4 class="code-header">type <a href="trait.Layer.html#associatedtype.Service" class="associatedtype">Service</a> = <L as <a class="trait" href="trait.Layer.html" title="trait tower::Layer">Layer</a><S>>::<a class="associatedtype" href="trait.Layer.html#associatedtype.Service" title="type tower::Layer::Service">Service</a></h4></section></summary><div class='docblock'>The wrapped service</div></details><details class="toggle method-toggle" open><summary><section id="method.layer-1" class="method trait-impl"><a class="src rightside" href="../src/tower/builder/mod.rs.html#868-870">Source</a><a href="#method.layer-1" class="anchor">§</a><h4 class="code-header">fn <a href="trait.Layer.html#tymethod.layer" class="fn">layer</a>(&self, inner: S) -> Self::<a class="associatedtype" href="trait.Layer.html#associatedtype.Service" title="type tower::Layer::Service">Service</a></h4></section></summary><div class='docblock'>Wrap the given service with the middleware, returning a new service
|
||
that has been decorated with the middleware.</div></details></div></details></div><h2 id="synthetic-implementations" class="section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-Freeze-for-ServiceBuilder%3CL%3E" class="impl"><a href="#impl-Freeze-for-ServiceBuilder%3CL%3E" class="anchor">§</a><h3 class="code-header">impl<L> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="struct" href="struct.ServiceBuilder.html" title="struct tower::ServiceBuilder">ServiceBuilder</a><L><div class="where">where
|
||
L: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a>,</div></h3></section><section id="impl-RefUnwindSafe-for-ServiceBuilder%3CL%3E" class="impl"><a href="#impl-RefUnwindSafe-for-ServiceBuilder%3CL%3E" class="anchor">§</a><h3 class="code-header">impl<L> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.ServiceBuilder.html" title="struct tower::ServiceBuilder">ServiceBuilder</a><L><div class="where">where
|
||
L: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a>,</div></h3></section><section id="impl-Send-for-ServiceBuilder%3CL%3E" class="impl"><a href="#impl-Send-for-ServiceBuilder%3CL%3E" class="anchor">§</a><h3 class="code-header">impl<L> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.ServiceBuilder.html" title="struct tower::ServiceBuilder">ServiceBuilder</a><L><div class="where">where
|
||
L: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,</div></h3></section><section id="impl-Sync-for-ServiceBuilder%3CL%3E" class="impl"><a href="#impl-Sync-for-ServiceBuilder%3CL%3E" class="anchor">§</a><h3 class="code-header">impl<L> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.ServiceBuilder.html" title="struct tower::ServiceBuilder">ServiceBuilder</a><L><div class="where">where
|
||
L: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>,</div></h3></section><section id="impl-Unpin-for-ServiceBuilder%3CL%3E" class="impl"><a href="#impl-Unpin-for-ServiceBuilder%3CL%3E" class="anchor">§</a><h3 class="code-header">impl<L> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.ServiceBuilder.html" title="struct tower::ServiceBuilder">ServiceBuilder</a><L><div class="where">where
|
||
L: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></h3></section><section id="impl-UnwindSafe-for-ServiceBuilder%3CL%3E" class="impl"><a href="#impl-UnwindSafe-for-ServiceBuilder%3CL%3E" class="anchor">§</a><h3 class="code-header">impl<L> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.ServiceBuilder.html" title="struct tower::ServiceBuilder">ServiceBuilder</a><L><div class="where">where
|
||
L: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a>,</div></h3></section></div><h2 id="blanket-implementations" class="section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor">§</a></h2><div id="blanket-implementations-list"><details class="toggle implementors-toggle"><summary><section id="impl-Any-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/any.rs.html#138">Source</a><a href="#impl-Any-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T<div class="where">where
|
||
T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/any.rs.html#139">Source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.93.1/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.93.1/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/borrow.rs.html#212">Source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T<div class="where">where
|
||
T: ?<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/borrow.rs.html#214">Source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.reference.html">&T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/borrow.rs.html#221">Source</a><a href="#impl-BorrowMut%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T<div class="where">where
|
||
T: ?<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/borrow.rs.html#222">Source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.reference.html">&mut T</a></h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-CloneToUninit-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/clone.rs.html#547">Source</a><a href="#impl-CloneToUninit-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/clone/trait.CloneToUninit.html" title="trait core::clone::CloneToUninit">CloneToUninit</a> for T<div class="where">where
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.clone_to_uninit" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/clone.rs.html#549">Source</a><a href="#method.clone_to_uninit" class="anchor">§</a><h4 class="code-header">unsafe fn <a href="https://doc.rust-lang.org/1.93.1/core/clone/trait.CloneToUninit.html#tymethod.clone_to_uninit" class="fn">clone_to_uninit</a>(&self, dest: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.pointer.html">*mut </a><a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>)</h4></section></summary><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>clone_to_uninit</code>)</span></div></span><div class='docblock'>Performs copy-assignment from <code>self</code> to <code>dest</code>. <a href="https://doc.rust-lang.org/1.93.1/core/clone/trait.CloneToUninit.html#tymethod.clone_to_uninit">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#785">Source</a><a href="#impl-From%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#788">Source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
|
||
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#767-769">Source</a><a href="#impl-Into%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#777">Source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.Into.html#tymethod.into" class="fn">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
|
||
<p>That is, this conversion is whatever the implementation of
|
||
<code><a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for U</code> chooses to do.</p>
|
||
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-ToOwned-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/alloc/borrow.rs.html#85-87">Source</a><a href="#impl-ToOwned-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/alloc/borrow/trait.ToOwned.html" title="trait alloc::borrow::ToOwned">ToOwned</a> for T<div class="where">where
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Owned" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/alloc/borrow.rs.html#89">Source</a><a href="#associatedtype.Owned" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.93.1/alloc/borrow/trait.ToOwned.html#associatedtype.Owned" class="associatedtype">Owned</a> = T</h4></section></summary><div class='docblock'>The resulting type after obtaining ownership.</div></details><details class="toggle method-toggle" open><summary><section id="method.to_owned" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/alloc/borrow.rs.html#90">Source</a><a href="#method.to_owned" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/alloc/borrow/trait.ToOwned.html#tymethod.to_owned" class="fn">to_owned</a>(&self) -> T</h4></section></summary><div class='docblock'>Creates owned data from borrowed data, usually by cloning. <a href="https://doc.rust-lang.org/1.93.1/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.clone_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/alloc/borrow.rs.html#94">Source</a><a href="#method.clone_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/alloc/borrow/trait.ToOwned.html#method.clone_into" class="fn">clone_into</a>(&self, target: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.reference.html">&mut T</a>)</h4></section></summary><div class='docblock'>Uses borrowed data to replace owned data, usually by cloning. <a href="https://doc.rust-lang.org/1.93.1/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#827-829">Source</a><a href="#impl-TryFrom%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#831">Source</a><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#834">Source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#811-813">Source</a><a href="#impl-TryInto%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#815">Source</a><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#818">Source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main></body></html> |