Function zstd_sys::ZSTD_CCtx_setPledgedSrcSize [−] [src]

pub unsafe extern "C" fn ZSTD_CCtx_setPledgedSrcSize(
    cctx: *mut ZSTD_CCtx, 
    pledgedSrcSize: c_ulonglong
) -> usize

ZSTD_CCtx_setPledgedSrcSize() : Total input data size to be compressed as a single frame. This value will be controlled at the end, and result in error if not respected. @result : 0, or an error code (which can be tested with ZSTD_isError()). Note 1 : 0 means zero, empty. In order to mean "unknown content size", pass constant ZSTD_CONTENTSIZE_UNKNOWN. Note that ZSTD_CONTENTSIZE_UNKNOWN is default value for new compression jobs. Note 2 : If all data is provided and consumed in a single round, this value is overriden by srcSize instead.