tkrzw::LZ4Compressor Class Reference

Compressor implemeted with LZ4. More...

#include <tkrzw_compress.h>

Public Member Functions
	LZ4Compressor (int32_t acceleration=1)
	Constructor. More...
virtual	~LZ4Compressor ()
	Destructor. More...
bool	IsSupported () const override
	Checks whether the implementation is actually supported. More...
char *	Compress (const void *buf, size_t size, size_t *sp) const override
	Compresses a serial data. More...
char *	Decompress (const void *buf, size_t size, size_t *sp) const override
	Decompresses a serial data. More...
std::unique_ptr< Compressor >	MakeCompressor () const override
	Makes a new Compressor object of the same concrete class. More...
Public Member Functions inherited from tkrzw::Compressor
virtual	~Compressor ()=default
	Destructor. More...
const std::type_info &	GetType () const
	Gets the type information of the actual class. More...

Detailed Description

Compressor implemeted with LZ4.

Constructor & Destructor Documentation

LZ4Compressor()

tkrzw::LZ4Compressor::LZ4Compressor ( int32_t  acceleration = 1 )

explicit

Constructor.

Parameters

acceleration

The accelaration level which is 1 or more. Increasing it by 1 means 3-4% speed boost with less compression ratio.

~LZ4Compressor()

virtual tkrzw::LZ4Compressor::~LZ4Compressor ( )

virtual

Destructor.

Member Function Documentation

IsSupported()

bool tkrzw::LZ4Compressor::IsSupported ( ) const

overridevirtual

Checks whether the implementation is actually supported.

Returns

True if the implementation is actually supported.

Implements tkrzw::Compressor.

Compress()

char* tkrzw::LZ4Compressor::Compress ( const void *  buf, size_t  size, size_t *  sp  ) const

overridevirtual

Compresses a serial data.

Parameters

buf	the input buffer.
size	the size of the input buffer.
sp	the pointer to the variable into which the size of the region of the return value is assigned.

Returns

The pointer to the result data, or nullptr on failure.

Because the region of the return value is allocated with the xmalloc function, it should be released with the xfree function.

Implements tkrzw::Compressor.

Decompress()

char* tkrzw::LZ4Compressor::Decompress ( const void *  buf, size_t  size, size_t *  sp  ) const

overridevirtual

Decompresses a serial data.

Parameters

buf	the input buffer.
size	the size of the input buffer.
sp	the pointer to the variable into which the size of the region of the return value is assigned.

Returns

The pointer to the result data, or nullptr on failure.

Because the region of the return value is allocated with the xmalloc function, it should be released with the xfree function.

Implements tkrzw::Compressor.

MakeCompressor()

std::unique_ptr<Compressor> tkrzw::LZ4Compressor::MakeCompressor ( ) const

overridevirtual

Makes a new Compressor object of the same concrete class.

Returns

The new Compressor object.

Implements tkrzw::Compressor.