Skip to content

Commit 5600a7f

Browse files
committed
Add note on multiple zip read modes
1 parent 406b90d commit 5600a7f

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,10 @@ But that's not all it does. That's just what that one comment says. Some other f
2828
- 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
31+
- Highly configurable, offering 3 ZIP reading strategies out of the box _(See `ZipIO` for convenience calls)_
32+
- Std / Forward scanning: Scans for `EndOfCentralDirectory` from the front of the file, like many other tools
33+
- Naive: Scans only for `LocalFileHeader` values from the front of the file, the fastest implementation, but obviously naive
34+
- 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.
3135

3236
## Usage
3337

0 commit comments

Comments
 (0)