puffin_writer.h

Go to the documentation of this file.

/*
 * 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.
 */
 
#pragma once
 
 
#include <cstddef>
#include <cstdint>
#include <memory>
#include <span>
#include <string>
#include <unordered_map>
#include <vector>
 
#include "iceberg/iceberg_export.h"
#include "iceberg/puffin/file_metadata.h"
#include "iceberg/result.h"
#include "iceberg/type_fwd.h"
 
namespace iceberg::puffin {
 
class ICEBERG_EXPORT PuffinWriter {
 public:
  static Result<std::unique_ptr<PuffinWriter>> Make(
      std::unique_ptr<OutputFile> output_file,
      std::unordered_map<std::string, std::string> properties = {},
      PuffinCompressionCodec default_codec = PuffinCompressionCodec::kNone,
      bool compress_footer = false);
 
  ~PuffinWriter();
 
  Result<BlobMetadata> Write(const Blob& blob);
 
  Status Finish();
 
  Status Close();
 
  const std::vector<BlobMetadata>& written_blobs_metadata() const;
 
  Result<int64_t> FooterSize() const;
 
  Result<int64_t> FileSize() const;
 
 private:
  PuffinWriter(std::unique_ptr<PositionOutputStream> stream,
               std::unordered_map<std::string, std::string> properties,
               PuffinCompressionCodec default_codec, bool compress_footer);
 
  Status WriteBytes(std::span<const std::byte> data);
  Status WriteHeader();
  Status WriteMagic();
 
  std::unique_ptr<PositionOutputStream> stream_;
  std::unordered_map<std::string, std::string> properties_;
  const PuffinCompressionCodec default_codec_;
  const bool compress_footer_;
  std::vector<BlobMetadata> written_blobs_metadata_;
  bool header_written_ = false;
  bool footer_written_ = false;
  bool finished_ = false;
  int64_t footer_size_ = -1;
  int64_t file_size_ = -1;
};
 
}  // namespace iceberg::puffin