| <!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="An implementation of a LRU cache. The cache supports `get`, `get_mut`, `put`, and `pop` operations, all of which are O(1). This crate was heavily influenced by the LRU Cache implementation in an earlier version of Rust’s std::collections crate."><meta name="keywords" content="rust, rustlang, rust-lang, lru"><title>lru - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../normalize.css"><link rel="stylesheet" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../ayu.css" disabled><link rel="stylesheet" href="../dark.css" disabled><link rel="stylesheet" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="../crates.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc mod crate"><!--[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">☰</button><a class="sidebar-logo" href="../lru/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../lru/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Crate lru</a></h2><div class="sidebar-elems"><ul class="block"><li class="version">Version 0.7.8</li><li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#types">Type Definitions</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Crate <a class="mod" href="#">lru</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../src/lru/lib.rs.html#23-1872">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>An implementation of a LRU cache. The cache supports <code>get</code>, <code>get_mut</code>, <code>put</code>, |
| and <code>pop</code> operations, all of which are O(1). This crate was heavily influenced |
| by the <a href="https://doc.rust-lang.org/0.12.0/std/collections/lru_cache/struct.LruCache.html">LRU Cache implementation in an earlier version of Rust’s std::collections crate</a>.</p> |
| <h3 id="example"><a href="#example">Example</a></h3> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">extern crate </span>lru; |
| |
| <span class="kw">use </span>lru::LruCache; |
| |
| <span class="kw">fn </span>main() { |
| <span class="kw">let </span><span class="kw-2">mut </span>cache = LruCache::new(<span class="number">2</span>); |
| cache.put(<span class="string">"apple"</span>, <span class="number">3</span>); |
| cache.put(<span class="string">"banana"</span>, <span class="number">2</span>); |
| |
| <span class="macro">assert_eq!</span>(<span class="kw-2">*</span>cache.get(<span class="kw-2">&</span><span class="string">"apple"</span>).unwrap(), <span class="number">3</span>); |
| <span class="macro">assert_eq!</span>(<span class="kw-2">*</span>cache.get(<span class="kw-2">&</span><span class="string">"banana"</span>).unwrap(), <span class="number">2</span>); |
| <span class="macro">assert!</span>(cache.get(<span class="kw-2">&</span><span class="string">"pear"</span>).is_none()); |
| |
| <span class="macro">assert_eq!</span>(cache.put(<span class="string">"banana"</span>, <span class="number">4</span>), <span class="prelude-val">Some</span>(<span class="number">2</span>)); |
| <span class="macro">assert_eq!</span>(cache.put(<span class="string">"pear"</span>, <span class="number">5</span>), <span class="prelude-val">None</span>); |
| |
| <span class="macro">assert_eq!</span>(<span class="kw-2">*</span>cache.get(<span class="kw-2">&</span><span class="string">"pear"</span>).unwrap(), <span class="number">5</span>); |
| <span class="macro">assert_eq!</span>(<span class="kw-2">*</span>cache.get(<span class="kw-2">&</span><span class="string">"banana"</span>).unwrap(), <span class="number">4</span>); |
| <span class="macro">assert!</span>(cache.get(<span class="kw-2">&</span><span class="string">"apple"</span>).is_none()); |
| |
| { |
| <span class="kw">let </span>v = cache.get_mut(<span class="kw-2">&</span><span class="string">"banana"</span>).unwrap(); |
| <span class="kw-2">*</span>v = <span class="number">6</span>; |
| } |
| |
| <span class="macro">assert_eq!</span>(<span class="kw-2">*</span>cache.get(<span class="kw-2">&</span><span class="string">"banana"</span>).unwrap(), <span class="number">6</span>); |
| }</code></pre></div> |
| </div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.IntoIter.html" title="lru::IntoIter struct">IntoIter</a></div><div class="item-right docblock-short">An iterator that moves out of a <code>LruCache</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Iter.html" title="lru::Iter struct">Iter</a></div><div class="item-right docblock-short">An iterator over the entries of a <code>LruCache</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.IterMut.html" title="lru::IterMut struct">IterMut</a></div><div class="item-right docblock-short">An iterator over mutables entries of a <code>LruCache</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.LruCache.html" title="lru::LruCache struct">LruCache</a></div><div class="item-right docblock-short">An LRU Cache</div></div></div><h2 id="types" class="small-section-header"><a href="#types">Type Definitions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="type" href="type.DefaultHasher.html" title="lru::DefaultHasher type">DefaultHasher</a></div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="lru" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
