boost/mysql/pfr.hpp

0001 //
0002 // Copyright (c) 2019-2024 Ruben Perez Hidalgo (rubenperez038 at gmail dot com)
0003 //
0004 // Distributed under the Boost Software License, Version 1.0. (See accompanying
0005 // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
0006 //
0007
0008 #ifndef BOOST_MYSQL_PFR_HPP
0009 #define BOOST_MYSQL_PFR_HPP
0010
0011 #include <boost/mysql/detail/config.hpp>
0012
0013 #include <boost/pfr/config.hpp>
0014
0015 #if BOOST_PFR_ENABLED && defined(BOOST_MYSQL_CXX14)
0016
0017 namespace boost {
0018 namespace mysql {
0019
0020 /**
0021  * \brief Static interface marker type to use Boost.PFR reflection with positional matching.
0022  * \details
0023  * A marker type that satisfies the `StaticRow` concept.
0024  * When used within the static interface, modifies its behavior
0025  * for the marked type so that Boost.PFR is used for reflection, instead of Boost.Describe.
0026  * Field matching is performed by position, with the same algorithm used for `std::tuple`.
0027  * \n
0028  * The underlying row type for this marker is `T`, i.e.
0029  * \ref underlying_row_t "underlying_row_t<pfr_by_position<T>>" is an alias for `T`.
0030  * \n
0031  * The type `T` must be a PFR-reflectable non-const object type.
0032  * \n
0033  * This type is only defined if the macro `BOOST_PFR_ENABLED` is defined and set to `1`.
0034  */
0035 template <class T>
0036 struct pfr_by_position;
0037
0038 #if BOOST_PFR_CORE_NAME_ENABLED
0039
0040 /**
0041  * \brief Static interface marker type to use Boost.PFR reflection with name-based field matching.
0042  * \details
0043  * A marker type that satisfies the `StaticRow` concept.
0044  * When used within the static interface, modifies its behavior
0045  * for the marked type so that Boost.PFR is used for reflection, instead of Boost.Describe.
0046  * Field matching is performed by name, with the same algorithm used for Boost.Describe structs.
0047  * \n
0048  * The underlying row type for this marker is `T`, i.e.
0049  * \ref underlying_row_t "underlying_row_t<pfr_by_name<T>>" is an alias for `T`.
0050  * \n
0051  * The type `T` must be a PFR-reflectable non-const object type.
0052  * \n
0053  * This type is only defined if the macro `BOOST_PFR_CORE_NAME_ENABLED` is defined and set to `1`
0054  * (requires C++20).
0055  */
0056 template <class T>
0057 struct pfr_by_name;
0058
0059 #endif
0060
0061 }  // namespace mysql
0062 }  // namespace boost
0063
0064 #include <boost/mysql/impl/pfr.hpp>
0065
0066 #endif
0067
0068 #endif