mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-26 19:58:50 +01:00
31 lines
7.0 KiB
HTML
31 lines
7.0 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="Asynchronous Services"><title>hyper::service - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-ac92e1bbe349e143.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="hyper" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.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></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../hyper/index.html">hyper</a><span class="version">0.14.27</span></h2></div><h2 class="location"><a href="#">Module service</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></section><h2><a href="../index.html">In crate hyper</a></h2></div></nav><div class="sidebar-resizer"></div>
|
||
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../hyper/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../index.html">hyper</a>::<wbr><a class="mod" href="#">service</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../src/hyper/service/mod.rs.html#1-55">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Asynchronous Services</p>
|
||
<p>A <a href="trait.Service.html" title="trait hyper::service::Service"><code>Service</code></a> is a trait representing an asynchronous
|
||
function of a request to a response. It’s similar to
|
||
<code>async fn(Request) -> Result<Response, Error></code>.</p>
|
||
<p>The argument and return value isn’t strictly required to be for HTTP.
|
||
Therefore, hyper uses several “trait aliases” to reduce clutter around
|
||
bounds. These are:</p>
|
||
<ul>
|
||
<li><code>HttpService</code>: This is blanketly implemented for all types that
|
||
implement <code>Service<http::Request<B1>, Response = http::Response<B2>></code>.</li>
|
||
<li><code>MakeService</code>: When a <code>Service</code> returns a new <code>Service</code> as its “response”,
|
||
we consider it a <code>MakeService</code>. Again, blanketly implemented in those cases.</li>
|
||
<li><code>MakeConnection</code>: A <code>Service</code> that returns a “connection”, a type that
|
||
implements <code>AsyncRead</code> and <code>AsyncWrite</code>.</li>
|
||
</ul>
|
||
<h2 id="httpservice"><a href="#httpservice">HttpService</a></h2>
|
||
<p>In hyper, especially in the server setting, a <code>Service</code> is usually bound
|
||
to a single connection. It defines how to respond to <strong>all</strong> requests that
|
||
connection will receive.</p>
|
||
<p>The helper <a href="fn.service_fn.html" title="fn hyper::service::service_fn"><code>service_fn</code></a> should be sufficient for most cases, but
|
||
if you need to implement <code>Service</code> for a type manually, you can follow the example
|
||
in <code>service_struct_impl.rs</code>.</p>
|
||
<h2 id="makeservice"><a href="#makeservice">MakeService</a></h2>
|
||
<p>Since a <code>Service</code> is bound to a single connection, a <a href="../server/struct.Server.html" title="struct hyper::server::Server"><code>Server</code></a>
|
||
needs a way to make them as it accepts connections. This is what a
|
||
<code>MakeService</code> does.</p>
|
||
<p>Resources that need to be shared by all <code>Service</code>s can be put into a
|
||
<code>MakeService</code>, and then passed to individual <code>Service</code>s when <code>call</code>
|
||
is called.</p>
|
||
</div></details><h2 id="traits" class="section-header"><a href="#traits">Traits</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.Service.html" title="trait hyper::service::Service">Service</a></div><div class="desc docblock-short">An asynchronous function from a <code>Request</code> to a <code>Response</code>.</div></li></ul><h2 id="functions" class="section-header"><a href="#functions">Functions</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.make_service_fn.html" title="fn hyper::service::make_service_fn">make_service_fn</a></div><div class="desc docblock-short">Create a <code>MakeService</code> from a function.</div></li><li><div class="item-name"><a class="fn" href="fn.service_fn.html" title="fn hyper::service::service_fn">service_fn</a></div><div class="desc docblock-short">Create a <code>Service</code> from a function.</div></li></ul></section></div></main></body></html> |