boost::urls::url_view_base::encoded_host_name :: Boost Libraries Documentation

# boost::urls::url_view_base::encoded_host_name

Return the host name

## Synopsis

Declared in `<boost/url/url_view_base.hpp>`

    pct_string_view
    encoded_host_name() const noexcept;

## Description

If the host type is `host_type::name`, this function returns the name as a string. Otherwise, if the host type is not an name, it returns an empty string. The returned string may contain percent escapes.

## Example

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

## Complexity

Constant.

## Exception Safety

Throws nothing.

## BNF

    host        = IP-literal / IPv4address / reg-name

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

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

## Specification

- 3.2.2. Host (rfc3986)

## Return Value

The host name as a percent‐encoded string.

Created with MrDocs