ORE Studio 0.0.4
Loading...
Searching...
No Matches
compression.hpp
1/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
2 *
3 * Copyright (C) 2025 Marco Craveiro <marco.craveiro@gmail.com>
4 *
5 * This program is free software; you can redistribute it and/or modify it under
6 * the terms of the GNU General Public License as published by the Free Software
7 * Foundation; either version 3 of the License, or (at your option) any later
8 * version.
9 *
10 * This program is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
12 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
13 * details.
14 *
15 * You should have received a copy of the GNU General Public License along with
16 * this program; if not, write to the Free Software Foundation, Inc., 51
17 * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 *
19 */
20#ifndef ORES_COMMS_MESSAGING_COMPRESSION_HPP
21#define ORES_COMMS_MESSAGING_COMPRESSION_HPP
22
23#include <span>
24#include <vector>
25#include <cstddef>
26#include <expected>
27#include "ores.comms/messaging/message_types.hpp"
28
30
38std::expected<std::vector<std::byte>, error_code>
39compress(std::span<const std::byte> data, compression_type type);
40
48std::expected<std::vector<std::byte>, error_code>
49decompress(std::span<const std::byte> data, compression_type type);
50
58
59}
60
61#endif
Contains messaging related infrastructure in the comms library.
Definition compression.hpp:29
std::expected< std::vector< std::byte >, error_code > decompress(std::span< const std::byte > data, compression_type type)
Decompress data using the specified algorithm.
Definition compression.cpp:103
std::expected< std::vector< std::byte >, error_code > compress(std::span< const std::byte > data, compression_type type)
Compress data using the specified algorithm.
Definition compression.cpp:62
bool is_compression_supported(compression_type type)
Check if compression is supported for the given type.
Definition compression.cpp:49
compression_type
Compression algorithm used for payload compression.
Definition message_types.hpp:104