[#boost-urls]
= xref:boost.adoc[boost]::urls
:relfileprefix: ../
:mrdocs:

== 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`] 
| Decoded query parameter helper base
| xref:boost/urls/params_encoded_base.adoc[`params&lowbar;encoded&lowbar;base`] 
| Percent&hyphen;encoded query helper base
| xref:boost/urls/params_encoded_ref.adoc[`params&lowbar;encoded&lowbar;ref`] 
| Mutable encoded query parameter proxy
| xref:boost/urls/params_encoded_view.adoc[`params&lowbar;encoded&lowbar;view`] 
| Non&hyphen;owning encoded query parameter view
| xref:boost/urls/params_ref.adoc[`params&lowbar;ref`] 
| Mutable decoded query parameter proxy
| xref:boost/urls/params_view.adoc[`params&lowbar;view`] 
| Non&hyphen;owning decoded query parameter view
| 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`] 
| Decoded path segment helper base
| xref:boost/urls/segments_encoded_base.adoc[`segments&lowbar;encoded&lowbar;base`] 
| Percent&hyphen;encoded path segment helper base
| xref:boost/urls/segments_encoded_ref.adoc[`segments&lowbar;encoded&lowbar;ref`] 
| Mutable encoded path segment proxy
| xref:boost/urls/segments_encoded_view.adoc[`segments&lowbar;encoded&lowbar;view`] 
| Non&hyphen;owning encoded path segment view
| xref:boost/urls/segments_ref.adoc[`segments&lowbar;ref`] 
| Mutable decoded path segment proxy
| xref:boost/urls/segments_view.adoc[`segments&lowbar;view`] 
| Non&hyphen;owning decoded path segment view
| 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
|===


== Type Aliases

[cols="1,4"]
|===
| Name| Description
| 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`]  [.small]#[deprecated]#
| The type of optional used by the library
| xref:boost/urls/string_view.adoc[`string&lowbar;view`]  [.small]#[deprecated]#
| The type of string&lowbar;view used by the library
| xref:boost/urls/variant.adoc[`variant`]  [.small]#[deprecated]#
| 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/decode-01.adoc[`decode`] 
| `decode` overloads
| xref:boost/urls/decoded_size.adoc[`decoded&lowbar;size`] 
| Return the buffer size needed for percent&hyphen;decoding
| 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`] 
|===



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