Namespaces

Name

boost

boost namespace

Namespaces

Name

urls

boost::urls namespace

Namespaces

Name

error_types

grammar

string_token

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

param

A query parameter

param_pct_view

A view of a percent‐encoded query parameter

param_view

A view of a query parameter

params_base

Common functionality for query parameter 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

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

format_arg

A temporary reference to a formatting argument

named_arg

A temporary reference to a named formatting argument

optional

The type of optional used by the library

string_view

The type of string_view used by the library

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

encode overloads

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

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

operator<<

Stream insertion operators

operator==

Equality operators

operator!=

Inequality operators

operator<

Less‐than operators

operator<=

Less‐than‐or‐equal operators

operator>

Greater‐than operators

operator>=

Greater‐than‐or‐equal operators

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 a query string

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 Namespace Directives

Name

error_types

boost::urls::error_types namespace

Namespace Aliases

Name

Description

errc

The set of constants used for cross‐platform error codes

Types

Name

Description

error_category

The type of error category used by the library

error_code

The type of error code used by the library

error_condition

The type of error condition used by the library

result

The type of result returned by library functions

system_error

The type of system error thrown by the library

Using Declarations

Name

Description

generic_category

A function to return the generic error category used by the library

system_category

A function to return the system error category used by the library

boost::urls::grammar namespace

Namespace Aliases

Name

string_token

Types

Name

Description

literal_rule

Match a string literal exactly

lut_chars

A set of characters

range

A forward range of parsed elements

recycled

A thread‐safe collection of instances of T

recycled_ptr

A pointer to a shared instance of T

string_view_base

Common functionality for string views

unsigned_rule

Match an unsigned decimal

aligned_storage

Provides an aligned storage buffer aligned for T

ci_equal

A case‐insensitive equals predicate for strings

ci_hash

A case‐insensitive hash function object for strings

ci_less

A case‐insensitive less predicate for strings

is_charset

Alias for std::true_type if T satisfies CharSet.

is_rule

Determine if T meets the requirements of Rule

Enums

Name

Description

condition

Error conditions for errors received from rules

error

Error codes returned when using rules

Functions

Name

Description

ci_compare

Return the case‐insensitive comparison of s0 and s1

ci_digest

Return the case‐insensitive digest of a string

ci_is_equal

Return true if s0 equals s1 using case‐insensitive comparison

ci_is_less

Return true if s0 is less than s1 using case‐insensitive comparison

delim_rule

delim_rule overloads

find_if

Find the first character in the string that is in the set.

find_if_not

Find the first character in the string that is not in CharSet

hexdig_value

Return the decimal value of a hex character

not_empty_rule

Match another rule, if the result is not empty

operator+

Return the union of two character sets.

operator‐

Return a new character set by subtracting

optional_rule

Match a rule, or the empty string

parse

Parse a character buffer using a rule

range_rule

Match a repeating number of elements

ref

ref overloads

squelch

Squelch the value of a rule

to_lower

Return c converted to lowercase

to_upper

Return c converted to uppercase

token_rule

Match a non‐empty string of characters from a set

tuple_rule

Match a series of rules in order

variant_rule

Match one of a set of rules

operator<<

Format a string to an output stream

operator==

Compare two string views for equality

operator!=

Compare two string views for inequality

operator<

Compare two string views for less than

operator<=

Compare two string views for less than or equal

operator>

Compare two string views for greater than

operator>=

Compare two string views for greater than or equal

Variables

Name

Description

all_chars

The set of all characters

alnum_chars

The set of letters and digits

alpha_chars

The set of all letters

dec_octet_rule

Match a decimal octet

digit_chars

The set of decimal digits

hexdig_chars

The set of hexadecimal digits

vchars

The set of visible characters

Concepts

Name

Description

CharSet

Concept for a CharSet

Rule

Concept for a grammar Rule

boost::urls::string_token namespace

Types

Name

Description

arg

Base class for string tokens, and algorithm parameters

is_token

Trait to determine if a type is a string token

return_string

A string token for returning a plain string

Functions

Name

Description

append_to

Create a string token for appending to a plain string

assign_to

Create a string token for assigning to a plain string

preserve_size

Create a string token for a durable core::string_view

Concepts

Name

Description

StringToken

Concept for a string token

Created with MrDocs