staticlib_compress  1.2.0
 All Classes Namespaces Files Functions Enumerations
Public Member Functions | List of all members
staticlib::compress::deflate_sink< Sink, compression_level, buf_size > Class Template Reference

Sink wrapper that compressed written data using Deflate algorithm. More...

#include <staticlib/compress/deflate_sink.hpp>

Public Member Functions

 deflate_sink (Sink &&sink)
 Constructor.
deflate_sink & operator= (const deflate_sink &)
 Deleted copy assignment operator.
 deflate_sink (deflate_sink &&other)
 Move constructor.
deflate_sink & operator= (deflate_sink &&other)
 Move assignment operator.
std::streamsize write (sl::io::span< const char > span)
 Write implementation.
std::streamsize flush ()
 Calls flush on dest stream.
Sink & get_sink ()
 Underlying sink accessor.

Detailed Description

template<typename Sink, int compression_level = 6, std::size_t buf_size = 4096>
class staticlib::compress::deflate_sink< Sink, compression_level, buf_size >

Sink wrapper that compressed written data using Deflate algorithm.

Constructor & Destructor Documentation

template<typename Sink , int compression_level = 6, std::size_t buf_size = 4096>
staticlib::compress::deflate_sink< Sink, compression_level, buf_size >::deflate_sink ( Sink &&  sink)
inline

Constructor.

Parameters
sinkdestination to write compressed data into
template<typename Sink , int compression_level = 6, std::size_t buf_size = 4096>
staticlib::compress::deflate_sink< Sink, compression_level, buf_size >::deflate_sink ( deflate_sink< Sink, compression_level, buf_size > &&  other)
inline

Move constructor.

Parameters
otherother instance

Member Function Documentation

template<typename Sink , int compression_level = 6, std::size_t buf_size = 4096>
std::streamsize staticlib::compress::deflate_sink< Sink, compression_level, buf_size >::flush ( )
inline

Calls flush on dest stream.

Returns
value returned by dest stream
template<typename Sink , int compression_level = 6, std::size_t buf_size = 4096>
Sink& staticlib::compress::deflate_sink< Sink, compression_level, buf_size >::get_sink ( )
inline

Underlying sink accessor.

Returns
underlying sink reference
template<typename Sink , int compression_level = 6, std::size_t buf_size = 4096>
deflate_sink& staticlib::compress::deflate_sink< Sink, compression_level, buf_size >::operator= ( const deflate_sink< Sink, compression_level, buf_size > &  )

Deleted copy assignment operator.

Parameters
otherinstance
Returns
this instance
template<typename Sink , int compression_level = 6, std::size_t buf_size = 4096>
deflate_sink& staticlib::compress::deflate_sink< Sink, compression_level, buf_size >::operator= ( deflate_sink< Sink, compression_level, buf_size > &&  other)
inline

Move assignment operator.

Parameters
otherother instance
Returns
this instance
template<typename Sink , int compression_level = 6, std::size_t buf_size = 4096>
std::streamsize staticlib::compress::deflate_sink< Sink, compression_level, buf_size >::write ( sl::io::span< const char >  span)
inline

Write implementation.

Parameters
spansource span
Returns
number of bytes processed (read from source span)

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