Boost C++ Libraries

Return a reference to a parsed URL string.

Synopsis

Defined in header <boost/url/parse.hpp>

result< url_view >
parse_uri_reference(
    string_view s);

Description

This function parses a string according to the grammar below and returns a view referencing the passed string upon success, else returns an error. Ownership of the string is not transferred; the caller is responsible for ensuring that the lifetime of the character buffer extends until the view is no longer being accessed.

Example

result< url_view > = parse_uri_reference( "ws://echo.example.com/?name=boost#demo" );

BNF

URI-reference = URI / relative-ref

URI           = scheme ":" hier-part [ "?" query ] [ "#" fragment ]

relative-ref  = relative-part [ "?" query ] [ "#" fragment ]

hier-part     = "//" authority path-abempty
              / path-absolute
              / path-rootless
              / path-empty

relative-part = "//" authority path-abempty
              / path-absolute
              / path-noscheme
              / path-abempty
              / path-empty

Exceptions

Return Value

A result containing a value or an error

Parameters

Specification

See Also

parse_absolute_uri, parse_origin_form, parse_relative_ref, parse_uri, url_view.

Convenience header <boost/url.hpp>