Module rust_macios::compression

Compression

Leverage common compression algorithms for lossless data compression.

Overview

The Compression framework enables your app to provide lossless compression when saving or sharing files and data. Compression is a process in which you compress (encode) and decompress (decode) data. For example, a text editor may save its files in a compressed format, and automatically decompress the saved file when opened by the user.

Structs

compression_stream

A structure representing a compression stream.

Enums

compression_algorithm

A structure for values that represent compression algorithms.

compression_status

A set of values used to represent the status of stream compression.

compression_stream_flags

A set of values used to represent a stream compression operation.

compression_stream_operation

A set of values used to represent a stream compression operation.

Functions

compression_decode_buffer^⚠

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

compression_decode_scratch_buffer_size^⚠

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

compression_encode_buffer^⚠

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

compression_encode_scratch_buffer_size^⚠

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

compression_stream_destroy^⚠

Frees any memory allocated by stream initialization function.

compression_stream_init^⚠

Initializes a compression stream for either compression or decompression.

compression_stream_process^⚠

Performs compression or decompression using an initialized compression stream structure.