mentat/tokio_service/trait.NewService.html

173 lines
17 KiB
HTML
Raw Permalink Normal View History

2018-08-22 17:04:13 +00:00
<!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="API documentation for the Rust `NewService` trait in crate `tokio_service`.">
<meta name="keywords" content="rust, rustlang, rust-lang, NewService">
<title>tokio_service::NewService - Rust</title>
<link rel="stylesheet" type="text/css" href="../normalize.css">
<link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle">
<link rel="stylesheet" type="text/css" href="../dark.css">
<link rel="stylesheet" type="text/css" href="../main.css" id="themeStyle">
<script src="../storage.js"></script>
</head>
<body class="rustdoc trait">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<div class="sidebar-menu">&#9776;</div>
<p class='location'>Trait NewService</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#associated-types">Associated Types</a><div class="sidebar-links"><a href="#associatedtype.Request">Request</a><a href="#associatedtype.Response">Response</a><a href="#associatedtype.Error">Error</a><a href="#associatedtype.Instance">Instance</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.new_service">new_service</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-NewService">Arc&lt;S&gt;</a><a href="#impl-NewService">Rc&lt;S&gt;</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>tokio_service</a></p><script>window.sidebarCurrent = {name: 'NewService', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script></div>
</nav>
<div class="theme-picker">
<button id="theme-picker" aria-label="Pick another theme!">
<img src="../brush.svg" width="18" alt="Pick another theme!">
</button>
<div id="theme-choices"></div>
</div>
<script src="../theme.js"></script>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press S to search, ? for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content">
<h1 class='fqn'><span class='in-band'>Trait <a href='index.html'>tokio_service</a>::<wbr><a class="trait" href=''>NewService</a></span><span class='out-of-band'><span id='render-detail'>
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
[<span class='inner'>&#x2212;</span>]
</a>
</span><a class='srclink' href='../src/tokio_service/lib.rs.html#159-174' title='goto source code'>[src]</a></span></h1>
<pre class='rust trait'>pub trait NewService {
type <a href='#associatedtype.Request' class="type">Request</a>;
type <a href='#associatedtype.Response' class="type">Response</a>;
type <a href='#associatedtype.Error' class="type">Error</a>;
type <a href='#associatedtype.Instance' class="type">Instance</a>: <a class="trait" href="../tokio_service/trait.Service.html" title="trait tokio_service::Service">Service</a>&lt;Request = Self::<a class="type" href="../tokio_service/trait.NewService.html#associatedtype.Request" title="type tokio_service::NewService::Request">Request</a>, Response = Self::<a class="type" href="../tokio_service/trait.NewService.html#associatedtype.Response" title="type tokio_service::NewService::Response">Response</a>, Error = Self::<a class="type" href="../tokio_service/trait.NewService.html#associatedtype.Error" title="type tokio_service::NewService::Error">Error</a>&gt;;
fn <a href='#tymethod.new_service' class='fnname'>new_service</a>(&amp;self) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a>&lt;Self::<a class="type" href="../tokio_service/trait.NewService.html#associatedtype.Instance" title="type tokio_service::NewService::Instance">Instance</a>&gt;;
}</pre><div class='docblock'><p>Creates new <code>Service</code> values.</p>
</div>
<h2 id='associated-types' class='small-section-header'>
Associated Types<a href='#associated-types' class='anchor'></a>
</h2>
<div class='methods'>
<h3 id='associatedtype.Request' class='method'><span id='Request.t' class='invisible'><code>type <a href='#associatedtype.Request' class="type">Request</a></code></span></h3><div class='docblock'><p>Requests handled by the service</p>
</div><h3 id='associatedtype.Response' class='method'><span id='Response.t' class='invisible'><code>type <a href='#associatedtype.Response' class="type">Response</a></code></span></h3><div class='docblock'><p>Responses given by the service</p>
</div><h3 id='associatedtype.Error' class='method'><span id='Error.t' class='invisible'><code>type <a href='#associatedtype.Error' class="type">Error</a></code></span></h3><div class='docblock'><p>Errors produced by the service</p>
</div><h3 id='associatedtype.Instance' class='method'><span id='Instance.t' class='invisible'><code>type <a href='#associatedtype.Instance' class="type">Instance</a>: <a class="trait" href="../tokio_service/trait.Service.html" title="trait tokio_service::Service">Service</a>&lt;Request = Self::<a class="type" href="../tokio_service/trait.NewService.html#associatedtype.Request" title="type tokio_service::NewService::Request">Request</a>, Response = Self::<a class="type" href="../tokio_service/trait.NewService.html#associatedtype.Response" title="type tokio_service::NewService::Response">Response</a>, Error = Self::<a class="type" href="../tokio_service/trait.NewService.html#associatedtype.Error" title="type tokio_service::NewService::Error">Error</a>&gt;</code></span></h3><div class='docblock'><p>The <code>Service</code> value created by this factory</p>
</div></div>
<h2 id='required-methods' class='small-section-header'>
Required Methods<a href='#required-methods' class='anchor'></a>
</h2>
<div class='methods'>
<h3 id='tymethod.new_service' class='method'><span id='new_service.v' class='invisible'><code>fn <a href='#tymethod.new_service' class='fnname'>new_service</a>(&amp;self) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a>&lt;Self::<a class="type" href="../tokio_service/trait.NewService.html#associatedtype.Instance" title="type tokio_service::NewService::Instance">Instance</a>&gt;</code></span></h3><div class='docblock'><p>Create and return a new service value.</p>
</div></div>
<h2 id='foreign-impls' class='small-section-header'>
Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a>
</h2>
<h3 id='impl-NewService' class='impl'><span class='in-band'><code>impl&lt;S:&nbsp;<a class="trait" href="../tokio_service/trait.NewService.html" title="trait tokio_service::NewService">NewService</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>&gt; <a class="trait" href="../tokio_service/trait.NewService.html" title="trait tokio_service::NewService">NewService</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/arc/struct.Arc.html" title="struct alloc::arc::Arc">Arc</a>&lt;S&gt;</code><a href='#impl-NewService' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_service/lib.rs.html#190-199' title='goto source code'>[src]</a></span></h3>
<span class='docblock autohide'><div class='impl-items'><h4 id='associatedtype.Request-1' class="type"><span id='Request.t-1' class='invisible'><code>type <a href='#associatedtype.Request' class="type">Request</a> = S::<a class="type" href="../tokio_service/trait.NewService.html#associatedtype.Request" title="type tokio_service::NewService::Request">Request</a></code></span></h4>
<h4 id='associatedtype.Response-1' class="type"><span id='Response.t-1' class='invisible'><code>type <a href='#associatedtype.Response' class="type">Response</a> = S::<a class="type" href="../tokio_service/trait.NewService.html#associatedtype.Response" title="type tokio_service::NewService::Response">Response</a></code></span></h4>
<h4 id='associatedtype.Error-1' class="type"><span id='Error.t-1' class='invisible'><code>type <a href='#associatedtype.Error' class="type">Error</a> = S::<a class="type" href="../tokio_service/trait.NewService.html#associatedtype.Error" title="type tokio_service::NewService::Error">Error</a></code></span></h4>
<h4 id='associatedtype.Instance-1' class="type"><span id='Instance.t-1' class='invisible'><code>type <a href='#associatedtype.Instance' class="type">Instance</a> = S::<a class="type" href="../tokio_service/trait.NewService.html#associatedtype.Instance" title="type tokio_service::NewService::Instance">Instance</a></code></span></h4>
<h4 id='method.new_service' class="method"><span id='new_service.v-1' class='invisible'><code>fn <a href='#method.new_service' class='fnname'>new_service</a>(&amp;self) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a>&lt;S::<a class="type" href="../tokio_service/trait.NewService.html#associatedtype.Instance" title="type tokio_service::NewService::Instance">Instance</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_service/lib.rs.html#196-198' title='goto source code'>[src]</a></span></h4>
</div></span><h3 id='impl-NewService-1' class='impl'><span class='in-band'><code>impl&lt;S:&nbsp;<a class="trait" href="../tokio_service/trait.NewService.html" title="trait tokio_service::NewService">NewService</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>&gt; <a class="trait" href="../tokio_service/trait.NewService.html" title="trait tokio_service::NewService">NewService</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc">Rc</a>&lt;S&gt;</code><a href='#impl-NewService-1' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_service/lib.rs.html#201-210' title='goto source code'>[src]</a></span></h3>
<span class='docblock autohide'><div class='impl-items'><h4 id='associatedtype.Request-2' class="type"><span id='Request.t-2' class='invisible'><code>type <a href='#associatedtype.Request' class="type">Request</a> = S::<a class="type" href="../tokio_service/trait.NewService.html#associatedtype.Request" title="type tokio_service::NewService::Request">Request</a></code></span></h4>
<h4 id='associatedtype.Response-2' class="type"><span id='Response.t-2' class='invisible'><code>type <a href='#associatedtype.Response' class="type">Response</a> = S::<a class="type" href="../tokio_service/trait.NewService.html#associatedtype.Response" title="type tokio_service::NewService::Response">Response</a></code></span></h4>
<h4 id='associatedtype.Error-2' class="type"><span id='Error.t-2' class='invisible'><code>type <a href='#associatedtype.Error' class="type">Error</a> = S::<a class="type" href="../tokio_service/trait.NewService.html#associatedtype.Error" title="type tokio_service::NewService::Error">Error</a></code></span></h4>
<h4 id='associatedtype.Instance-2' class="type"><span id='Instance.t-2' class='invisible'><code>type <a href='#associatedtype.Instance' class="type">Instance</a> = S::<a class="type" href="../tokio_service/trait.NewService.html#associatedtype.Instance" title="type tokio_service::NewService::Instance">Instance</a></code></span></h4>
<h4 id='method.new_service-1' class="method"><span id='new_service.v-2' class='invisible'><code>fn <a href='#method.new_service' class='fnname'>new_service</a>(&amp;self) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a>&lt;S::<a class="type" href="../tokio_service/trait.NewService.html#associatedtype.Instance" title="type tokio_service::NewService::Instance">Instance</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_service/lib.rs.html#207-209' title='goto source code'>[src]</a></span></h4>
</div></span>
<h2 id='implementors' class='small-section-header'>
Implementors<a href='#implementors' class='anchor'></a>
</h2>
<ul class='item-list' id='implementors-list'>
<li><div class='out-of-band'><a class='srclink' href='../src/tokio_service/lib.rs.html#176-188' title='goto source code'>[src]</a></div><code>impl&lt;F, R&gt; NewService for F <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>() -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a>&lt;R&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;R: <a class="trait" href="../tokio_service/trait.Service.html" title="trait tokio_service::Service">Service</a>,&nbsp;</span><span class="where fmt-newline"> type <a href='#associatedtype.Request' class="type">Request</a> = R::<a class="type" href="../tokio_service/trait.Service.html#associatedtype.Request" title="type tokio_service::Service::Request">Request</a>;</span><span class="where fmt-newline"> type <a href='#associatedtype.Response' class="type">Response</a> = R::<a class="type" href="../tokio_service/trait.Service.html#associatedtype.Response" title="type tokio_service::Service::Response">Response</a>;</span><span class="where fmt-newline"> type <a href='#associatedtype.Error' class="type">Error</a> = R::<a class="type" href="../tokio_service/trait.Service.html#associatedtype.Error" title="type tokio_service::Service::Error">Error</a>;</span><span class="where fmt-newline"> type <a href='#associatedtype.Instance' class="type">Instance</a> = R;</span></code></li>
</ul><script type="text/javascript" async
src="../implementors/tokio_service/trait.NewService.js">
</script></section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>
<aside id="help" class="hidden">
<div>
<h1 class="hidden">Help</h1>
<div class="shortcuts">
<h2>Keyboard Shortcuts</h2>
<dl>
<dt><kbd>?</kbd></dt>
<dd>Show this help dialog</dd>
<dt><kbd>S</kbd></dt>
<dd>Focus the search field</dd>
<dt><kbd></kbd></dt>
<dd>Move up in search results</dd>
<dt><kbd></kbd></dt>
<dd>Move down in search results</dd>
<dt><kbd></kbd></dt>
<dd>Switch tab</dd>
<dt><kbd>&#9166;</kbd></dt>
<dd>Go to active search result</dd>
<dt><kbd>+</kbd></dt>
<dd>Expand all sections</dd>
<dt><kbd>-</kbd></dt>
<dd>Collapse all sections</dd>
</dl>
</div>
<div class="infos">
<h2>Search Tricks</h2>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code>, <code>enum</code>,
<code>trait</code>, <code>type</code>, <code>macro</code>,
and <code>const</code>.
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code> or <code>* -> vec</code>)
</p>
</div>
</div>
</aside>
<script>
window.rootPath = "../";
window.currentCrate = "tokio_service";
</script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>