78 lines
1.8 KiB
C++
78 lines
1.8 KiB
C++
//
|
|
// Copyright (c) 2016-2019 Vinnie Falco (vinnie dot falco 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)
|
|
//
|
|
// Official repository: https://github.com/boostorg/url
|
|
//
|
|
|
|
#ifndef BOOST_URL_RFC_QUERY_RULE_HPP
|
|
#define BOOST_URL_RFC_QUERY_RULE_HPP
|
|
|
|
#include <boost/url/detail/config.hpp>
|
|
#include <boost/url/error_types.hpp>
|
|
#include <boost/url/params_encoded_view.hpp>
|
|
#include <cstddef>
|
|
|
|
namespace boost {
|
|
namespace urls {
|
|
|
|
/** Rule for query
|
|
|
|
@par Value Type
|
|
@code
|
|
using value_type = params_encoded_view;
|
|
@endcode
|
|
|
|
@par Example
|
|
Rules are used with the function @ref grammar::parse.
|
|
@code
|
|
system::result< params_encoded_view > rv = grammar::parse( "format=web&id=42&compact", query_rule );
|
|
@endcode
|
|
|
|
@par BNF
|
|
@code
|
|
query = *( pchar / "/" / "?" )
|
|
|
|
query-params = [ query-param ] *( "&" query-param )
|
|
query-param = key [ "=" value ]
|
|
key = *qpchar
|
|
value = *( qpchar / "=" )
|
|
qpchar = unreserved
|
|
/ pct-encoded
|
|
/ "!" / "$" / "'" / "(" / ")"
|
|
/ "*" / "+" / "," / ";"
|
|
/ ":" / "@" / "/" / "?"
|
|
@endcode
|
|
|
|
@par Specification
|
|
@li <a href="https://datatracker.ietf.org/doc/html/rfc3986#section-3.4"
|
|
>3.4. Query (rfc3986)</a>
|
|
|
|
@see
|
|
@ref grammar::parse,
|
|
@ref params_encoded_view.
|
|
*/
|
|
#ifdef BOOST_URL_DOCS
|
|
constexpr __implementation_defined__ query_rule;
|
|
#else
|
|
struct query_rule_t
|
|
{
|
|
using value_type = params_encoded_view;
|
|
|
|
BOOST_URL_DECL
|
|
system::result<value_type>
|
|
parse(
|
|
char const*& it,
|
|
char const* end
|
|
) const noexcept;
|
|
};
|
|
|
|
constexpr query_rule_t query_rule{};
|
|
#endif
|
|
|
|
} // urls
|
|
} // boost
|
|
|
|
#endif |