static_url

A modifiable container for a URL.

Synopsis

template< size_t Capacity> class static_url : public static_url_base;

Declared in file <boost/url/static_url.hpp> at line 107

Member Functions

Name Description
digest
size

Return the number of characters in the url

empty

Return true if the url is empty

data

Return a pointer to the url's character buffer

buffer

Return the url string

operator string_view

Return the URL as a core::string_view

persist

Return a shared, persistent copy of the url

has_scheme

Return true a scheme is present

scheme

Return the scheme

scheme_id

Return the scheme

has_authority

Return true if an authority is present

authority

Return the authority

encoded_authority

Return the authority.

has_userinfo

Return true if a userinfo is present

has_password

Return true if a password is present

userinfo

Return the userinfo

encoded_userinfo

Return the userinfo

user

Return the user

encoded_user

Return the user

password

Return the password

encoded_password

Return the password

host_type

Return the host type

host

Return the host

encoded_host

Return the host

host_address

Return the host

encoded_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

encoded_host_name

Return the host name

zone_id

Return the IPv6 Zone ID

encoded_zone_id

Return the IPv6 Zone ID

has_port

Return true if a port is present

port

Return the port

port_number

Return the port

is_path_absolute

Return true if the path is absolute

path

Return the path

encoded_path

Return the path

segments

Return the path as a container of segments

encoded_segments

Return the path as a container of segments

has_query

Return true if a query is present

query

Return the query

encoded_query

Return the query

params

Return the query as a container of parameters

params
encoded_params

Return the query as a container of parameters

has_fragment

Return true if a fragment is present

fragment

Return the fragment

encoded_fragment

Return the fragment

encoded_host_and_port

Return the host and port

encoded_origin

Return the origin

encoded_resource

Return the resource

encoded_target

Return the target

compare

Return the result of comparing this with another url

c_str

Return the url as a null-terminated string

capacity

Return the number of characters that can be stored without reallocating

clear

Clear the contents while preserving the capacity

reserve

Adjust the capacity without changing the size

set_scheme

Set the scheme

set_scheme_id
remove_scheme

Remove the scheme

set_encoded_authority

Set the authority

remove_authority

Remove the authority

set_userinfo

Set the userinfo

set_encoded_userinfo

Set the userinfo.

remove_userinfo

Remove the userinfo

set_user

Set the user

set_encoded_user

Set the user

set_password

Set the password.

set_encoded_password

Set the password.

remove_password

Remove the password

set_host

Set the host

set_encoded_host

Set the host

set_host_address

Set the host to an address

set_encoded_host_address

Set the host to an address

set_host_ipv4

Set the host to an address

set_host_ipv6

Set the host to an address

set_host_ipvfuture

Set the host to an address

set_host_name

Set the host to a name

set_encoded_host_name

Set the host to a name

set_port_number

Set the port

set_port

Set the port

remove_port

Remove the port

set_path_absolute

Set if the path is absolute

set_path

Set the path.

set_encoded_path

Set the path.

segments

Return the path as a container of segments

segments

Return the path as a container of segments

encoded_segments

Return the path as a container of segments

encoded_segments

Return the path as a container of segments

set_query

Set the query

set_encoded_query

Set the query

params

Return the query as a container of parameters

params

url_view_base::params

params

Return the query as a container of parameters

encoded_params

Return the query as a container of parameters

encoded_params

Return the query as a container of parameters

set_params

Set the query params

set_encoded_params

Set the query params

remove_query

Remove the query

remove_fragment

Remove the fragment

set_fragment

Set the fragment.

set_encoded_fragment

Set the fragment.

remove_origin

Remove the origin component

normalize

Normalize the URL components

normalize_scheme

Normalize the URL scheme

normalize_authority

Normalize the URL authority

normalize_path

Normalize the URL path

normalize_query

Normalize the URL query

normalize_fragment

Normalize the URL fragment

resolve

Resolve a URL reference against this base URL

~static_url

Destructor

static_url

Constructor

static_url

Constructor

static_url

Constructor

static_url

Constructor

operator=

Assignment

operator=

Assignment

set_scheme

Set the scheme

set_scheme_id

url_base::set_scheme_id

remove_scheme

Remove the scheme

set_encoded_authority

Set the authority

remove_authority

Remove the authority

set_userinfo

Set the userinfo

set_encoded_userinfo

Set the userinfo.

remove_userinfo

Remove the userinfo

set_user

Set the user

set_encoded_user

Set the user

set_password

Set the password.

set_encoded_password

Set the password.

remove_password

Remove the password

set_host

Set the host

set_encoded_host

Set the host

set_host_address

Set the host to an address

set_encoded_host_address

Set the host to an address

set_host_ipv4

Set the host to an address

set_host_ipv6

Set the host to an address

set_host_ipvfuture

Set the host to an address

set_host_name

Set the host to a name

set_encoded_host_name

Set the host to a name

set_port_number

Set the port

set_port

Set the port

remove_port

Remove the port

set_path

Set the path.

set_encoded_path

Set the path.

set_query

Set the query

set_encoded_query

Set the query

remove_query

Remove the query

remove_fragment

Remove the fragment

set_fragment

Set the fragment.

set_encoded_fragment

Set the fragment.

remove_origin

Remove the origin component

normalize

Normalize the URL components

normalize_scheme

Normalize the URL scheme

normalize_authority

Normalize the URL authority

normalize_path

Normalize the URL path

normalize_query

Normalize the URL query

normalize_fragment

Normalize the URL fragment

Description

This container owns a url, represented by an inline, null-terminated character buffer with fixed capacity. The contents may be inspected and modified, and the implementation maintains a useful invariant: changes to the url always leave it in a valid state.

Example

static_url< 1024 > u( "https://www.example.com" );

Invariants

this->capacity() == Capacity