blob: 432258ef247b3ee363942633f9aee3e42f769d42 [file] [log] [blame]
<!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="A dynamically changing set of related services."><meta name="keywords" content="rust, rustlang, rust-lang, Discover"><title>Discover in tower::discover - 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 trait"><!--[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">&#9776;</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="#">Discover</a></h2><div class="sidebar-elems"><section><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Error">Error</a></li><li><a href="#associatedtype.Key">Key</a></li><li><a href="#associatedtype.Service">Service</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.poll_discover">poll_discover</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In tower::discover</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">Trait <a href="../index.html">tower</a>::<wbr><a href="index.html">discover</a>::<wbr><a class="trait" href="#">Discover</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/discover/mod.rs.html#55-74">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="item-decl"><pre class="rust trait"><code>pub trait Discover: Sealed&lt;<a class="enum" href="enum.Change.html" title="enum tower::discover::Change">Change</a>&lt;(), ()&gt;&gt; {
type <a href="#associatedtype.Key" class="associatedtype">Key</a>: Eq;
type <a href="#associatedtype.Service" class="associatedtype">Service</a>;
type <a href="#associatedtype.Error" class="associatedtype">Error</a>;
fn <a href="#tymethod.poll_discover" class="fnname">poll_discover</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;self: Pin&lt;&amp;mut Self&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;cx: &amp;mut Context&lt;'_&gt;<br>&nbsp;&nbsp;&nbsp;&nbsp;) -&gt; Poll&lt;Option&lt;Result&lt;<a class="enum" href="enum.Change.html" title="enum tower::discover::Change">Change</a>&lt;Self::<a class="associatedtype" href="trait.Discover.html#associatedtype.Key" title="type tower::discover::Discover::Key">Key</a>, Self::<a class="associatedtype" href="trait.Discover.html#associatedtype.Service" title="type tower::discover::Discover::Service">Service</a>&gt;, Self::<a class="associatedtype" href="trait.Discover.html#associatedtype.Error" title="type tower::discover::Discover::Error">Error</a>&gt;&gt;&gt;;
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A dynamically changing set of related services.</p>
<p>As new services arrive and old services are retired,
<a href="enum.Change.html" title="Change"><code>Change</code></a>s are returned which provide unique identifiers
for the services.</p>
<p>See the module documentation for more details.</p>
</div></details><h2 id="required-associated-types" class="small-section-header">Required Associated Types<a href="#required-associated-types" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="associatedtype.Key" class="method has-srclink"><a class="srclink rightside" href="../../src/tower/discover/mod.rs.html#59">source</a><h4 class="code-header">type <a href="#associatedtype.Key" class="associatedtype">Key</a>: Eq</h4></section></summary><div class="docblock"><p>A unique identifier for each active service.</p>
<p>An identifier can be re-used once a <a href="enum.Change.html#variant.Remove" title="Change::Remove"><code>Change::Remove</code></a> has been yielded for its service.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="associatedtype.Service" class="method has-srclink"><a class="srclink rightside" href="../../src/tower/discover/mod.rs.html#64">source</a><h4 class="code-header">type <a href="#associatedtype.Service" class="associatedtype">Service</a></h4></section></summary><div class="docblock"><p>The type of <a href="../trait.Service.html"><code>Service</code></a> yielded by this <a href="trait.Discover.html" title="Discover"><code>Discover</code></a>.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="associatedtype.Error" class="method has-srclink"><a class="srclink rightside" href="../../src/tower/discover/mod.rs.html#67">source</a><h4 class="code-header">type <a href="#associatedtype.Error" class="associatedtype">Error</a></h4></section></summary><div class="docblock"><p>Error produced during discovery</p>
</div></details></div><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.poll_discover" class="method has-srclink"><a class="srclink rightside" href="../../src/tower/discover/mod.rs.html#70-73">source</a><h4 class="code-header">fn <a href="#tymethod.poll_discover" class="fnname">poll_discover</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;self: Pin&lt;&amp;mut Self&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;cx: &amp;mut Context&lt;'_&gt;<br>) -&gt; Poll&lt;Option&lt;Result&lt;<a class="enum" href="enum.Change.html" title="enum tower::discover::Change">Change</a>&lt;Self::<a class="associatedtype" href="trait.Discover.html#associatedtype.Key" title="type tower::discover::Discover::Key">Key</a>, Self::<a class="associatedtype" href="trait.Discover.html#associatedtype.Service" title="type tower::discover::Discover::Service">Service</a>&gt;, Self::<a class="associatedtype" href="trait.Discover.html#associatedtype.Error" title="type tower::discover::Discover::Error">Error</a>&gt;&gt;&gt;</h4></section></summary><div class="docblock"><p>Yields the next discovery change set.</p>
</div></details></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div id="implementors-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Discover-for-D" class="impl has-srclink"><a class="srclink rightside" href="../../src/tower/discover/mod.rs.html#83-98">source</a><a href="#impl-Discover-for-D" class="anchor"></a><h3 class="code-header">impl&lt;K, S, E, D:&nbsp;?Sized&gt; <a class="trait" href="trait.Discover.html" title="trait tower::discover::Discover">Discover</a> for D<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;D: <a class="trait" href="../../futures_core/stream/trait.TryStream.html" title="trait futures_core::stream::TryStream">TryStream</a>&lt;Ok = <a class="enum" href="enum.Change.html" title="enum tower::discover::Change">Change</a>&lt;K, S&gt;, Error = E&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;K: Eq,</span></h3></section></summary><div class="impl-items"><section id="associatedtype.Key-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Key-1" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Key" class="associatedtype">Key</a> = K</h4></section><section id="associatedtype.Service-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Service-1" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Service" class="associatedtype">Service</a> = S</h4></section><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 href="#associatedtype.Error" class="associatedtype">Error</a> = E</h4></section></div></details></div><script src="../../implementors/tower/discover/trait.Discover.js" async></script></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>