guan404ming commented on code in PR #399: URL: https://github.com/apache/tvm-ffi/pull/399#discussion_r2707914418
########## include/tvm/ffi/expected.h: ########## @@ -0,0 +1,256 @@ +/* + * 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. + */ + +/*! + * \file tvm/ffi/expected.h + * \brief Runtime Expected container type for exception-free error handling. + */ +#ifndef TVM_FFI_EXPECTED_H_ +#define TVM_FFI_EXPECTED_H_ + +#include <tvm/ffi/any.h> +#include <tvm/ffi/error.h> + +#include <type_traits> +#include <utility> + +namespace tvm { +namespace ffi { + +/*! + * \brief Expected<T> provides exception-free error handling for FFI functions. + * + * Expected<T> is similar to Rust's Result<T, Error> or C++23's std::expected. + * It can hold either a success value of type T or an error of type Error. + * + * \tparam T The success type. Must be Any-compatible and cannot be Error. + * + * Usage: + * \code + * Expected<int> divide(int a, int b) { + * if (b == 0) { + * return ExpectedErr(Error("ValueError", "Division by zero")); + * } + * return ExpectedOk(a / b); + * } + * + * Expected<int> result = divide(10, 2); + * if (result.is_ok()) { + * int value = result.value(); + * } else { + * Error err = result.error(); + * } + * \endcode + */ +template <typename T> +class Expected { + public: + static_assert(!std::is_same_v<T, Error>, "Expected<Error> is not allowed. Use Error directly."); + + /*! + * \brief Create an Expected with a success value. + * \param value The success value. + * \return Expected containing the success value. + */ + static Expected Ok(T value) { return Expected(Any(std::move(value))); } + + /*! + * \brief Create an Expected with an error. + * \param error The error value. + * \return Expected containing the error. + */ + static Expected Err(Error error) { return Expected(Any(std::move(error))); } + + /*! + * \brief Check if the Expected contains a success value. + * \return True if contains success value, false if contains error. + */ + TVM_FFI_INLINE bool is_ok() const { return data_.as<T>().has_value(); } + + /*! + * \brief Check if the Expected contains an error. + * \return True if contains error, false if contains success value. + */ + TVM_FFI_INLINE bool is_err() const { return data_.as<Error>().has_value(); } Review Comment: Changed is_err() to return !is_ok() and also fixed is_ok() to check for Error first. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
