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     query         = *( pchar / "/" / "?" )
0031     @endcode
0032
0033     @par Exception Safety
0034     No-throw guarantee.
0035
0036     @return A valid view on success, otherwise an
0037     error code.
0038
0039     @param s The string to parse
0040
0041     @par Specification
0042
0043     @see
0044         @ref params_encoded_view.
0045 */
0046 BOOST_URL_DECL
0047 system::result<params_encoded_view>
0048 parse_query(core::string_view s) noexcept;
0049
0050 } // urls
0051 } // boost
0052
0053 #endif