Skip to content

Commit 0bef8a6

Browse files
eustascopybara-github
authored andcommitted
clarify that prepared dictionaries are "lean"
PiperOrigin-RevId: 811236534
1 parent 9686382 commit 0bef8a6

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

c/include/brotli/encode.h

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -283,6 +283,10 @@ typedef struct BrotliEncoderPreparedDictionaryStruct
283283
* passed to @p alloc_func and @p free_func when they are called. @p free_func
284284
* has to return without doing anything when asked to free a NULL pointer.
285285
*
286+
* @warning Created instance is "lean"; it does not contain copy of @p data,
287+
* rather it contains only pointer to it; therefore,
288+
* @p data @b MUST outlive the created instance.
289+
*
286290
* @param type type of dictionary stored in data
287291
* @param data_size size of @p data buffer
288292
* @param data pointer to the dictionary data

0 commit comments

Comments
 (0)