12 releases

new 0.2.8 Mar 25, 2024
0.2.6 Mar 14, 2023
0.2.4 Nov 21, 2022
0.2.2 Mar 31, 2022
0.1.1 Jul 30, 2021

#159 in Concurrency

Download history 33/week @ 2023-12-06 59/week @ 2023-12-13 21/week @ 2023-12-20 17/week @ 2023-12-27 44/week @ 2024-01-03 39/week @ 2024-01-10 252/week @ 2024-01-17 452/week @ 2024-01-24 501/week @ 2024-01-31 122/week @ 2024-02-07 172/week @ 2024-02-14 210/week @ 2024-02-21 179/week @ 2024-02-28 58/week @ 2024-03-06 65/week @ 2024-03-13 169/week @ 2024-03-20

502 downloads per month
Used in 2 crates (via assets_manager)

MIT/Apache

42KB
1K SLoC

Sync File

Crates.io Docs.rs Minimum rustc version

Files that can be read concurrently.

std::fs::File is Sync but reading concurrently from it results in race conditions, because the OS has a single cursor which is advanced and used by several threads.

SyncFile solves this problem by using platform-specific extensions to do positional I/O, so the cursor of the file is not shared.

Example

use std::io::Read;
use sync_file::SyncFile;

/// Reads a file byte by byte.
/// Don't do this in real code !
fn read_all<R: Read>(mut file: R) -> std::io::Result<Vec<u8>> {
    let mut result = Vec::new();
    let mut buf = [0];

    while file.read(&mut buf)? != 0 {
        result.extend(&buf);
    }

    Ok(result)
}

// Open a file
let f = SyncFile::open("hello.txt")?;
let f_clone = f.clone();

// Read it concurrently
let thread = std::thread::spawn(move || read_all(f_clone));
let res1 = read_all(f)?;
let res2 = thread.join().unwrap()?;

// Both clones read the whole content
// This would not work with `std::fs::File`
assert_eq!(res1, b"Hello World!\n");
assert_eq!(res2, b"Hello World!\n");

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~165KB