Skip to main content

rocketmq_protocol/common/compression/
compressor.rs

1// Copyright 2023 The RocketMQ Rust Authors
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15use bytes::Bytes;
16
17pub trait Compressor {
18    /// Compress message by different compressor.
19    ///
20    /// # Arguments
21    ///
22    /// * `src` - Bytes ready to compress.
23    /// * `level` - Compression level used to balance compression rate and time consumption.
24    ///
25    /// # Returns
26    ///
27    /// Compressed byte data or an `std::io::Error`.
28    fn compress(&self, src: &[u8], level: i32) -> rocketmq_error::Result<Bytes>;
29
30    /// Decompress message by different compressor.
31    ///
32    /// # Arguments
33    ///
34    /// * `src` - Bytes ready to decompress.
35    ///
36    /// # Returns
37    ///
38    /// Decompressed byte data or an `std::io::Error`.
39    fn decompress(&self, src: &[u8]) -> rocketmq_error::Result<Bytes>;
40}