puffin_format.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 <array>
#include <cstddef>
#include <cstdint>
#include <span>
#include <vector>
 
#include "iceberg/iceberg_data_export.h"
#include "iceberg/puffin/file_metadata.h"
#include "iceberg/result.h"
 
namespace iceberg::puffin {
 
struct ICEBERG_DATA_EXPORT PuffinFormat {
  static constexpr std::array<uint8_t, 4> kMagicV1 = {0x50, 0x46, 0x41, 0x31};
 
  static constexpr int32_t kMagicLength = 4;
  static constexpr int32_t kFooterStartMagicOffset = 0;
  static constexpr int32_t kFooterStartMagicLength = kMagicLength;
  static constexpr int32_t kFooterStructPayloadSizeOffset = 0;
  static constexpr int32_t kFooterStructFlagsOffset = kFooterStructPayloadSizeOffset + 4;
  static constexpr int32_t kFooterStructFlagsLength = 4;
  static constexpr int32_t kFooterStructMagicOffset =
      kFooterStructFlagsOffset + kFooterStructFlagsLength;
 
  static constexpr int32_t kFooterStructLength = kFooterStructMagicOffset + kMagicLength;
 
  static constexpr PuffinCompressionCodec kDefaultFooterCompressionCodec =
      PuffinCompressionCodec::kLz4;
};
 
enum class PuffinFlag : uint8_t {
  kFooterPayloadCompressed = 0,
};
 
ICEBERG_DATA_EXPORT bool IsFlagSet(std::span<const uint8_t, 4> flags, PuffinFlag flag);
 
ICEBERG_DATA_EXPORT void SetFlag(std::span<uint8_t, 4> flags, PuffinFlag flag);
 
ICEBERG_DATA_EXPORT Result<std::vector<std::byte>> Compress(
    PuffinCompressionCodec codec, std::span<const std::byte> input);
 
ICEBERG_DATA_EXPORT Result<std::vector<std::byte>> Decompress(
    PuffinCompressionCodec codec, std::span<const std::byte> input);
 
}  // namespace iceberg::puffin