123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271 |
- /* Type sugar for success and failure
- (C) 2017-2021 Niall Douglas <http://www.nedproductions.biz/> (25 commits)
- File Created: July 2017
- Boost Software License - Version 1.0 - August 17th, 2003
- Permission is hereby granted, free of charge, to any person or organization
- obtaining a copy of the software and accompanying documentation covered by
- this license (the "Software") to use, reproduce, display, distribute,
- execute, and transmit the Software, and to prepare derivative works of the
- Software, and to permit third-parties to whom the Software is furnished to
- do so, all subject to the following:
- The copyright notices in the Software and this entire statement, including
- the above license grant, this restriction and the following disclaimer,
- must be included in all copies of the Software, in whole or in part, and
- all derivative works of the Software, unless such copies or derivative
- works are solely in the form of machine-executable object code generated by
- a source language processor.
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
- SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
- FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
- ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
- DEALINGS IN THE SOFTWARE.
- */
- #ifndef BOOST_OUTCOME_SUCCESS_FAILURE_HPP
- #define BOOST_OUTCOME_SUCCESS_FAILURE_HPP
- #include "config.hpp"
- BOOST_OUTCOME_V2_NAMESPACE_BEGIN
- /*! AWAITING HUGO JSON CONVERSION TOOL
- type definition template <class T> success_type. Potential doc page: `success_type<T>`
- */
- template <class T> struct BOOST_OUTCOME_NODISCARD success_type
- {
- using value_type = T;
- private:
- value_type _value;
- uint16_t _spare_storage{0};
- public:
- success_type() = default;
- success_type(const success_type &) = default;
- success_type(success_type &&) = default; // NOLINT
- success_type &operator=(const success_type &) = default;
- success_type &operator=(success_type &&) = default; // NOLINT
- ~success_type() = default;
- BOOST_OUTCOME_TEMPLATE(class U)
- BOOST_OUTCOME_TREQUIRES(BOOST_OUTCOME_TPRED(!std::is_same<success_type, std::decay_t<U>>::value))
- constexpr explicit success_type(U &&v, uint16_t spare_storage = 0)
- : _value(static_cast<U &&>(v)) // NOLINT
- , _spare_storage(spare_storage)
- {
- }
- constexpr value_type &value() & { return _value; }
- constexpr const value_type &value() const & { return _value; }
- constexpr value_type &&value() && { return static_cast<value_type &&>(_value); }
- constexpr const value_type &&value() const && { return static_cast<value_type &&>(_value); }
- constexpr uint16_t spare_storage() const { return _spare_storage; }
- };
- template <> struct BOOST_OUTCOME_NODISCARD success_type<void>
- {
- using value_type = void;
- constexpr uint16_t spare_storage() const { return 0; }
- };
- /*! Returns type sugar for implicitly constructing a `basic_result<T>` with a successful state,
- default constructing `T` if necessary.
- */
- inline constexpr success_type<void> success() noexcept
- {
- return success_type<void>{};
- }
- /*! Returns type sugar for implicitly constructing a `basic_result<T>` with a successful state.
- \effects Copies or moves the successful state supplied into the returned type sugar.
- */
- template <class T> inline constexpr success_type<std::decay_t<T>> success(T &&v, uint16_t spare_storage = 0)
- {
- return success_type<std::decay_t<T>>{static_cast<T &&>(v), spare_storage};
- }
- /*! AWAITING HUGO JSON CONVERSION TOOL
- type definition template <class EC, class E = void> failure_type. Potential doc page: `failure_type<EC, EP = void>`
- */
- template <class EC, class E = void> struct BOOST_OUTCOME_NODISCARD failure_type
- {
- using error_type = EC;
- using exception_type = E;
- private:
- error_type _error;
- exception_type _exception;
- bool _have_error{false}, _have_exception{false};
- uint16_t _spare_storage{0};
- struct error_init_tag
- {
- };
- struct exception_init_tag
- {
- };
- public:
- failure_type() = default;
- failure_type(const failure_type &) = default;
- failure_type(failure_type &&) = default; // NOLINT
- failure_type &operator=(const failure_type &) = default;
- failure_type &operator=(failure_type &&) = default; // NOLINT
- ~failure_type() = default;
- template <class U, class V>
- constexpr explicit failure_type(U &&u, V &&v, uint16_t spare_storage = 0)
- : _error(static_cast<U &&>(u))
- , _exception(static_cast<V &&>(v))
- , _have_error(true)
- , _have_exception(true)
- , _spare_storage(spare_storage)
- {
- }
- template <class U>
- constexpr explicit failure_type(in_place_type_t<error_type> /*unused*/, U &&u, uint16_t spare_storage = 0, error_init_tag /*unused*/ = error_init_tag())
- : _error(static_cast<U &&>(u))
- , _exception()
- , _have_error(true)
- , _spare_storage(spare_storage)
- {
- }
- template <class U>
- constexpr explicit failure_type(in_place_type_t<exception_type> /*unused*/, U &&u, uint16_t spare_storage = 0,
- exception_init_tag /*unused*/ = exception_init_tag())
- : _error()
- , _exception(static_cast<U &&>(u))
- , _have_exception(true)
- , _spare_storage(spare_storage)
- {
- }
- constexpr bool has_error() const { return _have_error; }
- constexpr bool has_exception() const { return _have_exception; }
- constexpr error_type &error() & { return _error; }
- constexpr const error_type &error() const & { return _error; }
- constexpr error_type &&error() && { return static_cast<error_type &&>(_error); }
- constexpr const error_type &&error() const && { return static_cast<error_type &&>(_error); }
- constexpr exception_type &exception() & { return _exception; }
- constexpr const exception_type &exception() const & { return _exception; }
- constexpr exception_type &&exception() && { return static_cast<exception_type &&>(_exception); }
- constexpr const exception_type &&exception() const && { return static_cast<exception_type &&>(_exception); }
- constexpr uint16_t spare_storage() const { return _spare_storage; }
- };
- template <class EC> struct BOOST_OUTCOME_NODISCARD failure_type<EC, void>
- {
- using error_type = EC;
- using exception_type = void;
- private:
- error_type _error;
- uint16_t _spare_storage{0};
- public:
- failure_type() = default;
- failure_type(const failure_type &) = default;
- failure_type(failure_type &&) = default; // NOLINT
- failure_type &operator=(const failure_type &) = default;
- failure_type &operator=(failure_type &&) = default; // NOLINT
- ~failure_type() = default;
- BOOST_OUTCOME_TEMPLATE(class U)
- BOOST_OUTCOME_TREQUIRES(BOOST_OUTCOME_TPRED(!std::is_same<failure_type, std::decay_t<U>>::value))
- constexpr explicit failure_type(U &&u, uint16_t spare_storage = 0)
- : _error(static_cast<U &&>(u)) // NOLINT
- , _spare_storage(spare_storage)
- {
- }
- constexpr error_type &error() & { return _error; }
- constexpr const error_type &error() const & { return _error; }
- constexpr error_type &&error() && { return static_cast<error_type &&>(_error); }
- constexpr const error_type &&error() const && { return static_cast<error_type &&>(_error); }
- constexpr uint16_t spare_storage() const { return _spare_storage; }
- };
- template <class E> struct BOOST_OUTCOME_NODISCARD failure_type<void, E>
- {
- using error_type = void;
- using exception_type = E;
- private:
- exception_type _exception;
- uint16_t _spare_storage{0};
- public:
- failure_type() = default;
- failure_type(const failure_type &) = default;
- failure_type(failure_type &&) = default; // NOLINT
- failure_type &operator=(const failure_type &) = default;
- failure_type &operator=(failure_type &&) = default; // NOLINT
- ~failure_type() = default;
- BOOST_OUTCOME_TEMPLATE(class V)
- BOOST_OUTCOME_TREQUIRES(BOOST_OUTCOME_TPRED(!std::is_same<failure_type, std::decay_t<V>>::value))
- constexpr explicit failure_type(V &&v, uint16_t spare_storage = 0)
- : _exception(static_cast<V &&>(v)) // NOLINT
- , _spare_storage(spare_storage)
- {
- }
- constexpr exception_type &exception() & { return _exception; }
- constexpr const exception_type &exception() const & { return _exception; }
- constexpr exception_type &&exception() && { return static_cast<exception_type &&>(_exception); }
- constexpr const exception_type &&exception() const && { return static_cast<exception_type &&>(_exception); }
- constexpr uint16_t spare_storage() const { return _spare_storage; }
- };
- /*! AWAITING HUGO JSON CONVERSION TOOL
- SIGNATURE NOT RECOGNISED
- */
- template <class EC> inline constexpr failure_type<std::decay_t<EC>> failure(EC &&v, uint16_t spare_storage = 0)
- {
- return failure_type<std::decay_t<EC>>{static_cast<EC &&>(v), spare_storage};
- }
- /*! AWAITING HUGO JSON CONVERSION TOOL
- SIGNATURE NOT RECOGNISED
- */
- template <class EC, class E> inline constexpr failure_type<std::decay_t<EC>, std::decay_t<E>> failure(EC &&v, E &&w, uint16_t spare_storage = 0)
- {
- return failure_type<std::decay_t<EC>, std::decay_t<E>>{static_cast<EC &&>(v), static_cast<E &&>(w), spare_storage};
- }
- namespace detail
- {
- template <class T> struct is_success_type
- {
- static constexpr bool value = false;
- };
- template <class T> struct is_success_type<success_type<T>>
- {
- static constexpr bool value = true;
- };
- template <class T> struct is_failure_type
- {
- static constexpr bool value = false;
- };
- template <class EC, class E> struct is_failure_type<failure_type<EC, E>>
- {
- static constexpr bool value = true;
- };
- } // namespace detail
- /*! AWAITING HUGO JSON CONVERSION TOOL
- SIGNATURE NOT RECOGNISED
- */
- template <class T> static constexpr bool is_success_type = detail::is_success_type<std::decay_t<T>>::value;
- /*! AWAITING HUGO JSON CONVERSION TOOL
- SIGNATURE NOT RECOGNISED
- */
- template <class T> static constexpr bool is_failure_type = detail::is_failure_type<std::decay_t<T>>::value;
- BOOST_OUTCOME_V2_NAMESPACE_END
- #endif
|