5 releases (3 breaking)

0.4.0 Apr 29, 2018
0.3.0 Aug 3, 2017
0.2.0 May 20, 2017
0.1.1 Feb 1, 2017
0.1.0 Jan 31, 2016

#70 in Filesystem

Download history 33/week @ 2019-11-01 26/week @ 2019-11-08 32/week @ 2019-11-15 28/week @ 2019-11-22 22/week @ 2019-11-29 62/week @ 2019-12-06 51/week @ 2019-12-13 7/week @ 2019-12-20 7/week @ 2019-12-27 43/week @ 2020-01-03 60/week @ 2020-01-10 40/week @ 2020-01-17 33/week @ 2020-01-24 56/week @ 2020-01-31 54/week @ 2020-02-07

156 downloads per month
Used in 9 crates (8 directly)

Apache-2.0

27KB
353 lines

Filebuffer

Fast and simple file reading for Rust.

Build Status Build Status Crates.io version Documentation

Filebuffer can map files into memory. This is often faster than using the primitives in std::io, and also more convenient. Furthermore this crate offers prefetching and checking whether file data is resident in physical memory (so access will not incur a page fault). This enables non-blocking file reading.

Example

Below is an implementation of the sha256sum program that is both faster and simpler than the naive std::io equivalent. (See sha256sum_filebuffer and sha256sum_naive in the examples directory.)

use std::env;
use crypto::digest::Digest;
use crypto::sha2::Sha256;
use filebuffer::FileBuffer;

extern crate crypto;
extern crate filebuffer;

fn main() {
    for fname in env::args().skip(1) {
        let fbuffer = FileBuffer::open(&fname).expect("failed to open file");
        let mut hasher = Sha256::new();
        hasher.input(&fbuffer);
        println!("{}  {}", hasher.result_str(), fname);
    }
}

License

Filebuffer is licensed under the Apache 2.0 license. It may be used in free software as well as closed-source applications, both for commercial and non-commercial use under the conditions given in the license. If you want to use Filebuffer in your GPLv2-licensed software, you can add an exception to your copyright notice.

Dependencies

~32KB