[#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=2]
|===
| 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/format_arg.adoc[`format&lowbar;arg`] 
| A temporary reference to a formatting argument

| 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/named_arg.adoc[`named&lowbar;arg`] 
| A temporary reference to a named formatting argument

| 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/optional.adoc[`optional`] 
| The type of optional used by the library

| 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 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/string_view.adoc[`string&lowbar;view`] 
| The type of string&lowbar;view used by the library

| 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/variant.adoc[`variant`] 
| The type of variant used by the library

|===
== Enums

[cols=2]
|===
| 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=2]
|===
| 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.adoc[`encode`] 
| Apply percent&hyphen;encoding to a string

Return a percent&hyphen;encoded string


| xref:boost/urls/encoded_size.adoc[`encoded&lowbar;size`] 
| Return the buffer size needed for percent&hyphen;encoding

| xref:boost/urls/format.adoc[`format`] 
| Format arguments into a URL


| xref:boost/urls/format_to.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/operator_not_eq.adoc[`operator!&equals;`] 
| 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&period;

Return true if two addresses are not equal


| xref:boost/urls/operator_lt.adoc[`operator&lt;`] 
| 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&period;


| xref:boost/urls/operator_lshift.adoc[`operator&lt;&lt;`] 
| Format the address to an output stream

Format the address to an output stream&period;

Format the encoded authority to the output stream

Format the string with percent&hyphen;decoding applied to the output stream

Format the url to the output stream

Format to an output stream


| xref:boost/urls/operator_le.adoc[`operator&lt;&equals;`] 
| 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&period;


| xref:boost/urls/operator_eq.adoc[`operator&equals;&equals;`] 
| 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&period;

Return true if two addresses are equal


| xref:boost/urls/operator_gt.adoc[`operator&gt;`] 
| 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&period;


| xref:boost/urls/operator_ge.adoc[`operator&gt;&equals;`] 
| 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&period;


| 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

|===
== Variables

[cols=2]
|===
| 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 query

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

[cols=1]
|===
| Name 

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



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