Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext
url_base::password

(Inherited from url_view_base)

Return the password.

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

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

Example
assert( [link url.ref.boost__urls__url_view_base.url_view `url_view`]( "http://jane%2Ddoe:pass@example.com" ).[link url.ref.boost__urls__url_base.password `password`]() == "pass" );
Complexity

Linear in this->password().size().

Exception Safety

Calls to allocate may throw.

BNF
[link url.ref.boost__urls__url_base.userinfo `userinfo`]    = [link url.ref.boost__urls__url_base.user `user`] [ ":" [ [link url.ref.boost__urls__url_base.password `password`] ] ]

[link url.ref.boost__urls__url_base.user `user`]        = *( unreserved / pct-encoded / sub-delims )
[link url.ref.boost__urls__url_base.password `password`]    = *( unreserved / pct-encoded / sub-delims / ":" )
Specification
See Also

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


PrevUpHomeNext