Skip to content

Commit b40dffc

Browse files
committed
Add README detail around file format compatibility
1 parent 73c67c7 commit b40dffc

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,9 +83,20 @@ Stream-based compressor/decompressor `SnappyOutputStream`/`SnappyInputStream` ar
8383
* See also [Javadoc API](https://oss.sonatype.org/service/local/repositories/releases/archive/org/xerial/snappy/snappy-java/1.1.3-M1/snappy-java-1.1.3-M1-javadoc.jar/!/index.html)
8484

8585
#### Compatibility Notes
86-
* `SnappyOutputStream` and `SnappyInputStream` use `[magic header:16 bytes]([block size:int32][compressed data:byte array])*` format. You can read the result of `Snappy.compress` with `SnappyInputStream`, but you cannot read the compressed data generated by `SnappyOutputStream` with `Snappy.uncompress`. Here is the data format compatibility matrix:
86+
87+
The original Snappy format definition did not define a file format. It later added
88+
a "framing" format to define a file format, but by this point major software was
89+
already using an industry standard instead -- represented in this library by the
90+
`SnappyOutputStream` and `SnappyInputStream` methods.
91+
92+
For interoperability with other libraries, check that compatible formats are used.
93+
Note that not all libraries support all variants.
94+
95+
* `SnappyOutputStream` and `SnappyInputStream` use `[magic header:16 bytes]([block size:int32][compressed data:byte array])*` format. You can read the result of `Snappy.compress` with `SnappyInputStream`, but you cannot read the compressed data generated by `SnappyOutputStream` with `Snappy.uncompress`.
8796
* `SnappyHadoopCompatibleOutputStream` does not emit a file header but write out the current block size as a preemble to each block
8897

98+
#### Data format compatibility matrix:
99+
89100
| Write\Read | `Snappy.uncompress` | `SnappyInputStream` | `SnappyFramedInputStream` | `org.apache.hadoop.io.compress.SnappyCodec` |
90101
| --------------- |:-------------------:|:------------------:|:-----------------------:|:-------------------------------------------:|
91102
| `Snappy.compress` | ok | ok | x | x |

0 commit comments

Comments
 (0)