Function ZSTD_readSkippableFrame

Source
pub unsafe extern "C" fn ZSTD_readSkippableFrame(
    dst: *mut c_void,
    dstCapacity: usize,
    magicVariant: *mut c_uint,
    src: *const c_void,
    srcSize: usize,
) -> usize
Expand description

ZSTD_readSkippableFrame() : Retrieves the content of a zstd skippable frame starting at @src, and writes it to @dst buffer.

The parameter @magicVariant will receive the magicVariant that was supplied when the frame was written, i.e. magicNumber - ZSTD_MAGIC_SKIPPABLE_START. This can be NULL if the caller is not interested in the magicVariant.

Returns an error if destination buffer is not large enough, or if the frame is not skippable.

@return : number of bytes written or a ZSTD error.