// // Copyright (c) 2019 Vinnie Falco (vinnie.falco@gmail.com) // Copyright (c) 2020 Krystian Stasiowski (sdkrystian@gmail.com) // Copyright (c) 2022 Dmitry Arkhipov (grisumbras@gmail.com) // // Distributed under the Boost Software License, Version 1.0. (See accompanying // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) // // Official repository: https://github.com/boostorg/json // #ifndef BOOST_JSON_VALUE_TO_HPP #define BOOST_JSON_VALUE_TO_HPP #include BOOST_JSON_NS_BEGIN /** Convert a @ref value to an object of type `T`. This function attempts to convert a @ref value to `T` using @li one of @ref value's accessors, or @li a library-provided generic conversion, or @li a user-provided overload of `tag_invoke`. Out of the box the function supports types satisfying SequenceContainer, arrays, arithmetic types, `bool`, `std::tuple`, `std::pair`, `std::variant`, `std::optional`, `std::monostate`, and `std::nullopt_t`. Conversion of other types is done by calling an overload of `tag_invoke` found by argument-dependent lookup. Its signature should be similar to: @code T tag_invoke( value_to_tag, value ); @endcode The object returned by the function call is returned by @ref value_to as the result of the conversion. @par Constraints @code ! std::is_reference< T >::value @endcode @par Exception Safety Strong guarantee. @tparam T The type to convert to. @returns `jv` converted to `T`. @param jv The @ref value to convert. @see @ref value_to_tag, @ref value_from, tag_invoke: A general pattern for supporting customisable functions */ template T value_to(const value& jv) { BOOST_STATIC_ASSERT(! std::is_reference::value); using bare_T = detail::remove_cvref; BOOST_STATIC_ASSERT(detail::conversion_round_trips< bare_T, detail::value_to_conversion>::value); using impl = detail::value_to_implementation; return detail::value_to_impl(value_to_tag(), jv, impl()); } /** Convert a @ref value to a @ref result of `T`. This function attempts to convert a @ref value to `result` using @li one of @ref value's accessors, or @li a library-provided generic conversion, or @li a user-provided overload of `tag_invoke`. Out of the box the function supports types satisfying SequenceContainer, arrays, arithmetic types, `bool`, `std::tuple`, `std::pair`, `std::variant`, `std::optional`, `std::monostate`, and `std::nullopt_t`. Conversion of other types is done by calling an overload of `tag_invoke` found by argument-dependent lookup. Its signature should be similar to: @code result tag_invoke( try_value_to_tag, value const& ); @endcode If an error occurs during conversion, the result will store the error code associated with the error. If an exception is thrown, the function will attempt to retrieve the associated error code and return it, otherwise it will return `error::exception`. @par Constraints @code ! std::is_reference< T >::value @endcode @par Exception Safety Strong guarantee. @tparam T The type to convert to. @param jv The @ref value to convert. @returns `jv` converted to `result`. @see @ref value_to_tag, @ref value_to, @ref value_from, tag_invoke: A general pattern for supporting customisable functions */ template typename result_for::type try_value_to(const value& jv) { BOOST_STATIC_ASSERT(! std::is_reference::value); using bare_T = detail::remove_cvref; BOOST_STATIC_ASSERT(detail::conversion_round_trips< bare_T, detail::value_to_conversion>::value); using impl = detail::value_to_implementation; return detail::value_to_impl( try_value_to_tag(), jv, impl()); } /** Convert a @ref value to an object of type `T`. This overload is **deleted** and participates in overload resolution only when `U` is not @ref value. The overload exists to prevent unintented creation of temporary @ref value instances, e.g. @code auto flag = value_to(true); @endcode */ template::value>::type #endif > T value_to(U const& jv) = delete; /** Determine a @ref value can be converted to `T`. If @ref value can be converted to `T` via a call to @ref value_to, the static data member `value` is defined as `true`. Otherwise, `value` is defined as `false`. @see @ref value_to */ #ifdef BOOST_JSON_DOCS template using has_value_to = __see_below__; #else template using has_value_to = detail::can_convert< detail::remove_cvref, detail::value_to_conversion>; #endif BOOST_JSON_NS_END #endif