[#boost-urls-authority_view-encoded_userinfo]
= xref:boost.adoc[boost]::xref:boost/urls.adoc[urls]::xref:boost/urls/authority_view.adoc[authority_view]::encoded_userinfo
:relfileprefix: ../../../
:mrdocs:

Return the userinfo

== Synopsis

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

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
xref:boost/urls/pct_string_view.adoc[pct_string_view]
encoded_userinfo() const noexcept;
----

== Description

If present, this function returns a string representing the userinfo (which may be empty). Otherwise it returns an empty string. The returned string may contain percent escapes.

== Example
[,cpp]
----
assert( url_view( "http://jane%2Ddoe:pass@example.com" ).encoded_userinfo() == "jane%2Ddoe:pass" );
----
== Complexity
Constant.

== Exception Safety
Throws nothing

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

authority   = [ userinfo "@" ] host [ ":" port ]
----
== Specification
* https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1[]

== Return Value

The userinfo

== See Also

xref:boost/urls/authority_view/has_password.adoc[`has_password`], xref:boost/urls/authority_view/has_userinfo.adoc[`has_userinfo`], xref:boost/urls/authority_view/encoded_password.adoc[`encoded_password`], xref:boost/urls/authority_view/encoded_user.adoc[`encoded_user`], xref:boost/urls/authority_view/password.adoc[`password`], xref:boost/urls/authority_view/user.adoc[`user`], xref:boost/urls/authority_view/userinfo.adoc[`userinfo`].


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