1
0
mirror of https://github.com/actix/actix-extras.git synced 2025-03-15 09:53:05 +01:00

87 lines
7.4 KiB
HTML
Raw Normal View History

2020-07-19 20:22:04 +00:00
<!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 to the Rust file `actix-redis/src/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.rs.html -- 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="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="shortcut icon" href="../../favicon.ico"><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'><img src='../../rust-logo.png' alt='logo'></div></a></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></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><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>
2020-07-19 20:22:04 +00:00
</pre><div class="example-wrap"><pre class="rust ">
<span class="doccomment">//! Redis integration for Actix framework.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! ## Documentation</span>
<span class="doccomment">//! * [API Documentation (Development)](http://actix.github.io/actix-redis/actix_redis/)</span>
<span class="doccomment">//! * [API Documentation (Releases)](https://docs.rs/actix-redis/)</span>
<span class="doccomment">//! * [Chat on gitter](https://gitter.im/actix/actix)</span>
<span class="doccomment">//! * Cargo package: [actix-redis](https://crates.io/crates/actix-redis)</span>
<span class="doccomment">//! * Minimum supported Rust version: 1.40.0 or later</span>
<span class="attribute">#![<span class="ident">deny</span>(<span class="ident">rust_2018_idioms</span>)]</span>
2020-07-19 20:22:04 +00:00
<span class="kw">mod</span> <span class="ident">redis</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">redis</span>::{<span class="ident">Command</span>, <span class="ident">RedisActor</span>};
<span class="kw">use</span> <span class="ident">derive_more</span>::{<span class="ident">Display</span>, <span class="ident">From</span>};
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;web&quot;</span>)]</span>
<span class="kw">mod</span> <span class="ident">session</span>;
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;web&quot;</span>)]</span>
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">actix_web</span>::<span class="ident">cookie</span>::<span class="ident">SameSite</span>;
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;web&quot;</span>)]</span>
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">session</span>::<span class="ident">RedisSession</span>;
<span class="doccomment">/// General purpose actix redis error</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Display</span>, <span class="ident">From</span>)]</span>
<span class="kw">pub</span> <span class="kw">enum</span> <span class="ident">Error</span> {
<span class="attribute">#[<span class="ident">display</span>(<span class="ident">fmt</span> <span class="op">=</span> <span class="string">&quot;Redis error {}&quot;</span>, <span class="ident">_0</span>)]</span>
<span class="ident">Redis</span>(<span class="ident">redis_async</span>::<span class="ident">error</span>::<span class="ident">Error</span>),
<span class="doccomment">/// Receiving message during reconnecting</span>
<span class="attribute">#[<span class="ident">display</span>(<span class="ident">fmt</span> <span class="op">=</span> <span class="string">&quot;Redis: Not connected&quot;</span>)]</span>
<span class="ident">NotConnected</span>,
<span class="doccomment">/// Cancel all waters when connection get dropped</span>
<span class="attribute">#[<span class="ident">display</span>(<span class="ident">fmt</span> <span class="op">=</span> <span class="string">&quot;Redis: Disconnected&quot;</span>)]</span>
<span class="ident">Disconnected</span>,
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;web&quot;</span>)]</span>
<span class="kw">impl</span> <span class="ident">actix_web</span>::<span class="ident">ResponseError</span> <span class="kw">for</span> <span class="ident">Error</span> {}
<span class="comment">// re-export</span>
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">redis_async</span>::<span class="ident">error</span>::<span class="ident">Error</span> <span class="kw">as</span> <span class="ident">RespError</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">redis_async</span>::<span class="ident">resp</span>::<span class="ident">RespValue</span>;
</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>