:relfileprefix: ../../../
[#196CB7CBAEAC397E28BFE121DE1C4D455B001306]

= Function url_base::set_user

pass:v,q[Set the user]


== Synopsis

Declared in header `</boost/url/url_base.hpp#L625[boost/url/url_base.hpp,window=blank_]>`

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

== Description

pass:v,q[This function sets the user part of the] pass:v,q[userinfo to the string.]
pass:v,q[Any special or reserved characters in the]
pass:v,q[string are automatically percent-encoded.]

=== Example
[,cpp]
----
assert( url().set_user("john doe").encoded_userinfo() == "john%20doe" );
----

=== Postconditions
[,cpp]
----
this->has_authority() == true && this->has_userinfo() == true
----

=== Complexity
pass:v,q[Linear in `this->size() + s.size()`.]

=== Exception Safety
pass:v,q[Strong guarantee.]
pass:v,q[Calls to allocate may throw.]

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

user          = *( unreserved / pct-encoded / sub-delims )
password      = *( unreserved / pct-encoded / sub-delims / ":" )
----

=== Specification

* link:https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1[            3.2.1. User Information (rfc3986)]



== Return Value

* `` 


== Parameters

|===
| Name | Type 

| *s*
| `string_view`

|===