//
// Copyright (c) 2023 Alan de Freitas (alandefreitas@gmail.com)
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at https://www.boost.org/LICENSE_1_0.txt)
//
// Official repository: https://github.com/boostorg/url
//


[#reference]
= Reference

[width=100%]
|===
3+| *URL* | *Encoding* | *Aliases*

| *Types (1/2)*

cpp:boost::urls::authority_view[authority_view]

cpp:boost::urls::ignore_case_param[ignore_case_param]

cpp:boost::urls::ipv4_address[ipv4_address]

cpp:boost::urls::ipv6_address[ipv6_address]

cpp:boost::urls::no_value_t[no_value_t]

cpp:boost::urls::param[param]

cpp:boost::urls::param_pct_view[param_pct_view]

cpp:boost::urls::param_view[param_view]

cpp:boost::urls::params_base[params_base]

cpp:boost::urls::params_encoded_base[params_encoded_base]

cpp:boost::urls::params_encoded_ref[params_encoded_ref]

cpp:boost::urls::params_encoded_view[params_encoded_view]

cpp:boost::urls::params_ref[params_ref]

cpp:boost::urls::params_view[params_view]

cpp:boost::urls::segments_base[segments_base]

cpp:boost::urls::segments_view[segments_view]

cpp:boost::urls::segments_encoded_base[segments_encoded_base]

| **Types (2/2)**

cpp:boost::urls::segments_encoded_ref[segments_encoded_ref]

cpp:boost::urls::segments_encoded_view[segments_encoded_view]

cpp:boost::urls::segments_ref[segments_ref]

cpp:boost::urls::static_url[static_url]

cpp:boost::urls::static_url_base[static_url_base]

cpp:boost::urls::url[url]

cpp:boost::urls::url_base[url_base]

cpp:boost::urls::url_view[url_view]

cpp:boost::urls::url_view_base[url_view_base]

**Constants**

cpp:boost::urls::error[error]

cpp:boost::urls::ignore_case[ignore_case]

cpp:boost::urls::host_type[host_type]

cpp:boost::urls::no_value[no_value]

cpp:boost::urls::scheme[scheme]

| **Functions**

// AFREITAS: cpp extension could not handle "<<"
// cpp:boost::urls::operator<<[operator<<]

cpp:boost::urls::arg[arg]

cpp:boost::urls::format[format]

cpp:boost::urls::format_to[format_to]

cpp:boost::urls::parse_absolute_uri[parse_absolute_uri]

cpp:boost::urls::parse_authority[parse_authority]

cpp:boost::urls::parse_origin_form[parse_origin_form]

cpp:boost::urls::parse_path[parse_path]

cpp:boost::urls::parse_query[parse_query]

cpp:boost::urls::parse_relative_ref[parse_relative_ref]

cpp:boost::urls::parse_uri[parse_uri]

cpp:boost::urls::parse_uri_reference[parse_uri_reference]

cpp:boost::urls::resolve[resolve]

| **Functions**

cpp:boost::urls::encode[encode]

cpp:boost::urls::encoded_size[encoded_size]

cpp:boost::urls::make_pct_string_view[make_pct_string_view]

**Types**

cpp:boost::urls::decode_view[decode_view]

cpp:boost::urls::encoding_opts[encoding_opts]

cpp:boost::urls::pct_string_view[pct_string_view]

| **Types**

cpp:boost::urls::error_types::errc[errc]

cpp:boost::urls::error_types::error_category[error_category]

cpp:boost::urls::error_types::error_code[error_code]

cpp:boost::urls::error_types::error_condition[error_condition]

cpp:boost::urls::error_types::generic_category[generic_category]

cpp:boost::urls::optional[optional]

cpp:boost::urls::error_types::result[result]

cpp:boost::urls::string_view[string_view]

cpp:boost::urls::error_types::system_category[system_category]

cpp:boost::urls::error_types::system_error[system_error]

|===

[width=100%]
|===
4+| *RFC3986* | *Grammar*

| **Grammar**

cpp:boost::urls::absolute_uri_rule[absolute_uri_rule]

cpp:boost::urls::authority_rule[authority_rule]

cpp:boost::urls::gen_delim_chars[gen_delim_chars]

cpp:boost::urls::ipv4_address_rule[ipv4_address_rule]

cpp:boost::urls::ipv6_address_rule[ipv6_address_rule]

cpp:boost::urls::pchars[pchars]

cpp:boost::urls::pct_encoded_rule[pct_encoded_rule]

cpp:boost::urls::query_rule[query_rule]

cpp:boost::urls::relative_ref_rule[relative_ref_rule]

cpp:boost::urls::reserved_chars[reserved_chars]

cpp:boost::urls::sub_delim_chars[sub_delim_chars]

cpp:boost::urls::unreserved_chars[unreserved_chars]

cpp:boost::urls::uri_reference_rule[uri_reference_rule]

cpp:boost::urls::uri_rule[uri_rule]

| **Functions (1/2)**

cpp:boost::urls::grammar::ci_compare[ci_compare]

cpp:boost::urls::grammar::ci_digest[ci_digest]

cpp:boost::urls::grammar::ci_is_equal[ci_is_equal]

cpp:boost::urls::grammar::ci_is_less[ci_is_less]

cpp:boost::urls::grammar::delim_rule[delim_rule]

cpp:boost::urls::grammar::find_if[find_if]

cpp:boost::urls::grammar::find_if_not[find_if_not]

cpp:boost::urls::grammar::hexdig_value[hexdig_value]

cpp:boost::urls::grammar::not_empty_rule[not_empty_rule]

cpp:boost::urls::grammar::optional_rule[optional_rule]

cpp:boost::urls::grammar::parse[parse]

cpp:boost::urls::grammar::range_rule[range_rule]

cpp:boost::urls::grammar::ref[ref]

| **Functions (2/2)**

cpp:boost::urls::grammar::squelch[squelch]

cpp:boost::urls::grammar::to_lower[to_lower]

cpp:boost::urls::grammar::to_upper[to_upper]

cpp:boost::urls::grammar::token_rule[token_rule]

cpp:boost::urls::grammar::tuple_rule[tuple_rule]

cpp:boost::urls::grammar::variant_rule[variant_rule]

**Type Traits**

cpp:boost::urls::grammar::is_charset[is_charset]

cpp:boost::urls::grammar::is_rule[is_rule]

| **Types**

cpp:boost::urls::grammar::aligned_storage[aligned_storage]

cpp:boost::urls::grammar::ci_hash[ci_hash]

cpp:boost::urls::grammar::ci_equal[ci_equal]

cpp:boost::urls::grammar::ci_less[ci_less]

cpp:boost::urls::grammar::lut_chars[lut_chars]

cpp:boost::urls::grammar::range[range]

cpp:boost::urls::grammar::recycled[recycled]

cpp:boost::urls::grammar::recycled_ptr[recycled_ptr]

cpp:boost::urls::grammar::string_view_base[string_view_base]

cpp:boost::urls::grammar::unsigned_rule[unsigned_rule]

**StringToken**

cpp:boost::urls::string_token::append_to[append_to]

cpp:boost::urls::string_token::arg[arg]

cpp:boost::urls::string_token::assign_to[assign_to]

cpp:boost::urls::string_token::is_token[is_token]

cpp:boost::urls::string_token::preserve_size[preserve_size]

cpp:boost::urls::string_token::return_string[return_string]

**Concepts**

cpp:boost::urls::string_token::StringToken[StringToken]

| **Constants**

cpp:boost::urls::grammar::all_chars[all_chars]

cpp:boost::urls::grammar::alnum_chars[alnum_chars]

cpp:boost::urls::grammar::alpha_chars[alpha_chars]

cpp:boost::urls::grammar::condition[condition]

cpp:boost::urls::grammar::dec_octet_rule[dec_octet_rule]

cpp:boost::urls::grammar::digit_chars[digit_chars]

cpp:boost::urls::grammar::error[error]

cpp:boost::urls::grammar::hexdig_chars[hexdig_chars]

cpp:boost::urls::grammar::not_empty_rule[not_empty_rule]

cpp:boost::urls::grammar::unsigned_rule[unsigned_rule]

cpp:boost::urls::grammar::vchars[vchars]

**Enums**

cpp:boost::urls::grammar::error[error]

cpp:boost::urls::grammar::condition[condition]

**Concepts**

cpp:boost::urls::grammar::CharSet[CharSet]

cpp:boost::urls::grammar::Rule[Rule]

|===
