boost::urls::url_base::set_password

Set the password.

Synopsis

Declared in <boost/url/url_base.hpp>

url_base&
set_password(core::string_view s);

Description

This function sets the password in the userinfo to the string. Reserved characters in the string are percent‐escaped in the result.

The interpretation of the userinfo as individual user and password components is scheme‐dependent. Transmitting passwords in URLs is deprecated.

Example

assert( url("http://user@example.com").set_password( "pass" ).encoded_userinfo() == "user:pass" );

Postconditions

this->has_password() == true && this->password() == s

Exception Safety

Strong guarantee. Calls to allocate may throw.

BNF

userinfo      = [ [ user ] [ ':' password ] ]

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

Specification

Return Value

*this

Parameters

Name

Description

s

The string to set. This string may contain any characters, including nulls.

See Also

remove_password, set_encoded_password, set_encoded_user, set_user.

Created with MrDocs