set_password

Set the password.

Synopsis

url& set_password( string_view s);

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

Description

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

NOTE

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

  • 3.2.1. User Information (rfc3986)