boost::urls::url_base::set_host

Set the host

Synopsis

Declared in <boost/url/url_base.hpp>

url_base&
set_host(core::string_view s);

Description

Depending on the contents of the passed string, this function sets the host:

  • If the string is a valid IPv4 address, then the host is set to the address. The host type is host_type::ipv4.

  • If the string is a valid IPv6 address enclosed in square brackets, then the host is set to that address. The host type is host_type::ipv6.

  • If the string is a valid IPvFuture address enclosed in square brackets, then the host is set to that address. The host type is host_type::ipvfuture.

  • Otherwise, the host name is set to the string, which may be empty. Reserved characters in the string are percent‐escaped in the result. The host type is host_type::name.

In all cases, when this function returns, the URL contains an authority.

Example

assert( url( "http://www.example.com" ).set_host( "127.0.0.1" ).buffer() == "http://127.0.0.1" );

Postconditions

this->has_authority() == true

Complexity

Linear in this‐>size() + s.size().

Exception Safety

Strong guarantee. Calls to allocate may throw.

BNF

host        = IP-literal / IPv4address / reg-name

IP-literal  = "[" ( IPv6address / IPvFuture  ) "]"

reg-name    = *( unreserved / pct-encoded / "-" / ".")

Specification

Return Value

*this

Parameters

Name

Description

s

The string to set.

See Also

set_encoded_host, set_encoded_host_address, set_encoded_host_name, set_host_address, set_host_ipv4, set_host_ipv6, set_host_ipvfuture, set_host_name.

Created with MrDocs