如何在 Rust 中实现获取缓存或加载操作？

Question

我正在尝试创建一个简单的缓存，它只有一个操作：“从缓存，必要时加载”。这是一个 working example（只是为简单起见使用文件加载）：

use std::collections::HashMap;
use std::fs::File;
use std::io;
use std::path::{Path, PathBuf};

#[derive(Debug, Default)]
pub struct FileCache {
    /// Map storing contents of loaded files.
    files: HashMap<PathBuf, Vec<u8>>,
}

impl FileCache {
    /// Get a file's contents, loading it if it hasn't yet been loaded.
    pub fn get(&mut self, path: &Path) -> io::Result<&[u8]> {
        if let Some(_) = self.files.get(path) {
            println!("Cached");
            return Ok(self.files.get(path).expect("just checked"));
        }
        let buf = self.load(path)?;
        Ok(self.files.entry(path.to_owned()).or_insert(buf))
    }
    /// Load a file, returning its contents.
    fn load(&self, path: &Path) -> io::Result<Vec<u8>> {
        println!("Loading");
        let mut buf = Vec::new();
        use std::io::Read;
        File::open(path)?.read_to_end(&mut buf)?;
        Ok(buf)
    }
}

pub fn main() -> io::Result<()> {
    let mut store = FileCache::default();
    let path = Path::new("src/main.rs");
    println!("Length: {}", store.get(path)?.len());
    println!("Length: {}", store.get(path)?.len());
    Ok(())
}

if let 的成功分支额外调用了 self.files.get 和一个额外的 expect。我们只是调用它并对其进行模式匹配结果，所以我们只想 return 匹配：

    pub fn get(&mut self, path: &Path) -> io::Result<&[u8]> {
        if let Some(x) = self.files.get(path) {
            println!("Cached");
            return Ok(x);
        }
        let buf = self.load(path)?;
        Ok(self.files.entry(path.to_owned()).or_insert(buf))
    }

但是这个fails the borrow checker:

error[E0502]: cannot borrow `self.files` as mutable because it is also borrowed as immutable
  --> src/main.rs:20:12
   |
14 |     pub fn get(&mut self, path: &Path) -> io::Result<&[u8]> {
   |                - let's call the lifetime of this reference `'1`
15 |         if let Some(x) = self.files.get(path) {
   |                          ---------- immutable borrow occurs here
16 |             println!("Cached");
17 |             return Ok(x);
   |                    ----- returning this value requires that `self.files` is borrowed for `'1`
...
20 |         Ok(self.files.entry(path.to_owned()).or_insert(buf))
   |            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ mutable borrow occurs here

我不明白为什么这两个版本的行为不同。不是 self.files 在这两种情况下都借了 &self 一生？在第一形式，我们放弃借用并获得一个新的，但我不明白为什么应该有所作为。第二种形式如何使我违反内存安全，以及如何在不进行额外查找的情况下编写此代码 expect 检查?

我读过，这是相关的，但是那里的答案要么重复查找（如在我的工作示例中）或克隆值（非常昂贵），所以还不够。

Answer 1

两种实现都应该是合法的 Rust 代码。 rustc 拒绝第二个的事实实际上是 issue 58910.

跟踪的错误

让我们详细说明：

pub fn get(&mut self, path: &Path) -> io::Result<&[u8]> {
    if let Some(x) = self.files.get(path) { // ---+ x
        println!("Cached");                    // |
        return Ok(x);                          // |
    }                                          // |
    let buf = self.load(path)?;                // |
    Ok(self.files.entry(path.to_owned())       // |
        .or_insert(buf))                       // |
}                                              // v

通过绑定到变量 x in let some expression，self.files 被借用为不可变的。相同的 x 后来被 return 发送给调用者，这意味着 self.files 一直被借用，直到调用者的某个时刻。所以在当前的 Rust 借用检查器实现中，self.files 是 不必要地 一直被借用整个 get 函数。它不能在以后再次借用为可变的。 x 在早期 return 之后从未使用过的事实未被考虑。

您的第一个实现可以解决此问题。因为 let some(_) = ... 没有创建任何绑定，所以它没有同样的问题。尽管由于多次查找，它确实会产生额外的运行时成本。

这是 Niko 的 NLL RFC 中描述的 problem case #3。好消息是：

TL;DR: Polonius is supposed to fix this.

（Polonius 是更复杂的 Rust 借用检查器的第三个版本，仍在开发中）。

如何在 Rust 中实现获取缓存或加载操作？

How can I implement a fetch-cached-or-load operation in Rust?

rust

borrow-checker