185 lines
9.3 KiB
HTML
185 lines
9.3 KiB
HTML
|
<!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 `lru_cache` crate.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, lru_cache">
|
|||
|
|
|
|||
|
|
<title>lru_cache - 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 lru_cache</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'lru_cache', 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"
|
|||
|
|
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
|
|||
|
|
type="search">
|
|||
|
|
</div>
|
|||
|
|
</form>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<section id='main' class="content"><h1 class='fqn'><span class='in-band'>Crate <a class="mod" href=''>lru_cache</a></span><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/lru_cache/lib.rs.html#11-567' title='goto source code'>[src]</a></span></h1><div class='docblock'><p>A cache that holds a limited number of key-value pairs. When the
|
|||
|
|
capacity of the cache is exceeded, the least-recently-used
|
|||
|
|
(where "used" means a look-up or putting the pair into the cache)
|
|||
|
|
pair is automatically removed.</p>
|
|||
|
|
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">use</span> <span class="ident">lru_cache</span>::<span class="ident">LruCache</span>;
|
|||
|
|
|
|||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">cache</span> <span class="op">=</span> <span class="ident">LruCache</span>::<span class="ident">new</span>(<span class="number">2</span>);
|
|||
|
|
|
|||
|
|
<span class="ident">cache</span>.<span class="ident">insert</span>(<span class="number">1</span>, <span class="number">10</span>);
|
|||
|
|
<span class="ident">cache</span>.<span class="ident">insert</span>(<span class="number">2</span>, <span class="number">20</span>);
|
|||
|
|
<span class="ident">cache</span>.<span class="ident">insert</span>(<span class="number">3</span>, <span class="number">30</span>);
|
|||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">cache</span>.<span class="ident">get_mut</span>(<span class="kw-2">&</span><span class="number">1</span>).<span class="ident">is_none</span>());
|
|||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">*</span><span class="ident">cache</span>.<span class="ident">get_mut</span>(<span class="kw-2">&</span><span class="number">2</span>).<span class="ident">unwrap</span>(), <span class="number">20</span>);
|
|||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">*</span><span class="ident">cache</span>.<span class="ident">get_mut</span>(<span class="kw-2">&</span><span class="number">3</span>).<span class="ident">unwrap</span>(), <span class="number">30</span>);
|
|||
|
|
|
|||
|
|
<span class="ident">cache</span>.<span class="ident">insert</span>(<span class="number">2</span>, <span class="number">22</span>);
|
|||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">*</span><span class="ident">cache</span>.<span class="ident">get_mut</span>(<span class="kw-2">&</span><span class="number">2</span>).<span class="ident">unwrap</span>(), <span class="number">22</span>);
|
|||
|
|
|
|||
|
|
<span class="ident">cache</span>.<span class="ident">insert</span>(<span class="number">6</span>, <span class="number">60</span>);
|
|||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">cache</span>.<span class="ident">get_mut</span>(<span class="kw-2">&</span><span class="number">3</span>).<span class="ident">is_none</span>());
|
|||
|
|
|
|||
|
|
<span class="ident">cache</span>.<span class="ident">set_capacity</span>(<span class="number">1</span>);
|
|||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">cache</span>.<span class="ident">get_mut</span>(<span class="kw-2">&</span><span class="number">2</span>).<span class="ident">is_none</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.IntoIter.html"
|
|||
|
|
title='struct lru_cache::IntoIter'>IntoIter</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>An iterator over a cache's key-value pairs in least- to most-recently-used order.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.Iter.html"
|
|||
|
|
title='struct lru_cache::Iter'>Iter</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>An iterator over a cache's key-value pairs in least- to most-recently-used order.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.IterMut.html"
|
|||
|
|
title='struct lru_cache::IterMut'>IterMut</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>An iterator over a cache's key-value pairs in least- to most-recently-used order with mutable
|
|||
|
|
references to the values.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.LruCache.html"
|
|||
|
|
title='struct lru_cache::LruCache'>LruCache</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>An LRU cache.</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>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</aside>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script>
|
|||
|
|
window.rootPath = "../";
|
|||
|
|
window.currentCrate = "lru_cache";
|
|||
|
|
</script>
|
|||
|
|
<script src="../main.js"></script>
|
|||
|
|
<script defer src="../search-index.js"></script>
|
|||
|
|
</body>
|
|||
|
|
</html>
|