:relfileprefix: ../../../
[#boost-urls-url_view_base-path]

= xref:boost.adoc[pass:[boost]]::xref:boost/urls.adoc[pass:[urls]]::xref:boost/urls/url_view_base.adoc[pass:[url_view_base]]::path


Return the path


== Synopsis

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

[source,cpp,subs="verbatim,macros,-callouts"]
----
template<class StringToken = xref:boost/urls/string_token.adoc[string_token]::xref:boost/urls/string_token/return_string.adoc[return_string]>
StringToken::result_type
path(StringToken&& token) const;
----

== Description


This function returns the path as a
string. The path may be empty.
Any percent-escapes in the string are
decoded first.

=== Example
[,cpp]
----
assert( url_view( "file:///Program%20Files/Games/config.ini" ).path() == "/Program Files/Games/config.ini" );
----

=== Complexity

Linear in `this-&gt;path().size()`.

=== Exception Safety

Calls to allocate may throw.

=== BNF
[,cpp]
----
path          = path-abempty    ; begins with "/" or is empty
              / path-absolute   ; begins with "/" but not "//"
              / path-noscheme   ; begins with a non-colon segment
              / path-rootless   ; begins with a segment
              / path-empty      ; zero characters

path-abempty  = *( "/" segment )
path-absolute = "/" [ segment-nz *( "/" segment ) ]
path-noscheme = segment-nz-nc *( "/" segment )
path-rootless = segment-nz *( "/" segment )
path-empty    = 0<pchar>
----

=== Specification

* link:https://datatracker.ietf.org/doc/html/rfc3986#section-3.3[3.3. Path (rfc3986)]








== See Also


xref:boost/urls/url_view_base/is_path_absolute.adoc[is_path_absolute]
,
xref:boost/urls/url_view_base/encoded_path.adoc[encoded_path]
,
xref:boost/urls/url_view_base/encoded_segments.adoc[encoded_segments]
.
xref:boost/urls/url_view_base/segments.adoc[segments]
.