url/rfc/origin_form_rule.hpp

0001 //
0002 // Copyright (c) 2016-2019 Vinnie Falco (vinnie dot falco 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 // Official repository: https://github.com/boostorg/url
0008 //
0009
0010 #ifndef BOOST_URL_RFC_ORIGIN_FORM_RULE_HPP
0011 #define BOOST_URL_RFC_ORIGIN_FORM_RULE_HPP
0012
0013 #include <boost/url/detail/config.hpp>
0014 #include <boost/url/url_view.hpp>
0015
0016 namespace boost {
0017 namespace urls {
0018
0019 /** Rule for origin-form
0020
0021     This appears in the HTTP/1 request-line grammar.
0022
0023     @par Value Type
0024     @code
0025     using value_type = url_view;
0026     @endcode
0027
0028     @par Example
0029     Rules are used with the function @ref grammar::parse.
0030     @code
0031     system::result< url_view > rv = grammar::parse( "/index.htm?layout=mobile", origin_form_rule );
0032     @endcode
0033
0034     @par BNF
0035     @code
0036     origin-form    = absolute-path [ "?" query ]
0037
0038     absolute-path = 1*( "/" segment )
0039     @endcode
0040
0041     @par Specification
0042     @li <a href="https://datatracker.ietf.org/doc/html/rfc7230#section-5.3.1"
0043         >5.3.1.  origin-form (rfc7230)</a>
0044
0045     @see
0046         @ref grammar::parse,
0047         @ref parse_origin_form,
0048         @ref url_view.
0049 */
0050 #ifdef BOOST_URL_DOCS
0051 constexpr __implementation_defined__ origin_form_rule;
0052 #else
0053 struct origin_form_rule_t
0054 {
0055     using value_type =
0056         url_view;
0057
0058     BOOST_URL_DECL
0059     system::result<value_type>
0060     parse(
0061         char const*& it,
0062         char const* end
0063             ) const noexcept;
0064 };
0065
0066 constexpr origin_form_rule_t origin_form_rule{};
0067 #endif
0068
0069 } // urls
0070 } // boost
0071
0072 #endif