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


Return the path

== Synopsis


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

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<xref:boost/urls/string_token.adoc[string_token]::xref:boost/urls/string_token/StringToken.adoc[StringToken] 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 = {});
----

== 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‐>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&period;3&period; Path (rfc3986)]

Return the path

This function returns the path as a        string&period; The path may be empty&period;        Any percent&hyphen;escapes in the string are        decoded first&period;


=== Example

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

=== Complexity

Linear in `this&hyphen;&gt;path()&period;size()`&period;


=== Exception Safety

Calls to allocate may throw&period;


=== 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&period;3&period; Path (rfc3986)]



== See Also


xref:boost/urls/url_view_base/is_path_absolute.adoc[is&lowbar;path&lowbar;absolute],            xref:boost/urls/url_view_base/encoded_path.adoc[encoded&lowbar;path],            xref:boost/urls/url_view_base/encoded_segments.adoc[encoded&lowbar;segments]&period;            xref:boost/urls/url_view_base/segments.adoc[segments]&period;



xref:boost/urls/url_view_base/is_path_absolute.adoc[is&lowbar;path&lowbar;absolute],            xref:boost/urls/url_view_base/encoded_path.adoc[encoded&lowbar;path],            xref:boost/urls/url_view_base/encoded_segments.adoc[encoded&lowbar;segments]&period;            xref:boost/urls/url_view_base/segments.adoc[segments]&period;






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