| <!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="Middleware that provides a buffered mpsc channel to a service."><meta name="keywords" content="rust, rustlang, rust-lang, buffer"><title>tower::buffer - 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="../../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 mod"><!--[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="#">Module buffer</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li></ul></section></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">Module <a href="../index.html">tower</a>::<wbr><a class="mod" href="#">buffer</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/buffer/mod.rs.html#1-47">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Middleware that provides a buffered mpsc channel to a service.</p> |
| <p>Sometimes you want to give out multiple handles to a single service, and allow each handle to |
| enqueue requests. That is, you want a <a href="../trait.Service.html"><code>Service</code></a> to be <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="Clone"><code>Clone</code></a>. This module allows you to do |
| that by placing the service behind a multi-producer, single-consumer buffering channel. Clients |
| enqueue requests by sending on the channel from any of the handles (<a href="struct.Buffer.html" title="Buffer"><code>Buffer</code></a>), and the single |
| service running elsewhere (usually spawned) receives and services the requests one by one. Each |
| request is enqueued alongside a response channel that allows the service to report the result |
| of the request back to the caller.</p> |
| <h2 id="examples"><a href="#examples">Examples</a></h2> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tower::buffer::Buffer; |
| <span class="kw">use </span>tower::{Service, ServiceExt}; |
| <span class="kw">async fn </span>mass_produce<S: Service<usize>>(svc: S) |
| <span class="kw">where |
| </span>S: <span class="lifetime">'static </span>+ Send, |
| S::Error: Send + Sync + std::error::Error, |
| S::Future: Send |
| { |
| <span class="kw">let </span>svc = Buffer::new(svc, <span class="number">10 </span><span class="comment">/* buffer length */</span>); |
| <span class="kw">for _ in </span><span class="number">0</span>..<span class="number">10 </span>{ |
| <span class="kw">let </span><span class="kw-2">mut </span>svc = svc.clone(); |
| tokio::spawn(<span class="kw">async move </span>{ |
| <span class="kw">for </span>i <span class="kw">in </span><span class="number">0usize</span>.. { |
| svc.ready().<span class="kw">await</span>.expect(<span class="string">"service crashed"</span>).call(i).<span class="kw">await</span>; |
| } |
| }); |
| } |
| }</code></pre></div> |
| </div></details><h2 id="modules" class="small-section-header"><a href="#modules">Modules</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="mod" href="error/index.html" title="tower::buffer::error mod">error</a></div><div class="item-right docblock-short">Error types for the <code>Buffer</code> middleware.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="future/index.html" title="tower::buffer::future mod">future</a></div><div class="item-right docblock-short">Future types for the <a href="struct.Buffer.html"><code>Buffer</code></a> middleware.</div></div></div><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Buffer.html" title="tower::buffer::Buffer struct">Buffer</a></div><div class="item-right docblock-short">Adds an mpsc buffer in front of an inner service.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.BufferLayer.html" title="tower::buffer::BufferLayer struct">BufferLayer</a></div><div class="item-right docblock-short">Adds an mpsc buffer in front of an inner service.</div></div></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> |
