Skip to content

[readme] Add banner for streaming writer interface issue #77

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Viq111 merged 1 commit into from
Dec 3, 2019
Merged

[readme] Add banner for streaming writer interface issue #77

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,12 @@ There are two main APIs:
The compress/decompress APIs mirror that of lz4, while the streaming API was
designed to be a drop-in replacement for zlib.

## Current status

There is currently a potential issue with the streaming `Writer` interface. See https://github.com/DataDog/zstd/issues/22 for more details.
If you intend to use the streaming interface instead of `Compress` method, it is currently recommended to use [release 1.3.0](https://github.com/DataDog/zstd/releases/tag/v1.3.0) or earlier.
If you are able to contribute or reproduce the issue, please let us know!

### Simple `Compress/Decompress`


Expand Down Expand Up @@ -73,6 +79,8 @@ NewReader(r io.Reader) io.ReadCloser
NewReaderDict(r io.Reader, dict []byte) io.ReadCloser
```

See section above `Current Status`

### Benchmarks (benchmarked with v0.5.0)

The author of Zstd also wrote lz4. Zstd is intended to occupy a speed/ratio
Expand Down Expand Up @@ -116,9 +124,3 @@ Testing with size: 45951... czlib: 201.62 MB/s, zstd: 1951.57 MB/s
```

zstd starts to shine with payloads > 1KB

### Stability - Current state: STABLE

The C library seems to be pretty stable and according to the author has been tested and fuzzed.

For the Go wrapper, the test cover most usual cases and we have succesfully tested it on all staging and prod data.