5eed8e7a55
to mean "pledgedSrcSize is not known at init time" instead of `0`. Note that, a few prototypes created and documented with `0` to mean "unknown" still interpret "0" as unknown, to avoid breaking 3rd party applications which depend on this behavior. But this value is no longer recommended to mean "unknown". In some future version, it might be possible to switch "0" to mean "empty", as is already the case for several prototypes. The advantage is that pledgedSrcSize field would have same behavior accross entire API, making it easier to reason about. Note that all concerned prototypes belong to the "experimental" API section. srcSize is controlled at end of compression, so if someone uses "0" to mean "unknown" while it effectively means "empty", this is immediately caught by the compression function, which generates an error code : ZSTD_ERROR_srcSize_wrong |
||
|---|---|---|
| .. | ||
| educational_decoder | ||
| images | ||
| README.md | ||
| zstd_compression_format.md | ||
| zstd_manual.html | ||
README.md
Zstandard Documentation
This directory contains material defining the Zstandard format,
as well as for help using the zstd library.
zstd_compression_format.md : This document defines the Zstandard compression format.
Compliant decoders must adhere to this document,
and compliant encoders must generate data that follows it.
educational_decoder : This directory contains an implementation of a Zstandard decoder,
compliant with the Zstandard compression format.
It can be used, for example, to better understand the format,
or as the basis for a separate implementation a Zstandard decoder/encoder.
zstd_manual.html : Documentation on the functions found in zstd.h.
See http://zstd.net/zstd_manual.html for
the manual released with the latest official zstd release.