Skip to content

Commit

Permalink
chore: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@aembke
aembke committed Sep 4, 2024
1 parent b48d289 commit cd14e6c
Show file tree
Hide file tree
Showing 106 changed files with 1,936 additions and 830 deletions.
66 changes: 34 additions & 32 deletions docs/glommio/fred/clients/struct.Transaction.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/glommio/fred/interfaces/trait.AclInterface.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -102,4 +102,4 @@
<p><a href="https://redis.io/commands/acl-log">https://redis.io/commands/acl-log</a></p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.acl_log_reset" class="method"><a class="src rightside" href="../../src/fred/commands/interfaces/acl.rs.html#12">source</a><h4 class="code-header">fn <a href="#method.acl_log_reset" class="fn">acl_log_reset</a>(&amp;self) -&gt; impl <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="type" href="type.RedisResult.html" title="type fred::interfaces::RedisResult">RedisResult</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>&gt;&gt;</h4></section></summary><div class="docblock"><p>Clear the ACL security events logs.</p>
<p><a href="https://redis.io/commands/acl-log">https://redis.io/commands/acl-log</a></p>
</div></details></div><h2 id="object-safety" class="section-header">Object Safety<a href="#object-safety" class="anchor">§</a></h2><div class="object-safety-info">This trait is <b>not</b> <a href="https://doc.rust-lang.org/nightly/reference/items/traits.html#object-safety">object safe</a>.</div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-AclInterface-for-RedisClient" class="impl"><a class="src rightside" href="../../src/fred/clients/redis.rs.html#70">source</a><a href="#impl-AclInterface-for-RedisClient" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.AclInterface.html" title="trait fred::interfaces::AclInterface">AclInterface</a> for <a class="struct" href="../clients/struct.RedisClient.html" title="struct fred::clients::RedisClient">RedisClient</a></h3></section><section id="impl-AclInterface-for-RedisPool" class="impl"><a class="src rightside" href="../../src/fred/clients/pool.rs.html#344">source</a><a href="#impl-AclInterface-for-RedisPool" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.AclInterface.html" title="trait fred::interfaces::AclInterface">AclInterface</a> for <a class="struct" href="../clients/struct.RedisPool.html" title="struct fred::clients::RedisPool">RedisPool</a></h3></section><section id="impl-AclInterface-for-SentinelClient" class="impl"><a class="src rightside" href="../../src/fred/clients/sentinel.rs.html#51">source</a><a href="#impl-AclInterface-for-SentinelClient" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.AclInterface.html" title="trait fred::interfaces::AclInterface">AclInterface</a> for <a class="struct" href="../clients/struct.SentinelClient.html" title="struct fred::clients::SentinelClient">SentinelClient</a></h3></section><section id="impl-AclInterface-for-SubscriberClient" class="impl"><a class="src rightside" href="../../src/fred/clients/pubsub.rs.html#85">source</a><a href="#impl-AclInterface-for-SubscriberClient" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.AclInterface.html" title="trait fred::interfaces::AclInterface">AclInterface</a> for <a class="struct" href="../clients/struct.SubscriberClient.html" title="struct fred::clients::SubscriberClient">SubscriberClient</a></h3></section><section id="impl-AclInterface-for-Transaction" class="impl"><a class="src rightside" href="../../src/fred/clients/transaction.rs.html#83">source</a><a href="#impl-AclInterface-for-Transaction" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.AclInterface.html" title="trait fred::interfaces::AclInterface">AclInterface</a> for <a class="struct" href="../clients/struct.Transaction.html" title="struct fred::clients::Transaction">Transaction</a></h3></section><section id="impl-AclInterface-for-Pipeline%3CC%3E" class="impl"><a class="src rightside" href="../../src/fred/clients/pipeline.rs.html#126">source</a><a href="#impl-AclInterface-for-Pipeline%3CC%3E" class="anchor">§</a><h3 class="code-header">impl&lt;C: <a class="trait" href="trait.AclInterface.html" title="trait fred::interfaces::AclInterface">AclInterface</a>&gt; <a class="trait" href="trait.AclInterface.html" title="trait fred::interfaces::AclInterface">AclInterface</a> for <a class="struct" href="../clients/struct.Pipeline.html" title="struct fred::clients::Pipeline">Pipeline</a>&lt;C&gt;</h3></section><section id="impl-AclInterface-for-WithOptions%3CC%3E" class="impl"><a class="src rightside" href="../../src/fred/clients/options.rs.html#100">source</a><a href="#impl-AclInterface-for-WithOptions%3CC%3E" class="anchor">§</a><h3 class="code-header">impl&lt;C: <a class="trait" href="trait.AclInterface.html" title="trait fred::interfaces::AclInterface">AclInterface</a>&gt; <a class="trait" href="trait.AclInterface.html" title="trait fred::interfaces::AclInterface">AclInterface</a> for <a class="struct" href="../clients/struct.WithOptions.html" title="struct fred::clients::WithOptions">WithOptions</a>&lt;C&gt;</h3></section></div><script src="../../trait.impl/fred/commands/interfaces/acl/trait.AclInterface.js" async></script></section></div></main></body></html>
</div></details></div><h2 id="object-safety" class="section-header">Object Safety<a href="#object-safety" class="anchor">§</a></h2><div class="object-safety-info">This trait is <b>not</b> <a href="https://doc.rust-lang.org/nightly/reference/items/traits.html#object-safety">object safe</a>.</div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-AclInterface-for-RedisClient" class="impl"><a class="src rightside" href="../../src/fred/clients/redis.rs.html#70">source</a><a href="#impl-AclInterface-for-RedisClient" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.AclInterface.html" title="trait fred::interfaces::AclInterface">AclInterface</a> for <a class="struct" href="../clients/struct.RedisClient.html" title="struct fred::clients::RedisClient">RedisClient</a></h3></section><section id="impl-AclInterface-for-RedisPool" class="impl"><a class="src rightside" href="../../src/fred/clients/pool.rs.html#344">source</a><a href="#impl-AclInterface-for-RedisPool" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.AclInterface.html" title="trait fred::interfaces::AclInterface">AclInterface</a> for <a class="struct" href="../clients/struct.RedisPool.html" title="struct fred::clients::RedisPool">RedisPool</a></h3></section><section id="impl-AclInterface-for-SentinelClient" class="impl"><a class="src rightside" href="../../src/fred/clients/sentinel.rs.html#51">source</a><a href="#impl-AclInterface-for-SentinelClient" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.AclInterface.html" title="trait fred::interfaces::AclInterface">AclInterface</a> for <a class="struct" href="../clients/struct.SentinelClient.html" title="struct fred::clients::SentinelClient">SentinelClient</a></h3></section><section id="impl-AclInterface-for-SubscriberClient" class="impl"><a class="src rightside" href="../../src/fred/clients/pubsub.rs.html#85">source</a><a href="#impl-AclInterface-for-SubscriberClient" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.AclInterface.html" title="trait fred::interfaces::AclInterface">AclInterface</a> for <a class="struct" href="../clients/struct.SubscriberClient.html" title="struct fred::clients::SubscriberClient">SubscriberClient</a></h3></section><section id="impl-AclInterface-for-Transaction" class="impl"><a class="src rightside" href="../../src/fred/clients/transaction.rs.html#88">source</a><a href="#impl-AclInterface-for-Transaction" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.AclInterface.html" title="trait fred::interfaces::AclInterface">AclInterface</a> for <a class="struct" href="../clients/struct.Transaction.html" title="struct fred::clients::Transaction">Transaction</a></h3></section><section id="impl-AclInterface-for-Pipeline%3CC%3E" class="impl"><a class="src rightside" href="../../src/fred/clients/pipeline.rs.html#126">source</a><a href="#impl-AclInterface-for-Pipeline%3CC%3E" class="anchor">§</a><h3 class="code-header">impl&lt;C: <a class="trait" href="trait.AclInterface.html" title="trait fred::interfaces::AclInterface">AclInterface</a>&gt; <a class="trait" href="trait.AclInterface.html" title="trait fred::interfaces::AclInterface">AclInterface</a> for <a class="struct" href="../clients/struct.Pipeline.html" title="struct fred::clients::Pipeline">Pipeline</a>&lt;C&gt;</h3></section><section id="impl-AclInterface-for-WithOptions%3CC%3E" class="impl"><a class="src rightside" href="../../src/fred/clients/options.rs.html#100">source</a><a href="#impl-AclInterface-for-WithOptions%3CC%3E" class="anchor">§</a><h3 class="code-header">impl&lt;C: <a class="trait" href="trait.AclInterface.html" title="trait fred::interfaces::AclInterface">AclInterface</a>&gt; <a class="trait" href="trait.AclInterface.html" title="trait fred::interfaces::AclInterface">AclInterface</a> for <a class="struct" href="../clients/struct.WithOptions.html" title="struct fred::clients::WithOptions">WithOptions</a>&lt;C&gt;</h3></section></div><script src="../../trait.impl/fred/commands/interfaces/acl/trait.AclInterface.js" async></script></section></div></main></body></html>
2 changes: 1 addition & 1 deletion docs/glommio/fred/interfaces/trait.AuthInterface.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@
) -&gt; impl <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="type" href="type.RedisResult.html" title="type fred::interfaces::RedisResult">RedisResult</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>&gt;&gt;</h4></section></summary><div class="docblock"><p>Switch to a different protocol, optionally authenticating in the process.</p>
<p>If running against clustered servers this function will issue the HELLO command to each server concurrently.</p>
<p><a href="https://redis.io/commands/hello">https://redis.io/commands/hello</a></p>
</div></details></div><h2 id="object-safety" class="section-header">Object Safety<a href="#object-safety" class="anchor">§</a></h2><div class="object-safety-info">This trait is <b>not</b> <a href="https://doc.rust-lang.org/nightly/reference/items/traits.html#object-safety">object safe</a>.</div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-AuthInterface-for-RedisClient" class="impl"><a class="src rightside" href="../../src/fred/clients/redis.rs.html#105">source</a><a href="#impl-AuthInterface-for-RedisClient" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.AuthInterface.html" title="trait fred::interfaces::AuthInterface">AuthInterface</a> for <a class="struct" href="../clients/struct.RedisClient.html" title="struct fred::clients::RedisClient">RedisClient</a></h3></section><section id="impl-AuthInterface-for-SentinelClient" class="impl"><a class="src rightside" href="../../src/fred/clients/sentinel.rs.html#58">source</a><a href="#impl-AuthInterface-for-SentinelClient" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.AuthInterface.html" title="trait fred::interfaces::AuthInterface">AuthInterface</a> for <a class="struct" href="../clients/struct.SentinelClient.html" title="struct fred::clients::SentinelClient">SentinelClient</a></h3></section><section id="impl-AuthInterface-for-SubscriberClient" class="impl"><a class="src rightside" href="../../src/fred/clients/pubsub.rs.html#120">source</a><a href="#impl-AuthInterface-for-SubscriberClient" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.AuthInterface.html" title="trait fred::interfaces::AuthInterface">AuthInterface</a> for <a class="struct" href="../clients/struct.SubscriberClient.html" title="struct fred::clients::SubscriberClient">SubscriberClient</a></h3></section><section id="impl-AuthInterface-for-Transaction" class="impl"><a class="src rightside" href="../../src/fred/clients/transaction.rs.html#111">source</a><a href="#impl-AuthInterface-for-Transaction" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.AuthInterface.html" title="trait fred::interfaces::AuthInterface">AuthInterface</a> for <a class="struct" href="../clients/struct.Transaction.html" title="struct fred::clients::Transaction">Transaction</a></h3></section><section id="impl-AuthInterface-for-Pipeline%3CC%3E" class="impl"><a class="src rightside" href="../../src/fred/clients/pipeline.rs.html#159">source</a><a href="#impl-AuthInterface-for-Pipeline%3CC%3E" class="anchor">§</a><h3 class="code-header">impl&lt;C: <a class="trait" href="trait.AuthInterface.html" title="trait fred::interfaces::AuthInterface">AuthInterface</a>&gt; <a class="trait" href="trait.AuthInterface.html" title="trait fred::interfaces::AuthInterface">AuthInterface</a> for <a class="struct" href="../clients/struct.Pipeline.html" title="struct fred::clients::Pipeline">Pipeline</a>&lt;C&gt;</h3><span class="item-info"><div class="stab portability">Available on <strong>crate feature <code>i-server</code></strong> only.</div></span></section><section id="impl-AuthInterface-for-WithOptions%3CC%3E" class="impl"><a class="src rightside" href="../../src/fred/clients/options.rs.html#133">source</a><a href="#impl-AuthInterface-for-WithOptions%3CC%3E" class="anchor">§</a><h3 class="code-header">impl&lt;C: <a class="trait" href="trait.AuthInterface.html" title="trait fred::interfaces::AuthInterface">AuthInterface</a>&gt; <a class="trait" href="trait.AuthInterface.html" title="trait fred::interfaces::AuthInterface">AuthInterface</a> for <a class="struct" href="../clients/struct.WithOptions.html" title="struct fred::clients::WithOptions">WithOptions</a>&lt;C&gt;</h3><span class="item-info"><div class="stab portability">Available on <strong>crate feature <code>i-server</code></strong> only.</div></span></section></div><script src="../../trait.impl/fred/interfaces/trait.AuthInterface.js" async></script></section></div></main></body></html>
</div></details></div><h2 id="object-safety" class="section-header">Object Safety<a href="#object-safety" class="anchor">§</a></h2><div class="object-safety-info">This trait is <b>not</b> <a href="https://doc.rust-lang.org/nightly/reference/items/traits.html#object-safety">object safe</a>.</div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-AuthInterface-for-RedisClient" class="impl"><a class="src rightside" href="../../src/fred/clients/redis.rs.html#105">source</a><a href="#impl-AuthInterface-for-RedisClient" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.AuthInterface.html" title="trait fred::interfaces::AuthInterface">AuthInterface</a> for <a class="struct" href="../clients/struct.RedisClient.html" title="struct fred::clients::RedisClient">RedisClient</a></h3></section><section id="impl-AuthInterface-for-SentinelClient" class="impl"><a class="src rightside" href="../../src/fred/clients/sentinel.rs.html#58">source</a><a href="#impl-AuthInterface-for-SentinelClient" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.AuthInterface.html" title="trait fred::interfaces::AuthInterface">AuthInterface</a> for <a class="struct" href="../clients/struct.SentinelClient.html" title="struct fred::clients::SentinelClient">SentinelClient</a></h3></section><section id="impl-AuthInterface-for-SubscriberClient" class="impl"><a class="src rightside" href="../../src/fred/clients/pubsub.rs.html#120">source</a><a href="#impl-AuthInterface-for-SubscriberClient" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.AuthInterface.html" title="trait fred::interfaces::AuthInterface">AuthInterface</a> for <a class="struct" href="../clients/struct.SubscriberClient.html" title="struct fred::clients::SubscriberClient">SubscriberClient</a></h3></section><section id="impl-AuthInterface-for-Transaction" class="impl"><a class="src rightside" href="../../src/fred/clients/transaction.rs.html#116">source</a><a href="#impl-AuthInterface-for-Transaction" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.AuthInterface.html" title="trait fred::interfaces::AuthInterface">AuthInterface</a> for <a class="struct" href="../clients/struct.Transaction.html" title="struct fred::clients::Transaction">Transaction</a></h3></section><section id="impl-AuthInterface-for-Pipeline%3CC%3E" class="impl"><a class="src rightside" href="../../src/fred/clients/pipeline.rs.html#159">source</a><a href="#impl-AuthInterface-for-Pipeline%3CC%3E" class="anchor">§</a><h3 class="code-header">impl&lt;C: <a class="trait" href="trait.AuthInterface.html" title="trait fred::interfaces::AuthInterface">AuthInterface</a>&gt; <a class="trait" href="trait.AuthInterface.html" title="trait fred::interfaces::AuthInterface">AuthInterface</a> for <a class="struct" href="../clients/struct.Pipeline.html" title="struct fred::clients::Pipeline">Pipeline</a>&lt;C&gt;</h3><span class="item-info"><div class="stab portability">Available on <strong>crate feature <code>i-server</code></strong> only.</div></span></section><section id="impl-AuthInterface-for-WithOptions%3CC%3E" class="impl"><a class="src rightside" href="../../src/fred/clients/options.rs.html#133">source</a><a href="#impl-AuthInterface-for-WithOptions%3CC%3E" class="anchor">§</a><h3 class="code-header">impl&lt;C: <a class="trait" href="trait.AuthInterface.html" title="trait fred::interfaces::AuthInterface">AuthInterface</a>&gt; <a class="trait" href="trait.AuthInterface.html" title="trait fred::interfaces::AuthInterface">AuthInterface</a> for <a class="struct" href="../clients/struct.WithOptions.html" title="struct fred::clients::WithOptions">WithOptions</a>&lt;C&gt;</h3><span class="item-info"><div class="stab portability">Available on <strong>crate feature <code>i-server</code></strong> only.</div></span></section></div><script src="../../trait.impl/fred/interfaces/trait.AuthInterface.js" async></script></section></div></main></body></html>
Loading

0 comments on commit cd14e6c

Please sign in to comment.