robot/include/boost/mysql/metadata_collection_view.hpp

//
// Copyright (c) 2019-2024 Ruben Perez Hidalgo (rubenperez038 at gmail dot 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)
//

#ifndef BOOST_MYSQL_METADATA_COLLECTION_VIEW_HPP
#define BOOST_MYSQL_METADATA_COLLECTION_VIEW_HPP

#include <boost/mysql/metadata.hpp>

#include <boost/core/span.hpp>

namespace boost {
namespace mysql {

/**
 * \brief A read-only view of a collection of \ref metadata objects.
 * \par Object lifetimes
 * The object doesn't own the storage for the \ref metadata objects. These are typically
 * owned by a \ref results or \ref execution_state object. This view is valid as long
 * as the memory allocated for the \ref metadata objects remain valid.
 */
using metadata_collection_view = boost::span<const metadata>;

}  // namespace mysql
}  // namespace boost

#endif