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