! ZSTD_estimateDDictSize() : * Estimate amount of memory that will be needed to create a dictionary for decompression. * Note : dictionary created

ZSTD_findDecompressedSize() : * `srcSize` must be the exact length of some number of ZSTD compressed and/or * skippable frames * note: compa

ZSTD_frameHeaderSize() : * srcSize must be >= ZSTD_frameHeaderSize_prefix. * @return : size of the Frame Header, * or an error code (if

ZSTD_getDecompressedSize() : * compatible with legacy mode * @return : decompressed size if known, 0 otherwise note : 0 can mean any o

! ZSTD_getDictID_fromDict() : * Provides the dictID stored within dictionary. * if @return == 0, the dictionary is not conformant with Zstandard s

! ZSTD_getDictID_fromFrame() : * Provides the dictID required to decompress frame stored within `src`. * If @return == 0, the dictID could not be

! ZSTD_getErrorName() : * provides error code string from function result (useful for debugging) */

! ZSTD_getErrorString() : * provides error code string from enum */

note : this variant can't fail */

ZSTD_initDStream_usingDDict() : * ddict will just be referenced, and must outlive decompression session * this function cannot fail */

ZSTD_initDStream_usingDict() : * return : expected size, aka ZSTD_startingInputLength(). * this function cannot fail */

ZSTD_insertBlock() : * insert `src` block into `dctx` history. Useful to track uncompressed blocks. */

! ZSTD_isFrame() : * Tells if the content of `buffer` starts with a valid Frame Identifier. * Note : Frame Identifier is 4 bytes. If `size < 4`, @

@return 1 if @u is a 2^n value, 0 otherwise * useful to check a value is valid for alignment restrictions */

! ZSTD_readSkippableFrame() : * Retrieves content of a skippable frame, and writes it to dst buffer. * * The parameter magicVariant will receive th

ZSTD_resetDStream() : * return : expected size, aka ZSTD_startingInputLength(). * this function cannot fail */

ZSTD_rotateRight_*(): * Rotates a bitfield to the right by "count" bits. * https://en.wikipedia.org/w/index.php?title=Circular_shift&oldid=991635599

-**************************************** * Version ******************************************/

* Collection of unused functions and const variables to work around \c * -Wunused-function and \c -Wunused-const-variable warnings. * * \todo LTO d

A few of these break the lane-based abstraction model. They are supported in SSE2, so it makes sense to support them and let the user figure it out.

Get all errors as a single string

Caller assumes ownership of the heap block associated with the container. Container is cleared. Caller must use free() on the returned pointer.