Function zstd_sys::ZSTD_initStaticDCtx [−] [src]

pub unsafe extern "C" fn ZSTD_initStaticDCtx(
    workspace: *mut c_void, 
    workspaceSize: usize
) -> *mut ZSTD_DCtx

ZSTD_initStaticDCtx() : initialize a fixed-size zstd decompression context workspace: The memory area to emplace the context into. Provided pointer must 8-bytes aligned. It must outlive context usage. workspaceSize: Use ZSTD_estimateDCtxSize() or ZSTD_estimateDStreamSize() to determine how large workspace must be to support scenario. @return : pointer to ZSTD_DCtx*, or NULL if error (size too small) Note : zstd will never resize nor malloc() when using a static dctx. If it needs more memory than available, it will simply error out. Note 2 : static dctx is incompatible with legacy support Note 3 : there is no corresponding "free" function. Since workspace was allocated externally, it must be freed externally. Limitation : currently not compatible with internal DDict creation, such as ZSTD_initDStream_usingDict().