include/linux/zstd_lib.h

111  *            or an error code if it fails (which can be tested using ZSTD_isError()). */
131  *            - ZSTD_CONTENTSIZE_ERROR if an error occurred (e.g. invalid magic number, srcSize too small)
155  *  "empty", "unknown" and "error" results to the same return value (0),
165  *        or an error code if input is invalid */
172 ZSTDLIB_API unsigned    ZSTD_isError(size_t code);          /*!< tells if a `size_t` function result is an error code */
173 ZSTDLIB_API const char* ZSTD_getErrorName(size_t code);     /*!< provides readable string from an error code */
366      * Otherwise, trying to set any other value than default (0) will be a no-op and return an error.
436     size_t error;
443  *  otherwise they will either trigger an error or be automatically clamped.
445  *         - an error status field, which must be tested using ZSTD_isError()
453  *  Providing a value beyond bound will either clamp it, or trigger an error (depending on parameter).
459  * @return : an error code (which can be tested using ZSTD_isError()).
466  *  This value will also be controlled at end of frame, and trigger an error if not respected.
467  * @result : 0, or an error code (which can be tested with ZSTD_isError()).
489  *                  Useful after an error, or to interrupt any ongoing compression.
497  *                  otherwise the reset fails, and function returns an error value (which can be tested using ZSTD_isError())
510  *           or an error code if it fails (which can be tested using ZSTD_isError()).
557  *  otherwise they will either trigger an error or be automatically clamped.
559  *         - an error status field, which must be tested using ZSTD_isError()
567  *  Providing a value beyond bound will either clamp it, or trigger an error (depending on parameter).
569  * @return : 0, or an error code (which can be tested using ZSTD_isError()).
577  * @return : 0, or an error code, which can be tested with ZSTD_isError()
633 *           or an error code, which can be tested using ZSTD_isError().
645 *            or an error code, which can be tested using ZSTD_isError().
657 *            or an error code, which can be tested using ZSTD_isError().
694  *            or an error code, which can be tested using ZSTD_isError().
745  * the next read size (if non-zero and not an error). ZSTD_compressStream2()
746  * returns the minimum nb of bytes left to flush (if non-zero and not an error).
776 *        or an error code, which can be tested using ZSTD_isError(),
919  *  When identifying the exact failure cause, it's possible to use ZSTD_getFrameHeader(), which will provide a more precise error code. */
936  * @result : 0, or an error code (which can be tested with ZSTD_isError()).
959  * @result : 0, or an error code (which can be tested with ZSTD_isError()).
972  * @result : 0, or an error code (which can be tested with ZSTD_isError()).
991  * @result : 0, or an error code (which can be tested with ZSTD_isError()).
1014  * @result : 0, or an error code (which can be tested with ZSTD_isError()).
1028  * @result : 0, or an error code (which can be tested with ZSTD_isError()).
1206     int checksumFlag;    /*< 1: generate a 32-bits checksum using XXH64 algorithm at end of frame, for error detection */
1313  *            - if an error occurred: ZSTD_CONTENTSIZE_ERROR
1335  *            - if an error occurred: ZSTD_CONTENTSIZE_ERROR
1337  *  note 1  : an error can occur if `src` contains an invalid or incorrectly formatted frame.
1348  *           or an error code (if srcSize is too small) */
1403  *    specifics regarding offset/matchlength requirements) then the function will bail out and return an error.
1408  *    - ZSTD_c_windowLog affects offset validation: this function will return an error at higher debug levels if a provided offset
1414  * @return : final compressed size or a ZSTD error.
1429  * Returns an error if destination buffer is not large enough, if the source size is not representable
1432  * @return : number of bytes written or a ZSTD error.
1444  * Returns an error if destination buffer is not large enough, or if the frame is not skippable.
1446  * @return : number of bytes written or a ZSTD error.
1483  *  ZSTD_estimateCCtxSize_usingCCtxParams() will return an error code if ZSTD_c_nbWorkers is >= 1.
1495  *  ZSTD_estimateCStreamSize_usingCCtxParams() can be used in tandem with ZSTD_CCtxParams_setParameter(). Only single-threaded compression is supported. This function will return an error code if ZSTD_c_nbWorkers is >= 1.
1526  *           or NULL if error (size too small, incorrect alignment, etc.)
1529  *         zstd will just error out (typically ZSTD_error_memory_allocation).
1639  * @return 0 on success, or an error code (can be checked with ZSTD_isError()) */
1813  * mode that makes sense is ZSTD_e_end, so zstd will error if ZSTD_e_end
1823  * NOTE: ZSTD_compressStream2() will error if ZSTD_e_end is not used.
1853  * Zstd will check that (out.size - out.pos) never grows and return an error
1881  * return an error.
1932  * @return : 0, or an error code (which can be tested with ZSTD_isError()).
1987  * @result : 0, or an error code (which can be tested with ZSTD_isError()).
2056  * @return : 0, or an error code (which can be tested using ZSTD_isError()).
2063  * @return : 0, or an error code (which can be tested with ZSTD_isError()).
2144  * @return : 0, or an error code (which can be tested using ZSTD_isError()). */
2271  * @return : 0, or an error code (which can be tested using ZSTD_isError())
2429   which can @return an error code if required value is too large for current system (in 32-bits mode).
2451   It can also be an error code, which can be tested with ZSTD_isError().
2487  *           or an error code, which can be tested using ZSTD_isError() */