Skip to content

Commit 9d9580b

Browse files
committed
Update readme noting new AdaptingZipReader usage
1 parent 90b98fa commit 9d9580b

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,14 @@ But that's not all it does. That's just what that one comment says. Some other f
2525

2626
## Additional features
2727

28-
- Reads ZIP files using Unsafe backed mapped files.
28+
- Reads ZIP files using `Unsafe` backed mapped files.
2929
- Using `FileChannel.map` yields `MappedByteBuffer` which uses `int` values, limiting files up to about 2GB
3030
- Our `UnsafeMappedFile` implementation uses `long` which far exceeds the GB file size range
3131
- Highly configurable, offering 3 ZIP reading strategies out of the box _(See `ZipIO` for convenience calls)_
3232
- Std / Forward scanning: Scans for `EndOfCentralDirectory` from the front of the file, like many other tools
3333
- Naive: Scans only for `LocalFileHeader` values from the front of the file, the fastest implementation, but obviously naive
3434
- JVM: Matches the behavior of the JVM's ZIP parser, including a number of odd edge cases. Useful for opening JAR files to mirror `java -jar <path>` behavior.
35+
- Inputs do not have to be on-disk to be read, you can supply zip data in-memory.
3536

3637
## Usage
3738

@@ -90,6 +91,7 @@ If you're looking to see which implementation models different ways of reading Z
9091
| `ZipInputSstream` | `ForwardScanZipReader` / `ZipIO.readStandard(...)` |
9192
| N/A | `NaiveLocalFileZipReader` / `ZipIO.readNaive(...)` |
9293

94+
There is also a `ZipFile` delegating reader `AdaptingZipReader` but it should primarily be used only for debugging purposes.
9395

9496
## Building
9597

0 commit comments

Comments
 (0)