Spicy
Public Member Functions | List of all members
spicy::rt::zlib::Stream Class Reference

#include <zlib_.h>

Public Member Functions

 Stream (int64_t window_bits=15+32)
 
 Stream (const Stream &)=default
 
 Stream (Stream &&) noexcept=default
 
Streamoperator= (const Stream &)=default
 
Streamoperator= (Stream &&) noexcept=default
 
hilti::rt::Bytes decompress (const hilti::rt::Bytes &data)
 
hilti::rt::Bytes decompress (const hilti::rt::stream::View &data)
 
hilti::rt::Bytes finish ()
 

Detailed Description

State for streaming gzip decompression.

Constructor & Destructor Documentation

◆ Stream()

Stream::Stream ( int64_t  window_bits = 15 + 32)

Constructor initializing a new stream for decompression.

Parameters
windows_bitsvalue corresponding to zlib's windowBits parameter for inflateInit2; the default means "check for, and require, a gzip file"

Member Function Documentation

◆ decompress() [1/2]

hilti::rt::Bytes Stream::decompress ( const hilti::rt::Bytes data)

Decompresses a chunk of data. Each chunk will continue where the previous one left off.

Parameters
datanext chunk of data to decompress
Returns
newly decompressed data

◆ decompress() [2/2]

hilti::rt::Bytes Stream::decompress ( const hilti::rt::stream::View data)

Decompresses a chunk of data. Each chunk will continue where the previous one left off.

Parameters
datanext chunk of data to decompress
Returns
newly decompressed data

◆ finish()

hilti::rt::Bytes Stream::finish ( )

Signals the end of decompression.

Returns
any additional data becoming available at the end of the process

The documentation for this class was generated from the following files: