userinfo

Return the userinfo

Synopsis

template< class StringToken = return_string> StringToken::result_type userinfo( StringToken&& token);

Declared in file <boost/url/url_view_base.hpp> at line 696

Description

If present, this function returns a string representing the userinfo (which may be empty). Otherwise it returns an empty string. Any percent-escapes in the string are decoded first.

NOTE

This function uses the string token return type customization. Depending on the token passed, the return type and behavior of the function can be different. See string_token::return_string for more information.

Example

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

Complexity

Linear in `this->userinfo().size()`.

Exception Safety

Calls to allocate may throw.

BNF

userinfo = user [ ":" [ password ] ] authority = [ userinfo "@" ] host [ ":" port ]

Specification

  • 3.2.1. User Information (rfc3986)