Kayrock.Compression (kayrock v0.1.12) View Source
Handles compression/decompression of messages.
NOTE this is a copy of KafkaEx.Compression: https://github.com/kafkaex/kafka_ex/blob/master/lib/kafka_ex/compression.ex
It is duplicated here to avoid creating a circular dependency.
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
Functions
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.
Link to this section Types
Specs
attribute_t() :: integer()
Specs
compression_type_t() :: :snappy | :gzip
Link to this section Functions
Specs
compress(compression_type_t(), iodata()) :: {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.
Specs
decompress(attribute_t(), binary()) :: binary()
This function should pattern match on the attribute value and return the decompressed data.