Skip to content

Commit

Permalink
chore: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
aembke committed Sep 3, 2024
1 parent 3882efd commit b48d289
Show file tree
Hide file tree
Showing 32 changed files with 580 additions and 88 deletions.
2 changes: 1 addition & 1 deletion docs/glommio/fred/all.html

Large diffs are not rendered by default.

11 changes: 11 additions & 0 deletions docs/glommio/fred/types/config/trait.CredentialProvider.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../fred/types/trait.CredentialProvider.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../fred/types/trait.CredentialProvider.html">../../../fred/types/trait.CredentialProvider.html</a>...</p>
<script>location.replace("../../../fred/types/trait.CredentialProvider.html" + location.search + location.hash);</script>
</body>
</html>
28 changes: 14 additions & 14 deletions docs/glommio/fred/types/enum.ServerConfig.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/glommio/fred/types/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/glommio/fred/types/sidebar-items.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions docs/glommio/fred/types/struct.Options.html

Large diffs are not rendered by default.

25 changes: 15 additions & 10 deletions docs/glommio/fred/types/struct.RedisConfig.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/glommio/fred/types/struct.SentinelConfig.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/glommio/fred/types/struct.TracingConfig.html

Large diffs are not rendered by default.

22 changes: 22 additions & 0 deletions docs/glommio/fred/types/trait.CredentialProvider.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<!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 trait that can be used to override the credentials used in each `AUTH` or `HELLO` command."><title>CredentialProvider in fred::types - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-fecee23daa4e8a6d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="fred" data-themes="" data-resource-suffix="" data-rustdoc-version="1.83.0-nightly (bd53aa3bf 2024-09-02)" data-channel="nightly" data-search-js="search-a99f1315e7cc5121.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-118b08c4c78b968e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-921df33f47b8780c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-3b12f09e550e0385.css"></noscript><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 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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../fred/index.html">fred</a><span class="version">9.2.0</span></h2></div><h2 class="location"><a href="#">Credential<wbr>Provider</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.fetch">fetch</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.refresh_interval">refresh_interval</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In fred::<wbr>types</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Trait <a href="../index.html">fred</a>::<wbr><a href="index.html">types</a>::<wbr><a class="trait" href="#">CredentialProvider</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../src/fred/types/config.rs.html#622-630">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub trait CredentialProvider: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + 'static {
// Required method
fn <a href="#tymethod.fetch" class="fn">fetch</a>&lt;'life0, 'life1, 'async_trait&gt;(
&amp;'life0 self,
server: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;&amp;'life1 <a class="struct" href="struct.Server.html" title="struct fred::types::Server">Server</a>&gt;,
) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>&lt;Output = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;(<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>&gt;, <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>&gt;), <a class="struct" href="../error/struct.RedisError.html" title="struct fred::error::RedisError">RedisError</a>&gt;&gt; + 'async_trait&gt;&gt;
<span class="where">where Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait</span>;

// Provided method
fn <a href="#method.refresh_interval" class="fn">refresh_interval</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</a>&gt; { ... }
}</code></pre><span class="item-info"><div class="stab portability">Available on <strong>crate feature <code>credential-provider</code></strong> only.</div></span><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A trait that can be used to override the credentials used in each <code>AUTH</code> or <code>HELLO</code> command.</p>
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.fetch" class="method"><a class="src rightside" href="../../src/fred/types/config.rs.html#624">source</a><h4 class="code-header">fn <a href="#tymethod.fetch" class="fn">fetch</a>&lt;'life0, 'life1, 'async_trait&gt;(
&amp;'life0 self,
server: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;&amp;'life1 <a class="struct" href="struct.Server.html" title="struct fred::types::Server">Server</a>&gt;,
) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>&lt;Output = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;(<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>&gt;, <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>&gt;), <a class="struct" href="../error/struct.RedisError.html" title="struct fred::error::RedisError">RedisError</a>&gt;&gt; + 'async_trait&gt;&gt;<div class="where">where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,</div></h4></section></summary><div class="docblock"><p>Read the username and password that should be used in the next <code>AUTH</code> or <code>HELLO</code> command.</p>
</div></details></div><h2 id="provided-methods" class="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="method.refresh_interval" class="method"><a class="src rightside" href="../../src/fred/types/config.rs.html#627-629">source</a><h4 class="code-header">fn <a href="#method.refresh_interval" class="fn">refresh_interval</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</a>&gt;</h4></section></summary><div class="docblock"><p>Configure the client to call <a href="trait.CredentialProvider.html#tymethod.fetch">fetch</a> and send <code>AUTH</code> or <code>HELLO</code> on some interval.</p>
</div></details></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../../trait.impl/fred/types/config/trait.CredentialProvider.js" async></script></section></div></main></body></html>
4 changes: 2 additions & 2 deletions docs/glommio/search-index.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/glommio/search.desc/fred/fred-desc-0-.js

Large diffs are not rendered by default.

Loading

0 comments on commit b48d289

Please sign in to comment.