Enumerations
enum class	Algorithm : std::uint8_t { None = 0x00 , LZ4 = 0x90 }
enum class	Compressed : std::uint8_t { On , Off }

Functions
template<typename InputStream>
std::size_t	decompress (InputStream &in, std::size_t inSize, std::uint8_t *decompressed, std::size_t decompressedSize, Algorithm algorithm=Algorithm::LZ4)
	Decompress input stream.
template<class BufferFactory>
std::size_t	compress (void const *in, std::size_t inSize, BufferFactory &&bf, Algorithm algorithm=Algorithm::LZ4)
	Compress input data.

Variables
constexpr std::size_t	kHeaderBytes = 6
constexpr std::size_t	kHeaderBytesCompressed = 10

Enumeration Type Documentation

◆ Algorithm

enum class xrpl::compression::Algorithm : std::uint8_t

strong

Enumerator
None
LZ4

Definition at line 13 of file Compression.h.

◆ Compressed

enum class xrpl::compression::Compressed : std::uint8_t

strong

Enumerator
On
Off

Definition at line 15 of file Compression.h.

Function Documentation

◆ decompress()

template<typename InputStream>

std::size_t xrpl::compression::decompress	(	InputStream &	in,
		std::size_t	inSize,
		std::uint8_t *	decompressed,
		std::size_t	decompressedSize,
		Algorithm	algorithm = Algorithm::LZ4 )

Decompress input stream.

Template Parameters

InputStream ZeroCopyInputStream

Parameters

in	Input source stream
inSize	Size of compressed data
decompressed	Buffer to hold decompressed message
algorithm	Compression algorithm type

Returns: Size of decompressed data or zero if failed to decompress

Definition at line 27 of file Compression.h.

◆ compress()

template<class BufferFactory>

std::size_t xrpl::compression::compress	(	void const *	in,
		std::size_t	inSize,
		BufferFactory &&	bf,
		Algorithm	algorithm = Algorithm::LZ4 )

Compress input data.

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
algorithm	Compression algorithm type

Returns: Size of compressed data, or zero if failed to compress

Definition at line 67 of file Compression.h.

Variable Documentation

◆ kHeaderBytes

std::size_t xrpl::compression::kHeaderBytes = 6

constexpr

Definition at line 8 of file Compression.h.

◆ kHeaderBytesCompressed

std::size_t xrpl::compression::kHeaderBytesCompressed = 10