:relfileprefix: ../
[#7679395CF7D1D8E68CA4261A1F77164B17137727]

= Namespace urls

== Namespaces
[,cols=2]
|===
|Name |Description
|xref:boost/urls/error_types.adoc[`pass:v[error_types]`] |

|xref:boost/urls/grammar.adoc[`pass:v[grammar]`] |

|xref:boost/urls/string_token.adoc[`pass:v[string_token]`] |

|===
==  Types
[,cols=2]
|===
|Name |Description
|xref:boost/urls/absolute_uri_rule_t.adoc[`pass:v[absolute_uri_rule_t]`] |

|xref:boost/urls/authority_rule_t.adoc[`pass:v[authority_rule_t]`] |

|xref:boost/urls/authority_view.adoc[`pass:v[authority_view]`] |
pass:v,q[A non-owning reference to a valid authority]

|xref:boost/urls/decode_view.adoc[`pass:v[decode_view]`] |
pass:v,q[A reference to a valid, percent-encoded string]

|xref:boost/urls/encoding_opts.adoc[`pass:v[encoding_opts]`] |
pass:v,q[Percent-encoding options]

|xref:boost/urls/ignore_case_param.adoc[`pass:v[ignore_case_param]`] |
pass:v,q[An optional parameter to determine case-sensitivity]

|xref:boost/urls/ignore_case_t.adoc[`pass:v[ignore_case_t]`] |

|xref:boost/urls/ipv4_address.adoc[`pass:v[ipv4_address]`] |
pass:v,q[An IP version 4 style address.]

|xref:boost/urls/ipv4_address_rule_t.adoc[`pass:v[ipv4_address_rule_t]`] |

|xref:boost/urls/ipv6_address.adoc[`pass:v[ipv6_address]`] |
pass:v,q[An IP version 6 style address.]

|xref:boost/urls/ipv6_address_rule_t.adoc[`pass:v[ipv6_address_rule_t]`] |

|xref:boost/urls/make_void.adoc[`pass:v[make_void]`] |

|xref:boost/urls/no_value_t.adoc[`pass:v[no_value_t]`] |
pass:v,q[The type of no_value]

|xref:boost/urls/optional.adoc[`pass:v[optional]`] |

|xref:boost/urls/origin_form_rule_t.adoc[`pass:v[origin_form_rule_t]`] |

|xref:boost/urls/param.adoc[`pass:v[param]`] |
pass:v,q[A query parameter]

|xref:boost/urls/param_pct_view.adoc[`pass:v[param_pct_view]`] |
pass:v,q[A query parameter]

|xref:boost/urls/param_view.adoc[`pass:v[param_view]`] |
pass:v,q[A query parameter]

|xref:boost/urls/params_base.adoc[`pass:v[params_base]`] |
pass:v,q[Common functionality for containers]

|xref:boost/urls/params_encoded_base.adoc[`pass:v[params_encoded_base]`] |
pass:v,q[Common functionality for containers]

|xref:boost/urls/params_encoded_ref.adoc[`pass:v[params_encoded_ref]`] |
pass:v,q[A view representing query parameters in a URL]

|xref:boost/urls/params_encoded_view.adoc[`pass:v[params_encoded_view]`] |
pass:v,q[A view representing query parameters in a URL]

|xref:boost/urls/params_ref.adoc[`pass:v[params_ref]`] |
pass:v,q[A view representing query parameters in a URL]

|xref:boost/urls/params_view.adoc[`pass:v[params_view]`] |
pass:v,q[A view representing query parameters in a URL]

|xref:boost/urls/pct_encoded_rule_t.adoc[`pass:v[pct_encoded_rule_t]`] |

|xref:boost/urls/pct_string_view.adoc[`pass:v[pct_string_view]`] |
pass:v,q[A reference to a valid percent-encoded string]

|xref:boost/urls/query_rule_t.adoc[`pass:v[query_rule_t]`] |

|xref:boost/urls/relative_ref_rule_t.adoc[`pass:v[relative_ref_rule_t]`] |

|xref:boost/urls/segments_base.adoc[`pass:v[segments_base]`] |
pass:v,q[Common functionality for containers]

|xref:boost/urls/segments_encoded_base.adoc[`pass:v[segments_encoded_base]`] |
pass:v,q[Common functionality for containers]

|xref:boost/urls/segments_encoded_ref.adoc[`pass:v[segments_encoded_ref]`] |
pass:v,q[A view representing path segments in a URL]

|xref:boost/urls/segments_encoded_view.adoc[`pass:v[segments_encoded_view]`] |
pass:v,q[A view representing path segments in a URL]

|xref:boost/urls/segments_ref.adoc[`pass:v[segments_ref]`] |
pass:v,q[A view representing path segments in a URL]

|xref:boost/urls/segments_view.adoc[`pass:v[segments_view]`] |
pass:v,q[A view representing path segments in a URL]

|xref:boost/urls/static_url.adoc[`pass:v[static_url]`] |
pass:v,q[A modifiable container for a URL.]

|xref:boost/urls/static_url_base.adoc[`pass:v[static_url_base]`] |
pass:v,q[Common implementation for all static URLs]

|xref:boost/urls/uri_reference_rule_t.adoc[`pass:v[uri_reference_rule_t]`] |

|xref:boost/urls/uri_rule_t.adoc[`pass:v[uri_rule_t]`] |

|xref:boost/urls/url.adoc[`pass:v[url]`] |
pass:v,q[A modifiable container for a URL.]

|xref:boost/urls/url_base.adoc[`pass:v[url_base]`] |
pass:v,q[Common functionality for containers]

|xref:boost/urls/url_view.adoc[`pass:v[url_view]`] |
pass:v,q[A non-owning reference to a valid URL]

|xref:boost/urls/url_view_base.adoc[`pass:v[url_view_base]`] |
pass:v,q[Common functionality for containers]

|xref:boost/urls/variant.adoc[`pass:v[variant]`] |
pass:v,q[The type of variant used by the library]

|xref:boost/urls/void_t.adoc[`pass:v[void_t]`] |

|===
==  Enums
[,cols=2]
|===
|Name |Description
|xref:boost/urls/error.adoc[`pass:v[error]`] |
pass:v,q[Error codes returned the library]

|xref:boost/urls/host_type.adoc[`pass:v[host_type]`] |
pass:v,q[Identifies the type of host in a URL.]

|xref:boost/urls/scheme.adoc[`pass:v[scheme]`] |
pass:v,q[Identifies a known URL scheme]

|===
== Functions
[,cols=2]
|===
|Name |Description
|xref:boost/urls/default_port.adoc[`pass:v[default_port]`] |
pass:v,q[Return the default port for a known scheme]

|xref:boost/urls/encode.adoc[`pass:v[encode]`] |
pass:v,q[Apply percent-encoding to a string]

pass:v,q[Return a percent-encoded string]

|xref:boost/urls/encode_unsafe.adoc[`pass:v[encode_unsafe]`] |

|xref:boost/urls/encoded_size.adoc[`pass:v[encoded_size]`] |
pass:v,q[Return the buffer size needed for percent-encoding]

|xref:boost/urls/make_error_code.adoc[`pass:v[make_error_code]`] |

|xref:boost/urls/make_pct_string_view.adoc[`pass:v[make_pct_string_view]`] |
pass:v,q[Return a valid percent-encoded string]

|xref:boost/urls/make_pct_string_view_unsafe.adoc[`pass:v[make_pct_string_view_unsafe]`] |

|xref:boost/urls/operator_not_eq.adoc[`pass:v[operator!=]`] |
pass:v,q[Return the result of comparing two URLs]

pass:v,q[Return the result of comparing two authorities] pass:v,q[The authorities are compared component]
pass:v,q[by component as if they were first]
pass:v,q[normalized.]

pass:v,q[Return true if two addresses are not equal]

|xref:boost/urls/operator_lt.adoc[`pass:v[operator<]`] |
pass:v,q[Return the result of comparing two URLs]

pass:v,q[Return the result of comparing two authorities] pass:v,q[The authorities are compared component]
pass:v,q[by component as if they were first]
pass:v,q[normalized.]

|xref:boost/urls/operator_lshift.adoc[`pass:v[operator<<]`] |
pass:v,q[Format the address to an output stream.]

pass:v,q[Format the address to an output stream]

pass:v,q[Format the encoded authority to the output stream]

pass:v,q[Format the string with percent-decoding applied to the output stream]

pass:v,q[Format the url to the output stream]

pass:v,q[Format to an output stream]

|xref:boost/urls/operator_le.adoc[`pass:v[operator<=]`] |
pass:v,q[Return the result of comparing two URLs]

pass:v,q[Return the result of comparing two authorities] pass:v,q[The authorities are compared component]
pass:v,q[by component as if they were first]
pass:v,q[normalized.]

|xref:boost/urls/operator_eq.adoc[`pass:v[operator==]`] |
pass:v,q[Return the result of comparing two URLs]

pass:v,q[Return the result of comparing two authorities] pass:v,q[The authorities are compared component]
pass:v,q[by component as if they were first]
pass:v,q[normalized.]

pass:v,q[Return true if two addresses are equal]

|xref:boost/urls/operator_gt.adoc[`pass:v[operator>]`] |
pass:v,q[Return the result of comparing two URLs]

pass:v,q[Return the result of comparing two authorities] pass:v,q[The authorities are compared component]
pass:v,q[by component as if they were first]
pass:v,q[normalized.]

|xref:boost/urls/operator_ge.adoc[`pass:v[operator>=]`] |
pass:v,q[Return the result of comparing two URLs]

pass:v,q[Return the result of comparing two authorities] pass:v,q[The authorities are compared component]
pass:v,q[by component as if they were first]
pass:v,q[normalized.]

|xref:boost/urls/parse_absolute_uri.adoc[`pass:v[parse_absolute_uri]`] |
pass:v,q[Return a reference to a parsed URL string]

|xref:boost/urls/parse_authority.adoc[`pass:v[parse_authority]`] |
pass:v,q[Parse an authority]

|xref:boost/urls/parse_ipv4_address.adoc[`pass:v[parse_ipv4_address]`] |
pass:v,q[Return an IPv4 address from an IP address string in dotted decimal form]

|xref:boost/urls/parse_ipv6_address.adoc[`pass:v[parse_ipv6_address]`] |
pass:v,q[Parse a string containing an IPv6 address.]

|xref:boost/urls/parse_origin_form.adoc[`pass:v[parse_origin_form]`] |
pass:v,q[Return a reference to a parsed URL string]

|xref:boost/urls/parse_path.adoc[`pass:v[parse_path]`] |
pass:v,q[Parse a string and return an encoded segment view]

|xref:boost/urls/parse_query.adoc[`pass:v[parse_query]`] |
pass:v,q[Parse a string and return an encoded params view]

|xref:boost/urls/parse_relative_ref.adoc[`pass:v[parse_relative_ref]`] |
pass:v,q[Return a reference to a parsed URL string]

|xref:boost/urls/parse_uri.adoc[`pass:v[parse_uri]`] |
pass:v,q[Return a reference to a parsed URL string]

|xref:boost/urls/parse_uri_reference.adoc[`pass:v[parse_uri_reference]`] |
pass:v,q[Return a reference to a parsed URL string]

|xref:boost/urls/pct_encoded_rule.adoc[`pass:v[pct_encoded_rule]`] |
|xref:boost/urls/resolve.adoc[`pass:v[resolve]`] |
pass:v,q[Resolve a URL reference against a base URL]

|xref:boost/urls/string_to_scheme.adoc[`pass:v[string_to_scheme]`] |
pass:v,q[Return the known scheme for a non-normalized string, if known]

|xref:boost/urls/swap.adoc[`pass:v[swap]`] |
pass:v,q[Swap]

|xref:boost/urls/to_string.adoc[`pass:v[to_string]`] |
pass:v,q[Return the normalized string for a known scheme]

|===
== Variables
[,cols=2]
|===
|Name |Description
|xref:boost/urls/absolute_uri_rule.adoc[`pass:v[absolute_uri_rule]`] |

|xref:boost/urls/authority_rule.adoc[`pass:v[authority_rule]`] |

|xref:boost/urls/ignore_case.adoc[`pass:v[ignore_case]`] |

|xref:boost/urls/ipv4_address_rule.adoc[`pass:v[ipv4_address_rule]`] |

|xref:boost/urls/ipv6_address_rule.adoc[`pass:v[ipv6_address_rule]`] |

|xref:boost/urls/no_value.adoc[`pass:v[no_value]`] |
pass:v,q[Constant indicating no value in a param]

|xref:boost/urls/origin_form_rule.adoc[`pass:v[origin_form_rule]`] |

|xref:boost/urls/pchars.adoc[`pass:v[pchars]`] |
pass:v,q[The path character set]

|xref:boost/urls/query_rule.adoc[`pass:v[query_rule]`] |

|xref:boost/urls/relative_ref_rule.adoc[`pass:v[relative_ref_rule]`] |

|xref:boost/urls/sub_delim_chars.adoc[`pass:v[sub_delim_chars]`] |
pass:v,q[The sub-delims character set]

|xref:boost/urls/unreserved_chars.adoc[`pass:v[unreserved_chars]`] |
pass:v,q[The unreserved character set]

|xref:boost/urls/uri_reference_rule.adoc[`pass:v[uri_reference_rule]`] |

|xref:boost/urls/uri_rule.adoc[`pass:v[uri_rule]`] |

|===
