LZ4_loadDict

[LZ4_loadDict()](API\Runtime\Core\Compression\LZ4_loadDict) : Use this function to reference a static dictionary into LZ4_stream_t.

Choose your operating system:

Windows

macOS

Linux

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Compression/lz4.h

Include

#include "Compression/lz4.h"

Source

/Engine/Source/Runtime/Core/Private/Compression/lz4.cpp

Syntax

LZ4int LZ4_loadDict
(
    LZ4_stream_t * streamPtr,
    const char * dictionary,
    int dictSize
)

Remarks

LZ4_loadDict() : Use this function to reference a static dictionary into LZ4_stream_t. The dictionary must remain available during compression. LZ4_loadDict() triggers a reset, so any previous data will be forgotten. The same dictionary will have to be loaded on decompression side for successful decoding. Dictionary are useful for better compression of small data (KB range). While LZ4 accept any input as dictionary, results are generally better when using Zstandard's Dictionary Builder. Loading a size of 0 is allowed, and is the same as reset.

Returns

: loaded dictionary size, in bytes (necessarily <= 64 KB)