diff --git a/README.md b/README.md index f941190..8cf8f1b 100755 --- a/README.md +++ b/README.md @@ -84,12 +84,14 @@ Stream-based compressor/decompressor `SnappyOutputStream`/`SnappyInputStream` ar #### Compatibility Notes * `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: + * `SnappyHadoopCompatibleOutputStream` does not emit a file header but write out the current block size as a preemble to each block -| Write\Read | `Snappy.uncompress` | `SnappyInputStream` | `SnappyFramedInputStream` | -| --------------- |:-------------------:|:------------------:|:-----------------------:| -| `Snappy.compress` | ok | ok | x | -| `SnappyOutputStream` | x | ok | x | -| `SnappyFramedOutputStream` | x | x | ok | +| Write\Read | `Snappy.uncompress` | `SnappyInputStream` | `SnappyFramedInputStream` | `org.apache.hadoop.io.compress.SnappyCodec` | +| --------------- |:-------------------:|:------------------:|:-----------------------:|:-------------------------------------------:| +| `Snappy.compress` | ok | ok | x | x | +| `SnappyOutputStream` | x | ok | x | x | +| `SnappyFramedOutputStream` | x | x | ok | x | +| `SnappyHadoopCompatibleOutputStream` | x | x | x | ok | ### BitShuffle API (Since 1.1.3-M2)