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

Set the path.

== Synopsis

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

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
xref:boost/urls/static_url.adoc[static_url]&
set_path(core::string_view s);
----

== Description

This function sets the path to the string, which may be empty. Reserved characters in the string are percent‐escaped in the result.

[NOTE]
The library may adjust the final result to ensure that no other parts of the url is semantically affected.

[NOTE]
This function does not encode '/' chars, which are unreserved for paths but reserved for path segments. If a path segment should include encoded '/'s to differentiate it from path separators, the functions xref:boost/urls/url_base/set_encoded_path.adoc[`set_encoded_path`] or xref:boost/urls/url_base/segments-07.adoc[`segments`] should be used instead.

== Example
[,cpp]
----
url u( "http://www.example.com" );

u.set_path( "path/to/file.txt" );

assert( u.path() == "/path/to/file.txt" );
----
== Complexity
Linear in `this‐>size() + s.size()`.

== Exception Safety
Strong guarantee. 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
* https://datatracker.ietf.org/doc/html/rfc3986#section-3.3[]

== Return Value

`&ast;this`

== Parameters

[cols=2]
|===
| Name
| Description
| *s*
| The string to set&period;
|===

== See Also

xref:boost/urls/url_base/encoded_segments-0a.adoc[`encoded&lowbar;segments`], xref:boost/urls/url_base/segments-07.adoc[`segments`], xref:boost/urls/static_url/set_encoded_path.adoc[`set&lowbar;encoded&lowbar;path`], xref:boost/urls/url_base/set_path_absolute.adoc[`set&lowbar;path&lowbar;absolute`]&period;


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