1// Licensed to the Apache Software Foundation (ASF) under one
2// or more contributor license agreements. See the NOTICE file
3// distributed with this work for additional information
4// regarding copyright ownership. The ASF licenses this file
5// to you under the Apache License, Version 2.0 (the
6// "License"); you may not use this file except in compliance
7// with 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,
12// software distributed under the License is distributed on an
13// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14// KIND, either express or implied. See the License for the
15// specific language governing permissions and limitations
16// under the License.
17
18#ifndef ARROW_UTIL_COMPRESSION_ZLIB_H
19#define ARROW_UTIL_COMPRESSION_ZLIB_H
20
21#include <cstdint>
22#include <memory>
23
24#include "arrow/status.h"
25#include "arrow/util/compression.h"
26#include "arrow/util/visibility.h"
27
28namespace arrow {
29namespace util {
30
31// GZip codec.
32class ARROW_EXPORT GZipCodec : public Codec {
33 public:
34 /// Compression formats supported by the zlib library
35 enum Format {
36 ZLIB,
37 DEFLATE,
38 GZIP,
39 };
40
41 explicit GZipCodec(Format format = GZIP);
42 ~GZipCodec() override;
43
44 Status Decompress(int64_t input_len, const uint8_t* input, int64_t output_buffer_len,
45 uint8_t* output_buffer) override;
46
47 Status Decompress(int64_t input_len, const uint8_t* input, int64_t output_buffer_len,
48 uint8_t* output_buffer, int64_t* output_len) override;
49
50 Status Compress(int64_t input_len, const uint8_t* input, int64_t output_buffer_len,
51 uint8_t* output_buffer, int64_t* output_len) override;
52
53 int64_t MaxCompressedLen(int64_t input_len, const uint8_t* input) override;
54
55 Status MakeCompressor(std::shared_ptr<Compressor>* out) override;
56
57 Status MakeDecompressor(std::shared_ptr<Decompressor>* out) override;
58
59 const char* name() const override;
60
61 private:
62 // The gzip compressor is stateful
63 class GZipCodecImpl;
64 std::unique_ptr<GZipCodecImpl> impl_;
65};
66
67} // namespace util
68} // namespace arrow
69
70#endif // ARROW_UTIL_COMPRESSION_ZLIB_H
71