6 releases (breaking)

0.5.0 Jul 23, 2024
0.4.0 Dec 5, 2023
0.3.0 Sep 22, 2023
0.2.1 Nov 23, 2022
0.1.0 Jun 8, 2022

#51 in #slice

Download history 696/week @ 2024-06-28 653/week @ 2024-07-05 585/week @ 2024-07-12 838/week @ 2024-07-19 122/week @ 2024-07-26 5/week @ 2024-08-02 36/week @ 2024-08-09 33/week @ 2024-08-16 15/week @ 2024-08-23 24/week @ 2024-08-30 17/week @ 2024-09-06 28/week @ 2024-09-13 28/week @ 2024-09-20 35/week @ 2024-09-27 56/week @ 2024-10-04 38/week @ 2024-10-11

161 downloads per month
Used in tass

Unlicense

11KB
172 lines

Slices of files

FileSlice is to File what Bytes is to Vec<u8>. Advantages over File:

  • You can slice it, reducing the scope to a range within the original file
  • Cloning is cheap (atomic addition; no syscall)
  • Seeking is very cheap (normal addition; no syscall)
  • Clones can't affect each other at all (the fd's real cursor is never used).

Once created, a FileSlice never changes length, even if the underlying file does. For example, if another process appends some data to the file, you need to call FileSlice::expand on your slice in order to add the new data.

Optional features

Optional integrations for crates which naturally benefit from file slicing:

  • tar: Adds a slice_tarball helper method for splitting up a tar::Archive into a bunch of FileSlices.
  • parquet: Adds a ChunkReader impl for FileSlice. A parquet file contains many pages, and the decoder needs to interleave reads from these pages. The ChunkReader impl for File accomplishes this by making many clones of the fd. Using FileSlice instead lets you open roughly 7x as many parquet files before you hit your fd limit.

Dependencies

~8–17MB
~256K SLoC