KafkaEx.Compression (kafka_ex v0.12.1) View Source

Handles compression/decompression of messages.

To add new compression types:

Add the appropriate dependency to mix.exs (don't forget to add it to the application list).
Add the appropriate attribute value and compression_type atom.
Add a decompress function clause.
Add a compress function clause.

Link to this section Summary

This function should pattern match on the compression_type atom and return the compressed data as well as the corresponding attribute value.

This function should pattern match on the attribute value and return the decompressed data.

attribute_t() :: integer()

compression_type_t() :: :snappy | :gzip

compress(compression_type_t(), binary()) :: {binary(), attribute_t()}

This function should pattern match on the compression_type atom and return the compressed data as well as the corresponding attribute value.

decompress(attribute_t(), binary()) :: binary()

This function should pattern match on the attribute value and return the decompressed data.