Return the user

Synopsis

Declared in <boost/url/url_view_base.hpp>

pct_string_view
encoded_user() const noexcept;

Description

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

Example

assert( url_view( "http://jane%2Ddoe:pass@example.com" ).encoded_user() == "jane%2Ddoe" );

Complexity

Constant.

Exception Safety

Throws nothing.

BNF

userinfo    = user [ ":" [ password ] ]

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

Specification

Return Value

The user as a string.

See Also

has_password, has_userinfo, encoded_password, encoded_userinfo, password, user, userinfo.

Created with MrDocs