boost::urls::url_view_base::host_name

Return the host name

Synopsis

Declared in <boost/url/url_view_base.hpp>

template<string_token::StringToken StringToken = string_token::return_string>
StringToken::result_type
host_name(StringToken&& token = {}) const;

Description

If the host type is host_type::name, this function returns the name as a string. Otherwise an empty string is returned. Any percent-escapes in the string are decoded first.

Example


assert( url_view( "https://www%2droot.example.com/" ).host_name() == "www-root.example.com" );

Complexity

Linear in this->host_name().size().

Exception Safety

Calls to allocate may throw.

BNF


host        = IP-literal / IPv4address / reg-name

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

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

Specification

Return Value

The host name as a string.

Parameters

Name	Description
token	A string token customization.