| <!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."><meta name="keywords" content="rust, rustlang, rust-lang, ServiceBuilder"><title>ServiceBuilder in tower::builder - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../tower/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><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><h2 class="location"><a href="#">ServiceBuilder</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.and_then">and_then</a></li><li><a href="#method.boxed">boxed</a></li><li><a href="#method.boxed_clone">boxed_clone</a></li><li><a href="#method.buffer">buffer</a></li><li><a href="#method.check_clone">check_clone</a></li><li><a href="#method.check_service">check_service</a></li><li><a href="#method.check_service_clone">check_service_clone</a></li><li><a href="#method.concurrency_limit">concurrency_limit</a></li><li><a href="#method.into_inner">into_inner</a></li><li><a href="#method.layer">layer</a></li><li><a href="#method.layer_fn">layer_fn</a></li><li><a href="#method.map_err">map_err</a></li><li><a href="#method.map_future">map_future</a></li><li><a href="#method.map_request">map_request</a></li><li><a href="#method.map_response">map_response</a></li><li><a href="#method.map_result">map_result</a></li><li><a href="#method.new">new</a></li><li><a href="#method.option_layer">option_layer</a></li><li><a href="#method.rate_limit">rate_limit</a></li><li><a href="#method.service">service</a></li><li><a href="#method.service_fn">service_fn</a></li><li><a href="#method.then">then</a></li><li><a href="#method.timeout">timeout</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-Clone-for-ServiceBuilder%3CL%3E">Clone</a></li><li><a href="#impl-Debug-for-ServiceBuilder%3CL%3E">Debug</a></li><li><a href="#impl-Default-for-ServiceBuilder%3CIdentity%3E">Default</a></li><li><a href="#impl-Layer%3CS%3E-for-ServiceBuilder%3CL%3E">Layer<S></a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-ServiceBuilder%3CL%3E">RefUnwindSafe</a></li><li><a href="#impl-Send-for-ServiceBuilder%3CL%3E">Send</a></li><li><a href="#impl-Sync-for-ServiceBuilder%3CL%3E">Sync</a></li><li><a href="#impl-Unpin-for-ServiceBuilder%3CL%3E">Unpin</a></li><li><a href="#impl-UnwindSafe-for-ServiceBuilder%3CL%3E">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-ServiceBuilder%3CL%3E">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-ServiceBuilder%3CL%3E">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-ServiceBuilder%3CL%3E">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-ServiceBuilder%3CL%3E">From<T></a></li><li><a href="#impl-Instrument-for-ServiceBuilder%3CL%3E">Instrument</a></li><li><a href="#impl-Into%3CU%3E-for-ServiceBuilder%3CL%3E">Into<U></a></li><li><a href="#impl-ToOwned-for-ServiceBuilder%3CL%3E">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-ServiceBuilder%3CL%3E">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-ServiceBuilder%3CL%3E">TryInto<U></a></li><li><a href="#impl-VZip%3CV%3E-for-ServiceBuilder%3CL%3E">VZip<V></a></li><li><a href="#impl-WithSubscriber-for-ServiceBuilder%3CL%3E">WithSubscriber</a></li></ul></section><h2><a href="index.html">In tower::builder</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Struct <a href="../index.html">tower</a>::<wbr><a href="index.html">builder</a>::<wbr><a class="struct" href="#">ServiceBuilder</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/tower/builder/mod.rs.html#106-108">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust struct"><code>pub struct ServiceBuilder<L> { /* private fields */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Declaratively construct <a href="../trait.Service.html"><code>Service</code></a> values.</p> |
| <p><a href="../struct.ServiceBuilder.html" title="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"><code>Service</code></a>.</p> |
| <h2 id="service"><a href="#service">Service</a></h2> |
| <p>A <a href="../trait.Service.html"><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"><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 href="#order">Order</a></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 href="#examples">Examples</a></h2> |
| <p>A <a href="../trait.Service.html"><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"><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"><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="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-ServiceBuilder%3CIdentity%3E" class="impl has-srclink"><a class="srclink 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="rustdoc-toggle method-toggle" open><summary><section id="method.new" class="method has-srclink"><a class="srclink rightside" href="../../src/tower/builder/mod.rs.html#118-122">source</a><h4 class="code-header">pub fn <a href="#method.new" class="fnname">new</a>() -> Self</h4></section></summary><div class="docblock"><p>Create a new <a href="../struct.ServiceBuilder.html" title="ServiceBuilder"><code>ServiceBuilder</code></a>.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-ServiceBuilder%3CL%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/tower/builder/mod.rs.html#125-811">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="rustdoc-toggle method-toggle" open><summary><section id="method.layer" class="method has-srclink"><a class="srclink rightside" href="../../src/tower/builder/mod.rs.html#132-136">source</a><h4 class="code-header">pub fn <a href="#method.layer" class="fnname">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="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"><code>Layer</code></a>. The provided layer must implement the <a href="../trait.Layer.html"><code>Layer</code></a> trait.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.option_layer" class="method has-srclink"><a class="srclink rightside" href="../../src/tower/builder/mod.rs.html#156-161">source</a><h4 class="code-header">pub fn <a href="#method.option_layer" class="fnname">option_layer</a><T>(<br> self,<br> layer: Option<T><br>) -> <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="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="rustdoc-toggle method-toggle" open><summary><section id="method.layer_fn" class="method has-srclink"><a class="srclink rightside" href="../../src/tower/builder/mod.rs.html#168-170">source</a><h4 class="code-header">pub fn <a href="#method.layer_fn" class="fnname">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="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"><code>layer_fn</code></a> for more details.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.buffer" class="method has-srclink"><a class="srclink rightside" href="../../src/tower/builder/mod.rs.html#180-185">source</a><h4 class="code-header">pub fn <a href="#method.buffer" class="fnname">buffer</a><Request>(<br> self,<br> bound: usize<br>) -> <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="../buffer/struct.BufferLayer.html" title="struct tower::buffer::BufferLayer">BufferLayer</a><Request>, L>></h4></section></summary><div class="docblock"><p>Buffer requests when the next layer is not ready.</p> |
| <p>This wraps the inner service with an instance of the <a href="../buffer/index.html"><code>Buffer</code></a> |
| middleware.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.concurrency_limit" class="method has-srclink"><a class="srclink rightside" href="../../src/tower/builder/mod.rs.html#199-204">source</a><h4 class="code-header">pub fn <a href="#method.concurrency_limit" class="fnname">concurrency_limit</a>(<br> self,<br> max: usize<br>) -> <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="../limit/concurrency/struct.ConcurrencyLimitLayer.html" title="struct tower::limit::concurrency::ConcurrencyLimitLayer">ConcurrencyLimitLayer</a>, L>></h4></section></summary><div class="docblock"><p>Limit the max number of in-flight requests.</p> |
| <p>A request is in-flight from the time the request is received until the |
| response future completes. This includes the time spent in the next |
| layers.</p> |
| <p>This wraps the inner service with an instance of the |
| <a href="../limit/concurrency/index.html"><code>ConcurrencyLimit</code></a> middleware.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.rate_limit" class="method has-srclink"><a class="srclink rightside" href="../../src/tower/builder/mod.rs.html#235-241">source</a><h4 class="code-header">pub fn <a href="#method.rate_limit" class="fnname">rate_limit</a>(<br> self,<br> num: u64,<br> per: Duration<br>) -> <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="../limit/rate/struct.RateLimitLayer.html" title="struct tower::limit::rate::RateLimitLayer">RateLimitLayer</a>, L>></h4></section></summary><div class="docblock"><p>Limit requests to at most <code>num</code> per the given duration.</p> |
| <p>This wraps the inner service with an instance of the <a href="../limit/rate/index.html"><code>RateLimit</code></a> |
| middleware.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.timeout" class="method has-srclink"><a class="srclink rightside" href="../../src/tower/builder/mod.rs.html#270-275">source</a><h4 class="code-header">pub fn <a href="#method.timeout" class="fnname">timeout</a>(self, timeout: Duration) -> <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"><code>timeout</code></a> |
| middleware.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.map_request" class="method has-srclink"><a class="srclink rightside" href="../../src/tower/builder/mod.rs.html#375-383">source</a><h4 class="code-header">pub fn <a href="#method.map_request" class="fnname">map_request</a><F, R1, R2>(<br> self,<br> f: F<br>) -> <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>><span class="where fmt-newline">where<br> F: FnMut(R1) -> R2 + Clone,</span></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"><code>MapRequest</code></a> |
| middleware.</p> |
| <h5 id="examples-1"><a href="#examples-1">Examples</a></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 middlware 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="rustdoc-toggle method-toggle" open><summary><section id="method.map_response" class="method has-srclink"><a class="srclink rightside" href="../../src/tower/builder/mod.rs.html#396-401">source</a><h4 class="code-header">pub fn <a href="#method.map_response" class="fnname">map_response</a><F>(<br> self,<br> f: F<br>) -> <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"><code>MapResponse</code></a> |
| middleware.</p> |
| <p>See the documentation for the <a href="../trait.ServiceExt.html#method.map_response"><code>map_response</code> combinator</a> for details.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.map_err" class="method has-srclink"><a class="srclink rightside" href="../../src/tower/builder/mod.rs.html#414-416">source</a><h4 class="code-header">pub fn <a href="#method.map_err" class="fnname">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"><code>MapErr</code></a> |
| middleware.</p> |
| <p>See the documentation for the <a href="../trait.ServiceExt.html#method.map_err"><code>map_err</code> combinator</a> for details.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.map_future" class="method has-srclink"><a class="srclink rightside" href="../../src/tower/builder/mod.rs.html#428-430">source</a><h4 class="code-header">pub fn <a href="#method.map_future" class="fnname">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"><code>MapFutureLayer</code></a> middleware.</p> |
| <p>See the documentation for the <a href="../trait.ServiceExt.html#method.map_future"><code>map_future</code></a> combinator for details.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.then" class="method has-srclink"><a class="srclink rightside" href="../../src/tower/builder/mod.rs.html#452-454">source</a><h4 class="code-header">pub fn <a href="#method.then" class="fnname">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"><code>Then</code></a> |
| middleware.</p> |
| <p>This is similar to the <a href="../struct.ServiceBuilder.html#method.map_response"><code>map_response</code></a> and <a href="../struct.ServiceBuilder.html#method.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 [<code>Result</code>] returned by the service’s future, and returns a |
| [<code>Result</code>].</p> |
| <p>See the documentation for the <a href="../trait.ServiceExt.html#method.then"><code>then</code> combinator</a> for details.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.and_then" class="method has-srclink"><a class="srclink rightside" href="../../src/tower/builder/mod.rs.html#474-476">source</a><h4 class="code-header">pub fn <a href="#method.and_then" class="fnname">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"><code>poll_ready</code></a> method.</p> |
| <p>This method can be used to change the <a href="../trait.Service.html#associatedtype.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"><code>AndThen</code></a> |
| middleware.</p> |
| <p>See the documentation for the <a href="../trait.ServiceExt.html#method.and_then"><code>and_then</code> combinator</a> for details.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.map_result" class="method has-srclink"><a class="srclink rightside" href="../../src/tower/builder/mod.rs.html#491-493">source</a><h4 class="code-header">pub fn <a href="#method.map_result" class="fnname">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"><code>MapResult</code></a> |
| middleware.</p> |
| <p>See the documentation for the <a href="../trait.ServiceExt.html#method.map_result"><code>map_result</code> combinator</a> for details.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into_inner" class="method has-srclink"><a class="srclink rightside" href="../../src/tower/builder/mod.rs.html#496-498">source</a><h4 class="code-header">pub fn <a href="#method.into_inner" class="fnname">into_inner</a>(self) -> L</h4></section></summary><div class="docblock"><p>Returns the underlying <code>Layer</code> implementation.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.service" class="method has-srclink"><a class="srclink rightside" href="../../src/tower/builder/mod.rs.html#505-510">source</a><h4 class="code-header">pub fn <a href="#method.service" class="fnname">service</a><S>(&self, service: S) -> L::<a class="associatedtype" href="../trait.Layer.html#associatedtype.Service" title="type tower::Layer::Service">Service</a><span class="where fmt-newline">where<br> L: <a class="trait" href="../trait.Layer.html" title="trait tower::Layer">Layer</a><S>,</span></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="ServiceBuilder"><code>ServiceBuilder</code></a>’s <a href="../trait.Layer.html"><code>Layer</code></a>’s, returning a new <a href="../trait.Service.html"><code>Service</code></a>.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.service_fn" class="method has-srclink"><a class="srclink rightside" href="../../src/tower/builder/mod.rs.html#557-562">source</a><h4 class="code-header">pub fn <a href="#method.service_fn" class="fnname">service_fn</a><F>(self, f: F) -> L::<a class="associatedtype" href="../trait.Layer.html#associatedtype.Service" title="type tower::Layer::Service">Service</a><span class="where fmt-newline">where<br> 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>>,</span></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="ServiceBuilder"><code>ServiceBuilder</code></a>’s |
| <a href="../trait.Layer.html"><code>Layer</code></a>s, returning a new <a href="../trait.Service.html"><code>Service</code></a>.</p> |
| <p>This is a convenience method which is equivalent to calling |
| <a href="../struct.ServiceBuilder.html#method.service" title="ServiceBuilder::service"><code>ServiceBuilder::service</code></a> with a <a href="../util/fn.service_fn.html"><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 href="#example">Example</a></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="rustdoc-toggle method-toggle" open><summary><section id="method.check_clone" class="method has-srclink"><a class="srclink rightside" href="../../src/tower/builder/mod.rs.html#590-595">source</a><h4 class="code-header">pub fn <a href="#method.check_clone" class="fnname">check_clone</a>(self) -> Self<span class="where fmt-newline">where<br> Self: Clone,</span></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 href="#example-1">Example</a></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="rustdoc-toggle method-toggle" open><summary><section id="method.check_service_clone" class="method has-srclink"><a class="srclink rightside" href="../../src/tower/builder/mod.rs.html#627-633">source</a><h4 class="code-header">pub fn <a href="#method.check_service_clone" class="fnname">check_service_clone</a><S>(self) -> Self<span class="where fmt-newline">where<br> L: <a class="trait" href="../trait.Layer.html" title="trait tower::Layer">Layer</a><S>,<br> L::<a class="associatedtype" href="../trait.Layer.html#associatedtype.Service" title="type tower::Layer::Service">Service</a>: Clone,</span></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 href="#example-2">Example</a></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="rustdoc-toggle method-toggle" open><summary><section id="method.check_service" class="method has-srclink"><a class="srclink rightside" href="../../src/tower/builder/mod.rs.html#684-690">source</a><h4 class="code-header">pub fn <a href="#method.check_service" class="fnname">check_service</a><S, T, U, E>(self) -> Self<span class="where fmt-newline">where<br> L: <a class="trait" href="../trait.Layer.html" title="trait tower::Layer">Layer</a><S>,<br> 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>,</span></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 href="#example-3">Example</a></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 = futures_util::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="rustdoc-toggle method-toggle" open><summary><section id="method.boxed" class="method has-srclink"><a class="srclink rightside" href="../../src/tower/builder/mod.rs.html#724-746">source</a><h4 class="code-header">pub fn <a href="#method.boxed" class="fnname">boxed</a><S, R>(<br> self<br>) -> <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><fn(_: 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>><span class="where fmt-newline">where<br> L: <a class="trait" href="../trait.Layer.html" title="trait tower::Layer">Layer</a><S>,<br> 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> + Send + 'static,<br> <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>: Send + 'static,</span></h4></section></summary><div class="docblock"><p>This wraps the inner service with the <a href="../trait.Layer.html" title="Layer"><code>Layer</code></a> returned by <a href="../util/struct.BoxService.html#method.layer"><code>BoxService::layer()</code></a>.</p> |
| <p>See that method for more details.</p> |
| <h5 id="example-4"><a href="#example-4">Example</a></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="rustdoc-toggle method-toggle" open><summary><section id="method.boxed_clone" class="method has-srclink"><a class="srclink rightside" href="../../src/tower/builder/mod.rs.html#788-810">source</a><h4 class="code-header">pub fn <a href="#method.boxed_clone" class="fnname">boxed_clone</a><S, R>(<br> self<br>) -> <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><fn(_: 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>><span class="where fmt-newline">where<br> L: <a class="trait" href="../trait.Layer.html" title="trait tower::Layer">Layer</a><S>,<br> 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> + Clone + Send + 'static,<br> <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>: Send + 'static,</span></h4></section></summary><div class="docblock"><p>This wraps the inner service with the <a href="../trait.Layer.html" title="Layer"><code>Layer</code></a> returned by <a href="../util/struct.BoxCloneService.html#method.layer"><code>BoxCloneService::layer()</code></a>.</p> |
| <p>This is similar to the <a href="../struct.ServiceBuilder.html#method.boxed"><code>boxed</code></a> method, but it requires that <code>Self</code> implement |
| [<code>Clone</code>], and the returned boxed service implements [<code>Clone</code>].</p> |
| <p>See <a href="../util/struct.BoxCloneService.html"><code>BoxCloneService</code></a> for more details.</p> |
| <h5 id="example-5"><a href="#example-5">Example</a></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></div></details></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Clone-for-ServiceBuilder%3CL%3E" class="impl has-srclink"><a class="srclink 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: Clone> Clone for <a class="struct" href="../struct.ServiceBuilder.html" title="struct tower::ServiceBuilder">ServiceBuilder</a><L></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tower/builder/mod.rs.html#105">source</a><a href="#method.clone" class="anchor"></a><h4 class="code-header">fn <a class="fnname">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 copy of the value. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl has-srclink"><span class="since rightside" title="Stable since Rust version 1.0.0">1.0.0</span><a href="#method.clone_from" class="anchor"></a><h4 class="code-header">const fn <a class="fnname">clone_from</a>(&mut self, source: &Self)</h4></section></summary><div class='docblock'>Performs copy-assignment from <code>source</code>. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Debug-for-ServiceBuilder%3CL%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/tower/builder/mod.rs.html#813-817">source</a><a href="#impl-Debug-for-ServiceBuilder%3CL%3E" class="anchor"></a><h3 class="code-header">impl<L: Debug> Debug for <a class="struct" href="../struct.ServiceBuilder.html" title="struct tower::ServiceBuilder">ServiceBuilder</a><L></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tower/builder/mod.rs.html#814-816">source</a><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a class="fnname">fmt</a>(&self, f: &mut Formatter<'_>) -> Result</h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Default-for-ServiceBuilder%3CIdentity%3E" class="impl has-srclink"><a class="srclink 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 Default 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="rustdoc-toggle method-toggle" open><summary><section id="method.default" class="method trait-impl has-srclink"><a class="srclink 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 class="fnname">default</a>() -> Self</h4></section></summary><div class='docblock'>Returns the “default value” for a type. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Layer%3CS%3E-for-ServiceBuilder%3CL%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/tower/builder/mod.rs.html#819-828">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><span class="where fmt-newline">where<br> L: <a class="trait" href="../trait.Layer.html" title="trait tower::Layer">Layer</a><S>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Service" class="associatedtype trait-impl has-srclink"><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="rustdoc-toggle method-toggle" open><summary><section id="method.layer-1" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tower/builder/mod.rs.html#825-827">source</a><a href="#method.layer-1" class="anchor"></a><h4 class="code-header">fn <a href="../trait.Layer.html#tymethod.layer" class="fnname">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. <a href="../trait.Layer.html#tymethod.layer">Read more</a></div></details></div></details></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><section id="impl-RefUnwindSafe-for-ServiceBuilder%3CL%3E" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-ServiceBuilder%3CL%3E" class="anchor"></a><h3 class="code-header">impl<L> RefUnwindSafe for <a class="struct" href="../struct.ServiceBuilder.html" title="struct tower::ServiceBuilder">ServiceBuilder</a><L><span class="where fmt-newline">where<br> L: RefUnwindSafe,</span></h3></section><section id="impl-Send-for-ServiceBuilder%3CL%3E" class="impl has-srclink"><a href="#impl-Send-for-ServiceBuilder%3CL%3E" class="anchor"></a><h3 class="code-header">impl<L> Send for <a class="struct" href="../struct.ServiceBuilder.html" title="struct tower::ServiceBuilder">ServiceBuilder</a><L><span class="where fmt-newline">where<br> L: Send,</span></h3></section><section id="impl-Sync-for-ServiceBuilder%3CL%3E" class="impl has-srclink"><a href="#impl-Sync-for-ServiceBuilder%3CL%3E" class="anchor"></a><h3 class="code-header">impl<L> Sync for <a class="struct" href="../struct.ServiceBuilder.html" title="struct tower::ServiceBuilder">ServiceBuilder</a><L><span class="where fmt-newline">where<br> L: Sync,</span></h3></section><section id="impl-Unpin-for-ServiceBuilder%3CL%3E" class="impl has-srclink"><a href="#impl-Unpin-for-ServiceBuilder%3CL%3E" class="anchor"></a><h3 class="code-header">impl<L> Unpin for <a class="struct" href="../struct.ServiceBuilder.html" title="struct tower::ServiceBuilder">ServiceBuilder</a><L><span class="where fmt-newline">where<br> L: Unpin,</span></h3></section><section id="impl-UnwindSafe-for-ServiceBuilder%3CL%3E" class="impl has-srclink"><a href="#impl-UnwindSafe-for-ServiceBuilder%3CL%3E" class="anchor"></a><h3 class="code-header">impl<L> UnwindSafe for <a class="struct" href="../struct.ServiceBuilder.html" title="struct tower::ServiceBuilder">ServiceBuilder</a><L><span class="where fmt-newline">where<br> L: UnwindSafe,</span></h3></section></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Any-for-ServiceBuilder%3CL%3E" class="impl has-srclink"><a href="#impl-Any-for-ServiceBuilder%3CL%3E" class="anchor"></a><h3 class="code-header">impl<T> Any for T<span class="where fmt-newline">where<br> T: 'static + ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl has-srclink"><a href="#method.type_id" class="anchor"></a><h4 class="code-header">fn <a class="fnname">type_id</a>(&self) -> TypeId</h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-ServiceBuilder%3CL%3E" class="impl has-srclink"><a href="#impl-Borrow%3CT%3E-for-ServiceBuilder%3CL%3E" class="anchor"></a><h3 class="code-header">impl<T> Borrow<T> for T<span class="where fmt-newline">where<br> T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow</a>(&self) -> &T</h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-ServiceBuilder%3CL%3E" class="impl has-srclink"><a href="#impl-BorrowMut%3CT%3E-for-ServiceBuilder%3CL%3E" class="anchor"></a><h3 class="code-header">impl<T> BorrowMut<T> for T<span class="where fmt-newline">where<br> T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow_mut</a>(&mut self) -> &mut T</h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-ServiceBuilder%3CL%3E" class="impl has-srclink"><a href="#impl-From%3CT%3E-for-ServiceBuilder%3CL%3E" class="anchor"></a><h3 class="code-header">impl<T> From<T> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Instrument-for-ServiceBuilder%3CL%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/tracing/instrument.rs.html#276">source</a><a href="#impl-Instrument-for-ServiceBuilder%3CL%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="../../tracing/instrument/trait.Instrument.html" title="trait tracing::instrument::Instrument">Instrument</a> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.instrument" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tracing/instrument.rs.html#82">source</a><a href="#method.instrument" class="anchor"></a><h4 class="code-header">fn <a href="../../tracing/instrument/trait.Instrument.html#method.instrument" class="fnname">instrument</a>(self, span: <a class="struct" href="../../tracing/span/struct.Span.html" title="struct tracing::span::Span">Span</a>) -> <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><Self></h4></section></summary><div class='docblock'>Instruments this type with the provided <a href="../../tracing/span/struct.Span.html" title="Span"><code>Span</code></a>, returning an |
| <code>Instrumented</code> wrapper. <a href="../../tracing/instrument/trait.Instrument.html#method.instrument">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.in_current_span" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tracing/instrument.rs.html#121">source</a><a href="#method.in_current_span" class="anchor"></a><h4 class="code-header">fn <a href="../../tracing/instrument/trait.Instrument.html#method.in_current_span" class="fnname">in_current_span</a>(self) -> <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><Self></h4></section></summary><div class='docblock'>Instruments this type with the <a href="../../tracing/span/struct.Span.html#method.current">current</a> <a href="../../tracing/span/struct.Span.html"><code>Span</code></a>, returning an |
| <code>Instrumented</code> wrapper. <a href="../../tracing/instrument/trait.Instrument.html#method.in_current_span">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-ServiceBuilder%3CL%3E" class="impl has-srclink"><a href="#impl-Into%3CU%3E-for-ServiceBuilder%3CL%3E" class="anchor"></a><h3 class="code-header">impl<T, U> Into<U> for T<span class="where fmt-newline">where<br> U: From<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">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>[From]<T> for U</code> chooses to do.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-ToOwned-for-ServiceBuilder%3CL%3E" class="impl has-srclink"><a href="#impl-ToOwned-for-ServiceBuilder%3CL%3E" class="anchor"></a><h3 class="code-header">impl<T> ToOwned for T<span class="where fmt-newline">where<br> T: Clone,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Owned" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Owned" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Owned</a> = T</h4></section></summary><div class='docblock'>The resulting type after obtaining ownership.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.to_owned" class="method trait-impl has-srclink"><a href="#method.to_owned" class="anchor"></a><h4 class="code-header">fn <a class="fnname">to_owned</a>(&self) -> T</h4></section></summary><div class='docblock'>Creates owned data from borrowed data, usually by cloning. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_into" class="method trait-impl has-srclink"><a href="#method.clone_into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">clone_into</a>(&self, target: &mut T)</h4></section></summary><div class='docblock'>Uses borrowed data to replace owned data, usually by cloning. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-ServiceBuilder%3CL%3E" class="impl has-srclink"><a href="#impl-TryFrom%3CU%3E-for-ServiceBuilder%3CL%3E" class="anchor"></a><h3 class="code-header">impl<T, U> TryFrom<U> for T<span class="where fmt-newline">where<br> U: Into<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = Infallible</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_from</a>(value: U) -> Result<T, <T as TryFrom<U>>::Error></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-ServiceBuilder%3CL%3E" class="impl has-srclink"><a href="#impl-TryInto%3CU%3E-for-ServiceBuilder%3CL%3E" class="anchor"></a><h3 class="code-header">impl<T, U> TryInto<U> for T<span class="where fmt-newline">where<br> U: TryFrom<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = <U as TryFrom<T>>::Error</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_into</a>(self) -> Result<U, <U as TryFrom<T>>::Error></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-VZip%3CV%3E-for-ServiceBuilder%3CL%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/ppv_lite86/types.rs.html#221">source</a><a href="#impl-VZip%3CV%3E-for-ServiceBuilder%3CL%3E" class="anchor"></a><h3 class="code-header">impl<V, T> <a class="trait" href="../../ppv_lite86/types/trait.VZip.html" title="trait ppv_lite86::types::VZip">VZip</a><V> for T<span class="where fmt-newline">where<br> V: <a class="trait" href="../../ppv_lite86/types/trait.MultiLane.html" title="trait ppv_lite86::types::MultiLane">MultiLane</a><T>,</span></h3></section></summary><div class="impl-items"><section id="method.vzip" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/ppv_lite86/types.rs.html#226">source</a><a href="#method.vzip" class="anchor"></a><h4 class="code-header">fn <a href="../../ppv_lite86/types/trait.VZip.html#tymethod.vzip" class="fnname">vzip</a>(self) -> V</h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-WithSubscriber-for-ServiceBuilder%3CL%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/tracing/instrument.rs.html#334">source</a><a href="#impl-WithSubscriber-for-ServiceBuilder%3CL%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="../../tracing/instrument/trait.WithSubscriber.html" title="trait tracing::instrument::WithSubscriber">WithSubscriber</a> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.with_subscriber" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tracing/instrument.rs.html#169-171">source</a><a href="#method.with_subscriber" class="anchor"></a><h4 class="code-header">fn <a href="../../tracing/instrument/trait.WithSubscriber.html#method.with_subscriber" class="fnname">with_subscriber</a><S>(self, subscriber: S) -> <a class="struct" href="../../tracing/instrument/struct.WithDispatch.html" title="struct tracing::instrument::WithDispatch">WithDispatch</a><Self><span class="where fmt-newline">where<br> S: Into<<a class="struct" href="../../tracing_core/dispatcher/struct.Dispatch.html" title="struct tracing_core::dispatcher::Dispatch">Dispatch</a>>,</span></h4></section></summary><div class='docblock'>Attaches the provided <a href="../../tracing_core/subscriber/trait.Subscriber.html"><code>Subscriber</code></a> to this type, returning a |
| <a href="../../tracing/instrument/struct.WithDispatch.html" title="WithDispatch"><code>WithDispatch</code></a> wrapper. <a href="../../tracing/instrument/trait.WithSubscriber.html#method.with_subscriber">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.with_current_subscriber" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tracing/instrument.rs.html#221">source</a><a href="#method.with_current_subscriber" class="anchor"></a><h4 class="code-header">fn <a href="../../tracing/instrument/trait.WithSubscriber.html#method.with_current_subscriber" class="fnname">with_current_subscriber</a>(self) -> <a class="struct" href="../../tracing/instrument/struct.WithDispatch.html" title="struct tracing::instrument::WithDispatch">WithDispatch</a><Self></h4></section></summary><div class='docblock'>Attaches the current <a href="../../tracing/dispatcher/index.html#setting-the-default-subscriber">default</a> <a href="../../tracing_core/subscriber/trait.Subscriber.html"><code>Subscriber</code></a> to this type, returning a |
| <a href="../../tracing/instrument/struct.WithDispatch.html" title="WithDispatch"><code>WithDispatch</code></a> wrapper. <a href="../../tracing/instrument/trait.WithSubscriber.html#method.with_current_subscriber">Read more</a></div></details></div></details></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> |
