Update documentation for ZSTD_frameSizeInfo

dev
shakeelrao 2019-03-17 17:41:27 -07:00
parent 19b75b6ecb
commit 0033bb4785
1 changed files with 4 additions and 4 deletions

View File

@ -244,14 +244,14 @@ typedef struct {
/** /**
* Contains the compressed frame size and an upper-bound for the decompressed frame size. * Contains the compressed frame size and an upper-bound for the decompressed frame size.
* Note: before using `compressedSize` you must check for errors using ZSTD_isError(). * Note: before using `compressedSize`, check for errors using ZSTD_isError().
* similarly, before using `decompressedBound`, you must check for errors using: * similarly, before using `decompressedBound`, check for errors using:
* `decompressedBound` != ZSTD_CONTENTSIZE_ERROR * `decompressedBound != ZSTD_CONTENTSIZE_ERROR`
*/ */
typedef struct { typedef struct {
size_t compressedSize; size_t compressedSize;
unsigned long long decompressedBound; unsigned long long decompressedBound;
} ZSTD_frameSizeInfo; } ZSTD_frameSizeInfo; /* decompress & legacy */
const seqStore_t* ZSTD_getSeqStore(const ZSTD_CCtx* ctx); /* compress & dictBuilder */ const seqStore_t* ZSTD_getSeqStore(const ZSTD_CCtx* ctx); /* compress & dictBuilder */
void ZSTD_seqToCodes(const seqStore_t* seqStorePtr); /* compress, dictBuilder, decodeCorpus (shouldn't get its definition from here) */ void ZSTD_seqToCodes(const seqStore_t* seqStorePtr); /* compress, dictBuilder, decodeCorpus (shouldn't get its definition from here) */