Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext
static_url::set_encoded_password

Set the password.

Synopsis
static_url&
set_encoded_password(
    pct_string_view s);
Description

This function sets the password in the userinfo to the string, which may contain percent-escapes. Escapes in the string are preserved, and reserved characters in the string are percent-escaped in the result.

Remarks

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" ).[link url.ref.boost__urls__static_url.set_encoded_password `set_encoded_password`]( "pass" ).[link url.ref.boost__urls__static_url.encoded_userinfo `encoded_userinfo`]() == "user:pass" );
Postconditions
this->[link url.ref.boost__urls__static_url.has_password `has_password`]() == true
Exception Safety

Strong guarantee. Calls to allocate may throw.

Exceptions

Type

Thrown On

system_error

s contains an invalid percent-encoding.

Parameters

Name

Description

s

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

BNF
[link url.ref.boost__urls__static_url.userinfo `userinfo`]      = [ [ [link url.ref.boost__urls__static_url.user `user`] ] [ ':' [link url.ref.boost__urls__static_url.password `password`] ] ]

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

remove_password, set_encoded_password, set_encoded_user, /root/project/libs/url/include/boost/url/static_url.hpp


PrevUpHomeNext