rippled
Functions
ripple::compression_algorithms Namespace Reference

Functions

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 inSizeUnchecked, std::uint8_t *decompressed, std::size_t decompressedSizeUnchecked)
 
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

◆ 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
BufferFactoryCallable object or lambda. Takes the requested buffer size and returns allocated buffer pointer.
Parameters
inData to compress
inSizeSize of the data
bfCompressed buffer allocator
Returns
Size of compressed data, or zero if failed to compress

Definition at line 44 of file CompressionAlgorithms.h.

◆ lz4Decompress() [1/2]

std::size_t ripple::compression_algorithms::lz4Decompress ( std::uint8_t const *  in,
std::size_t  inSizeUnchecked,
std::uint8_t decompressed,
std::size_t  decompressedSizeUnchecked 
)
Parameters
inCompressed data
inSizeUncheckedSize of compressed data
decompressedBuffer to hold decompressed data
decompressedSizeUncheckedSize of the decompressed buffer
Returns
size of the decompressed data

Definition at line 74 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
InputStreamZeroCopyInputStream
Parameters
inInput source stream
inSizeSize of compressed data
decompressedBuffer to hold decompressed data
decompressedSizeSize of the decompressed buffer
Returns
size of the decompressed data

Definition at line 109 of file CompressionAlgorithms.h.