standard_key_metadata.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 <cstdint>
#include <optional>
#include <span>
#include <vector>
 
#include "iceberg/iceberg_export.h"
#include "iceberg/result.h"
 
namespace iceberg {
 
struct ICEBERG_EXPORT StandardKeyMetadata {
  static constexpr uint8_t kV1 = 1;
 
  std::vector<uint8_t> encryption_key;
  std::optional<std::vector<uint8_t>> aad_prefix;
  std::optional<int64_t> file_length;
 
  static Result<StandardKeyMetadata> Parse(std::span<const uint8_t> buffer);
 
  std::vector<uint8_t> Serialize() const;
 
  StandardKeyMetadata WithFileLength(int64_t length) const;
 
  friend bool operator==(const StandardKeyMetadata&,
                         const StandardKeyMetadata&) = default;
};
 
}  // namespace iceberg