Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

This is the documentation for a snapshot of the develop branch, built from commit dcea408971.
PrevUpHomeNext
zlib::deflate_stream::prime

Insert bits into the compressed output stream.

Synopsis
void
prime(
    int bits,
    int value,
    error_code& ec);
Description

This function inserts bits in the deflate output stream. The intent is that this function is used to start off the deflate output with the bits leftover from a previous deflate stream when appending to it. As such, this function can only be used for raw deflate, and must be used before the first write call after an initialization. bits must be less than or equal to 16, and that many of the least significant bits of value will be inserted in the output.

Return Value

error::need_buffers if there was not enough room in the internal buffer to insert the bits.


PrevUpHomeNext