2022-05-23 00:16:32 +04:00

119 lines
3.5 KiB
C++

// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.
// Compressed stream implementations
#pragma once
#include <memory>
#include <string>
#include "arrow/io/concurrency.h"
#include "arrow/io/interfaces.h"
#include "arrow/util/visibility.h"
namespace arrow {
class MemoryPool;
class Status;
namespace util {
class Codec;
} // namespace util
namespace io {
class ARROW_EXPORT CompressedOutputStream : public OutputStream {
public:
~CompressedOutputStream() override;
/// \brief Create a compressed output stream wrapping the given output stream.
static Result<std::shared_ptr<CompressedOutputStream>> Make(
util::Codec* codec, const std::shared_ptr<OutputStream>& raw,
MemoryPool* pool = default_memory_pool());
// OutputStream interface
/// \brief Close the compressed output stream. This implicitly closes the
/// underlying raw output stream.
Status Close() override;
Status Abort() override;
bool closed() const override;
Result<int64_t> Tell() const override;
Status Write(const void* data, int64_t nbytes) override;
/// \cond FALSE
using Writable::Write;
/// \endcond
Status Flush() override;
/// \brief Return the underlying raw output stream.
std::shared_ptr<OutputStream> raw() const;
private:
ARROW_DISALLOW_COPY_AND_ASSIGN(CompressedOutputStream);
CompressedOutputStream() = default;
class ARROW_NO_EXPORT Impl;
std::unique_ptr<Impl> impl_;
};
class ARROW_EXPORT CompressedInputStream
: public internal::InputStreamConcurrencyWrapper<CompressedInputStream> {
public:
~CompressedInputStream() override;
/// \brief Create a compressed input stream wrapping the given input stream.
static Result<std::shared_ptr<CompressedInputStream>> Make(
util::Codec* codec, const std::shared_ptr<InputStream>& raw,
MemoryPool* pool = default_memory_pool());
// InputStream interface
bool closed() const override;
Result<std::shared_ptr<const KeyValueMetadata>> ReadMetadata() override;
Future<std::shared_ptr<const KeyValueMetadata>> ReadMetadataAsync(
const IOContext& io_context) override;
/// \brief Return the underlying raw input stream.
std::shared_ptr<InputStream> raw() const;
private:
friend InputStreamConcurrencyWrapper<CompressedInputStream>;
ARROW_DISALLOW_COPY_AND_ASSIGN(CompressedInputStream);
CompressedInputStream() = default;
/// \brief Close the compressed input stream. This implicitly closes the
/// underlying raw input stream.
Status DoClose();
Status DoAbort() override;
Result<int64_t> DoTell() const;
Result<int64_t> DoRead(int64_t nbytes, void* out);
Result<std::shared_ptr<Buffer>> DoRead(int64_t nbytes);
class ARROW_NO_EXPORT Impl;
std::unique_ptr<Impl> impl_;
};
} // namespace io
} // namespace arrow