[#boost-urls-url_base-set_encoded_user]
= xref:boost.adoc[boost]::xref:boost/urls.adoc[urls]::xref:boost/urls/url_base.adoc[url&lowbar;base]::set&lowbar;encoded&lowbar;user
:relfileprefix: ../../../
:mrdocs:

Set the user

== Synopsis

Declared in `&lt;https://www.github.com/boostorg/url/blob/develop/include/boost/url/url_base.hpp#L693[boost&sol;url&sol;url&lowbar;base&period;hpp]&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
xref:boost/urls/url_base.adoc[url&lowbar;base]&
set&lowbar;encoded&lowbar;user(xref:boost/urls/pct_string_view.adoc[pct&lowbar;string&lowbar;view] s);
----

== Description

This function sets the user part of the userinfo the the string, which may contain percent&hyphen;escapes&period; Escapes in the string are preserved, and reserved characters in the string are percent&hyphen;escaped in the result&period;

== Example
[,cpp]
----
assert( url().set_encoded_user("john%20doe").userinfo() == "john doe" );
----
== Postconditions
[,cpp]
----
this->has_authority() == true && this->has_userinfo() == true
----
== Complexity
Linear in `this&hyphen;&gt;size() &plus; s&period;size()`&period;

== Exception Safety
Strong guarantee&period; Calls to allocate may throw&period;

== BNF
[,cpp]
----
userinfo      = [ [ user ] [ ':' password ] ]

user          = *( unreserved / pct-encoded / sub-delims )
password      = *( unreserved / pct-encoded / sub-delims / ":" )
----
== Specification
* https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1[]

== Exceptions

[cols=2]
|===
| Name
| Thrown on
| `system&lowbar;error`
| `s` contains an invalid percent&hyphen;encoding&period;
|===

== Return Value

* `&ast;this`
* `&ast;this`

== Parameters

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

== See Also

xref:boost/urls/url_base/remove_password.adoc[`remove&lowbar;password`], xref:boost/urls/url_base/set_encoded_password.adoc[`set&lowbar;encoded&lowbar;password`], xref:boost/urls/url_base/set_password.adoc[`set&lowbar;password`], xref:boost/urls/url_base/set_user.adoc[`set&lowbar;user`]&period;


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