[#index]
= Global namespace
:mrdocs:

== Namespaces

[cols=1]
|===
| Name
| xref:boost.adoc[`boost`] 
|===

== xref:boost.adoc[boost] namespace

=== Namespaces

[cols=1]
|===
| Name
| xref:boost/urls.adoc[`urls`] 
|===

== xref:boost/urls.adoc[boost::urls] namespace

=== Namespaces

[cols=1]
|===
| Name
| xref:boost/urls/error_types.adoc[`error&lowbar;types`] 
| xref:boost/urls/grammar.adoc[`grammar`] 
| xref:boost/urls/string_token.adoc[`string&lowbar;token`] 
|===

=== Types

[cols="1,4"]
|===
| Name| Description
| xref:boost/urls/authority_view.adoc[`authority&lowbar;view`] 
| A non&hyphen;owning reference to a valid authority
| xref:boost/urls/decode_view.adoc[`decode&lowbar;view`] 
| A reference to a valid, percent&hyphen;encoded string
| xref:boost/urls/encoding_opts.adoc[`encoding&lowbar;opts`] 
| Percent&hyphen;encoding options
| xref:boost/urls/ignore_case_param.adoc[`ignore&lowbar;case&lowbar;param`] 
| An optional parameter to determine case&hyphen;sensitivity
| xref:boost/urls/ipv4_address.adoc[`ipv4&lowbar;address`] 
| An IP version 4 style address&period;
| xref:boost/urls/ipv6_address.adoc[`ipv6&lowbar;address`] 
| An IP version 6 style address&period;
| xref:boost/urls/no_value_t.adoc[`no&lowbar;value&lowbar;t`] 
| The type of xref:boost/urls/no_value.adoc[`no&lowbar;value`]
| xref:boost/urls/param.adoc[`param`] 
| A query parameter
| xref:boost/urls/param_pct_view.adoc[`param&lowbar;pct&lowbar;view`] 
| A view of a percent&hyphen;encoded query parameter
| xref:boost/urls/param_view.adoc[`param&lowbar;view`] 
| A view of a query parameter
| xref:boost/urls/params_base.adoc[`params&lowbar;base`] 
| Common functionality for query parameter containers
| xref:boost/urls/params_encoded_base.adoc[`params&lowbar;encoded&lowbar;base`] 
| Common functionality for containers
| xref:boost/urls/params_encoded_ref.adoc[`params&lowbar;encoded&lowbar;ref`] 
| A view representing query parameters in a URL
| xref:boost/urls/params_encoded_view.adoc[`params&lowbar;encoded&lowbar;view`] 
| A view representing query parameters in a URL
| xref:boost/urls/params_ref.adoc[`params&lowbar;ref`] 
| A view representing query parameters in a URL
| xref:boost/urls/params_view.adoc[`params&lowbar;view`] 
| A view representing query parameters in a URL
| xref:boost/urls/pct_string_view.adoc[`pct&lowbar;string&lowbar;view`] 
| A reference to a valid percent&hyphen;encoded string
| xref:boost/urls/segments_base.adoc[`segments&lowbar;base`] 
| Common functionality for containers
| xref:boost/urls/segments_encoded_base.adoc[`segments&lowbar;encoded&lowbar;base`] 
| Common functionality for containers
| xref:boost/urls/segments_encoded_ref.adoc[`segments&lowbar;encoded&lowbar;ref`] 
| A view representing path segments in a URL
| xref:boost/urls/segments_encoded_view.adoc[`segments&lowbar;encoded&lowbar;view`] 
| A view representing path segments in a URL
| xref:boost/urls/segments_ref.adoc[`segments&lowbar;ref`] 
| A view representing path segments in a URL
| xref:boost/urls/segments_view.adoc[`segments&lowbar;view`] 
| A view representing path segments in a URL
| xref:boost/urls/static_url.adoc[`static&lowbar;url`] 
| A modifiable container for a URL&period;
| xref:boost/urls/static_url_base.adoc[`static&lowbar;url&lowbar;base`] 
| Common implementation for all static URLs
| xref:boost/urls/url.adoc[`url`] 
| A modifiable container for a URL&period;
| xref:boost/urls/url_base.adoc[`url&lowbar;base`] 
| Common functionality for containers
| xref:boost/urls/url_view.adoc[`url&lowbar;view`] 
| A non&hyphen;owning reference to a valid URL
| xref:boost/urls/url_view_base.adoc[`url&lowbar;view&lowbar;base`] 
| Common functionality for containers
| xref:boost/urls/format_arg.adoc[`format&lowbar;arg`] 
| A temporary reference to a formatting argument
| xref:boost/urls/named_arg.adoc[`named&lowbar;arg`] 
| A temporary reference to a named formatting argument
| xref:boost/urls/optional.adoc[`optional`] 
| The type of optional used by the library
| xref:boost/urls/string_view.adoc[`string&lowbar;view`] 
| The type of string&lowbar;view used by the library
| xref:boost/urls/variant.adoc[`variant`] 
| The type of variant used by the library
|===

=== Enums

[cols="1,4"]
|===
| Name| Description
| xref:boost/urls/error.adoc[`error`] 
| Error codes returned the library
| xref:boost/urls/host_type.adoc[`host&lowbar;type`] 
| Identifies the type of host in a URL&period;
| xref:boost/urls/scheme.adoc[`scheme`] 
| Identifies a known URL scheme
|===

=== Functions

[cols="1,4"]
|===
| Name| Description
| xref:boost/urls/arg.adoc[`arg`] 
| Designate a named argument for a replacement field
| xref:boost/urls/default_port.adoc[`default&lowbar;port`] 
| Return the default port for a known scheme
| xref:boost/urls/encode-0d.adoc[`encode`] 
| `encode` overloads
| xref:boost/urls/encoded_size.adoc[`encoded&lowbar;size`] 
| Return the buffer size needed for percent&hyphen;encoding
| xref:boost/urls/format-06.adoc[`format`] 
| Format arguments into a URL
| xref:boost/urls/format_to-01.adoc[`format&lowbar;to`] 
| Format arguments into a URL
| xref:boost/urls/make_pct_string_view.adoc[`make&lowbar;pct&lowbar;string&lowbar;view`] 
| Return a valid percent&hyphen;encoded string
| xref:boost/urls/parse_absolute_uri.adoc[`parse&lowbar;absolute&lowbar;uri`] 
| Return a reference to a parsed URL string
| xref:boost/urls/parse_authority.adoc[`parse&lowbar;authority`] 
| Parse an authority
| xref:boost/urls/parse_ipv4_address.adoc[`parse&lowbar;ipv4&lowbar;address`] 
| Return an IPv4 address from an IP address string in dotted decimal form
| xref:boost/urls/parse_ipv6_address.adoc[`parse&lowbar;ipv6&lowbar;address`] 
| Parse a string containing an IPv6 address&period;
| xref:boost/urls/parse_origin_form.adoc[`parse&lowbar;origin&lowbar;form`] 
| Return a reference to a parsed URL string
| xref:boost/urls/parse_path.adoc[`parse&lowbar;path`] 
| Parse a string and return an encoded segment view
| xref:boost/urls/parse_query.adoc[`parse&lowbar;query`] 
| Parse a string and return an encoded params view
| xref:boost/urls/parse_relative_ref.adoc[`parse&lowbar;relative&lowbar;ref`] 
| Return a reference to a parsed URL string
| xref:boost/urls/parse_uri.adoc[`parse&lowbar;uri`] 
| Return a reference to a parsed URL string
| xref:boost/urls/parse_uri_reference.adoc[`parse&lowbar;uri&lowbar;reference`] 
| Return a reference to a parsed URL string
| xref:boost/urls/pct_encoded_rule.adoc[`pct&lowbar;encoded&lowbar;rule`] 
| Rule for a string with percent&hyphen;encoded escapes
| xref:boost/urls/resolve.adoc[`resolve`] 
| Resolve a URL reference against a base URL
| xref:boost/urls/string_to_scheme.adoc[`string&lowbar;to&lowbar;scheme`] 
| Return the known scheme for a non&hyphen;normalized string, if known
| xref:boost/urls/swap.adoc[`swap`] 
| Swap
| xref:boost/urls/to_string.adoc[`to&lowbar;string`] 
| Return the normalized string for a known scheme
| xref:boost/urls/operator_lshift-049.adoc[`operator&lt;&lt;`] 
| Stream insertion operators
| xref:boost/urls/operator_eq-011.adoc[`operator&equals;&equals;`] 
| Equality operators
| xref:boost/urls/operator_not_eq-04d.adoc[`operator!&equals;`] 
| Inequality operators
| xref:boost/urls/operator_lt-05c.adoc[`operator&lt;`] 
| Less&hyphen;than operators
| xref:boost/urls/operator_le-0b.adoc[`operator&lt;&equals;`] 
| Less&hyphen;than&hyphen;or&hyphen;equal operators
| xref:boost/urls/operator_gt-0f.adoc[`operator&gt;`] 
| Greater&hyphen;than operators
| xref:boost/urls/operator_ge-07.adoc[`operator&gt;&equals;`] 
| Greater&hyphen;than&hyphen;or&hyphen;equal operators
|===

=== Variables

[cols="1,4"]
|===
| Name| Description
| xref:boost/urls/absolute_uri_rule.adoc[`absolute&lowbar;uri&lowbar;rule`] 
| Rule for absolute&hyphen;URI
| xref:boost/urls/authority_rule.adoc[`authority&lowbar;rule`] 
| Rule for authority
| xref:boost/urls/gen_delim_chars.adoc[`gen&lowbar;delim&lowbar;chars`] 
| The gen&hyphen;delims character set
| xref:boost/urls/ignore_case.adoc[`ignore&lowbar;case`] 
| Ignore case when comparing
| xref:boost/urls/ipv4_address_rule.adoc[`ipv4&lowbar;address&lowbar;rule`] 
| Rule for an IP version 4 style address
| xref:boost/urls/ipv6_address_rule.adoc[`ipv6&lowbar;address&lowbar;rule`] 
| Rule for An IP version 6 style address
| xref:boost/urls/no_value.adoc[`no&lowbar;value`] 
| Constant indicating no value in a param
| xref:boost/urls/origin_form_rule.adoc[`origin&lowbar;form&lowbar;rule`] 
| Rule for origin&hyphen;form
| xref:boost/urls/pchars.adoc[`pchars`] 
| The path character set
| xref:boost/urls/query_rule.adoc[`query&lowbar;rule`] 
| Rule for a query string
| xref:boost/urls/relative_ref_rule.adoc[`relative&lowbar;ref&lowbar;rule`] 
| Rule for relative&hyphen;ref
| xref:boost/urls/reserved_chars.adoc[`reserved&lowbar;chars`] 
| The reserved character set
| xref:boost/urls/sub_delim_chars.adoc[`sub&lowbar;delim&lowbar;chars`] 
| The sub&hyphen;delims character set
| xref:boost/urls/unreserved_chars.adoc[`unreserved&lowbar;chars`] 
| The unreserved character set
| xref:boost/urls/uri_reference_rule.adoc[`uri&lowbar;reference&lowbar;rule`] 
| Rule for URI&hyphen;reference
| xref:boost/urls/uri_rule.adoc[`uri&lowbar;rule`] 
| Rule for URI
|===

=== Using Namespace Directives

[cols=1]
|===
| Name
| xref:boost/urls/error_types.adoc[`error&lowbar;types`]
|===


== xref:boost/urls/error_types.adoc[boost::urls::error&lowbar;types] namespace

=== Namespace Aliases

[cols="1,4"]
|===
| Name| Description
| xref:boost/urls/error_types/errc.adoc[`errc`] 
| The set of constants used for cross&hyphen;platform error codes
|===

=== Types

[cols="1,4"]
|===
| Name| Description
| xref:boost/urls/error_types/error_category.adoc[`error&lowbar;category`] 
| The type of error category used by the library
| xref:boost/urls/error_types/error_code.adoc[`error&lowbar;code`] 
| The type of error code used by the library
| xref:boost/urls/error_types/error_condition.adoc[`error&lowbar;condition`] 
| The type of error condition used by the library
| xref:boost/urls/error_types/result.adoc[`result`] 
| The type of result returned by library functions
| xref:boost/urls/error_types/system_error.adoc[`system&lowbar;error`] 
| The type of system error thrown by the library
|===

=== Using Declarations

[cols="1,4"]
|===
| Name| Description
| xref:boost/urls/error_types/generic_category.adoc[`generic&lowbar;category`] 
| A function to return the generic error category used by the library
| xref:boost/urls/error_types/system_category.adoc[`system&lowbar;category`] 
| A function to return the system error category used by the library
|===

== xref:boost/urls/grammar.adoc[boost::urls::grammar] namespace

=== Namespace Aliases

[cols=1]
|===
| Name
| xref:boost/urls/grammar/string_token.adoc[`string&lowbar;token`] 
|===

=== Types

[cols="1,4"]
|===
| Name| Description
| xref:boost/urls/grammar/literal_rule.adoc[`literal&lowbar;rule`] 
| Match a string literal exactly
| xref:boost/urls/grammar/lut_chars.adoc[`lut&lowbar;chars`] 
| A set of characters
| xref:boost/urls/grammar/range.adoc[`range`] 
| A forward range of parsed elements
| xref:boost/urls/grammar/recycled.adoc[`recycled`] 
| A thread&hyphen;safe collection of instances of T
| xref:boost/urls/grammar/recycled_ptr.adoc[`recycled&lowbar;ptr`] 
| A pointer to a shared instance of T
| xref:boost/urls/grammar/string_view_base.adoc[`string&lowbar;view&lowbar;base`] 
| Common functionality for string views
| xref:boost/urls/grammar/unsigned_rule.adoc[`unsigned&lowbar;rule`] 
| Match an unsigned decimal
| xref:boost/urls/grammar/aligned_storage.adoc[`aligned&lowbar;storage`] 
| Provides an aligned storage buffer aligned for T
| xref:boost/urls/grammar/ci_equal.adoc[`ci&lowbar;equal`] 
| A case&hyphen;insensitive equals predicate for strings
| xref:boost/urls/grammar/ci_hash.adoc[`ci&lowbar;hash`] 
| A case&hyphen;insensitive hash function object for strings
| xref:boost/urls/grammar/ci_less.adoc[`ci&lowbar;less`] 
| A case&hyphen;insensitive less predicate for strings
| xref:boost/urls/grammar/is_charset.adoc[`is&lowbar;charset`] 
| Alias for `std&colon;&colon;true&lowbar;type` if T satisfies xref:boost/urls/grammar/CharSet.adoc[`CharSet`]&period;
| xref:boost/urls/grammar/is_rule.adoc[`is&lowbar;rule`] 
| Determine if T meets the requirements of xref:boost/urls/grammar/Rule.adoc[`Rule`]
|===

=== Enums

[cols="1,4"]
|===
| Name| Description
| xref:boost/urls/grammar/condition.adoc[`condition`] 
| Error conditions for errors received from rules
| xref:boost/urls/grammar/error.adoc[`error`] 
| Error codes returned when using rules
|===

=== Functions

[cols="1,4"]
|===
| Name| Description
| xref:boost/urls/grammar/ci_compare.adoc[`ci&lowbar;compare`] 
| Return the case&hyphen;insensitive comparison of s0 and s1
| xref:boost/urls/grammar/ci_digest.adoc[`ci&lowbar;digest`] 
| Return the case&hyphen;insensitive digest of a string
| xref:boost/urls/grammar/ci_is_equal-0b2.adoc[`ci&lowbar;is&lowbar;equal`] 
| Return true if s0 equals s1 using case&hyphen;insensitive comparison
| xref:boost/urls/grammar/ci_is_less.adoc[`ci&lowbar;is&lowbar;less`] 
| Return true if s0 is less than s1 using case&hyphen;insensitive comparison
| xref:boost/urls/grammar/delim_rule-0a.adoc[`delim&lowbar;rule`] 
| `delim&lowbar;rule` overloads
| xref:boost/urls/grammar/find_if.adoc[`find&lowbar;if`] 
| Find the first character in the string that is in the set&period;
| xref:boost/urls/grammar/find_if_not.adoc[`find&lowbar;if&lowbar;not`] 
| Find the first character in the string that is not in CharSet
| xref:boost/urls/grammar/hexdig_value.adoc[`hexdig&lowbar;value`] 
| Return the decimal value of a hex character
| xref:boost/urls/grammar/not_empty_rule.adoc[`not&lowbar;empty&lowbar;rule`] 
| Match another rule, if the result is not empty
| xref:boost/urls/grammar/operator_plus.adoc[`operator&plus;`] 
| Return the union of two character sets&period;
| xref:boost/urls/grammar/operator_minus.adoc[`operator&hyphen;`] 
| Return a new character set by subtracting
| xref:boost/urls/grammar/optional_rule.adoc[`optional&lowbar;rule`] 
| Match a rule, or the empty string
| xref:boost/urls/grammar/parse-09.adoc[`parse`] 
| Parse a character buffer using a rule
| xref:boost/urls/grammar/range_rule-02.adoc[`range&lowbar;rule`] 
| Match a repeating number of elements
| xref:boost/urls/grammar/ref-01.adoc[`ref`] 
| `ref` overloads
| xref:boost/urls/grammar/squelch.adoc[`squelch`] 
| Squelch the value of a rule
| xref:boost/urls/grammar/to_lower.adoc[`to&lowbar;lower`] 
| Return c converted to lowercase
| xref:boost/urls/grammar/to_upper.adoc[`to&lowbar;upper`] 
| Return c converted to uppercase
| xref:boost/urls/grammar/token_rule.adoc[`token&lowbar;rule`] 
| Match a non&hyphen;empty string of characters from a set
| xref:boost/urls/grammar/tuple_rule.adoc[`tuple&lowbar;rule`] 
| Match a series of rules in order
| xref:boost/urls/grammar/variant_rule.adoc[`variant&lowbar;rule`] 
| Match one of a set of rules
| xref:boost/urls/grammar/operator_lshift.adoc[`operator&lt;&lt;`] 
| Format a string to an output stream
| xref:boost/urls/grammar/operator_eq.adoc[`operator&equals;&equals;`] 
| Compare two string views for equality
| xref:boost/urls/grammar/operator_not_eq.adoc[`operator!&equals;`] 
| Compare two string views for inequality
| xref:boost/urls/grammar/operator_lt.adoc[`operator&lt;`] 
| Compare two string views for less than
| xref:boost/urls/grammar/operator_le.adoc[`operator&lt;&equals;`] 
| Compare two string views for less than or equal
| xref:boost/urls/grammar/operator_gt.adoc[`operator&gt;`] 
| Compare two string views for greater than
| xref:boost/urls/grammar/operator_ge.adoc[`operator&gt;&equals;`] 
| Compare two string views for greater than or equal
|===

=== Variables

[cols="1,4"]
|===
| Name| Description
| xref:boost/urls/grammar/all_chars.adoc[`all&lowbar;chars`] 
| The set of all characters
| xref:boost/urls/grammar/alnum_chars.adoc[`alnum&lowbar;chars`] 
| The set of letters and digits
| xref:boost/urls/grammar/alpha_chars.adoc[`alpha&lowbar;chars`] 
| The set of all letters
| xref:boost/urls/grammar/dec_octet_rule.adoc[`dec&lowbar;octet&lowbar;rule`] 
| Match a decimal octet
| xref:boost/urls/grammar/digit_chars.adoc[`digit&lowbar;chars`] 
| The set of decimal digits
| xref:boost/urls/grammar/hexdig_chars.adoc[`hexdig&lowbar;chars`] 
| The set of hexadecimal digits
| xref:boost/urls/grammar/vchars.adoc[`vchars`] 
| The set of visible characters
|===

=== Concepts

[cols="1,4"]
|===
| Name| Description
| xref:boost/urls/grammar/CharSet.adoc[`CharSet`] 
| Concept for a CharSet
| xref:boost/urls/grammar/Rule.adoc[`Rule`] 
| Concept for a grammar Rule
|===

== xref:boost/urls/string_token.adoc[boost::urls::string&lowbar;token] namespace

=== Types

[cols="1,4"]
|===
| Name| Description
| xref:boost/urls/string_token/arg.adoc[`arg`] 
| Base class for string tokens, and algorithm parameters
| xref:boost/urls/string_token/is_token.adoc[`is&lowbar;token`] 
| Trait to determine if a type is a string token
| xref:boost/urls/string_token/return_string.adoc[`return&lowbar;string`] 
| A string token for returning a plain string
|===

=== Functions

[cols="1,4"]
|===
| Name| Description
| xref:boost/urls/string_token/append_to.adoc[`append&lowbar;to`] 
| Create a string token for appending to a plain string
| xref:boost/urls/string_token/assign_to.adoc[`assign&lowbar;to`] 
| Create a string token for assigning to a plain string
| xref:boost/urls/string_token/preserve_size.adoc[`preserve&lowbar;size`] 
| Create a string token for a durable core&colon;&colon;string&lowbar;view
|===

=== Concepts

[cols="1,4"]
|===
| Name| Description
| xref:boost/urls/string_token/StringToken.adoc[`StringToken`] 
| Concept for a string token
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#
