Contents

compression_decode_buffer(_:_:_:_:_:_:)

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

Declaration

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

Parameters

  • dst_buffer:

    Pointer to the buffer that receives the decompressed data.

  • dst_size:

    Size of the destination buffer in bytes.

  • src_buffer:

    Pointer to a buffer containing all of the compressed source data.

  • src_size:

    Size of the data in the source buffer in bytes.

  • scratch_buffer:

    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_decode_scratch_buffer_size(_:).

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

  • algorithm:

    Set to the desired algorithm: Compression_lz4, Compression_zlib, Compression_lzma, or Compression_lzfse.

Return Value

The number of bytes written to the destination buffer after decompressing the input. If there is not enough space in the destination buffer to hold the entire decompressed output, the function writes the first dst_size bytes to the buffer and returns dst_size. Note that this behavior differs from that of compression_encode_buffer(_:_:_:_:_:_:).

Discussion

The function writes the decompressed data to dst_buffer.

See Also

Single-step compression