Decompresses the contents of a source buffer into a destination buffer.
SDKs
- iOS 9.0+
- macOS 10.11+
- Mac Catalyst 13.0+
- tvOS 9.0+
- watchOS 2.0+
Framework
- Compression
Declaration
func compression_decode_buffer(_ dst_buffer: UnsafeParameters
dst_bufferPointer to the buffer that receives the decompressed data.
dst_sizeSize of the destination buffer in bytes.
src_bufferPointer to a buffer containing all of the compressed source data.
src_sizeSize of the data in the source buffer in bytes.
scratch_bufferIf
scratchis not_buffer 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 tocompression._decode _scratch _buffer _size(_:) If
scratchis_buffer nil, the function creates and manages its own scratch space, but with a possible performance hit.algorithmSet to the desired algorithm:
COMPRESSION,_LZ4 COMPRESSION,_ZLIB COMPRESSION, or_LZMA 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 bytes to the buffer and returns dst. Note that this behavior differs from that of compression.
Discussion
The function writes the decompressed data to dst.