Skip to content

Commit 3c9e576

Browse files
committed
Add note on os.unzip.stream not supporting perms and symlinks
1 parent 00cf04e commit 3c9e576

File tree

2 files changed

+4
-1
lines changed

2 files changed

+4
-1
lines changed

Readme.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1435,6 +1435,9 @@ os.unzip.stream(
14351435
This can be useful if the zip file does not exist on disk, e.g. if it is received over the network
14361436
or produced in-memory by application logic.
14371437

1438+
File permissions and symbolic links are not supported since permissions and symlink mode are stored as external attributes which might reside in the central directory located at the end of the zip archive.
1439+
For more a more detailed explanation see the `ZipArchiveInputStream` vs `ZipFile` section at https://commons.apache.org/proper/commons-compress/zip.html.
1440+
14381441
OS-Lib also provides the `os.unzip.streamRaw` API, which is a lower level API used internally
14391442
within `os.unzip.stream` but can also be used directly if lower-level control is necessary.
14401443

os/src/ZipOps.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -404,7 +404,7 @@ object unzip {
404404
* File permissions and symbolic links are not supported since permissions and symlink mode are stored
405405
* as external attributes which reside in the central directory located at the end of the zip archive.
406406
* For more a more detailed explanation see the `ZipArchiveInputStream` vs `ZipFile` section at
407-
* [[https://commons.apache.org/proper/commons-compress/zip.html]]
407+
* [[https://commons.apache.org/proper/commons-compress/zip.html]].
408408
*
409409
* @param source A geny.Readable object representing the ZIP data stream.
410410
* @param dest The path to the destination directory for extracted files.

0 commit comments

Comments
 (0)