boost::urls::authority_view::userinfo

Return the userinfo

Synopsis

Declared in <boost/url/authority_view.hpp>

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

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.

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

Return Value

The userinfo

Parameters

Name

Description

token

A string token to receive the result.

See Also

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

Created with MrDocs