<!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="API documentation for the Rust `memcache` crate."><meta name="keywords" content="rust, rustlang, rust-lang, memcache"><title>memcache - Rust</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></head><body class="rustdoc mod"><!--[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">☰</div><p class='location'>Crate memcache</p><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all memcache's items</p></a><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'memcache', ty: 'mod', relpath: '../'};</script></div></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 js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><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"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../src/memcache/lib.rs.html#1-73' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>memcache</a></span></h1><div class='docblock'><p>rust-memcache is a <a href="https://memcached.org/">Memcached</a> client written in pure rust.</p>
<h1 id="install" class="section-header"><a href="#install">Install:</a></h1>
<p>The crate is called <code>memcache</code> and you can depend on it via cargo:</p>
<pre><code class="language-ini">[dependencies]
memcache = "*"
</code></pre>
<h1 id="features" class="section-header"><a href="#features">Features:</a></h1>
<ul>
<li><input type="checkbox" disabled checked /> Binary protocal</li>
<li><input type="checkbox" disabled checked /> TCP connection</li>
<li><input type="checkbox" disabled checked /> UDP connection</li>
<li><input type="checkbox" disabled checked/> UNIX Domain socket connection</li>
<li><input type="checkbox" disabled /> Automatically compress</li>
<li><input type="checkbox" disabled /> Automatically serialize to JSON / msgpack etc.</li>
<li><input type="checkbox" disabled checked /> Typed interface</li>
<li><input type="checkbox" disabled checkbox /> Mutiple server support with custom key hash algorithm</li>
</ul>
<h1 id="basic-usage" class="section-header"><a href="#basic-usage">Basic usage:</a></h1>
<pre class="rust rust-example-rendered">
<span class="comment">// create connection with to memcached server node:</span>
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">client</span> <span class="op">=</span> <span class="ident">memcache</span>::<span class="ident">Client</span>::<span class="ident">connect</span>(<span class="string">"memcache://127.0.0.1:12345?timeout=10&tcp_nodelay=true"</span>).<span class="ident">unwrap</span>();
<span class="comment">// flush the database:</span>
<span class="ident">client</span>.<span class="ident">flush</span>().<span class="ident">unwrap</span>();
<span class="comment">// set a string value:</span>
<span class="ident">client</span>.<span class="ident">set</span>(<span class="string">"foo"</span>, <span class="string">"bar"</span>, <span class="number">0</span>).<span class="ident">unwrap</span>();
<span class="comment">// retrieve from memcached:</span>
<span class="kw">let</span> <span class="ident">value</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">String</span><span class="op">></span> <span class="op">=</span> <span class="ident">client</span>.<span class="ident">get</span>(<span class="string">"foo"</span>).<span class="ident">unwrap</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">value</span>, <span class="prelude-val">Some</span>(<span class="ident">String</span>::<span class="ident">from</span>(<span class="string">"bar"</span>)));
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">value</span>.<span class="ident">unwrap</span>(), <span class="string">"bar"</span>);
<span class="comment">// prepend, append:</span>
<span class="ident">client</span>.<span class="ident">prepend</span>(<span class="string">"foo"</span>, <span class="string">"foo"</span>).<span class="ident">unwrap</span>();
<span class="ident">client</span>.<span class="ident">append</span>(<span class="string">"foo"</span>, <span class="string">"baz"</span>).<span class="ident">unwrap</span>();
<span class="kw">let</span> <span class="ident">value</span>: <span class="ident">String</span> <span class="op">=</span> <span class="ident">client</span>.<span class="ident">get</span>(<span class="string">"foo"</span>).<span class="ident">unwrap</span>().<span class="ident">unwrap</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">value</span>, <span class="string">"foobarbaz"</span>);
<span class="comment">// delete value:</span>
<span class="ident">client</span>.<span class="ident">delete</span>(<span class="string">"foo"</span>).<span class="ident">unwrap</span>();
<span class="comment">// using counter:</span>
<span class="ident">client</span>.<span class="ident">set</span>(<span class="string">"counter"</span>, <span class="number">40</span>, <span class="number">0</span>).<span class="ident">unwrap</span>();
<span class="ident">client</span>.<span class="ident">increment</span>(<span class="string">"counter"</span>, <span class="number">2</span>).<span class="ident">unwrap</span>();
<span class="kw">let</span> <span class="ident">answer</span>: <span class="ident">i32</span> <span class="op">=</span> <span class="ident">client</span>.<span class="ident">get</span>(<span class="string">"counter"</span>).<span class="ident">unwrap</span>().<span class="ident">unwrap</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">answer</span>, <span class="number">42</span>);</pre>
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table>
<tr class=' module-item'>
<td><a class="struct" href="struct.Client.html"
title='struct memcache::Client'>Client</a></td>
<td class='docblock-short'>
</td>
</tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
<table>
<tr class=' module-item'>
<td><a class="enum" href="enum.MemcacheError.html"
title='enum memcache::MemcacheError'>MemcacheError</a></td>
<td class='docblock-short'>
<p>Stands for errors raised from rust-memcache</p>
</td>
</tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
<table>
<tr class=' module-item'>
<td><a class="trait" href="trait.Connectable.html"
title='trait memcache::Connectable'>Connectable</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="trait" href="trait.FromMemcacheValue.html"
title='trait memcache::FromMemcacheValue'>FromMemcacheValue</a></td>
<td class='docblock-short'>
<p>determine how the value is unserialize to memcache</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="trait" href="trait.ToMemcacheValue.html"
title='trait memcache::ToMemcacheValue'>ToMemcacheValue</a></td>
<td class='docblock-short'>
<p>determine how the value is serialize to memcache</p>
</td>
</tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "memcache";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>