drill-press

Crates.iodrill-press
lib.rsdrill-press
version0.1.2
created_at2022-02-16 16:00:17.72244+00
updated_at2025-08-05 10:54:03.970008+00
descriptionA cross platform library for listing and manipulating holes in sparse files.
homepage
repositoryhttps://github.com/aj-bagwell/drill-press
max_upload_size
id533384
size49,793
AJ Bagwell (aj-bagwell)

documentation

https://docs.rs/drill-press/

README

Drill-Press

Crates.io License Unsafe Maintenance

A simple, cross platform crate for finding the locations of holes in sparse files.

Forked from Nathan McCarty's hole_punch (git)

Currently supports Unix-like platforms that support the SEEK_HOLE and SEEK_DATA commands on lseek, as well as windows.

The operating systems that currently support filesystem-level sparsity information are:

  1. Linux
  2. Android
  3. FreeBSD
  4. Windows
  5. MacOS

These are currently implemented with a compile time switch, and SparseFile::scan_chunks will always immediately return with a ScanError::UnsupportedPlatform error on platforms not on this list.

Usage

use std::fs::File;
use std::io::{Read, Seek, SeekFrom};
use drill_press::*;

if let Ok(mut file) = File::open("README.md") {
    let segments = file.scan_chunks().expect("Unable to scan chunks");
    for segment in segments.data() {
        let start = segment.start;
        let length = segment.end - segment.start;
        file.seek(SeekFrom::Start(start));
        let chunk = (&mut file).take(length);
    }
}

License

Drill-Press is distributed under your choice of the MIT license, or Apache 2.0.

Commit count: 71

cargo fmt