Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. — Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

This is the documentation for a snapshot of the master branch, built from commit e83975fcee.

authority_view::userinfo

Return the userinfo.

Synopsis

template<
    class StringToken = string_token::return_string>
StringToken::result_type
userinfo(
    StringToken&& token = {}) const;

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

3.2.1. User Information (rfc3986)

See Also

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