url/rfc/absolute_uri_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_ABSOLUTE_URI_RULE_HPP
0011 #define BOOST_URL_RFC_ABSOLUTE_URI_RULE_HPP
0012
0013 #include <boost/url/detail/config.hpp>
0014 #include <boost/url/error_types.hpp>
0015 #include <boost/url/url_view.hpp>
0016
0017 namespace boost {
0018 namespace urls {
0019
0020 namespace implementation_defined {
0021 struct absolute_uri_rule_t
0022 {
0023     using value_type = url_view;
0024
0025     BOOST_URL_DECL
0026     auto
0027     parse(
0028         char const*& it,
0029         char const* end
0030             ) const noexcept ->
0031         system::result<value_type>;
0032 };
0033 } // implementation_defined
0034
0035 /** Rule for absolute-URI
0036
0037     @par Value Type
0038     @code
0039     using value_type = url_view;
0040     @endcode
0041
0042     @par Example
0043     Rules are used with the function @ref grammar::parse.
0044     @code
0045     system::result< url_view > rv = grammar::parse( "http://example.com/index.htm?id=1", absolute_uri_rule );
0046     @endcode
0047
0048     @par BNF
0049     @code
0050     absolute-URI    = scheme ":" hier-part [ "?" query ]
0051
0052     hier-part       = "//" authority path-abempty
0053                     / path-absolute
0054                     / path-rootless
0055                     / path-empty
0056     @endcode
0057
0058     @par Specification
0059     @li <a href="https://datatracker.ietf.org/doc/html/rfc3986#section-4.3"
0060         >4.3. Absolute URI (rfc3986)</a>
0061
0062     @see
0063         @ref grammar::parse,
0064         @ref parse_absolute_uri,
0065         @ref url_view.
0066 */
0067 BOOST_INLINE_CONSTEXPR implementation_defined::absolute_uri_rule_t absolute_uri_rule{};
0068
0069 } // urls
0070 } // boost
0071
0072 #endif