Structure

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

Compression Stream Properties

var dst_ptr: UnsafeMutablePointer<UInt8>

A pointer to the first byte of the destination buffer.

var dst_size: Int

The size, in bytes, of the destination buffer.

var src_ptr: UnsafePointer<UInt8>

A pointer to the first byte of the source buffer.

var src_size: Int

The size, in bytes, of the source buffer.

var state: UnsafeMutableRawPointer?

The stream state object of the compression stream.

See Also

Multiple-Step Compression

Compressing and Decompressing Files with Stream Compression

Perform compression or the appropriate kind of decompression to a file based on its path extension.

func compression_stream_process(UnsafeMutablePointer<compression_stream>, Int32) -> compression_status

Performs compression or decompression using an initialized compression stream structure.

struct compression_status

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

struct compression_stream_flags

A set of values used to represent stream compression flags.

struct compression_stream_operation

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

Beta Software

This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.

Learn more about using Apple's beta software