Contents

compression_stream

A structure representing a compression stream.

Declaration

struct compression_stream

Overview

The basic workflow for using the stream interface is as follows:

  1. Initialize the state of your compression_stream structure by calling compression_stream_init(_:_:_:) with the operation parameter set to specify whether you are encoding or decoding, and the chosen algorithm specified by the algorithm parameter. This allocates storage for the state that allows you to resume encoding or decoding across calls.

  2. Set the dst_buffer, dst_size, src_buffer, and src_size fields of the compression_stream object to point to the next blocks that your code processes.

  3. Call compression_stream_process(_:_:). If no further input will be added to the stream via subsequent calls, flags should be COMPRESSION_STREAM_FINALIZE (otherwise 0). If compression_stream_process(_:_:) returns COMPRESSION_STATUS_END, there is no further output from the stream.

  4. Repeat steps 2 and 3 as necessary to process the entire stream.

  5. Call compression_stream_destroy(_:) to free the state object in the stream structure.

Topics

Initializers

Compression Stream Properties

See Also

Multiple-step compression