puffin_reader.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 <optional>
#include <utility>
#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 PuffinReader {
 public:
  static Result<std::unique_ptr<PuffinReader>> Make(
      std::unique_ptr<InputFile> input_file,
      std::optional<int64_t> footer_size = std::nullopt,
      std::optional<int64_t> file_size = std::nullopt);
 
  ~PuffinReader();
 
  Result<FileMetadata> ReadFileMetadata();
 
  Result<std::pair<BlobMetadata, std::vector<std::byte>>> ReadBlob(
      const BlobMetadata& blob_metadata);
 
  Result<std::vector<std::pair<BlobMetadata, std::vector<std::byte>>>> ReadAll(
      const std::vector<BlobMetadata>& blobs);
 
  Status Close();
 
 private:
  PuffinReader(std::unique_ptr<SeekableInputStream> stream, int64_t file_size,
               std::optional<int64_t> known_footer_size);
 
  Result<std::vector<std::byte>> ReadBytes(int64_t offset, int64_t length);
  Result<int64_t> FooterSize();
  Result<std::vector<std::byte>> ReadFooter(int64_t footer_size);
 
  std::unique_ptr<SeekableInputStream> stream_;
  int64_t file_size_;
  std::optional<int64_t> known_footer_size_;
  bool closed_ = false;
};
 
}  // namespace iceberg::puffin