boost::urls

Types

Name

Description

authority_view

A non-owning reference to a valid authority

decode_view

A reference to a valid, percent-encoded string

encoding_opts

Percent-encoding options

ignore_case_param

An optional parameter to determine case-sensitivity

ipv4_address

An IP version 4 style address.

ipv6_address

An IP version 6 style address.

no_value_t

The type of no_value

optional

The type of optional used by the library

param

A query parameter

param_pct_view

A query parameter

param_view

A query parameter

params_base

Common functionality for containers

params_encoded_base

Common functionality for containers

params_encoded_ref

A view representing query parameters in a URL

params_encoded_view

A view representing query parameters in a URL

params_ref

A view representing query parameters in a URL

params_view

A view representing query parameters in a URL

pct_string_view

A reference to a valid percent-encoded string

segments_base

Common functionality for containers

segments_encoded_base

Common functionality for containers

segments_encoded_ref

A view representing path segments in a URL

segments_encoded_view

A view representing path segments in a URL

segments_ref

A view representing path segments in a URL

segments_view

A view representing path segments in a URL

static_url

A modifiable container for a URL.

static_url_base

Common implementation for all static URLs

string_view

The type of string_view used by the library

url

A modifiable container for a URL.

url_base

Common functionality for containers

url_view

A non-owning reference to a valid URL

url_view_base

Common functionality for containers

variant

The type of variant used by the library

Enums

Name

Description

error

Error codes returned the library

host_type

Identifies the type of host in a URL.

scheme

Identifies a known URL scheme

Functions

Name

Description

arg

Designate a named argument for a replacement field

default_port

Return the default port for a known scheme

encode

Apply percent-encoding to a string

Return a percent-encoded string

encoded_size

Return the buffer size needed for percent-encoding

format

Format arguments into a URL

format_to

Format arguments into a URL

make_pct_string_view

Return a valid percent-encoded string

operator!=

Compare two decode views for inequality

Return the result of comparing two URLs

Return the result of comparing two authorities The authorities are compared component by component as if they were first normalized.

Return true if two addresses are not equal

operator<

Compare two decode views for less than

Return the result of comparing two URLs

Return the result of comparing two authorities The authorities are compared component by component as if they were first normalized.

operator<<

Format the address to an output stream

Format the address to an output stream.

Format the encoded authority to the output stream

Format the string with percent-decoding applied to the output stream

Format the url to the output stream

Format to an output stream

operator⇐

Compare two decode views for less than or equal

Return the result of comparing two URLs

Return the result of comparing two authorities The authorities are compared component by component as if they were first normalized.

operator==

Compare two decode views for equality

Return the result of comparing two URLs

Return the result of comparing two authorities The authorities are compared component by component as if they were first normalized.

Return true if two addresses are equal

operator>

Compare two decode views for greater than

Return the result of comparing two URLs

Return the result of comparing two authorities The authorities are compared component by component as if they were first normalized.

operator>=

Compare two decode views for greater than or equal

Return the result of comparing two URLs

Return the result of comparing two authorities The authorities are compared component by component as if they were first normalized.

parse_absolute_uri

Return a reference to a parsed URL string

parse_authority

Parse an authority

parse_ipv4_address

Return an IPv4 address from an IP address string in dotted decimal form

parse_ipv6_address

Parse a string containing an IPv6 address.

parse_origin_form

Return a reference to a parsed URL string

parse_path

Parse a string and return an encoded segment view

parse_query

Parse a string and return an encoded params view

parse_relative_ref

Return a reference to a parsed URL string

parse_uri

Return a reference to a parsed URL string

parse_uri_reference

Return a reference to a parsed URL string

pct_encoded_rule

Rule for a string with percent-encoded escapes

resolve

Resolve a URL reference against a base URL

string_to_scheme

Return the known scheme for a non-normalized string, if known

swap

Swap

to_string

Return the normalized string for a known scheme

Variables

Name

Description

absolute_uri_rule

Rule for absolute-URI

authority_rule

Rule for authority

gen_delim_chars

The gen-delims character set

ignore_case

Ignore case when comparing

ipv4_address_rule

Rule for an IP version 4 style address

ipv6_address_rule

Rule for An IP version 6 style address

no_value

Constant indicating no value in a param

origin_form_rule

Rule for origin-form

pchars

The path character set

query_rule

Rule for query

relative_ref_rule

Rule for relative-ref

reserved_chars

The reserved character set

sub_delim_chars

The sub-delims character set

unreserved_chars

The unreserved character set

uri_reference_rule

Rule for URI-reference

uri_rule

Rule for URI

Using Directives

Name

Description

error_types