boost/url/parse_query.hpp

0001 //
0002 // Copyright (c) 2019 Vinnie Falco (vinnie.falco@gmail.com)
0003 // Copyright (c) 2022 Alan de Freitas (alandefreitas@gmail.com)
0004 //
0005 // Distributed under the Boost Software License, Version 1.0. (See accompanying
0006 // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
0007 //
0008 // Official repository: https://github.com/CPPAlliance/url
0009 //
0010
0011 #ifndef BOOST_URL_PARSE_PARAMS_HPP
0012 #define BOOST_URL_PARSE_PARAMS_HPP
0013
0014 #include <boost/url/detail/config.hpp>
0015 #include <boost/url/error_types.hpp>
0016 #include <boost/url/params_encoded_view.hpp>
0017 #include <boost/core/detail/string_view.hpp>
0018
0019 namespace boost {
0020 namespace urls {
0021
0022 /** Parse a string and return an encoded params view
0023
0024     This function parses the string and returns the
0025     corresponding params object if the string is valid,
0026     otherwise returns an error.
0027
0028     @par BNF
0029     @code
0030     @endcode
0031
0032     @par Exception Safety
0033     No-throw guarantee.
0034
0035     @return A valid view on success, otherwise an
0036     error code.
0037
0038     @param s The string to parse
0039
0040     @par Specification
0041
0042     @see
0043         @ref params_encoded_view.
0044 */
0045 BOOST_URL_DECL
0046 system::result<params_encoded_view>
0047 parse_query(core::string_view s) noexcept;
0048
0049 } // urls
0050 } // boost
0051
0052 #endif