[#boost-urls-parse_uri]
= xref:boost.adoc[boost]::xref:boost/urls.adoc[urls]::parse_uri
:relfileprefix: ../../
:mrdocs:

Return a reference to a parsed URL string

== Synopsis

Declared in `<https://www.github.com/boostorg/url/blob/develop/include/boost/url/parse.hpp#L211[boost/url/parse.hpp]>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
system::result<url_view>
parse_uri(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( "https://www.example.com/index.htm?id=guest#s1" );
----
== BNF
[,cpp]
----
URI           = scheme ":" hier-part [ "?" query ] [ "#" fragment ]

hier-part     = "//" authority path-abempty
              / path-absolute
              / path-rootless
              / path-empty
----
== Specification
* https://datatracker.ietf.org/doc/html/rfc3986#section-3[]

== Exceptions

[cols=2]
|===
| Name
| Thrown on
| `std&colon;&colon;length&lowbar;error`
| `s&period;size() &gt; url&lowbar;view&colon;&colon;max&lowbar;size`
|===

== Return Value

A `boost&colon;&colon;system&colon;&colon;result` containing a value or an error

== Parameters

[cols=2]
|===
| Name
| Description
| *s*
| The string to parse
|===

== See Also

xref:boost/urls/parse_absolute_uri.adoc[`parse&lowbar;absolute&lowbar;uri`], xref:boost/urls/parse_origin_form.adoc[`parse&lowbar;origin&lowbar;form`], xref:boost/urls/parse_relative_ref.adoc[`parse&lowbar;relative&lowbar;ref`], xref:boost/urls/parse_uri_reference.adoc[`parse&lowbar;uri&lowbar;reference`], xref:boost/urls/url_view.adoc[`url&lowbar;view`]&period;


[.small]#Created with https://www.mrdocs.com[MrDocs]#