以固定大小的块读取二进制文件并将所有这些块存储到Vec中的正确方法是什么？

Question

我在打开文件时遇到了麻烦。大多数示例将文件读入String或将整个文件读入Vec。我需要的是将文件读入固定大小的块并将这些块存储到块的数组（Vec）中。

例如，我有一个名为my_file的文件正好是64 KB大小，我想以16KB的块读取它，所以我最终得到一个大小为4的Vec，其中每个元素是另一个大小为16Kb（0x4000字节）的Vec。

阅读文档并检查其他Stack Overflow答案后，我能够得到这样的结果：

let mut file = std::fs::File::open("my_file")?;
// ...calculate num_of_chunks 4 in this case
let list_of_chunks = Vec::new();

for chunk in 0..num_of_chunks {
    let mut data: [u8; 0x4000] = [0; 0x4000];
    file.read(&mut data[..])?;
    list_of_chunks.push(data.to_vec());
}

虽然这似乎工作正常，但看起来有点复杂。我读：

• 对于每次迭代，在堆栈上创建一个新数组
• 将块读入数组
• 将数组的内容复制到一个新的Vec，然后将Vec移动到list_of_chunks Vec。

我不确定它是否是惯用的，甚至可能，但我更喜欢这样的东西：

• 用Vec元素创建一个num_of_chunk，其中每个元素是另一个大小为16KB的Vec。
• 将文件块直接读入正确的Vec

没有复制，我们确保在读取文件之前分配内存。

这种方法可行吗？或者有更好的传统/惯用/正确方法吗？我想知道Vec是否是解决这个问题的正确类型。我的意思是，读取文件后我不需要数组增长。

Answer 1

我认为最常用的方法是使用迭代器。下面的代码（由M-ou-se's answer自由启发）：

• 通过使用泛型类型处理许多用例
• 将使用预先分配的矢量
• 隐藏副作用
• 避免两次复制数据

use std::io::{self, Read, Seek, SeekFrom};

struct Chunks<R> {
    read: R,
    size: usize,
    hint: (usize, Option<usize>),
}

impl<R> Chunks<R> {
    pub fn new(read: R, size: usize) -> Self {
        Self {
            read,
            size,
            hint: (0, None),
        }
    }

    pub fn from_seek(mut read: R, size: usize) -> io::Result<Self>
    where
        R: Seek,
    {
        let old_pos = read.seek(SeekFrom::Current(0))?;
        let len = read.seek(SeekFrom::End(0))?;

        let rest = (len - old_pos) as usize; // len is always >= old_pos but they are u64
        if rest != 0 {
            read.seek(SeekFrom::Start(old_pos))?;
        }

        let min = rest / size + if rest % size != 0 { 1 } else { 0 };
        Ok(Self {
            read,
            size,
            hint: (min, None), // this could be wrong I'm unsure
        })
    }

    // This could be useful if you want to try to recover from an error
    pub fn into_inner(self) -> R {
        self.read
    }
}

impl<R> Iterator for Chunks<R>
where
    R: Read,
{
    type Item = io::Result<Vec<u8>>;

    fn next(&mut self) -> Option<Self::Item> {
        let mut chunk = Vec::with_capacity(self.size);
        match self
            .read
            .by_ref()
            .take(chunk.capacity() as u64)
            .read_to_end(&mut chunk)
        {
            Ok(n) => {
                if n != 0 {
                    Some(Ok(chunk))
                } else {
                    None
                }
            }
            Err(e) => Some(Err(e)),
        }
    }

    fn size_hint(&self) -> (usize, Option<usize>) {
        self.hint
    }
}

trait ReadPlus: Read {
    fn chunks(self, size: usize) -> Chunks<Self>
    where
        Self: Sized,
    {
        Chunks::new(self, size)
    }
}

impl<T: ?Sized> ReadPlus for T where T: Read {}

fn main() -> io::Result<()> {
    let file = std::fs::File::open("src/main.rs")?;
    let iter = Chunks::from_seek(file, 0xFF)?; // replace with anything 0xFF was to test

    println!("{:?}", iter.size_hint());
    // This iterator could return Err forever be careful collect it into an Result
    let chunks = iter.collect::<Result<Vec<_>, _>>()?;
    println!("{:?}, {:?}", chunks.len(), chunks.capacity());

    Ok(())
}

Answer 2

Read::read_to_end有效地直接读入Vec。如果你想要它的块，可以将它与Read::take结合起来，以限制read_to_end读取的字节数。

例：

let mut file = std::fs::File::open("your_file")?;

let mut list_of_chunks = Vec::new();

let chunk_size = 0x4000;

loop {
    let mut chunk = Vec::with_capacity(chunk_size);
    let n = file.by_ref().take(chunk_size as u64).read_to_end(&mut chunk)?;
    if n == 0 { break; }
    list_of_chunks.push(chunk);
    if n < chunk_size { break; }
}

最后一个if不是必需的，但是它阻止了额外的read调用：如果read_to_end读取的字节数少于所请求的字节数，我们可以预期下一个read什么都不读，因为我们到达了文件的末尾。