ripple::compression_algorithms Namespace Reference

Functions
void	doThrow (const char *message)
	Convenience wrapper for Throw. More...
template<typename BufferFactory >
std::size_t	lz4Compress (void const *in, std::size_t inSize, BufferFactory &&bf)
	LZ4 block compression. More...
std::size_t	lz4Decompress (std::uint8_t const *in, std::size_t inSize, std::uint8_t *decompressed, std::size_t decompressedSize)
template<typename InputStream >
std::size_t	lz4Decompress (InputStream &in, std::size_t inSize, std::uint8_t *decompressed, std::size_t decompressedSize)
	LZ4 block decompression. More...

Function Documentation

doThrow()

void ripple::compression_algorithms::doThrow

(

const char *

message

)

Convenience wrapper for Throw.

Parameters

message

Message to log/throw

Definition at line 35 of file CompressionAlgorithms.h.

lz4Compress()

template<typename BufferFactory >

std::size_t ripple::compression_algorithms::lz4Compress	(	void const *	in,
		std::size_t	inSize,
		BufferFactory &&	bf
	)

LZ4 block compression.

Template Parameters

BufferFactory

Callable object or lambda. Takes the requested buffer size and returns allocated buffer pointer.

Parameters

in	Data to compress
inSize	Size of the data
bf	Compressed buffer allocator

Returns

Size of compressed data, or zero if failed to compress

Definition at line 50 of file CompressionAlgorithms.h.

lz4Decompress() [1/2]

std::size_t ripple::compression_algorithms::lz4Decompress	(	std::uint8_t const *	in,
		std::size_t	inSize,
		std::uint8_t *	decompressed,
		std::size_t	decompressedSize
	)

Parameters

in	Compressed data
inSize	Size of compressed data
decompressed	Buffer to hold decompressed data
decompressedSize	Size of the decompressed buffer

Returns

size of the decompressed data

Definition at line 80 of file CompressionAlgorithms.h.

lz4Decompress() [2/2]

template<typename InputStream >

std::size_t ripple::compression_algorithms::lz4Decompress	(	InputStream &	in,
		std::size_t	inSize,
		std::uint8_t *	decompressed,
		std::size_t	decompressedSize
	)

LZ4 block decompression.

Template Parameters

InputStream

ZeroCopyInputStream

Parameters

in	Input source stream
inSize	Size of compressed data
decompressed	Buffer to hold decompressed data
decompressedSize	Size of the decompressed buffer

Returns

size of the decompressed data

Definition at line 108 of file CompressionAlgorithms.h.