Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext
url::set_encoded_host_name

Set the host to a name.

Synopsis
url&
set_encoded_host_name(
    pct_string_view s);
Description

The host is set to the specified string, which may contain percent-escapes and can be empty. Escapes in the string are preserved, and reserved characters in the string are percent-escaped in the result. The host type is host_type::name.

Example
assert( [link url.ref.boost__urls__url.url `url`]( "http://www.example.com/index.htm" ).[link url.ref.boost__urls__url.set_encoded_host_name `set_encoded_host_name`]( "localhost" ).[link url.ref.boost__urls__url.host_address `host_address`]() == "localhost" );
Postconditions
this->[link url.ref.boost__urls__url.has_authority `has_authority`]() == true && this->[link url.ref.boost__urls__url.host_ipv6_address `host_ipv6_address`]() == addr && this->[link url.ref.boost__urls__host_type `host_type`]() == [link url.ref.boost__urls__host_type `host_type::name`]
Exception Safety

Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input.

Exceptions

Type

Thrown On

system_error

s contains an invalid percent-encoding.

Parameters

Name

Description

s

The string to set.

BNF
reg-[link url.ref.boost__urls__host_type `name`]    = *( unreserved / pct-encoded / "-" / "." )
Specification
See Also

set_encoded_host, set_encoded_host_address, set_host, set_host_address, set_host_ipv4, set_host_ipv6, set_host_ipvfuture, /root/project/libs/url/include/boost/url/url.hpp


PrevUpHomeNext