LZ4 API Guide  1.00.01.00
Data Fields
LZ4_compressParams Struct Reference

Compression parameters for a LZ4 frame. More...

#include <lz4.h>

Data Fields

const void * src
 Pointer to the source data buffer to compress. More...
 
void * dst
 Pointer to the destination data buffer to store compressed data. More...
 
uint32_t length
 Length of source data buffer. More...
 
void * hashTable
 Pointer to memory block with pow2(hashLog2Size) bytes allocated. More...
 
uint16_t hashLog2Size
 Power of two used to determine the hash table size. More...
 
bool addBlockChecksum
 
bool addContentChecksum
 
bool addContentSize
 

Detailed Description

Compression parameters for a LZ4 frame.

Field Documentation

§ src

const void* LZ4_compressParams::src

Pointer to the source data buffer to compress.

Referenced by LZ4_compress().

§ dst

void* LZ4_compressParams::dst

Pointer to the destination data buffer to store compressed data.

Referenced by LZ4_compress().

§ length

uint32_t LZ4_compressParams::length

Length of source data buffer.

§ hashTable

void* LZ4_compressParams::hashTable

Pointer to memory block with pow2(hashLog2Size) bytes allocated.

§ hashLog2Size

uint16_t LZ4_compressParams::hashLog2Size

Power of two used to determine the hash table size.

§ addBlockChecksum

bool LZ4_compressParams::addBlockChecksum

Add checksum to each compressed block. Decreases compression performance. Valid values are:

  • false
  • true

§ addContentChecksum

bool LZ4_compressParams::addContentChecksum

Add checksum of original source data buffer. Decreases compression performance. Valid values are:

  • false
  • true

§ addContentSize

bool LZ4_compressParams::addContentSize

Add total content size to LZ4 frame. Increases total frame size by 8 bytes. Valid values are:

  • false
  • true

The documentation for this struct was generated from the following file:
© Copyright 1995-2019, Texas Instruments Incorporated. All rights reserved.
Trademarks | Privacy policy | Terms of use | Terms of sale