compression.hpp

/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
 *
 * Copyright (C) 2025 Marco Craveiro <marco.craveiro@gmail.com>
 *
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License as published by the Free Software
 * Foundation; either version 3 of the License, or (at your option) any later
 * version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc., 51
 * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 */
#ifndef ORES_COMMS_MESSAGING_COMPRESSION_HPP
#define ORES_COMMS_MESSAGING_COMPRESSION_HPP
 
#include <span>
#include <vector>
#include <cstddef>
#include <expected>
#include "ores.comms/messaging/message_types.hpp"
 
namespace ores::comms::messaging {
 
constexpr std::size_t MAX_DECOMPRESSED_SIZE = 16 * 1024 * 1024;
 
std::expected<std::vector<std::byte>, ores::utility::serialization::error_code>
compress(std::span<const std::byte> data, compression_type type);
 
std::expected<std::vector<std::byte>, ores::utility::serialization::error_code>
decompress(std::span<const std::byte> data, compression_type type);
 
bool is_compression_supported(compression_type type);
 
}
 
#endif