73 lines
1.7 KiB
C++
73 lines
1.7 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_URI_REFERENCE_RULE_HPP
|
|
#define BOOST_URL_RFC_URI_REFERENCE_RULE_HPP
|
|
|
|
#include <boost/url/detail/config.hpp>
|
|
#include <boost/url/error_types.hpp>
|
|
#include <boost/url/url_view.hpp>
|
|
|
|
namespace boost {
|
|
namespace urls {
|
|
|
|
/** Rule for URI-reference
|
|
|
|
@par Value Type
|
|
@code
|
|
using value_type = url_view;
|
|
@endcode;
|
|
|
|
@par Example
|
|
Rules are used with the function @ref grammar::parse.
|
|
@code
|
|
system::result< url_view > rv = grammar::parse( "ws://echo.example.com/?name=boost#demo", uri_reference_rule );
|
|
@endcode
|
|
|
|
@par BNF
|
|
@code
|
|
URI-reference = URI / relative-ref
|
|
|
|
URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ]
|
|
relative-ref = relative-part [ "?" query ] [ "#" fragment ]
|
|
@endcode
|
|
|
|
@par Specification
|
|
@li <a href="https://datatracker.ietf.org/doc/html/rfc3986#section-3"
|
|
>3. Syntax Components (rfc3986)</a>
|
|
|
|
@see
|
|
@ref grammar::parse,
|
|
@ref parse_uri_reference,
|
|
@ref url_view.
|
|
*/
|
|
#ifdef BOOST_URL_DOCS
|
|
constexpr __implementation_defined__ uri_reference_rule{};
|
|
#else
|
|
struct uri_reference_rule_t
|
|
{
|
|
using value_type = url_view;
|
|
|
|
BOOST_URL_DECL
|
|
auto
|
|
parse(
|
|
char const*& it,
|
|
char const* end
|
|
) const noexcept ->
|
|
system::result<value_type>;
|
|
};
|
|
|
|
constexpr uri_reference_rule_t uri_reference_rule{};
|
|
#endif
|
|
|
|
} // urls
|
|
} // boost
|
|
|
|
#endif
|