abstract class Crabbit::CompressionCodec

• Crabbit::CompressionCodec
• Reference
• Object

Overview

Interface for a Stream sub-entry compression algorithm.

Custom implementations can be installed with CompressionCodecs#register. Decompression must return exactly expected_size bytes or raise CompressionError.

Direct Known Subclasses

• Crabbit::GzipCompressionCodec
• Crabbit::Lz4CompressionCodec
• Crabbit::NoCompressionCodec
• Crabbit::SnappyCompressionCodec
• Crabbit::ZstdCompressionCodec

Defined in:

crabbit/compression.cr

Instance Method Summary

• #compress(source : Bytes) : Bytes

  Compresses source and returns a newly owned byte slice.

• #compression : Compression

  Returns the protocol algorithm implemented by this codec.

• #decompress(source : Bytes, expected_size : Int32) : Bytes

  Decompresses source to exactly expected_size bytes.

Instance Method Detail