boost::urls::url_view_base

Common functionality for containers

Synopsis

Declared in <boost/url/url_view_base.hpp>

class url_view_base;

Description

This base class is used by the library to provide common member functions for containers. This cannot be instantiated directly; Instead, use one of the containers or functions:

Containers

Functions

Member Functions

NameDescription
authority Return the authority
buffer Return the url string
compare Return the result of comparing this with another url
data Return a pointer to the url's character buffer
empty Return true if the url is empty
encoded_authority Return the authority.
encoded_fragment Return the fragment
encoded_host Return the host
encoded_host_address Return the host
encoded_host_and_port Return the host and port
encoded_host_name Return the host name
encoded_origin Return the origin
encoded_params Return the query as a container of parameters
encoded_password Return the password
encoded_path Return the path
encoded_query Return the query
encoded_resource Return the resource
encoded_segments Return the path as a container of segments
encoded_target Return the target
encoded_user Return the user
encoded_userinfo Return the userinfo
encoded_zone_id Return the IPv6 Zone ID
fragment Return the fragment
has_authority Return true if an authority is present
has_fragment Return true if a fragment is present
has_password Return true if a password is present
has_port Return true if a port is present
has_query Return true if a query is present
has_scheme Return true a scheme is present
has_userinfo Return true if a userinfo is present
host Return the host
host_address Return the host
host_ipv4_address Return the host IPv4 address
host_ipv6_address Return the host IPv6 address
host_ipvfuture Return the host IPvFuture address
host_name Return the host name
host_type Return the host type
is_path_absolute Return true if the path is absolute
params Return the query as a container of parameters
password Return the password
path Return the path
persist Return a shared, persistent copy of the url
port Return the port
port_number Return the port
query Return the query
scheme Return the scheme
scheme_id Return the scheme
segments Return the path as a container of segments
size Return the number of characters in the url
user Return the user
userinfo Return the userinfo
zone_id Return the IPv6 Zone ID
operator core::string_view Return the URL as a core::string_view

Static Member Functions

NameDescription
max_size Return the maximum number of characters possible

Protected Member Functions

NameDescription
digest Calculate a hash of the url

Friends

NameDescription
boost::urls::operator<<Format the url to the output stream
boost::urls::operator>=Return the result of comparing two URLs
boost::urls::operator>Return the result of comparing two URLs
boost::urls::operator<=Return the result of comparing two URLs
boost::urls::operator<Return the result of comparing two URLs
boost::urls::operator!=Return the result of comparing two URLs
boost::urls::operator==Return the result of comparing two URLs
boost::urls::segments_viewNon-owning decoded path segment view
boost::urls::segments_refMutable decoded path segment proxy
boost::urls::segments_encoded_viewNon-owning encoded path segment view
boost::urls::segments_encoded_refMutable encoded path segment proxy
boost::urls::segments_encoded_basePercent-encoded path segment helper base
boost::urls::segments_baseDecoded path segment helper base
boost::urls::params_viewNon-owning decoded query parameter view
boost::urls::params_refMutable decoded query parameter proxy
boost::urls::params_encoded_viewNon-owning encoded query parameter view
boost::urls::params_encoded_refMutable encoded query parameter proxy
boost::urls::params_encoded_basePercent-encoded query helper base
boost::urls::params_baseDecoded query parameter helper base
boost::urls::static_url_baseCommon implementation for all static URLs
boost::urls::url_viewA non-owning reference to a valid URL
boost::urls::url_baseCommon functionality for containers
boost::urls::urlA modifiable container for a URL.

Non-Member Functions

NameDescription
resolveResolve a URL reference against a base URL

Derived Classes

NameDescription
url_base Common functionality for containers
url_view A non-owning reference to a valid URL