chore: update docs

aembke · Sep 3, 2024 · ff9bbbb · ff9bbbb
1 parent a3204ba
commit ff9bbbb
Show file tree

Hide file tree

Showing 1,960 changed files with 231,511 additions and 232,469 deletions.
diff --git a/docs/glommio/crates.js → docs/.doc/glommio/crates.js b/docs/glommio/crates.js → docs/.doc/glommio/crates.js
diff --git a/docs/.doc/glommio/fred/all.html b/docs/.doc/glommio/fred/all.html
diff --git a/docs/.doc/glommio/fred/clients/index.html b/docs/.doc/glommio/fred/clients/index.html
@@ -0,0 +1,2 @@
+<!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="Redis client implementations."><title>fred::clients - 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 mod"><!--[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="#">Module clients</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li></ul></section><h2><a href="../index.html">In crate fred</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>Module <a href="../index.html">fred</a>::<wbr><a class="mod" href="#">clients</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/clients/mod.rs.html#1-36">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Redis client implementations.</p>
+</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.Pipeline.html" title="struct fred::clients::Pipeline">Pipeline</a></div><div class="desc docblock-short">Send a series of commands in a <a href="https://redis.io/docs/manual/pipelining/">pipeline</a>.</div></li><li><div class="item-name"><a class="struct" href="struct.RedisClient.html" title="struct fred::clients::RedisClient">Redis<wbr>Client</a></div><div class="desc docblock-short">A cheaply cloneable Redis client struct.</div></li><li><div class="item-name"><a class="struct" href="struct.RedisPool.html" title="struct fred::clients::RedisPool">Redis<wbr>Pool</a></div><div class="desc docblock-short">A cheaply cloneable round-robin client pool.</div></li><li><div class="item-name"><a class="struct" href="struct.Replicas.html" title="struct fred::clients::Replicas">Replicas</a><wbr><span class="stab portability" title="Available on crate feature `replicas` only"><code>replicas</code></span></div><div class="desc docblock-short">A struct for interacting with cluster replica nodes.</div></li><li><div class="item-name"><a class="struct" href="struct.SentinelClient.html" title="struct fred::clients::SentinelClient">Sentinel<wbr>Client</a><wbr><span class="stab portability" title="Available on crate feature `sentinel-client` only"><code>sentinel-client</code></span></div><div class="desc docblock-short">A struct for interacting directly with Sentinel nodes.</div></li><li><div class="item-name"><a class="struct" href="struct.SubscriberClient.html" title="struct fred::clients::SubscriberClient">Subscriber<wbr>Client</a><wbr><span class="stab portability" title="Available on crate feature `subscriber-client` only"><code>subscriber-client</code></span></div><div class="desc docblock-short">A subscriber client that will manage subscription state to any <a href="https://redis.io/docs/manual/pubsub/">pubsub</a> channels or patterns for the caller.</div></li><li><div class="item-name"><a class="struct" href="struct.Transaction.html" title="struct fred::clients::Transaction">Transaction</a><wbr><span class="stab portability" title="Available on crate feature `transactions` only"><code>transactions</code></span></div><div class="desc docblock-short">A cheaply cloneable transaction block.</div></li><li><div class="item-name"><a class="struct" href="struct.WithOptions.html" title="struct fred::clients::WithOptions">With<wbr>Options</a></div><div class="desc docblock-short">A client interface used to customize command configuration options.</div></li></ul></section></div></main></body></html>
diff --git a/...d/clients/options/struct.WithOptions.html → ...d/clients/options/struct.WithOptions.html b/...d/clients/options/struct.WithOptions.html → ...d/clients/options/struct.WithOptions.html
diff --git a/...red/clients/pipeline/struct.Pipeline.html → ...red/clients/pipeline/struct.Pipeline.html b/...red/clients/pipeline/struct.Pipeline.html → ...red/clients/pipeline/struct.Pipeline.html
diff --git a/...o/fred/clients/pool/struct.RedisPool.html → ...o/fred/clients/pool/struct.RedisPool.html b/...o/fred/clients/pool/struct.RedisPool.html → ...o/fred/clients/pool/struct.RedisPool.html
diff --git a/...ients/pubsub/struct.SubscriberClient.html → ...ients/pubsub/struct.SubscriberClient.html b/...ients/pubsub/struct.SubscriberClient.html → ...ients/pubsub/struct.SubscriberClient.html
diff --git a/...red/clients/redis/struct.RedisClient.html → ...red/clients/redis/struct.RedisClient.html b/...red/clients/redis/struct.RedisClient.html → ...red/clients/redis/struct.RedisClient.html
diff --git a/...fred/clients/replica/struct.Replicas.html → ...fred/clients/replica/struct.Replicas.html b/...fred/clients/replica/struct.Replicas.html → ...fred/clients/replica/struct.Replicas.html
diff --git a/...ients/sentinel/struct.SentinelClient.html → ...ients/sentinel/struct.SentinelClient.html b/...ients/sentinel/struct.SentinelClient.html → ...ients/sentinel/struct.SentinelClient.html
diff --git a/docs/glommio/fred/clients/sidebar-items.js → ...doc/glommio/fred/clients/sidebar-items.js b/docs/glommio/fred/clients/sidebar-items.js → ...doc/glommio/fred/clients/sidebar-items.js
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		<!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="Redis client implementations."><title>fred::clients - 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 mod"><!--[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="#">Module clients</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li></ul></section><h2><a href="../index.html">In crate fred</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>Module <a href="../index.html">fred</a>::<wbr><a class="mod" href="#">clients</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/clients/mod.rs.html#1-36">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Redis client implementations.</p>
		</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.Pipeline.html" title="struct fred::clients::Pipeline">Pipeline</a></div><div class="desc docblock-short">Send a series of commands in a <a href="https://redis.io/docs/manual/pipelining/">pipeline</a>.</div></li><li><div class="item-name"><a class="struct" href="struct.RedisClient.html" title="struct fred::clients::RedisClient">Redis<wbr>Client</a></div><div class="desc docblock-short">A cheaply cloneable Redis client struct.</div></li><li><div class="item-name"><a class="struct" href="struct.RedisPool.html" title="struct fred::clients::RedisPool">Redis<wbr>Pool</a></div><div class="desc docblock-short">A cheaply cloneable round-robin client pool.</div></li><li><div class="item-name"><a class="struct" href="struct.Replicas.html" title="struct fred::clients::Replicas">Replicas</a><wbr><span class="stab portability" title="Available on crate feature `replicas` only"><code>replicas</code></span></div><div class="desc docblock-short">A struct for interacting with cluster replica nodes.</div></li><li><div class="item-name"><a class="struct" href="struct.SentinelClient.html" title="struct fred::clients::SentinelClient">Sentinel<wbr>Client</a><wbr><span class="stab portability" title="Available on crate feature `sentinel-client` only"><code>sentinel-client</code></span></div><div class="desc docblock-short">A struct for interacting directly with Sentinel nodes.</div></li><li><div class="item-name"><a class="struct" href="struct.SubscriberClient.html" title="struct fred::clients::SubscriberClient">Subscriber<wbr>Client</a><wbr><span class="stab portability" title="Available on crate feature `subscriber-client` only"><code>subscriber-client</code></span></div><div class="desc docblock-short">A subscriber client that will manage subscription state to any <a href="https://redis.io/docs/manual/pubsub/">pubsub</a> channels or patterns for the caller.</div></li><li><div class="item-name"><a class="struct" href="struct.Transaction.html" title="struct fred::clients::Transaction">Transaction</a><wbr><span class="stab portability" title="Available on crate feature `transactions` only"><code>transactions</code></span></div><div class="desc docblock-short">A cheaply cloneable transaction block.</div></li><li><div class="item-name"><a class="struct" href="struct.WithOptions.html" title="struct fred::clients::WithOptions">With<wbr>Options</a></div><div class="desc docblock-short">A client interface used to customize command configuration options.</div></li></ul></section></div></main></body></html>