src/iceberg/result.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

/// \file iceberg/result.h
/// \brief Define Result, Status, and error helpers.

#include <concepts>
#include <format>
#include <string>
#include <type_traits>

#include "iceberg/compat/expected.h"
#include "iceberg/iceberg_export.h"

namespace iceberg {

/// \brief Error types for iceberg.
enum class ErrorKind {
  kAlreadyExists,
  kAuthenticationFailed,
  kBadRequest,
  kCommitFailed,
  kCommitStateUnknown,
  kCompressError,
  kDecompressError,
  kForbidden,
  kInternalServerError,
  kInvalid,  // For general invalid errors
  kInvalidArgument,
  kInvalidArrowData,
  kInvalidExpression,
  kInvalidManifest,
  kInvalidManifestList,
  kInvalidSchema,
  kIOError,
  kJsonParseError,
  kNamespaceNotEmpty,
  kNoSuchNamespace,
  kNoSuchPlanId,
  kNoSuchPlanTask,
  kNoSuchTable,
  kNoSuchWarehouse,
  kNoSuchView,
  kNotAllowed,
  kNotAuthorized,
  kNotFound,
  kNotImplemented,
  kNotSupported,
  kRestError,
  kRetryableValidationFailed,
  kServiceUnavailable,
  kTokenExpired,
  kUnknownError,
  kValidationFailed,
};

/// \brief Error with a kind and a message.
struct ICEBERG_EXPORT [[nodiscard]] Error {
  ErrorKind kind;
  std::string message;
};

/// /brief Default error trait
template <typename T>
struct DefaultError {
  using type = Error;
};

/// \brief Result alias
template <typename T, typename E = typename DefaultError<T>::type>
using Result = ::iceberg::expected<T, E>;

using Status = Result<void>;

/// \brief Macro to define error creation functions
#define DEFINE_ERROR_FUNCTION(name)                                                \
  template <typename... Args>                                                      \
  inline auto name(const std::format_string<Args...> fmt, Args&&... args)          \
      -> ::iceberg::unexpected<Error> {                                            \
    return ::iceberg::unexpected<Error>(                                           \
        {ErrorKind::k##name, std::format(fmt, std::forward<Args>(args)...)});      \
  }                                                                                \
  inline auto name(std::string message) -> ::iceberg::unexpected<Error> {          \
    return ::iceberg::unexpected<Error>({ErrorKind::k##name, std::move(message)}); \
  }

DEFINE_ERROR_FUNCTION(AlreadyExists)
DEFINE_ERROR_FUNCTION(AuthenticationFailed)
DEFINE_ERROR_FUNCTION(BadRequest)
DEFINE_ERROR_FUNCTION(CommitFailed)
DEFINE_ERROR_FUNCTION(CommitStateUnknown)
DEFINE_ERROR_FUNCTION(CompressError)
DEFINE_ERROR_FUNCTION(DecompressError)
DEFINE_ERROR_FUNCTION(Forbidden)
DEFINE_ERROR_FUNCTION(InternalServerError)
DEFINE_ERROR_FUNCTION(Invalid)
DEFINE_ERROR_FUNCTION(InvalidArgument)
DEFINE_ERROR_FUNCTION(InvalidArrowData)
DEFINE_ERROR_FUNCTION(InvalidExpression)
DEFINE_ERROR_FUNCTION(InvalidManifest)
DEFINE_ERROR_FUNCTION(InvalidManifestList)
DEFINE_ERROR_FUNCTION(InvalidSchema)
DEFINE_ERROR_FUNCTION(IOError)
DEFINE_ERROR_FUNCTION(JsonParseError)
DEFINE_ERROR_FUNCTION(NamespaceNotEmpty)
DEFINE_ERROR_FUNCTION(NoSuchNamespace)
DEFINE_ERROR_FUNCTION(NoSuchPlanId)
DEFINE_ERROR_FUNCTION(NoSuchPlanTask)
DEFINE_ERROR_FUNCTION(NoSuchTable)
DEFINE_ERROR_FUNCTION(NoSuchWarehouse)
DEFINE_ERROR_FUNCTION(NoSuchView)
DEFINE_ERROR_FUNCTION(NotAllowed)
DEFINE_ERROR_FUNCTION(NotAuthorized)
DEFINE_ERROR_FUNCTION(NotFound)
DEFINE_ERROR_FUNCTION(NotImplemented)
DEFINE_ERROR_FUNCTION(NotSupported)
DEFINE_ERROR_FUNCTION(RestError)
DEFINE_ERROR_FUNCTION(RetryableValidationFailed)
DEFINE_ERROR_FUNCTION(ServiceUnavailable)
DEFINE_ERROR_FUNCTION(TokenExpired)
DEFINE_ERROR_FUNCTION(UnknownError)
DEFINE_ERROR_FUNCTION(ValidationFailed)

#undef DEFINE_ERROR_FUNCTION

template <typename T>
concept AsResult = std::derived_from<std::remove_cvref_t<T>,
                                     Result<typename std::remove_cvref_t<T>::value_type>>;

template <AsResult T>
using ResultValueT = typename std::remove_cvref_t<T>::value_type;

}  // namespace iceberg