boost/mysql/metadata_collection_view.hpp

0001 //
0002 // Copyright (c) 2019-2023 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_METADATA_COLLECTION_VIEW_HPP
0009 #define BOOST_MYSQL_METADATA_COLLECTION_VIEW_HPP
0010
0011 #include <boost/mysql/metadata.hpp>
0012
0013 #include <boost/core/span.hpp>
0014
0015 namespace boost {
0016 namespace mysql {
0017
0018 /**
0019  * \brief A read-only view of a collection of \ref metadata objects.
0020  * \par Object lifetimes
0021  * The object doesn't own the storage for the \ref metadata objects. These are typically
0022  * owned by a \ref results or \ref execution_state object. This view is valid as long
0023  * as the memory allocated for the \ref metadata objects remain valid.
0024  */
0025 using metadata_collection_view = boost::span<const metadata>;
0026
0027 }  // namespace mysql
0028 }  // namespace boost
0029
0030 #endif