ZSTD_CCtx_setPledgedSrcSize method

int ZSTD_CCtx_setPledgedSrcSize(
  1. Pointer<ZSTD_CCtx> cctx,
  2. int pledgedSrcSize
)

! ZSTD_CCtx_setPledgedSrcSize() : Total input data size to be compressed as a single frame. Value will be written in frame header, unless if explicitly forbidden using ZSTD_c_contentSizeFlag. This value will also be controlled at end of frame, and trigger an error if not respected. @result : 0, or an error code (which can be tested with ZSTD_isError()). Note 1 : pledgedSrcSize==0 actually means zero, aka an empty frame. In order to mean "unknown content size", pass constant ZSTD_CONTENTSIZE_UNKNOWN. ZSTD_CONTENTSIZE_UNKNOWN is default value for any new frame. Note 2 : pledgedSrcSize is only valid once, for the next frame. It's discarded at the end of the frame, and replaced by ZSTD_CONTENTSIZE_UNKNOWN. Note 3 : Whenever all input data is provided and consumed in a single round, for example with ZSTD_compress2(), or invoking immediately ZSTD_compressStream2(,,,ZSTD_e_end), this value is automatically overridden by srcSize instead.

Implementation

int ZSTD_CCtx_setPledgedSrcSize(
    ffi.Pointer<ZSTD_CCtx> cctx,
    int pledgedSrcSize,
    ) {
  return _ZSTD_CCtx_setPledgedSrcSize(
    cctx,
    pledgedSrcSize,
  );
}