| <!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="Types that implement this trait can give an estimate of how loaded they are."><meta name="keywords" content="rust, rustlang, rust-lang, Load"><title>Load in tower::load - 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">☰</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="#">Load</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.Metric">Metric</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.load">load</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In tower::load</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">load</a>::<wbr><a class="trait" href="#">Load</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/load/mod.rs.html#80-89">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 trait"><code>pub trait Load { |
| type <a href="#associatedtype.Metric" class="associatedtype">Metric</a>: PartialOrd; |
| |
| fn <a href="#tymethod.load" class="fnname">load</a>(&self) -> Self::<a class="associatedtype" href="trait.Load.html#associatedtype.Metric" title="type tower::load::Load::Metric">Metric</a>; |
| }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Types that implement this trait can give an estimate of how loaded they are.</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.Metric" class="method has-srclink"><a class="srclink rightside" href="../../src/tower/load/mod.rs.html#85">source</a><h4 class="code-header">type <a href="#associatedtype.Metric" class="associatedtype">Metric</a>: PartialOrd</h4></section></summary><div class="docblock"><p>A comparable load metric.</p> |
| <p>Lesser values indicate that the service is less loaded, and should be preferred for new |
| requests over another service with a higher value.</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.load" class="method has-srclink"><a class="srclink rightside" href="../../src/tower/load/mod.rs.html#88">source</a><h4 class="code-header">fn <a href="#tymethod.load" class="fnname">load</a>(&self) -> Self::<a class="associatedtype" href="trait.Load.html#associatedtype.Metric" title="type tower::load::Load::Metric">Metric</a></h4></section></summary><div class="docblock"><p>Estimate the service’s current load.</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-Load-for-ConcurrencyLimit%3CS%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/tower/limit/concurrency/service.rs.html#111-119">source</a><a href="#impl-Load-for-ConcurrencyLimit%3CS%3E" class="anchor"></a><h3 class="code-header">impl<S> <a class="trait" href="trait.Load.html" title="trait tower::load::Load">Load</a> for <a class="struct" href="../limit/concurrency/struct.ConcurrencyLimit.html" title="struct tower::limit::concurrency::ConcurrencyLimit">ConcurrencyLimit</a><S><span class="where fmt-newline">where<br> S: <a class="trait" href="trait.Load.html" title="trait tower::load::Load">Load</a>,</span></h3></section></summary><div class="impl-items"><section id="associatedtype.Metric-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Metric-1" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Metric" class="associatedtype">Metric</a> = <S as <a class="trait" href="trait.Load.html" title="trait tower::load::Load">Load</a>>::<a class="associatedtype" href="trait.Load.html#associatedtype.Metric" title="type tower::load::Load::Metric">Metric</a></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Load-for-RateLimit%3CS%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/tower/limit/rate/service.rs.html#123-131">source</a><a href="#impl-Load-for-RateLimit%3CS%3E" class="anchor"></a><h3 class="code-header">impl<S> <a class="trait" href="trait.Load.html" title="trait tower::load::Load">Load</a> for <a class="struct" href="../limit/rate/struct.RateLimit.html" title="struct tower::limit::rate::RateLimit">RateLimit</a><S><span class="where fmt-newline">where<br> S: <a class="trait" href="trait.Load.html" title="trait tower::load::Load">Load</a>,</span></h3></section></summary><div class="impl-items"><section id="associatedtype.Metric-2" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Metric-2" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Metric" class="associatedtype">Metric</a> = <S as <a class="trait" href="trait.Load.html" title="trait tower::load::Load">Load</a>>::<a class="associatedtype" href="trait.Load.html#associatedtype.Metric" title="type tower::load::Load::Metric">Metric</a></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Load-for-PeakEwma%3CS%2C%20C%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/tower/load/peak_ewma.rs.html#134-153">source</a><a href="#impl-Load-for-PeakEwma%3CS%2C%20C%3E" class="anchor"></a><h3 class="code-header">impl<S, C> <a class="trait" href="trait.Load.html" title="trait tower::load::Load">Load</a> for <a class="struct" href="peak_ewma/struct.PeakEwma.html" title="struct tower::load::peak_ewma::PeakEwma">PeakEwma</a><S, C></h3></section></summary><div class="impl-items"><section id="associatedtype.Metric-3" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Metric-3" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Metric" class="associatedtype">Metric</a> = <a class="struct" href="peak_ewma/struct.Cost.html" title="struct tower::load::peak_ewma::Cost">Cost</a></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Load-for-PendingRequests%3CS%2C%20C%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/tower/load/pending_requests.rs.html#67-74">source</a><a href="#impl-Load-for-PendingRequests%3CS%2C%20C%3E" class="anchor"></a><h3 class="code-header">impl<S, C> <a class="trait" href="trait.Load.html" title="trait tower::load::Load">Load</a> for <a class="struct" href="pending_requests/struct.PendingRequests.html" title="struct tower::load::pending_requests::PendingRequests">PendingRequests</a><S, C></h3></section></summary><div class="impl-items"><section id="associatedtype.Metric-4" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Metric-4" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Metric" class="associatedtype">Metric</a> = <a class="struct" href="pending_requests/struct.Count.html" title="struct tower::load::pending_requests::Count">Count</a></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Load-for-Constant%3CT%2C%20M%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/tower/load/constant.rs.html#35-41">source</a><a href="#impl-Load-for-Constant%3CT%2C%20M%3E" class="anchor"></a><h3 class="code-header">impl<T, M: Copy + PartialOrd> <a class="trait" href="trait.Load.html" title="trait tower::load::Load">Load</a> for <a class="struct" href="struct.Constant.html" title="struct tower::load::Constant">Constant</a><T, M></h3></section></summary><div class="impl-items"><section id="associatedtype.Metric-5" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Metric-5" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Metric" class="associatedtype">Metric</a> = M</h4></section></div></details></div><script src="../../implementors/tower/load/trait.Load.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> |
