:relfileprefix: ../../
[#boost-urls-parse_uri_reference]

= xref:boost.adoc[pass:[boost]]::xref:boost/urls.adoc[pass:[urls]]::parse_uri_reference


Return a reference to a parsed URL string


== Synopsis

Declared in header `<https://www.github.com/boostorg/url/blob/develop/include/boost/url/parse.hpp#L277[boost/url/parse.hpp,window=blank_]>`

[source,cpp,subs="verbatim,macros,-callouts"]
----
xref:boost/system.adoc[system]::result<xref:boost/urls/url_view.adoc[url_view]>
parse_uri_reference(core::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
[,cpp]
----
system::result< url_view > = parse_uri_reference( "ws://echo.example.com/?name=boost#demo" );
----

=== BNF
[,cpp]
----
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
----

=== Specification

* link:https://datatracker.ietf.org/doc/html/rfc3986#section-4.1[4.1. URI Reference (rfc3986)]

* link:https://www.rfc-editor.org/errata/eid5428[Errata ID: 5428 (rfc3986)]



== Exceptions

|===
| Name | Thrown on

| `std::length_error`
| 
`s.size() &gt; url_view::max_size`

|===


== Return Value


A
result
containing a value or an error



== Parameters

|===
| Name | Description 

| *s*
| 
The string to parse

|===




== See Also


xref:boost/urls/parse_absolute_uri.adoc[parse_absolute_uri]
,
xref:boost/urls/parse_origin_form.adoc[parse_origin_form]
,
xref:boost/urls/parse_relative_ref.adoc[parse_relative_ref]
,
xref:boost/urls/parse_uri.adoc[parse_uri]
,
xref:boost/urls/url_view.adoc[url_view]
.