Compresses the contents of a source buffer into a destination buffer.


func compression_encode_buffer(_ dst_buffer: UnsafeMutablePointer<UInt8>, _ dst_size: Int, _ src_buffer: UnsafePointer<UInt8>, _ src_size: Int, _ scratch_buffer: UnsafeMutableRawPointer?, _ algorithm: compression_algorithm) -> Int



Pointer to the buffer that receives the compressed data.


Size of the destination buffer in bytes.


Pointer to a buffer containing all of the source data.


Size of the data in the source buffer in bytes.


If scratch_buffer is not nil, this parameter is a pointer to a buffer that the function uses for scratch purposes. The size of this buffer must be at least the size returned by a previous call to compression_encode_scratch_buffer_size(_:).

If scratch_buffer is nil, the function creates and manages its own scratch space, but with a possible performance hit.


Return Value

The number of bytes written to the destination buffer after compressing the input. If the funtion can't compress the entire input to fit into the provided destination buffer, or an error occurs, 0 is returned.


If the input is successfully compressed, the function writes the compressed data to dst_buffer.

See Also

Single-Step Compression

Compressing and Decompressing Data with Buffer Compression

Compress a string, write it to the file system, and decompress the same file using buffer compression.

func compression_encode_scratch_buffer_size(compression_algorithm) -> Int

Returns the required compression scratch buffer size for the selected algorithm.

func compression_decode_scratch_buffer_size(compression_algorithm) -> Int

Returns the required decompression scratch buffer size for the selected algorithm.