1
0
mirror of https://github.com/actix/actix-extras.git synced 2025-03-12 16:42:49 +01:00
actix-extras/src/actix_redis/redis.rs.html

202 lines
17 KiB
HTML
Raw Normal View History

<!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="Source of the Rust file `actix-redis/src/redis.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>redis.rs - source</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc source"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../../actix_redis/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press S to search, ? for more options…" type="search"></div><button type="button" class="help-button">?</button>
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><pre class="line-numbers"><span id="1"> 1</span>
<span id="2"> 2</span>
<span id="3"> 3</span>
<span id="4"> 4</span>
<span id="5"> 5</span>
<span id="6"> 6</span>
<span id="7"> 7</span>
<span id="8"> 8</span>
<span id="9"> 9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
<span id="80">80</span>
<span id="81">81</span>
<span id="82">82</span>
<span id="83">83</span>
<span id="84">84</span>
<span id="85">85</span>
<span id="86">86</span>
<span id="87">87</span>
<span id="88">88</span>
<span id="89">89</span>
<span id="90">90</span>
<span id="91">91</span>
<span id="92">92</span>
<span id="93">93</span>
<span id="94">94</span>
<span id="95">95</span>
<span id="96">96</span>
<span id="97">97</span>
<span id="98">98</span>
2020-07-19 20:22:04 +00:00
</pre><div class="example-wrap"><pre class="rust ">
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">collections</span>::<span class="ident">VecDeque</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">net</span>::<span class="ident">SocketAddr</span>;
2020-07-19 20:22:04 +00:00
<span class="kw">use</span> <span class="ident">redis_async</span>::<span class="ident">client</span>::{<span class="ident">paired_connect</span>, <span class="ident">PairedConnection</span>};
<span class="kw">use</span> <span class="ident">redis_async</span>::<span class="ident">resp</span>::<span class="ident">RespValue</span>;
<span class="kw">use</span> <span class="ident">tokio</span>::<span class="ident">sync</span>::<span class="ident">Mutex</span>;
<span class="kw">use</span> <span class="ident">trust_dns_resolver</span>::<span class="ident">config</span>::{<span class="ident">ResolverConfig</span>, <span class="ident">ResolverOpts</span>};
<span class="kw">use</span> <span class="ident">trust_dns_resolver</span>::<span class="ident">TokioAsyncResolver</span> <span class="kw">as</span> <span class="ident">AsyncResolver</span>;
2020-07-19 20:22:04 +00:00
<span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">Error</span>;
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">RedisClient</span> {
2020-07-19 20:22:04 +00:00
<span class="ident">addr</span>: <span class="ident">String</span>,
<span class="ident">connection</span>: <span class="ident">Mutex</span><span class="op">&lt;</span><span class="prelude-ty">Option</span><span class="op">&lt;</span><span class="ident">PairedConnection</span><span class="op">&gt;</span><span class="op">&gt;</span>,
2020-07-19 20:22:04 +00:00
}
<span class="kw">impl</span> <span class="ident">RedisClient</span> {
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>(<span class="ident">addr</span>: <span class="kw">impl</span> <span class="ident">Into</span><span class="op">&lt;</span><span class="ident">String</span><span class="op">&gt;</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="self">Self</span> {
<span class="self">Self</span> {
<span class="ident">addr</span>: <span class="ident">addr</span>.<span class="ident">into</span>(),
<span class="ident">connection</span>: <span class="ident">Mutex</span>::<span class="ident">new</span>(<span class="prelude-val">None</span>),
}
2020-07-19 20:22:04 +00:00
}
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">get_connection</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="prelude-ty">Result</span><span class="op">&lt;</span><span class="ident">PairedConnection</span>, <span class="ident">Error</span><span class="op">&gt;</span> {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">connection</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">connection</span>.<span class="ident">lock</span>().<span class="kw">await</span>;
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="kw-2">ref</span> <span class="ident">connection</span>) <span class="op">=</span> <span class="kw-2">*</span><span class="ident">connection</span> {
<span class="kw">return</span> <span class="prelude-val">Ok</span>(<span class="ident">connection</span>.<span class="ident">clone</span>());
}
2020-07-19 20:22:04 +00:00
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">addrs</span> <span class="op">=</span> <span class="ident">resolve</span>(<span class="kw-2">&amp;</span><span class="self">self</span>.<span class="ident">addr</span>).<span class="kw">await</span><span class="question-mark">?</span>;
<span class="kw">loop</span> {
<span class="comment">// try to connect</span>
<span class="kw">let</span> <span class="ident">socket_addr</span> <span class="op">=</span> <span class="ident">addrs</span>.<span class="ident">pop_front</span>().<span class="ident">ok_or_else</span>(<span class="op">|</span><span class="op">|</span> {
<span class="ident">log</span>::<span class="macro">warn</span><span class="macro">!</span>(<span class="string">&quot;Cannot connect to {}.&quot;</span>, <span class="self">self</span>.<span class="ident">addr</span>);
<span class="ident">Error</span>::<span class="ident">NotConnected</span>
})<span class="question-mark">?</span>;
<span class="kw">match</span> <span class="ident">paired_connect</span>(<span class="ident">socket_addr</span>).<span class="kw">await</span> {
<span class="prelude-val">Ok</span>(<span class="ident">conn</span>) <span class="op">=</span><span class="op">&gt;</span> {
<span class="kw-2">*</span><span class="ident">connection</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">conn</span>.<span class="ident">clone</span>());
<span class="kw">return</span> <span class="prelude-val">Ok</span>(<span class="ident">conn</span>);
2020-07-19 20:22:04 +00:00
}
<span class="prelude-val">Err</span>(<span class="ident">err</span>) <span class="op">=</span><span class="op">&gt;</span> <span class="ident">log</span>::<span class="macro">warn</span><span class="macro">!</span>(
<span class="string">&quot;Attempt to connect to {} as {} failed: {}.&quot;</span>,
<span class="self">self</span>.<span class="ident">addr</span>,
<span class="ident">socket_addr</span>,
<span class="ident">err</span>
),
}
2020-07-19 20:22:04 +00:00
}
}
<span class="kw">pub</span> <span class="kw">async</span> <span class="kw">fn</span> <span class="ident">send</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">req</span>: <span class="ident">RespValue</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="prelude-ty">Result</span><span class="op">&lt;</span><span class="ident">RespValue</span>, <span class="ident">Error</span><span class="op">&gt;</span> {
<span class="kw">let</span> <span class="ident">res</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">get_connection</span>().<span class="kw">await</span><span class="question-mark">?</span>.<span class="ident">send</span>(<span class="ident">req</span>).<span class="kw">await</span><span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(<span class="ident">res</span>)
2020-07-19 20:22:04 +00:00
}
}
<span class="kw">fn</span> <span class="ident">parse_addr</span>(<span class="ident">addr</span>: <span class="kw-2">&amp;</span><span class="ident">str</span>, <span class="ident">default_port</span>: <span class="ident">u16</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="prelude-ty">Option</span><span class="op">&lt;</span>(<span class="kw-2">&amp;</span><span class="ident">str</span>, <span class="ident">u16</span>)<span class="op">&gt;</span> {
<span class="comment">// split the string by &#39;:&#39; and convert the second part to u16</span>
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">parts_iter</span> <span class="op">=</span> <span class="ident">addr</span>.<span class="ident">splitn</span>(<span class="number">2</span>, <span class="string">&#39;:&#39;</span>);
<span class="kw">let</span> <span class="ident">host</span> <span class="op">=</span> <span class="ident">parts_iter</span>.<span class="ident">next</span>()<span class="question-mark">?</span>;
<span class="kw">let</span> <span class="ident">port_str</span> <span class="op">=</span> <span class="ident">parts_iter</span>.<span class="ident">next</span>().<span class="ident">unwrap_or</span>(<span class="string">&quot;&quot;</span>);
<span class="kw">let</span> <span class="ident">port</span>: <span class="ident">u16</span> <span class="op">=</span> <span class="ident">port_str</span>.<span class="ident">parse</span>().<span class="ident">unwrap_or</span>(<span class="ident">default_port</span>);
<span class="prelude-val">Some</span>((<span class="ident">host</span>, <span class="ident">port</span>))
2020-07-19 20:22:04 +00:00
}
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">resolve</span>(<span class="ident">addr</span>: <span class="kw-2">&amp;</span><span class="ident">str</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="prelude-ty">Result</span><span class="op">&lt;</span><span class="ident">VecDeque</span><span class="op">&lt;</span><span class="ident">SocketAddr</span><span class="op">&gt;</span>, <span class="ident">Error</span><span class="op">&gt;</span> {
<span class="comment">// try to parse as a regular SocketAddr first</span>
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Ok</span>(<span class="ident">addr</span>) <span class="op">=</span> <span class="ident">addr</span>.<span class="ident">parse</span>::<span class="op">&lt;</span><span class="ident">SocketAddr</span><span class="op">&gt;</span>() {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">addrs</span> <span class="op">=</span> <span class="ident">VecDeque</span>::<span class="ident">new</span>();
<span class="ident">addrs</span>.<span class="ident">push_back</span>(<span class="ident">addr</span>);
<span class="kw">return</span> <span class="prelude-val">Ok</span>(<span class="ident">addrs</span>);
}
2020-07-19 20:22:04 +00:00
<span class="kw">let</span> (<span class="ident">host</span>, <span class="ident">port</span>) <span class="op">=</span> <span class="ident">parse_addr</span>(<span class="ident">addr</span>, <span class="number">6379</span>).<span class="ident">ok_or</span>(<span class="ident">Error</span>::<span class="ident">InvalidAddress</span>)<span class="question-mark">?</span>;
2020-07-19 20:22:04 +00:00
<span class="comment">// we need to do dns resolution</span>
<span class="kw">let</span> <span class="ident">resolver</span> <span class="op">=</span> <span class="ident">AsyncResolver</span>::<span class="ident">tokio_from_system_conf</span>()
.<span class="ident">or_else</span>(<span class="op">|</span><span class="ident">err</span><span class="op">|</span> {
<span class="ident">log</span>::<span class="macro">warn</span><span class="macro">!</span>(<span class="string">&quot;Cannot create system DNS resolver: {}&quot;</span>, <span class="ident">err</span>);
<span class="ident">AsyncResolver</span>::<span class="ident">tokio</span>(<span class="ident">ResolverConfig</span>::<span class="ident">default</span>(), <span class="ident">ResolverOpts</span>::<span class="ident">default</span>())
})
.<span class="ident">map_err</span>(<span class="op">|</span><span class="ident">err</span><span class="op">|</span> {
<span class="ident">log</span>::<span class="macro">error</span><span class="macro">!</span>(<span class="string">&quot;Cannot create DNS resolver: {}&quot;</span>, <span class="ident">err</span>);
<span class="ident">Error</span>::<span class="ident">ResolveError</span>
})<span class="question-mark">?</span>;
<span class="kw">let</span> <span class="ident">addrs</span> <span class="op">=</span> <span class="ident">resolver</span>
.<span class="ident">lookup_ip</span>(<span class="ident">host</span>)
.<span class="kw">await</span>
.<span class="ident">map_err</span>(<span class="op">|</span><span class="kw">_</span><span class="op">|</span> <span class="ident">Error</span>::<span class="ident">ResolveError</span>)<span class="question-mark">?</span>
.<span class="ident">into_iter</span>()
.<span class="ident">map</span>(<span class="op">|</span><span class="ident">ip</span><span class="op">|</span> <span class="ident">SocketAddr</span>::<span class="ident">new</span>(<span class="ident">ip</span>, <span class="ident">port</span>))
.<span class="ident">collect</span>();
<span class="prelude-val">Ok</span>(<span class="ident">addrs</span>)
2020-07-19 20:22:04 +00:00
}
</pre></div>
</section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../../";window.currentCrate = "actix_redis";</script><script src="../../main.js"></script><script src="../../source-script.js"></script><script src="../../source-files.js"></script><script defer src="../../search-index.js"></script></body></html>