[][src]Constant compu_brotli_sys::BrotliEncoderOperation_BROTLI_OPERATION_EMIT_METADATA

pub const BrotliEncoderOperation_BROTLI_OPERATION_EMIT_METADATA: BrotliEncoderOperation

Emit metadata block to stream.

Metadata is opaque to Brotli: neither encoder, nor decoder processes this data or relies on it. It may be used to pass some extra information from encoder client to decoder client without interfering with main data stream.

@note Encoder may emit empty metadata blocks internally, to pad encoded stream to byte boundary.

@warning Until emitting metadata is complete client @b SHOULD @b NOT swap, reduce or extend input stream.

@warning The whole content of input buffer is considered to be the content of metadata block. Do @b NOT @e append metadata to input stream, before it is depleted with other operations.

Stream is soft-flushed before metadata block is emitted. Metadata block @b MUST be no longer than than 16MiB.