ゴミ箱
Public Attributes | List of all members
boost::beast::zlib::z_params Struct Reference

#include <zlib.hpp>

Public Attributes

void const * next_in
 
std::size_t avail_in
 
std::size_t total_in = 0
 
void * next_out
 
std::size_t avail_out
 
std::size_t total_out = 0
 
int data_type = Z_UNKNOWN
 

Detailed Description

Deflate codec parameters.

Objects of this type are filled in by callers and provided to the deflate codec to define the input and output areas for the next compress or decompress operation.

The application must update next_in and avail_in when avail_in has dropped to zero. It must update next_out and avail_out when avail_out has dropped to zero. The application must initialize zalloc, zfree and opaque before calling the init function. All other fields are set by the compression library and must not be updated by the application.

The fields total_in and total_out can be used for statistics or progress reports. After compression, total_in holds the total size of the uncompressed data and may be saved for use in the decompressor (particularly if the decompressor wants to decompress everything in a single step).

Member Data Documentation

std::size_t boost::beast::zlib::z_params::avail_in

The number of bytes of input available at next_in.

If there is no more input, this should be set to zero.

std::size_t boost::beast::zlib::z_params::avail_out

The remaining bytes of space at next_out.

int boost::beast::zlib::z_params::data_type = Z_UNKNOWN
void const* boost::beast::zlib::z_params::next_in

A pointer to the next input byte.

If there is no more input, this may be set to nullptr.

void* boost::beast::zlib::z_params::next_out

A pointer to the next output byte.

std::size_t boost::beast::zlib::z_params::total_in = 0

The total number of input bytes read so far.

std::size_t boost::beast::zlib::z_params::total_out = 0

The total number of bytes output so far.


The documentation for this struct was generated from the following file: