src/iceberg/util/conversions.h

/*
 * 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 <span>
#include <vector>

#include "iceberg/expression/literal.h"
#include "iceberg/result.h"
#include "iceberg/type_fwd.h"

/// \file iceberg/util/conversions.h
/// \brief Conversion utilities for primitive types

namespace iceberg {

/// \brief Conversion utilities for primitive types
class ICEBERG_EXPORT Conversions {
 public:
  /// \brief Serializes a raw literal value into a byte vector according to its type.
  /// \param type The primitive type of the value.
  /// \param value The std::variant holding the raw literal value to serialize.
  /// \return A Result containing the serialized value.
  static Result<std::vector<uint8_t>> ToBytes(const PrimitiveType& type,
                                              const Literal::Value& value);

  /// \brief Serializes a complete Literal object into a byte vector.
  /// \param literal The Literal object to serialize.
  /// \return A Result containing the serialized value.
  static Result<std::vector<uint8_t>> ToBytes(const Literal& literal);

  /// \brief Deserializes a span of bytes into a raw literal value based on the given
  /// type.
  /// \param type The target primitive type to interpret the bytes as.
  /// \param data A std::span of bytes representing the serialized value.
  /// \return A Result containing the deserialized value.
  static Result<Literal::Value> FromBytes(const PrimitiveType& type,
                                          std::span<const uint8_t> data);

  /// \brief Deserializes a span of bytes into a complete Literal object.
  /// \param type A shared pointer to the target primitive type.
  /// \param data A std::span of bytes representing the serialized value.
  /// \return A Result containing the deserialized value.
  static Result<Literal> FromBytes(std::shared_ptr<PrimitiveType> type,
                                   std::span<const uint8_t> data);
};

}  // namespace iceberg