boost::urls::url_view_base::host

Return the host

Synopsis

Declared in <boost/url/url_view_base.hpp>

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

Description

This function returns the host portion of the authority as a string, or the empty string if there is no authority. Any percent‐escapes in the string are decoded first.

Example

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

Complexity

Linear in this‐>host().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 address as a string.

Parameters

Name

Description

token

A string token customization

Created with MrDocs