Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
klauspost authored Mar 2, 2022
1 parent 67a6288 commit ebaaaa2
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion zstd/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,8 @@ and seems to ignore concatenated streams, even though [it is part of the spec](h
For compressing small blocks, the returned encoder has a function called `EncodeAll(src, dst []byte) []byte`.

`EncodeAll` will encode all input in src and append it to dst.
This function can be called concurrently, but each call will only run on a single goroutine.
This function can be called concurrently.
Each call will only run on a same goroutine as the caller.

Encoded blocks can be concatenated and the result will be the combined input stream.
Data compressed with EncodeAll can be decoded with the Decoder, using either a stream or `DecodeAll`.
Expand Down Expand Up @@ -288,6 +289,7 @@ func Decompress(in io.Reader, out io.Writer) error {

It is important to use the "Close" function when you no longer need the Reader to stop running goroutines,
when running with default settings.
Goroutines will exit once an error has been returned, including `io.EOF` at the end of a stream.

Streams are decoded concurrently in 4 asynchronous stages to give the best possible throughput.
However, if you prefer synchronous decompression, use `WithDecoderConcurrency(1)` which will decompress data
Expand Down

0 comments on commit ebaaaa2

Please sign in to comment.