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


Set the userinfo.

== Synopsis


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

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

== Description


The userinfo is set to the given string,        which may contain percent‐escapes.        Escapes in the string are preserved,        and reserved characters in the string        are percent‐escaped in the result.        The effects on the user and password        depend on the presence of a colon (':')        in the string:

* If an unescaped colon exists, the        characters up to the colon become
        the user and the rest of the characters        after the colon become the password.
        In this case 
has_password
 returns        true. Otherwise,
* If there is no colon, the user is        set to the string. The function
        
has_password
 returns false.

[NOTE]
The interpretation of the userinfo as        individual user and password components        is scheme‐dependent. Transmitting        passwords in URLs is deprecated.


=== Example

[,cpp]
----
assert( url( "http://example.com" ).set_encoded_userinfo( "john%20doe" ).user() == "john doe" );
----

=== Complexity

Linear in `this‐>size() + s.size()`.


=== Exception Safety

Strong guarantee.        Calls to allocate may throw.        Exceptions thrown on invalid input.


=== 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)]



== Exceptions


|===
| Name | Thrown on

| `system_error`
| `s` contains an invalid percent‐encoding.


|===

== Parameters


|===
| Name | Description

| *s*
| The string to set.


|===

== See Also


xref:boost/urls/url_base/remove_userinfo.adoc[remove_userinfo],            xref:boost/urls/url_base/set_userinfo.adoc[set_userinfo].






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