compression.hpp

Go to the documentation of this file.

#pragma once
 
#include <cstdint>
#include <memory>
#include <optional>
#include <span>
#include <variant>
#include <vector>
 
#include <sparrow/buffer/buffer.hpp>
 
#include "sparrow_ipc/config/config.hpp"
 
namespace sparrow_ipc
{
    enum class CompressionType : std::uint8_t
    {
        LZ4_FRAME,
        ZSTD
    };
 
    class CompressionCacheImpl;
 
    class SPARROW_IPC_API CompressionCache
    {
    public:
 
        CompressionCache();
        ~CompressionCache();
 
        CompressionCache(CompressionCache&&) noexcept;
        CompressionCache& operator=(CompressionCache&&) noexcept;
 
        CompressionCache(const CompressionCache&) = delete;
        CompressionCache& operator=(const CompressionCache&) = delete;
 
        std::optional<std::span<const std::uint8_t>> find(const void* data_ptr, const size_t data_size);
        std::span<const std::uint8_t>
        store(const void* data_ptr, const size_t data_size, std::vector<std::uint8_t>&& data);
 
        [[nodiscard]] size_t size() const;
        [[nodiscard]] size_t count(const void* data_ptr, const size_t data_size) const;
        [[nodiscard]] bool empty() const;
        void clear();
 
    private:
 
        std::unique_ptr<CompressionCacheImpl> m_pimpl;
    };
 
    [[nodiscard]] SPARROW_IPC_API std::span<const std::uint8_t> compress(
        const CompressionType compression_type,
        const std::span<const std::uint8_t>& data,
        CompressionCache& cache
    );
 
    [[nodiscard]] SPARROW_IPC_API size_t get_compressed_size(
        const CompressionType compression_type,
        const std::span<const std::uint8_t>& data,
        CompressionCache& cache
    );
 
    [[nodiscard]] SPARROW_IPC_API std::variant<sparrow::buffer<std::uint8_t>, std::span<const std::uint8_t>>
    decompress(const CompressionType compression_type, std::span<const std::uint8_t> data);
}