namespace //////////////////////////8= regular 8SJGETJzAZc1cROvH1DlPkae19g= +jO0pmMB/RXahxtatVUYoEwUKWs= eIvg7iueGIPcE8p1NVfngsp2ojw= OgYTTolxk6PlfTvK9ZUzbHrYJaA= yyFXUu8rv7aaT9jXnuKPsRi1l/k= kudbivIRNhkwwv6+lKh/Jhe77Qk= F7CKD1KMBJ7E0w+DAD3vTetTRO0= SYQefJSILIN79en+XPpp+29rKMo= 8zDnOjjKm1v06VXFNK8ZaRd/GD8= CWoDP52BwoWASYZ+Ob+51yqRBYY= Qvo2fOST20EZC7bSOAFZr+u3ITg= 7oVuEnhtvBxEe7A4rvwLtoVcL6g= UgT6sUutwWc5x+c3CSdSXq4xntQ= boost boost/url/detail/config.hpp include/boost/url/detail/config.hpp 260 1 boost/url/grammar/detail/charset.hpp include/boost/url/grammar/detail/charset.hpp 31 1 boost/url/grammar/alnum_chars.hpp include/boost/url/grammar/alnum_chars.hpp 16 1 boost/url/grammar/alpha_chars.hpp include/boost/url/grammar/alpha_chars.hpp 16 1 boost/url/grammar/charset.hpp include/boost/url/grammar/charset.hpp 25 1 boost/url/grammar/detail/ci_string.hpp include/boost/url/grammar/detail/ci_string.hpp 20 1 boost/url/grammar/ci_string.hpp include/boost/url/grammar/ci_string.hpp 19 1 boost/url/error_types.hpp include/boost/url/error_types.hpp 18 1 boost/url/grammar/dec_octet_rule.hpp include/boost/url/grammar/dec_octet_rule.hpp 17 1 boost/url/grammar/digit_chars.hpp include/boost/url/grammar/digit_chars.hpp 16 1 boost/url/grammar/error.hpp include/boost/url/grammar/error.hpp 16 1 boost/url/grammar/type_traits.hpp include/boost/url/grammar/type_traits.hpp 17 1 boost/url/grammar/delim_rule.hpp include/boost/url/grammar/delim_rule.hpp 21 1 boost/url/grammar/hexdig_chars.hpp include/boost/url/grammar/hexdig_chars.hpp 16 1 boost/url/grammar/literal_rule.hpp include/boost/url/grammar/literal_rule.hpp 19 1 boost/url/grammar/lut_chars.hpp include/boost/url/grammar/lut_chars.hpp 21 1 boost/url/grammar/not_empty_rule.hpp include/boost/url/grammar/not_empty_rule.hpp 18 1 boost/url/grammar/parse.hpp include/boost/url/grammar/parse.hpp 19 1 boost/url/optional.hpp include/boost/url/optional.hpp 16 1 boost/url/grammar/optional_rule.hpp include/boost/url/grammar/optional_rule.hpp 22 1 boost/url/error.hpp include/boost/url/error.hpp 17 1 boost/url/grammar/detail/range_rule.hpp include/boost/url/grammar/detail/range_rule.hpp 17 1 boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 26 1 boost/url/detail/except.hpp include/boost/url/detail/except.hpp 16 1 boost/url/grammar/detail/recycled.hpp include/boost/url/grammar/detail/recycled.hpp 15 1 boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 24 1 boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 19 1 boost/url/detail/string_view.hpp include/boost/url/detail/string_view.hpp 15 1 boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 22 1 boost/url/grammar/token_rule.hpp include/boost/url/grammar/token_rule.hpp 21 1 boost/url/grammar/detail/tuple.hpp include/boost/url/grammar/detail/tuple.hpp 35 1 boost/url/grammar/tuple_rule.hpp include/boost/url/grammar/tuple_rule.hpp 24 1 boost/url/grammar/unsigned_rule.hpp include/boost/url/grammar/unsigned_rule.hpp 22 1 boost/url/variant.hpp include/boost/url/variant.hpp 16 1 boost/url/grammar/variant_rule.hpp include/boost/url/grammar/variant_rule.hpp 20 1 boost/url/grammar/vchars.hpp include/boost/url/grammar/vchars.hpp 16 1 boost/url/host_type.hpp include/boost/url/host_type.hpp 15 1 boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 24 1 boost/url/ipv6_address.hpp include/boost/url/ipv6_address.hpp 23 1 boost/url/encoding_opts.hpp include/boost/url/encoding_opts.hpp 16 1 boost/url/pct_string_view.hpp include/boost/url/pct_string_view.hpp 26 1 boost/url/decode_view.hpp include/boost/url/decode_view.hpp 21 1 boost/url/scheme.hpp include/boost/url/scheme.hpp 18 1 boost/url/detail/parts_base.hpp include/boost/url/detail/parts_base.hpp 15 1 boost/url/detail/url_impl.hpp include/boost/url/detail/url_impl.hpp 23 1 boost/url/detail/memcpy.hpp include/boost/url/detail/memcpy.hpp 17 1 boost/url/detail/path.hpp include/boost/url/detail/path.hpp 16 1 boost/url/detail/impl/url_impl.hpp include/boost/url/detail/impl/url_impl.hpp 22 1 boost/url/authority_view.hpp include/boost/url/authority_view.hpp 26 1 boost/url/rfc/authority_rule.hpp include/boost/url/rfc/authority_rule.hpp 18 1 boost/url/rfc/detail/host_rule.hpp include/boost/url/rfc/detail/host_rule.hpp 21 1 boost/url/rfc/ipv4_address_rule.hpp include/boost/url/rfc/ipv4_address_rule.hpp 18 1 boost/url/rfc/detail/ip_literal_rule.hpp include/boost/url/rfc/detail/ip_literal_rule.hpp 19 1 boost/url/rfc/ipv6_address_rule.hpp include/boost/url/rfc/ipv6_address_rule.hpp 18 1 boost/url/rfc/detail/h16_rule.hpp include/boost/url/rfc/detail/h16_rule.hpp 18 1 boost/url/rfc/detail/impl/h16_rule.hpp include/boost/url/rfc/detail/impl/h16_rule.hpp 18 1 boost/url/rfc/detail/ipv6_addrz_rule.hpp include/boost/url/rfc/detail/ipv6_addrz_rule.hpp 18 1 boost/url/rfc/unreserved_chars.hpp include/boost/url/rfc/unreserved_chars.hpp 16 1 boost/url/rfc/pct_encoded_rule.hpp include/boost/url/rfc/pct_encoded_rule.hpp 19 1 boost/url/rfc/detail/impl/ipv6_addrz_rule.hpp include/boost/url/rfc/detail/impl/ipv6_addrz_rule.hpp 20 1 boost/url/rfc/detail/ipvfuture_rule.hpp include/boost/url/rfc/detail/ipvfuture_rule.hpp 17 1 boost/url/rfc/sub_delim_chars.hpp include/boost/url/rfc/sub_delim_chars.hpp 16 1 boost/url/rfc/pchars.hpp include/boost/url/rfc/pchars.hpp 17 1 boost/url/rfc/detail/charsets.hpp include/boost/url/rfc/detail/charsets.hpp 17 1 boost/url/rfc/detail/impl/ipvfuture_rule.hpp include/boost/url/rfc/detail/impl/ipvfuture_rule.hpp 24 1 boost/url/rfc/detail/impl/ip_literal_rule.hpp include/boost/url/rfc/detail/impl/ip_literal_rule.hpp 23 1 boost/url/rfc/detail/reg_name_rule.hpp include/boost/url/rfc/detail/reg_name_rule.hpp 19 1 boost/url/rfc/detail/impl/host_rule.hpp include/boost/url/rfc/detail/impl/host_rule.hpp 21 1 boost/url/rfc/detail/port_rule.hpp include/boost/url/rfc/detail/port_rule.hpp 19 1 boost/url/rfc/detail/impl/port_rule.hpp include/boost/url/rfc/detail/impl/port_rule.hpp 19 1 boost/url/rfc/detail/userinfo_rule.hpp include/boost/url/rfc/detail/userinfo_rule.hpp 18 1 boost/url/rfc/detail/impl/userinfo_rule.hpp include/boost/url/rfc/detail/impl/userinfo_rule.hpp 20 1 boost/url/decode.hpp include/boost/url/decode.hpp 19 1 boost/url/detail/decode.hpp include/boost/url/detail/decode.hpp 18 1 boost/url/grammar/all_chars.hpp include/boost/url/grammar/all_chars.hpp 16 1 boost/url/encode.hpp include/boost/url/encode.hpp 22 1 boost/url/detail/encode.hpp include/boost/url/detail/encode.hpp 20 1 boost/url/ignore_case.hpp include/boost/url/ignore_case.hpp 15 1 boost/url/detail/optional_string.hpp include/boost/url/detail/optional_string.hpp 16 1 boost/url/param.hpp include/boost/url/param.hpp 20 1 boost/url/detail/params_iter_impl.hpp include/boost/url/detail/params_iter_impl.hpp 18 1 boost/url/detail/impl/params_iter_impl.hpp include/boost/url/detail/impl/params_iter_impl.hpp 15 1 boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 21 1 boost/url/params_base.hpp include/boost/url/params_base.hpp 22 1 boost/url/params_view.hpp include/boost/url/params_view.hpp 17 1 boost/url/params_encoded_view.hpp include/boost/url/params_encoded_view.hpp 22 1 boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 19 1 boost/url/params_ref.hpp include/boost/url/params_ref.hpp 20 1 boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 20 1 boost/url/detail/segments_iter_impl.hpp include/boost/url/detail/segments_iter_impl.hpp 19 1 boost/url/detail/impl/segments_iter_impl.hpp include/boost/url/detail/impl/segments_iter_impl.hpp 18 1 boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 19 1 boost/url/segments_base.hpp include/boost/url/segments_base.hpp 20 1 boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 19 1 boost/url/segments_view.hpp include/boost/url/segments_view.hpp 18 1 boost/url/segments_encoded_view.hpp include/boost/url/segments_encoded_view.hpp 22 1 boost/url/detail/segments_range.hpp include/boost/url/detail/segments_range.hpp 20 1 boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 35 1 boost/url/detail/fnv_1a.hpp include/boost/url/detail/fnv_1a.hpp 18 1 boost/url/url_base.hpp include/boost/url/url_base.hpp 30 1 boost/url/url_view.hpp include/boost/url/url_view.hpp 18 1 boost/url/parse.hpp include/boost/url/parse.hpp 18 1 boost/url/rfc/absolute_uri_rule.hpp include/boost/url/rfc/absolute_uri_rule.hpp 17 1 boost/url/rfc/detail/hier_part_rule.hpp include/boost/url/rfc/detail/hier_part_rule.hpp 19 1 boost/url/rfc/detail/path_rules.hpp include/boost/url/rfc/detail/path_rules.hpp 19 1 boost/url/rfc/detail/impl/hier_part_rule.hpp include/boost/url/rfc/detail/impl/hier_part_rule.hpp 18 1 boost/url/rfc/detail/query_part_rule.hpp include/boost/url/rfc/detail/query_part_rule.hpp 21 1 boost/url/rfc/detail/scheme_rule.hpp include/boost/url/rfc/detail/scheme_rule.hpp 19 1 boost/url/rfc/detail/impl/scheme_rule.hpp include/boost/url/rfc/detail/impl/scheme_rule.hpp 21 1 boost/url/rfc/relative_ref_rule.hpp include/boost/url/rfc/relative_ref_rule.hpp 17 1 boost/url/rfc/detail/fragment_part_rule.hpp include/boost/url/rfc/detail/fragment_part_rule.hpp 18 1 boost/url/rfc/detail/relative_part_rule.hpp include/boost/url/rfc/detail/relative_part_rule.hpp 19 1 boost/url/rfc/detail/impl/relative_part_rule.hpp include/boost/url/rfc/detail/impl/relative_part_rule.hpp 21 1 boost/url/rfc/uri_rule.hpp include/boost/url/rfc/uri_rule.hpp 17 1 boost/url/rfc/uri_reference_rule.hpp include/boost/url/rfc/uri_reference_rule.hpp 17 1 boost/url/rfc/origin_form_rule.hpp include/boost/url/rfc/origin_form_rule.hpp 17 1 boost/url/detail/over_allocator.hpp include/boost/url/detail/over_allocator.hpp 26 1 boost/url/detail/any_params_iter.hpp include/boost/url/detail/any_params_iter.hpp 20 1 boost/url/detail/impl/any_params_iter.hpp include/boost/url/detail/impl/any_params_iter.hpp 18 1 boost/url/detail/any_segments_iter.hpp include/boost/url/detail/any_segments_iter.hpp 19 1 boost/url/detail/impl/any_segments_iter.hpp include/boost/url/detail/impl/any_segments_iter.hpp 19 1 boost/url/detail/normalize.hpp include/boost/url/detail/normalize.hpp 19 1 boost/url/detail/print.hpp include/boost/url/detail/print.hpp 17 1 boost/url/rfc/query_rule.hpp include/boost/url/rfc/query_rule.hpp 19 1 boost/url/detail/move_chars.hpp include/boost/url/detail/move_chars.hpp 18 1 boost/url/url.hpp include/boost/url/url.hpp 19 1 boost/url/detail/format_args.hpp include/boost/url/detail/format_args.hpp 22 1 boost/url/detail/impl/format_args.hpp include/boost/url/detail/impl/format_args.hpp 13 1 boost/url/detail/vformat.hpp include/boost/url/detail/vformat.hpp 17 1 boost/url/format.hpp include/boost/url/format.hpp 23 1 boost/url/parse_path.hpp include/boost/url/parse_path.hpp 18 1 boost/url/parse_query.hpp include/boost/url/parse_query.hpp 19 1 boost/url/static_url.hpp include/boost/url/static_url.hpp 19 1 boost/url/string_view.hpp include/boost/url/string_view.hpp 16 1 boost/url/rfc/gen_delim_chars.hpp include/boost/url/rfc/gen_delim_chars.hpp 16 1 boost/url/rfc/reserved_chars.hpp include/boost/url/rfc/reserved_chars.hpp 16 1 namespace +jO0pmMB/RXahxtatVUYoEwUKWs= regular //////////////////////////8= jfKMZmwdQz1vi4olOs8HBTBDdw4= WJ21EDxRmwBYtk0o44mUeU6Vo7A= 8Z27XCFaXDyED4bb0H80Uz1lun8= LWQB+dn+7lsRKPzx/twz66ZcOWI= dnk5XPfR2OaMpCYaH3cWSxcTdyc= 4XJlIWBo4vCVWjuTJ0zRUf6DK6U= uXSWHtDOKYYXdzrtjB1TZfvzAVk= pvbTh8h5rATyXjIZZScz9NuTDj8= urls boost/url/grammar/detail/charset.hpp include/boost/url/grammar/detail/charset.hpp 32 1 boost/url/grammar/alnum_chars.hpp include/boost/url/grammar/alnum_chars.hpp 17 1 boost/url/grammar/alpha_chars.hpp include/boost/url/grammar/alpha_chars.hpp 17 1 boost/url/grammar/charset.hpp include/boost/url/grammar/charset.hpp 26 1 boost/url/grammar/detail/ci_string.hpp include/boost/url/grammar/detail/ci_string.hpp 21 1 boost/url/grammar/ci_string.hpp include/boost/url/grammar/ci_string.hpp 20 1 boost/url/error_types.hpp include/boost/url/error_types.hpp 19 1 boost/url/grammar/dec_octet_rule.hpp include/boost/url/grammar/dec_octet_rule.hpp 18 1 boost/url/grammar/digit_chars.hpp include/boost/url/grammar/digit_chars.hpp 17 1 boost/url/grammar/error.hpp include/boost/url/grammar/error.hpp 17 1 boost/url/grammar/type_traits.hpp include/boost/url/grammar/type_traits.hpp 18 1 boost/url/grammar/delim_rule.hpp include/boost/url/grammar/delim_rule.hpp 22 1 boost/url/grammar/hexdig_chars.hpp include/boost/url/grammar/hexdig_chars.hpp 17 1 boost/url/grammar/literal_rule.hpp include/boost/url/grammar/literal_rule.hpp 20 1 boost/url/grammar/lut_chars.hpp include/boost/url/grammar/lut_chars.hpp 22 1 boost/url/grammar/not_empty_rule.hpp include/boost/url/grammar/not_empty_rule.hpp 19 1 boost/url/grammar/parse.hpp include/boost/url/grammar/parse.hpp 20 1 boost/url/optional.hpp include/boost/url/optional.hpp 17 1 boost/url/grammar/optional_rule.hpp include/boost/url/grammar/optional_rule.hpp 23 1 boost/url/error.hpp include/boost/url/error.hpp 18 1 boost/url/grammar/detail/range_rule.hpp include/boost/url/grammar/detail/range_rule.hpp 18 1 boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 27 1 boost/url/detail/except.hpp include/boost/url/detail/except.hpp 17 1 boost/url/grammar/detail/recycled.hpp include/boost/url/grammar/detail/recycled.hpp 16 1 boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 25 1 boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 20 1 boost/url/detail/string_view.hpp include/boost/url/detail/string_view.hpp 16 1 boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 23 1 boost/url/grammar/token_rule.hpp include/boost/url/grammar/token_rule.hpp 22 1 boost/url/grammar/detail/tuple.hpp include/boost/url/grammar/detail/tuple.hpp 36 1 boost/url/grammar/tuple_rule.hpp include/boost/url/grammar/tuple_rule.hpp 25 1 boost/url/grammar/unsigned_rule.hpp include/boost/url/grammar/unsigned_rule.hpp 23 1 boost/url/variant.hpp include/boost/url/variant.hpp 17 1 boost/url/grammar/variant_rule.hpp include/boost/url/grammar/variant_rule.hpp 21 1 boost/url/grammar/vchars.hpp include/boost/url/grammar/vchars.hpp 17 1 boost/url/host_type.hpp include/boost/url/host_type.hpp 16 1 boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 25 1 boost/url/ipv6_address.hpp include/boost/url/ipv6_address.hpp 24 1 boost/url/encoding_opts.hpp include/boost/url/encoding_opts.hpp 17 1 boost/url/pct_string_view.hpp include/boost/url/pct_string_view.hpp 27 1 boost/url/decode_view.hpp include/boost/url/decode_view.hpp 22 1 boost/url/scheme.hpp include/boost/url/scheme.hpp 19 1 boost/url/detail/parts_base.hpp include/boost/url/detail/parts_base.hpp 16 1 boost/url/detail/url_impl.hpp include/boost/url/detail/url_impl.hpp 24 1 boost/url/detail/memcpy.hpp include/boost/url/detail/memcpy.hpp 18 1 boost/url/detail/path.hpp include/boost/url/detail/path.hpp 17 1 boost/url/detail/impl/url_impl.hpp include/boost/url/detail/impl/url_impl.hpp 23 1 boost/url/authority_view.hpp include/boost/url/authority_view.hpp 27 1 boost/url/rfc/authority_rule.hpp include/boost/url/rfc/authority_rule.hpp 19 1 boost/url/rfc/detail/host_rule.hpp include/boost/url/rfc/detail/host_rule.hpp 22 1 boost/url/rfc/ipv4_address_rule.hpp include/boost/url/rfc/ipv4_address_rule.hpp 19 1 boost/url/rfc/detail/ip_literal_rule.hpp include/boost/url/rfc/detail/ip_literal_rule.hpp 20 1 boost/url/rfc/ipv6_address_rule.hpp include/boost/url/rfc/ipv6_address_rule.hpp 19 1 boost/url/rfc/detail/h16_rule.hpp include/boost/url/rfc/detail/h16_rule.hpp 19 1 boost/url/rfc/detail/impl/h16_rule.hpp include/boost/url/rfc/detail/impl/h16_rule.hpp 19 1 boost/url/rfc/detail/ipv6_addrz_rule.hpp include/boost/url/rfc/detail/ipv6_addrz_rule.hpp 19 1 boost/url/rfc/unreserved_chars.hpp include/boost/url/rfc/unreserved_chars.hpp 17 1 boost/url/rfc/pct_encoded_rule.hpp include/boost/url/rfc/pct_encoded_rule.hpp 20 1 boost/url/rfc/detail/impl/ipv6_addrz_rule.hpp include/boost/url/rfc/detail/impl/ipv6_addrz_rule.hpp 21 1 boost/url/rfc/detail/ipvfuture_rule.hpp include/boost/url/rfc/detail/ipvfuture_rule.hpp 18 1 boost/url/rfc/sub_delim_chars.hpp include/boost/url/rfc/sub_delim_chars.hpp 17 1 boost/url/rfc/pchars.hpp include/boost/url/rfc/pchars.hpp 18 1 boost/url/rfc/detail/charsets.hpp include/boost/url/rfc/detail/charsets.hpp 18 1 boost/url/rfc/detail/impl/ipvfuture_rule.hpp include/boost/url/rfc/detail/impl/ipvfuture_rule.hpp 25 1 boost/url/rfc/detail/impl/ip_literal_rule.hpp include/boost/url/rfc/detail/impl/ip_literal_rule.hpp 24 1 boost/url/rfc/detail/reg_name_rule.hpp include/boost/url/rfc/detail/reg_name_rule.hpp 20 1 boost/url/rfc/detail/impl/host_rule.hpp include/boost/url/rfc/detail/impl/host_rule.hpp 22 1 boost/url/rfc/detail/port_rule.hpp include/boost/url/rfc/detail/port_rule.hpp 20 1 boost/url/rfc/detail/impl/port_rule.hpp include/boost/url/rfc/detail/impl/port_rule.hpp 20 1 boost/url/rfc/detail/userinfo_rule.hpp include/boost/url/rfc/detail/userinfo_rule.hpp 19 1 boost/url/rfc/detail/impl/userinfo_rule.hpp include/boost/url/rfc/detail/impl/userinfo_rule.hpp 21 1 boost/url/decode.hpp include/boost/url/decode.hpp 20 1 boost/url/detail/decode.hpp include/boost/url/detail/decode.hpp 19 1 boost/url/grammar/all_chars.hpp include/boost/url/grammar/all_chars.hpp 17 1 boost/url/encode.hpp include/boost/url/encode.hpp 23 1 boost/url/detail/encode.hpp include/boost/url/detail/encode.hpp 21 1 boost/url/ignore_case.hpp include/boost/url/ignore_case.hpp 16 1 boost/url/detail/optional_string.hpp include/boost/url/detail/optional_string.hpp 17 1 boost/url/param.hpp include/boost/url/param.hpp 21 1 boost/url/detail/params_iter_impl.hpp include/boost/url/detail/params_iter_impl.hpp 19 1 boost/url/detail/impl/params_iter_impl.hpp include/boost/url/detail/impl/params_iter_impl.hpp 16 1 boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 22 1 boost/url/params_base.hpp include/boost/url/params_base.hpp 23 1 boost/url/params_view.hpp include/boost/url/params_view.hpp 18 1 boost/url/params_encoded_view.hpp include/boost/url/params_encoded_view.hpp 23 1 boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 20 1 boost/url/params_ref.hpp include/boost/url/params_ref.hpp 21 1 boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 21 1 boost/url/detail/segments_iter_impl.hpp include/boost/url/detail/segments_iter_impl.hpp 20 1 boost/url/detail/impl/segments_iter_impl.hpp include/boost/url/detail/impl/segments_iter_impl.hpp 19 1 boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 20 1 boost/url/segments_base.hpp include/boost/url/segments_base.hpp 21 1 boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 20 1 boost/url/segments_view.hpp include/boost/url/segments_view.hpp 19 1 boost/url/segments_encoded_view.hpp include/boost/url/segments_encoded_view.hpp 23 1 boost/url/detail/segments_range.hpp include/boost/url/detail/segments_range.hpp 21 1 boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 36 1 boost/url/detail/fnv_1a.hpp include/boost/url/detail/fnv_1a.hpp 19 1 boost/url/url_base.hpp include/boost/url/url_base.hpp 31 1 boost/url/url_view.hpp include/boost/url/url_view.hpp 19 1 boost/url/parse.hpp include/boost/url/parse.hpp 19 1 boost/url/rfc/absolute_uri_rule.hpp include/boost/url/rfc/absolute_uri_rule.hpp 18 1 boost/url/rfc/detail/hier_part_rule.hpp include/boost/url/rfc/detail/hier_part_rule.hpp 20 1 boost/url/rfc/detail/path_rules.hpp include/boost/url/rfc/detail/path_rules.hpp 20 1 boost/url/rfc/detail/impl/hier_part_rule.hpp include/boost/url/rfc/detail/impl/hier_part_rule.hpp 19 1 boost/url/rfc/detail/query_part_rule.hpp include/boost/url/rfc/detail/query_part_rule.hpp 22 1 boost/url/rfc/detail/scheme_rule.hpp include/boost/url/rfc/detail/scheme_rule.hpp 20 1 boost/url/rfc/detail/impl/scheme_rule.hpp include/boost/url/rfc/detail/impl/scheme_rule.hpp 22 1 boost/url/rfc/relative_ref_rule.hpp include/boost/url/rfc/relative_ref_rule.hpp 18 1 boost/url/rfc/detail/fragment_part_rule.hpp include/boost/url/rfc/detail/fragment_part_rule.hpp 19 1 boost/url/rfc/detail/relative_part_rule.hpp include/boost/url/rfc/detail/relative_part_rule.hpp 20 1 boost/url/rfc/detail/impl/relative_part_rule.hpp include/boost/url/rfc/detail/impl/relative_part_rule.hpp 22 1 boost/url/rfc/uri_rule.hpp include/boost/url/rfc/uri_rule.hpp 18 1 boost/url/rfc/uri_reference_rule.hpp include/boost/url/rfc/uri_reference_rule.hpp 18 1 boost/url/rfc/origin_form_rule.hpp include/boost/url/rfc/origin_form_rule.hpp 18 1 boost/url/detail/over_allocator.hpp include/boost/url/detail/over_allocator.hpp 27 1 boost/url/detail/any_params_iter.hpp include/boost/url/detail/any_params_iter.hpp 21 1 boost/url/detail/impl/any_params_iter.hpp include/boost/url/detail/impl/any_params_iter.hpp 19 1 boost/url/detail/any_segments_iter.hpp include/boost/url/detail/any_segments_iter.hpp 20 1 boost/url/detail/impl/any_segments_iter.hpp include/boost/url/detail/impl/any_segments_iter.hpp 20 1 boost/url/detail/normalize.hpp include/boost/url/detail/normalize.hpp 20 1 boost/url/detail/print.hpp include/boost/url/detail/print.hpp 18 1 boost/url/rfc/query_rule.hpp include/boost/url/rfc/query_rule.hpp 20 1 boost/url/detail/move_chars.hpp include/boost/url/detail/move_chars.hpp 19 1 boost/url/url.hpp include/boost/url/url.hpp 20 1 boost/url/detail/format_args.hpp include/boost/url/detail/format_args.hpp 23 1 boost/url/detail/impl/format_args.hpp include/boost/url/detail/impl/format_args.hpp 14 1 boost/url/detail/vformat.hpp include/boost/url/detail/vformat.hpp 18 1 boost/url/format.hpp include/boost/url/format.hpp 24 1 boost/url/parse_path.hpp include/boost/url/parse_path.hpp 19 1 boost/url/parse_query.hpp include/boost/url/parse_query.hpp 20 1 boost/url/static_url.hpp include/boost/url/static_url.hpp 20 1 boost/url/string_view.hpp include/boost/url/string_view.hpp 17 1 boost/url/rfc/gen_delim_chars.hpp include/boost/url/rfc/gen_delim_chars.hpp 17 1 boost/url/rfc/reserved_chars.hpp include/boost/url/rfc/reserved_chars.hpp 17 1 namespace dnk5XPfR2OaMpCYaH3cWSxcTdyc= regular +jO0pmMB/RXahxtatVUYoEwUKWs= identifier dFhpRnVrPPpdq5ewgStCIemieCE= error_types N0a0PcWBzeWPZcu7RT7dbUuOvwU= dFhpRnVrPPpdq5ewgStCIemieCE= 1HiiaUSr2qeoadbVYr8/BZxU47k= xCd2tUlylXT9zvj8ZcHXybU4P/k= MOmWJXtSzgLTSr4XFeqs4WKGaYg= SSBC59C6XUs+gwNHiw2EV5oj4Pg= HO2ZXp4PSbe153fApaGEDkq0ks0= oSAYJle80BcL838BBRX63lch/5Q= eTmWJVJVu1SBdk3eyejLHvdkz6o= FhVAnUhR1V4cDQt6TPQXGyakQHc= d/hMlyyC3Ave6L9McUD7B4TwENA= IhE/V16b2wBX2q+s4QtlgzozWlQ= Bb04pNwExynJkzlY9a9GCeeB13k= RATceEbebMWrhFXGkG2RDFi+7WY= /Wpp3ZZDp3kUHzbULeDoaOEhnVs= dhMSRVBIIIItY0URHSc8rwHcdTQ= 51rV2xfhRV96h9L23+q8lPiw4x8= fsdT8sbwW/lniPI5gqvIf2JMGBM= SMbLJWxhkkCMp2sPkBpWmdnoNGI= C+IWBHRl3NluE4QVhoCkgb59VAc= paRP7A1SOQlKcnfXhxL4FgbVXKs= 2+L1/+BrjUzoccWPIYkGu108y1I= oR5B5D0/JYTOQYvyFXRv+at91JE= 0nSfM4mK92fIx58KtzdWGiHuq2w= 8S83BKvWBCDdTktlY8X93Mlo9E0= DzqMpaJX2O25vPFxEN5EDTyU6uw= t9KlfUmMV/Lq0e5tGD9d/eCq+X0= ge9cOBTN19ywbVTnB5ajdJUC46Q= qs4TNMM406MPgeboXz6oVUmcauE= TCUUfRiqZjX62kt7tK2fs//VWr0= EvaX3SmNTAtai2Kf6Kma3fUkTkQ= zdr3gU7+2/G05oo6ta/IfHlkTF0= ZNJOLZ4RhCB2A2ooiNo7KxZJHrA= 4HBDcnMjZthTXFnhpS7z+UhDNjA= dmsqdje8dXFRFgNB9wxOs9Y5nb8= B4dRaSXMG3fDmuNKMW3KOeRu6kA= aHkFCWJbYb0t+7FT+A5gCI0krpU= wh3UbUToX9YDmRmnpcoM9EUEZo8= UEVNhDEjkZMXfjN1DxbtX0n2rCg= 0CIF+QeihUmkg/SM/JmNHthVUUc= YLHFVyAYZGSFQe18DPGjn6XsAMs= P7uOjuAMILimKGOcbjDUSpMAL/U= IQym8fO7DIG67s+M2rtFQszkoaY= EWBg+x5e110QbcM7IDtIDwumEw0= /AThCMbL32Ow06PKJyfrPXN/Yxg= 0hWNSMZWo7QSp/muF+6J2s3jsLA= 09aIpdxxNNYbVZSULaBGficRxZ4= ydZ7bTykSMnwehDU9NtjTjWeB+I= Xq8kBc9a/F5Bpmn1q4OszstzJ4g= ZTww0Dx20RT0z0QTruz8U8gZuIY= FNXbTBfIxbiM2pjYEryMCZH+yoY= mgIS/AfQlcgKNFKOdLRtjihgyFk= LmKHQZfsj3PYKU9ldLJvacNvZaA= U3CVElRbcTcbg1JzOqhBCd5RSzM= dl7C/yP8Suze9+hv0RfYWxZaWCY= 3H1nFll3jIwKtiUjrAoL1itMXS8= bEw/qaAlNfZy1QraETx5dipoF+I= J4f05lEg7oi89R2SkpRaYiBhCIQ= UGT2YeR0J7z0ZcyG8/VStlmtGhU= uNT8hVd3FIORJnihg+axBbyOnBE= QFzcl8vSLEeKOEO6w3mv1zGqX3k= f+9kR517VGSM5ZPoS7g/RFb0g/0= 7d2b1xVBWJPgL/+PWFdoBaZJvMA= tqgOJBBmkI71v1H8Vjo+5AjUBNk= /6zWjIFN5df0PBj9zFsfNUjNY6s= ViRFbAhqyfzry2qMQUxKJSvsEQU= r+2jsv/V/6eYTTn9n6oVkgy6U/Y= bWzp24u26R/CcIVKOEeAZxMwSG4= SdFdcdup2kXvm4kt7IFusgel9jM= EUEfV2/Q0PUKk4boBo8vxNymBsw= TcVr8Ed3rRtx/zQttClcoTybe2s= XBk4cGiSAiq2cC42CccYfpnYrn4= tKIekZ4LOo4Oe6XEHJFLnYgizMk= 9UoXN2fhMGIv9/Cwla3t/6wKV74= evLaAmUXMOD+YMeWXJG9YdwR4xw= 4SGJz+AJ+UhdwU8wP3Xh11mlvBM= kWc6VwnEqWA0KYFMRYavAgCCB4M= M0EYo5t0pgHX2bya+60gL5gq8Mc= y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= M9SQbDZx89d7w32vLj4LMkyNHYI= HNlbMWgGFyUa8zfk9rDcguyMilg= INQ2ouuVlRY3LsAsb8F4jYk7wBA= nz+wKEzMLKgYPZA/4y/jAJmzf6I= 2V+Z9ecepqbZRna6GFcGry1dzDs= 6a/9GskAZnBXlwr4d3UtNR0aCNQ= SMHCvo8zmYWXaMRwpIb2LkyRmJE= LHgNC6HzmNSmob+HNYbdFf3I/ss= W5ZnEm5Wr2aNUSnMwlBHGfqRHgY= sPt+l16WQkJLiqM+m+B6d5s9eA0= S1qIdty2BzQiH3cIDwP1tc/RJzM= AL2wo0R+80Md4UIYeUHuHTClsvI= detail boost/url/detail/except.hpp include/boost/url/detail/except.hpp 18 1 boost/url/detail/string_view.hpp include/boost/url/detail/string_view.hpp 17 1 boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 1132 1 boost/url/pct_string_view.hpp include/boost/url/pct_string_view.hpp 41 1 boost/url/pct_string_view.hpp include/boost/url/pct_string_view.hpp 395 1 boost/url/pct_string_view.hpp include/boost/url/pct_string_view.hpp 456 1 boost/url/decode_view.hpp include/boost/url/decode_view.hpp 28 1 boost/url/decode_view.hpp include/boost/url/decode_view.hpp 1059 1 boost/url/detail/parts_base.hpp include/boost/url/detail/parts_base.hpp 17 1 boost/url/detail/url_impl.hpp include/boost/url/detail/url_impl.hpp 29 1 boost/url/detail/memcpy.hpp include/boost/url/detail/memcpy.hpp 19 1 boost/url/detail/path.hpp include/boost/url/detail/path.hpp 18 1 boost/url/detail/impl/url_impl.hpp include/boost/url/detail/impl/url_impl.hpp 24 1 boost/url/rfc/detail/host_rule.hpp include/boost/url/rfc/detail/host_rule.hpp 23 1 boost/url/rfc/detail/ip_literal_rule.hpp include/boost/url/rfc/detail/ip_literal_rule.hpp 21 1 boost/url/rfc/detail/h16_rule.hpp include/boost/url/rfc/detail/h16_rule.hpp 20 1 boost/url/rfc/detail/impl/h16_rule.hpp include/boost/url/rfc/detail/impl/h16_rule.hpp 20 1 boost/url/rfc/detail/ipv6_addrz_rule.hpp include/boost/url/rfc/detail/ipv6_addrz_rule.hpp 20 1 boost/url/rfc/detail/impl/ipv6_addrz_rule.hpp include/boost/url/rfc/detail/impl/ipv6_addrz_rule.hpp 22 1 boost/url/rfc/detail/ipvfuture_rule.hpp include/boost/url/rfc/detail/ipvfuture_rule.hpp 19 1 boost/url/rfc/detail/charsets.hpp include/boost/url/rfc/detail/charsets.hpp 19 1 boost/url/rfc/detail/impl/ipvfuture_rule.hpp include/boost/url/rfc/detail/impl/ipvfuture_rule.hpp 26 1 boost/url/rfc/detail/impl/ip_literal_rule.hpp include/boost/url/rfc/detail/impl/ip_literal_rule.hpp 25 1 boost/url/rfc/detail/reg_name_rule.hpp include/boost/url/rfc/detail/reg_name_rule.hpp 21 1 boost/url/rfc/detail/impl/host_rule.hpp include/boost/url/rfc/detail/impl/host_rule.hpp 23 1 boost/url/rfc/detail/port_rule.hpp include/boost/url/rfc/detail/port_rule.hpp 21 1 boost/url/rfc/detail/impl/port_rule.hpp include/boost/url/rfc/detail/impl/port_rule.hpp 21 1 boost/url/rfc/detail/userinfo_rule.hpp include/boost/url/rfc/detail/userinfo_rule.hpp 20 1 boost/url/rfc/detail/impl/userinfo_rule.hpp include/boost/url/rfc/detail/impl/userinfo_rule.hpp 22 1 boost/url/detail/decode.hpp include/boost/url/detail/decode.hpp 20 1 boost/url/detail/encode.hpp include/boost/url/detail/encode.hpp 22 1 boost/url/detail/optional_string.hpp include/boost/url/detail/optional_string.hpp 23 1 boost/url/detail/params_iter_impl.hpp include/boost/url/detail/params_iter_impl.hpp 20 1 boost/url/detail/impl/params_iter_impl.hpp include/boost/url/detail/impl/params_iter_impl.hpp 17 1 boost/url/detail/segments_iter_impl.hpp include/boost/url/detail/segments_iter_impl.hpp 21 1 boost/url/detail/impl/segments_iter_impl.hpp include/boost/url/detail/impl/segments_iter_impl.hpp 20 1 boost/url/detail/segments_range.hpp include/boost/url/detail/segments_range.hpp 22 1 boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 39 1 boost/url/detail/fnv_1a.hpp include/boost/url/detail/fnv_1a.hpp 20 1 boost/url/url_base.hpp include/boost/url/url_base.hpp 33 1 boost/url/rfc/detail/hier_part_rule.hpp include/boost/url/rfc/detail/hier_part_rule.hpp 21 1 boost/url/rfc/detail/path_rules.hpp include/boost/url/rfc/detail/path_rules.hpp 21 1 boost/url/rfc/detail/impl/hier_part_rule.hpp include/boost/url/rfc/detail/impl/hier_part_rule.hpp 20 1 boost/url/rfc/detail/query_part_rule.hpp include/boost/url/rfc/detail/query_part_rule.hpp 23 1 boost/url/rfc/detail/scheme_rule.hpp include/boost/url/rfc/detail/scheme_rule.hpp 21 1 boost/url/rfc/detail/impl/scheme_rule.hpp include/boost/url/rfc/detail/impl/scheme_rule.hpp 23 1 boost/url/rfc/detail/fragment_part_rule.hpp include/boost/url/rfc/detail/fragment_part_rule.hpp 20 1 boost/url/rfc/detail/relative_part_rule.hpp include/boost/url/rfc/detail/relative_part_rule.hpp 21 1 boost/url/rfc/detail/impl/relative_part_rule.hpp include/boost/url/rfc/detail/impl/relative_part_rule.hpp 23 1 boost/url/detail/over_allocator.hpp include/boost/url/detail/over_allocator.hpp 28 1 boost/url/detail/any_params_iter.hpp include/boost/url/detail/any_params_iter.hpp 22 1 boost/url/detail/impl/any_params_iter.hpp include/boost/url/detail/impl/any_params_iter.hpp 20 1 boost/url/detail/any_segments_iter.hpp include/boost/url/detail/any_segments_iter.hpp 21 1 boost/url/detail/impl/any_segments_iter.hpp include/boost/url/detail/impl/any_segments_iter.hpp 21 1 boost/url/detail/normalize.hpp include/boost/url/detail/normalize.hpp 21 1 boost/url/detail/print.hpp include/boost/url/detail/print.hpp 19 1 boost/url/detail/move_chars.hpp include/boost/url/detail/move_chars.hpp 20 1 boost/url/detail/format_args.hpp include/boost/url/detail/format_args.hpp 24 1 boost/url/detail/impl/format_args.hpp include/boost/url/detail/impl/format_args.hpp 15 1 boost/url/detail/vformat.hpp include/boost/url/detail/vformat.hpp 19 1 namespace N0a0PcWBzeWPZcu7RT7dbUuOvwU= implementation-defined dnk5XPfR2OaMpCYaH3cWSxcTdyc= N907Zq1jcNQM3QvuYRWfKy3naJo= yN69vxXJAP6E65u8Qke0AHCTZns= /zMrc2EfowBhSEHWufUSB6T3OeI= 81sFU1ap8/xDfdip9jIZTHzrnZc= eyrJc7lS2X0ncdAwqP02OzkVx6g= Kjj4FMkjLyAYk5A+0siPoF+6BxE= c2oHkdZKXA2sws1urqbpOsR9Kx8= 8i/2kU0xJOUDBwaU8J+g4bAFCYo= 7JLc2rJyxvIcYx4cE8r71g0pp0U= 2lCBK8wOkLy56QnHftTAflfUb+E= T/F7KeOYUTv4+tRVY0biDvq/yFw= w9A8Yp2yPRq3OCYinKx8LDDbDwY= 4SJMftn6IPr1dGqX5JdpCnmJy/o= dwj6lWET5mCtZKi/XhKQ5u+ixOQ= LxnyO1oMtIpumA27UM8WIh7lozo= any_params_iter boost/url/detail/any_params_iter.hpp include/boost/url/detail/any_params_iter.hpp 34 1 record N907Zq1jcNQM3QvuYRWfKy3naJo= implementation-defined N0a0PcWBzeWPZcu7RT7dbUuOvwU= struct any_segments_iter boost/url/detail/any_segments_iter.hpp include/boost/url/detail/any_segments_iter.hpp 23 1 record yN69vxXJAP6E65u8Qke0AHCTZns= implementation-defined N0a0PcWBzeWPZcu7RT7dbUuOvwU= struct format_arg boost/url/detail/format_args.hpp include/boost/url/detail/format_args.hpp 101 1 record /zMrc2EfowBhSEHWufUSB6T3OeI= implementation-defined N0a0PcWBzeWPZcu7RT7dbUuOvwU= class named_arg boost/url/detail/format_args.hpp include/boost/url/detail/format_args.hpp 88 1 record 81sFU1ap8/xDfdip9jIZTHzrnZc= implementation-defined N0a0PcWBzeWPZcu7RT7dbUuOvwU= struct optional_string boost/url/detail/optional_string.hpp include/boost/url/detail/optional_string.hpp 24 1 record eyrJc7lS2X0ncdAwqP02OzkVx6g= implementation-defined N0a0PcWBzeWPZcu7RT7dbUuOvwU= struct params_iter_impl boost/url/detail/params_iter_impl.hpp include/boost/url/detail/params_iter_impl.hpp 22 1 record Kjj4FMkjLyAYk5A+0siPoF+6BxE= implementation-defined N0a0PcWBzeWPZcu7RT7dbUuOvwU= struct identifier c2oHkdZKXA2sws1urqbpOsR9Kx8= parts_base parts_base boost/url/detail/parts_base.hpp include/boost/url/detail/parts_base.hpp 21 1 record c2oHkdZKXA2sws1urqbpOsR9Kx8= implementation-defined N0a0PcWBzeWPZcu7RT7dbUuOvwU= struct 1JOsZvgqqrPd7AKwjtAHDfQ2icA= XBsOBACbev7ebnNe3ePPa6j4G58= boost/url/detail/parts_base.hpp include/boost/url/detail/parts_base.hpp 23 5 enum 1JOsZvgqqrPd7AKwjtAHDfQ2icA= implementation-defined c2oHkdZKXA2sws1urqbpOsR9Kx8= aDRmuukPUIFkZQLbFOWYlK2bgy8= S9v7VhfAboWJfu4WIJ9nOZw4SeE= 1j3nr2ruLm4K69Nh/QTuJI762qM= VpINKQ141yD1/02sgBPryhDQAB4= s5NwdxwYSg5/VhC56cr6w0OspaY= 1XXJbkDIhTELSbS226G62YkL6m4= sshcQdVWwkO9XCJlIScbpgnAtGw= I8MPlOaNY67hQgssw5TWhU6Sf1c= e/5/mys/Nvj/omyvu7SnJtddic0= id_scheme boost/url/detail/parts_base.hpp include/boost/url/detail/parts_base.hpp 25 9 enum-constant aDRmuukPUIFkZQLbFOWYlK2bgy8= implementation-defined 1JOsZvgqqrPd7AKwjtAHDfQ2icA= -1 id_user boost/url/detail/parts_base.hpp include/boost/url/detail/parts_base.hpp 26 9 enum-constant S9v7VhfAboWJfu4WIJ9nOZw4SeE= implementation-defined 1JOsZvgqqrPd7AKwjtAHDfQ2icA= id_pass boost/url/detail/parts_base.hpp include/boost/url/detail/parts_base.hpp 27 9 enum-constant 1j3nr2ruLm4K69Nh/QTuJI762qM= implementation-defined 1JOsZvgqqrPd7AKwjtAHDfQ2icA= id_host boost/url/detail/parts_base.hpp include/boost/url/detail/parts_base.hpp 28 9 enum-constant VpINKQ141yD1/02sgBPryhDQAB4= implementation-defined 1JOsZvgqqrPd7AKwjtAHDfQ2icA= id_port boost/url/detail/parts_base.hpp include/boost/url/detail/parts_base.hpp 29 9 enum-constant s5NwdxwYSg5/VhC56cr6w0OspaY= implementation-defined 1JOsZvgqqrPd7AKwjtAHDfQ2icA= id_path boost/url/detail/parts_base.hpp include/boost/url/detail/parts_base.hpp 30 9 enum-constant 1XXJbkDIhTELSbS226G62YkL6m4= implementation-defined 1JOsZvgqqrPd7AKwjtAHDfQ2icA= id_query boost/url/detail/parts_base.hpp include/boost/url/detail/parts_base.hpp 31 9 enum-constant sshcQdVWwkO9XCJlIScbpgnAtGw= implementation-defined 1JOsZvgqqrPd7AKwjtAHDfQ2icA= id_frag boost/url/detail/parts_base.hpp include/boost/url/detail/parts_base.hpp 32 9 enum-constant I8MPlOaNY67hQgssw5TWhU6Sf1c= implementation-defined 1JOsZvgqqrPd7AKwjtAHDfQ2icA= id_end boost/url/detail/parts_base.hpp include/boost/url/detail/parts_base.hpp 33 9 enum-constant e/5/mys/Nvj/omyvu7SnJtddic0= implementation-defined 1JOsZvgqqrPd7AKwjtAHDfQ2icA= from boost/url/detail/parts_base.hpp include/boost/url/detail/parts_base.hpp 36 5 enum XBsOBACbev7ebnNe3ePPa6j4G58= implementation-defined c2oHkdZKXA2sws1urqbpOsR9Kx8= 1 identifier char vpVwmAcC6OXdrsZhVf1BmnWZnmI= 8ldFenKrZsAFoCNV3yIDGFEYfIo= 56D5ifG890qyCbZKFxTTtprHKlM= string boost/url/detail/parts_base.hpp include/boost/url/detail/parts_base.hpp 38 9 enum-constant vpVwmAcC6OXdrsZhVf1BmnWZnmI= implementation-defined XBsOBACbev7ebnNe3ePPa6j4G58= 0 url boost/url/detail/parts_base.hpp include/boost/url/detail/parts_base.hpp 42 9 enum-constant 8ldFenKrZsAFoCNV3yIDGFEYfIo= implementation-defined XBsOBACbev7ebnNe3ePPa6j4G58= 1 authority boost/url/detail/parts_base.hpp include/boost/url/detail/parts_base.hpp 45 9 enum-constant 56D5ifG890qyCbZKFxTTtprHKlM= implementation-defined XBsOBACbev7ebnNe3ePPa6j4G58= 2 path_ref boost/url/detail/url_impl.hpp include/boost/url/detail/url_impl.hpp 127 1 record 8i/2kU0xJOUDBwaU8J+g4bAFCYo= implementation-defined N0a0PcWBzeWPZcu7RT7dbUuOvwU= class pattern boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 40 1 record 7JLc2rJyxvIcYx4cE8r71g0pp0U= implementation-defined N0a0PcWBzeWPZcu7RT7dbUuOvwU= struct query_ref boost/url/detail/url_impl.hpp include/boost/url/detail/url_impl.hpp 174 1 record 2lCBK8wOkLy56QnHftTAflfUb+E= implementation-defined N0a0PcWBzeWPZcu7RT7dbUuOvwU= class segments_iter_access boost/url/detail/segments_range.hpp include/boost/url/detail/segments_range.hpp 24 1 record T/F7KeOYUTv4+tRVY0biDvq/yFw= implementation-defined N0a0PcWBzeWPZcu7RT7dbUuOvwU= struct segments_iter_impl boost/url/detail/segments_iter_impl.hpp include/boost/url/detail/segments_iter_impl.hpp 23 1 record w9A8Yp2yPRq3OCYinKx8LDDbDwY= implementation-defined N0a0PcWBzeWPZcu7RT7dbUuOvwU= struct url_impl boost/url/detail/url_impl.hpp include/boost/url/detail/url_impl.hpp 39 1 record 4SJMftn6IPr1dGqX5JdpCnmJy/o= implementation-defined N0a0PcWBzeWPZcu7RT7dbUuOvwU= struct identifier c2oHkdZKXA2sws1urqbpOsR9Kx8= parts_base make_decode_view boost/url/decode_view.hpp include/boost/url/decode_view.hpp 32 1 function dwj6lWET5mCtZKi/XhKQ5u+ixOQ= implementation-defined N0a0PcWBzeWPZcu7RT7dbUuOvwU= identifier IhE/V16b2wBX2q+s4QtlgzozWlQ= decode_view 1 identifier Args args normal ref boost/url/pct_string_view.hpp include/boost/url/pct_string_view.hpp 42 1 function LxnyO1oMtIpumA27UM8WIh7lozo= implementation-defined N0a0PcWBzeWPZcu7RT7dbUuOvwU= identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view s normal error_types boost/url/error_types.hpp include/boost/url/error_types.hpp 22 1 namespace dFhpRnVrPPpdq5ewgStCIemieCE= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= uT4AHZWwz1y2PxO9wFdu8NHmv9U= RuTgDILNiOM1qWodZIqh3i+ojjs= yqrUKgPOvS84EWFL529N0kb/HDU= qI57jEGO0MVlJexMJPKj6/Bs5FM= bjSUKhX+n1GPEPg5Jloenh4Xi9A= THGORlBSfx7zCN79rsiin41X6hE= 1VpRAua/ImyxIw/Sv4H7RHpffcQ= fu9ui8aa6jfmb5DOCLF4dVB+LCg= errc boost/url/error_types.hpp include/boost/url/error_types.hpp 171 1 1 namespace-alias uT4AHZWwz1y2PxO9wFdu8NHmv9U= regular dFhpRnVrPPpdq5ewgStCIemieCE= admonition paragraph text This alias is no longer supported and should not be used in new code. Please use code text system::errc text instead. warning paragraph text This alias is included for backwards compatibility with earlier versions of the library. paragraph text However, it will be removed in future releases, and using it in new code is not recommended. paragraph text Please use the updated version instead to ensure compatibility with future versions of the library. brief text The set of constants used for cross-platform error codes identifier errc identifier LWQB+dn+7lsRKPzx/twz66ZcOWI= system identifier +jO0pmMB/RXahxtatVUYoEwUKWs= boost error_category boost/url/error_types.hpp include/boost/url/error_types.hpp 43 1 1 typedef RuTgDILNiOM1qWodZIqh3i+ojjs= regular dFhpRnVrPPpdq5ewgStCIemieCE= admonition paragraph text This alias is no longer supported and should not be used in new code. Please use code text system::error_category text instead. warning paragraph text This alias is included for backwards compatibility with earlier versions of the library. paragraph text However, it will be removed in future releases, and using it in new code is not recommended. paragraph text Please use the updated version instead to ensure compatibility with future versions of the library. brief text The type of error category used by the library identifier nO3jcHtBw/fBE2CuJphjVyhkdcs= error_category identifier LWQB+dn+7lsRKPzx/twz66ZcOWI= system identifier +jO0pmMB/RXahxtatVUYoEwUKWs= boost 1 error_code boost/url/error_types.hpp include/boost/url/error_types.hpp 65 1 1 typedef yqrUKgPOvS84EWFL529N0kb/HDU= regular dFhpRnVrPPpdq5ewgStCIemieCE= admonition paragraph text This alias is no longer supported and should not be used in new code. Please use code text system::error_code text instead. warning paragraph text This alias is included for backwards compatibility with earlier versions of the library. paragraph text However, it will be removed in future releases, and using it in new code is not recommended. paragraph text Please use the updated version instead to ensure compatibility with future versions of the library. brief text The type of error code used by the library identifier 6rIGjIhXzK1yZlcD+UBEOkwfUGc= error_code identifier LWQB+dn+7lsRKPzx/twz66ZcOWI= system identifier +jO0pmMB/RXahxtatVUYoEwUKWs= boost 1 error_condition boost/url/error_types.hpp include/boost/url/error_types.hpp 87 1 1 typedef qI57jEGO0MVlJexMJPKj6/Bs5FM= regular dFhpRnVrPPpdq5ewgStCIemieCE= admonition paragraph text This alias is no longer supported and should not be used in new code. Please use code text system::error_condition text instead. warning paragraph text This alias is included for backwards compatibility with earlier versions of the library. paragraph text However, it will be removed in future releases, and using it in new code is not recommended. paragraph text Please use the updated version instead to ensure compatibility with future versions of the library. brief text The type of error condition used by the library identifier k1130brDADLgbCjQCdBnAjXEIoI= error_condition identifier LWQB+dn+7lsRKPzx/twz66ZcOWI= system identifier +jO0pmMB/RXahxtatVUYoEwUKWs= boost 1 result boost/url/error_types.hpp include/boost/url/error_types.hpp 264 1 1 typedef bjSUKhX+n1GPEPg5Jloenh4Xi9A= regular dFhpRnVrPPpdq5ewgStCIemieCE= admonition paragraph text This alias is no longer supported and should not be used in new code. Please use code text system::result text instead. warning paragraph text This alias is included for backwards compatibility with earlier versions of the library. paragraph text However, it will be removed in future releases, and using it in new code is not recommended. paragraph text Please use the updated version instead to ensure compatibility with future versions of the library. paragraph text This is an alias template used as the return type for functions that can either return a container, or fail with an error code. This is a brief synopsis of the type: heading text Declaration 1 code template< class T > class result { public: // // Return true if the result contains an error // constexpr bool has_error() const noexcept; // // Return the error // constexpr system::error_code error() const noexcept; // // Return true if the result contains a value // constexpr bool has_value() const noexcept; constexpr explicit operator bool() const noexcept; // // Return the value, or throw an exception // constexpr T& value(); constexpr T const& value() const; // Return the value. // Precondition: has_value()==true // constexpr T& operator*() noexcept; constexpr T* operator->() noexcept; constexpr T const& operator*() const noexcept; constexpr T const* operator->() const noexcept; ...more heading text Usage 1 paragraph text Given the function reference parse_uri f+9kR517VGSM5ZPoS7g/RFb0g/0= text with this signature: code system::result< url_view > parse_uri( core::string_view s ) noexcept; paragraph text The following statement captures the value in a variable upon success, otherwise throws: code url_view u = parse_uri( "http://example.com/path/to/file.txt" ).value(); paragraph text This statement captures the result in a local variable and inspects the error condition: code system::result< url_view > rv = parse_uri( "http://example.com/path/to/file.txt" ); if(! rv ) std::cout << rv.error(); else std::cout << *rv; list paragraph link code text boost::system::result https://boost.org/libs/system/doc/html/system.html#ref_resultt_e unordered brief text The type of result returned by library functions t-param text The type of value held by the result. T specialization O+YzwnquzbCEPErxi2iuhXKphsk= result identifier LWQB+dn+7lsRKPzx/twz66ZcOWI= system identifier +jO0pmMB/RXahxtatVUYoEwUKWs= boost 1 system_error boost/url/error_types.hpp include/boost/url/error_types.hpp 109 1 1 typedef THGORlBSfx7zCN79rsiin41X6hE= regular dFhpRnVrPPpdq5ewgStCIemieCE= admonition paragraph text This alias is no longer supported and should not be used in new code. Please use code text system::system_error text instead. warning paragraph text This alias is included for backwards compatibility with earlier versions of the library. paragraph text However, it will be removed in future releases, and using it in new code is not recommended. paragraph text Please use the updated version instead to ensure compatibility with future versions of the library. brief text The type of system error thrown by the library identifier WWHylWATMliP7X8mi649Z47r1rY= system_error identifier LWQB+dn+7lsRKPzx/twz66ZcOWI= system identifier +jO0pmMB/RXahxtatVUYoEwUKWs= boost 1 generic_category boost/url/error_types.hpp include/boost/url/error_types.hpp 131 1 1 using 1VpRAua/ImyxIw/Sv4H7RHpffcQ= regular dFhpRnVrPPpdq5ewgStCIemieCE= admonition paragraph text This alias is no longer supported and should not be used in new code. Please use code text system::generic_category text instead. warning paragraph text This alias is included for backwards compatibility with earlier versions of the library. paragraph text However, it will be removed in future releases, and using it in new code is not recommended. paragraph text Please use the updated version instead to ensure compatibility with future versions of the library. brief text A function to return the generic error category used by the library normal identifier generic_category identifier LWQB+dn+7lsRKPzx/twz66ZcOWI= system identifier +jO0pmMB/RXahxtatVUYoEwUKWs= boost system_category boost/url/error_types.hpp include/boost/url/error_types.hpp 151 1 1 using fu9ui8aa6jfmb5DOCLF4dVB+LCg= regular dFhpRnVrPPpdq5ewgStCIemieCE= admonition paragraph text This alias is no longer supported and should not be used in new code. Please use code text system::system_category text instead. warning paragraph text This alias is included for backwards compatibility with earlier versions of the library. paragraph text However, it will be removed in future releases, and using it in new code is not recommended. paragraph text Please use the updated version instead to ensure compatibility with future versions of the library. brief text A function to return the system error category used by the library normal identifier system_category identifier LWQB+dn+7lsRKPzx/twz66ZcOWI= system identifier +jO0pmMB/RXahxtatVUYoEwUKWs= boost grammar boost/url/grammar/detail/charset.hpp include/boost/url/grammar/detail/charset.hpp 33 1 boost/url/grammar/alnum_chars.hpp include/boost/url/grammar/alnum_chars.hpp 18 1 boost/url/grammar/alpha_chars.hpp include/boost/url/grammar/alpha_chars.hpp 18 1 boost/url/grammar/charset.hpp include/boost/url/grammar/charset.hpp 27 1 boost/url/grammar/detail/ci_string.hpp include/boost/url/grammar/detail/ci_string.hpp 22 1 boost/url/grammar/ci_string.hpp include/boost/url/grammar/ci_string.hpp 21 1 boost/url/grammar/dec_octet_rule.hpp include/boost/url/grammar/dec_octet_rule.hpp 19 1 boost/url/grammar/digit_chars.hpp include/boost/url/grammar/digit_chars.hpp 18 1 boost/url/grammar/error.hpp include/boost/url/grammar/error.hpp 18 1 boost/url/grammar/type_traits.hpp include/boost/url/grammar/type_traits.hpp 19 1 boost/url/grammar/delim_rule.hpp include/boost/url/grammar/delim_rule.hpp 23 1 boost/url/grammar/hexdig_chars.hpp include/boost/url/grammar/hexdig_chars.hpp 18 1 boost/url/grammar/literal_rule.hpp include/boost/url/grammar/literal_rule.hpp 21 1 boost/url/grammar/lut_chars.hpp include/boost/url/grammar/lut_chars.hpp 23 1 boost/url/grammar/not_empty_rule.hpp include/boost/url/grammar/not_empty_rule.hpp 20 1 boost/url/grammar/parse.hpp include/boost/url/grammar/parse.hpp 21 1 boost/url/grammar/optional_rule.hpp include/boost/url/grammar/optional_rule.hpp 24 1 boost/url/grammar/detail/range_rule.hpp include/boost/url/grammar/detail/range_rule.hpp 19 1 boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 28 1 boost/url/grammar/detail/recycled.hpp include/boost/url/grammar/detail/recycled.hpp 17 1 boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 26 1 boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 478 1 boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 24 1 boost/url/grammar/token_rule.hpp include/boost/url/grammar/token_rule.hpp 23 1 boost/url/grammar/detail/tuple.hpp include/boost/url/grammar/detail/tuple.hpp 37 1 boost/url/grammar/tuple_rule.hpp include/boost/url/grammar/tuple_rule.hpp 26 1 boost/url/grammar/unsigned_rule.hpp include/boost/url/grammar/unsigned_rule.hpp 24 1 boost/url/grammar/variant_rule.hpp include/boost/url/grammar/variant_rule.hpp 22 1 boost/url/grammar/vchars.hpp include/boost/url/grammar/vchars.hpp 18 1 boost/url/grammar/all_chars.hpp include/boost/url/grammar/all_chars.hpp 18 1 namespace 1HiiaUSr2qeoadbVYr8/BZxU47k= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= kjqcso5U9E4PFvl5kQX9ptGH8vA= 9V9OWFKGAdzyoTAl2TNIxHn9M/Y= k2EX7IarFscJBSv6Hora+WRxv58= CjuyvGEHcSn7860a6yvIb6sLSEE= Q973ONH3kBp0tyBEy2h5J78Mrjg= G4q1ugzl5mM1xE9Wxyzevu6JB+M= 0GCmQo0daSi2/pqQuIRhYWbW6lk= igmXj/EJZhF6GH0xFrbNGwojmx4= Lqb+A8s0WInDfI5fYlmrSx9QEaU= ukWFUYQUpI0btoZU+USn4FjgQkg= XMite/FuGUZ+4DHIikZwrlGV6fA= 79IFwv0C40oPrhucou1uA6DC1RI= OoA4Z9AuWLA63EMtSC/V6ZU9qgw= x2v5wd8/Skv+UtDnwS5/F27XMxc= nzXpJoD/SY/HaQ+j1P4/pDyDfbQ= Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= RxDnM7pIw/ahE/QBEDu7T14vtTs= HB8NuzkdJne0JnuamlIzyVfG2z4= /RsVEYVgVIkSjV+EtQuU7JX6dIY= uoHBJFmwhkbiP8wxUin0sZRRl8c= 9LlLzFVP/IbL/LcZtLU7W/WJuXI= sptDPr3Ix33X6DX8v6cIDLD/zk0= pvpJA5sq72L2h76KosSqrJ2IccM= qF6kM++zYvuIkL97v/RpKnwOR10= tYu+dbhQn5Jt+oUv1QmBQz+Z4Mk= o4IF1hl0/rSoqWdSZjOKE4MHFjM= Euqnbrbiv6WcHygsjJQdaZ1rnhg= T0Kj3BI+iG7hOIjh52aUMxjy2vY= RPE7nl0nzHl50NxeKWVlHlj0EEc= 7CUoh11FVhxOsS+h3YMv9zT8QAI= f5cvDgg9R+ZZkGkfvf3EI947ciA= laQxW+BBeJINbRrZtau+U15+v7c= KRm16yawSU2JFWabmZP+Z4VVllM= H/8iIA3bdc3RmHv6e6466sm8A4k= SqrTdaO1Y5GdnwvZBirZfRUnteI= uyRz7dsU+AM3TNmwz2kmeP9U+OA= wJ8AXedwlI+rgqL6jyk8IsQ8lzM= CLa7o0IwRfen+iyqOmlpKhjqAJg= 3dL9L+9O6pMj9teadg4abB/3n2E= nvXVohM9V8Y+LBy840FJ5xMZrOM= hrpJ3syhXM9TxBwdAWZcTYgV1MM= V8wTrpMKuyusSnj0DQUMT3AGjEM= +pTwj7vLxN5lirAmjjLZFLgcAIM= L/ezmiWj+8oAMQBf/H3xY12Tens= gNMERW7vBJ5oy0+D5SHS3lJwELE= dQbW0x0SHjC6bYCIyGZgDYxSPEc= evQmFIytUm7bsb+yuZJVfaz3lp4= XQO24StkYHcztVq6ahPu5A0nO2I= KtYcXkgaXTfO7spDy/S3Zqu5+DQ= d7YdTQNJGO03J/WSHg33UUwcLdU= wGQE3O3P2kijozE1QPKz8pdNszQ= ookgwXeQg4dQaa4byxIjCl6r61k= DL6gFomghn24jmaE6CBpvXe7C6k= 5EAOeMjGjcl9HrYrkUHpxzX2ZpM= FxMSGnhcpF1/OxJmfRXaS2a37Bo= J9KhyxiHDUbMsQsnkTAcNgru350= cRU3xcDmjFTdAqKX4QDnvPvWuIU= implementation_defined boost/url/grammar/alnum_chars.hpp include/boost/url/grammar/alnum_chars.hpp 19 1 boost/url/grammar/alpha_chars.hpp include/boost/url/grammar/alpha_chars.hpp 19 1 boost/url/grammar/charset.hpp include/boost/url/grammar/charset.hpp 29 1 boost/url/grammar/charset.hpp include/boost/url/grammar/charset.hpp 206 1 boost/url/grammar/ci_string.hpp include/boost/url/grammar/ci_string.hpp 252 1 boost/url/grammar/ci_string.hpp include/boost/url/grammar/ci_string.hpp 289 1 boost/url/grammar/ci_string.hpp include/boost/url/grammar/ci_string.hpp 328 1 boost/url/grammar/dec_octet_rule.hpp include/boost/url/grammar/dec_octet_rule.hpp 20 1 boost/url/grammar/digit_chars.hpp include/boost/url/grammar/digit_chars.hpp 19 1 boost/url/grammar/type_traits.hpp include/boost/url/grammar/type_traits.hpp 21 1 boost/url/grammar/delim_rule.hpp include/boost/url/grammar/delim_rule.hpp 25 1 boost/url/grammar/delim_rule.hpp include/boost/url/grammar/delim_rule.hpp 89 1 boost/url/grammar/hexdig_chars.hpp include/boost/url/grammar/hexdig_chars.hpp 19 1 boost/url/grammar/not_empty_rule.hpp include/boost/url/grammar/not_empty_rule.hpp 22 1 boost/url/grammar/parse.hpp include/boost/url/grammar/parse.hpp 69 1 boost/url/grammar/optional_rule.hpp include/boost/url/grammar/optional_rule.hpp 26 1 boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 29 1 boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 34 1 boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 411 1 boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 420 1 boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 540 1 boost/url/grammar/detail/recycled.hpp include/boost/url/grammar/detail/recycled.hpp 18 1 boost/url/grammar/token_rule.hpp include/boost/url/grammar/token_rule.hpp 25 1 boost/url/grammar/tuple_rule.hpp include/boost/url/grammar/tuple_rule.hpp 28 1 boost/url/grammar/tuple_rule.hpp include/boost/url/grammar/tuple_rule.hpp 144 1 boost/url/grammar/variant_rule.hpp include/boost/url/grammar/variant_rule.hpp 24 1 boost/url/grammar/vchars.hpp include/boost/url/grammar/vchars.hpp 19 1 boost/url/grammar/all_chars.hpp include/boost/url/grammar/all_chars.hpp 19 1 namespace kjqcso5U9E4PFvl5kQX9ptGH8vA= implementation-defined 1HiiaUSr2qeoadbVYr8/BZxU47k= LRfE6XJSvL3V5ROAZvkYO4H/JAU= nRXavJqZzPf3zVFXWgsPc/IdjN8= PecAmXu5iFbTP95XO6HABBapM0M= aZ8NmGk2LhJ7q/tOUwi0dMSLAPY= 3CTA0y/pdHpybn8r5XIQDF7OBlE= 221l+sWJpD23An4Nsc351qg0OBk= d4OeqgdLPPZtBxcOd4SVe7om3SY= rozFn9EUSvD+OQ01EGPOx42b3T4= OnCcxBqYA2CnO6oQF7zOSRE6mo8= Mn+TpHAfUsKvpUzJ4XXH4KRW+Hw= HxXn4S3XY1ehyjJnmQaLixjJWW4= RzrXifCkxfQaJRtdGmnkdmkNNCk= thD44DGIe9GW1wf4LsqenuROJj0= 0Ut3sHh6/eonI4BcjmvoRJSvnu0= dpB1sUMR76vF8FCDfSaw4s1Ak0c= F4PN1oLk/eYanladpXAuMnkZIuw= 7Q7zhRx23P+FJ7L7QnHWo4R/dFY= T56AU5rfLjzDT59R+kMpH1selCY= J8dRb4F9BB1DL+D9Zt9RR+ub9l0= 9s5SPyGDH/DN4NyzMZQe1+pDd5c= J5kxsYNgICiyE+NSIa2FMMmE+PI= DhWhEpk9CuLc798VTS0BKCR2OWc= m+FYUn7TLf2kNtSNExDzwqrsSB4= nWoWNVw77zLQ6OOna6+pGGaTIdo= h8EW/tdUnEu5iJrF1YVO3fGWKNg= 3dzyJ9uJweYXT1VXLoYXSVyuPqg= aligned_storage_impl boost/url/grammar/detail/recycled.hpp include/boost/url/grammar/detail/recycled.hpp 20 1 record LRfE6XJSvL3V5ROAZvkYO4H/JAU= implementation-defined kjqcso5U9E4PFvl5kQX9ptGH8vA= struct all_chars_t boost/url/grammar/all_chars.hpp include/boost/url/grammar/all_chars.hpp 21 1 record nRXavJqZzPf3zVFXWgsPc/IdjN8= implementation-defined kjqcso5U9E4PFvl5kQX9ptGH8vA= struct alnum_chars_t boost/url/grammar/alnum_chars.hpp include/boost/url/grammar/alnum_chars.hpp 20 1 record PecAmXu5iFbTP95XO6HABBapM0M= implementation-defined kjqcso5U9E4PFvl5kQX9ptGH8vA= struct alpha_chars_t boost/url/grammar/alpha_chars.hpp include/boost/url/grammar/alpha_chars.hpp 20 1 record aZ8NmGk2LhJ7q/tOUwi0dMSLAPY= implementation-defined kjqcso5U9E4PFvl5kQX9ptGH8vA= struct ch_delim_rule boost/url/grammar/delim_rule.hpp include/boost/url/grammar/delim_rule.hpp 26 1 record 3CTA0y/pdHpybn8r5XIQDF7OBlE= implementation-defined kjqcso5U9E4PFvl5kQX9ptGH8vA= struct charset_ref boost/url/grammar/charset.hpp include/boost/url/grammar/charset.hpp 207 1 record 221l+sWJpD23An4Nsc351qg0OBk= implementation-defined kjqcso5U9E4PFvl5kQX9ptGH8vA= struct ci_equal boost/url/grammar/ci_string.hpp include/boost/url/grammar/ci_string.hpp 290 1 record d4OeqgdLPPZtBxcOd4SVe7om3SY= implementation-defined kjqcso5U9E4PFvl5kQX9ptGH8vA= struct ci_hash boost/url/grammar/ci_string.hpp include/boost/url/grammar/ci_string.hpp 253 1 record rozFn9EUSvD+OQ01EGPOx42b3T4= implementation-defined kjqcso5U9E4PFvl5kQX9ptGH8vA= struct ci_less boost/url/grammar/ci_string.hpp include/boost/url/grammar/ci_string.hpp 329 1 record OnCcxBqYA2CnO6oQF7zOSRE6mo8= implementation-defined kjqcso5U9E4PFvl5kQX9ptGH8vA= struct cs_delim_rule boost/url/grammar/delim_rule.hpp include/boost/url/grammar/delim_rule.hpp 90 1 record Mn+TpHAfUsKvpUzJ4XXH4KRW+Hw= implementation-defined kjqcso5U9E4PFvl5kQX9ptGH8vA= struct dec_octet_rule_t boost/url/grammar/dec_octet_rule.hpp include/boost/url/grammar/dec_octet_rule.hpp 21 1 record HxXn4S3XY1ehyjJnmQaLixjJWW4= implementation-defined kjqcso5U9E4PFvl5kQX9ptGH8vA= struct digit_chars_t boost/url/grammar/digit_chars.hpp include/boost/url/grammar/digit_chars.hpp 20 1 record RzrXifCkxfQaJRtdGmnkdmkNNCk= implementation-defined kjqcso5U9E4PFvl5kQX9ptGH8vA= struct hexdig_chars_t boost/url/grammar/hexdig_chars.hpp include/boost/url/grammar/hexdig_chars.hpp 20 1 record thD44DGIe9GW1wf4LsqenuROJj0= implementation-defined kjqcso5U9E4PFvl5kQX9ptGH8vA= struct is_charset boost/url/grammar/charset.hpp include/boost/url/grammar/charset.hpp 31 1 record 0Ut3sHh6/eonI4BcjmvoRJSvnu0= implementation-defined kjqcso5U9E4PFvl5kQX9ptGH8vA= struct identifier lTUoA6OkHYQaJQjJcb3WGNd183s= false_type identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std is_range_rule boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 50 1 record dpB1sUMR76vF8FCDfSaw4s1Ak0c= implementation-defined kjqcso5U9E4PFvl5kQX9ptGH8vA= struct identifier lTUoA6OkHYQaJQjJcb3WGNd183s= false_type identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std is_rule boost/url/grammar/type_traits.hpp include/boost/url/grammar/type_traits.hpp 23 1 record F4PN1oLk/eYanladpXAuMnkZIuw= implementation-defined kjqcso5U9E4PFvl5kQX9ptGH8vA= struct identifier lTUoA6OkHYQaJQjJcb3WGNd183s= false_type identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std not_empty_rule_t boost/url/grammar/not_empty_rule.hpp include/boost/url/grammar/not_empty_rule.hpp 23 1 record 7Q7zhRx23P+FJ7L7QnHWo4R/dFY= implementation-defined kjqcso5U9E4PFvl5kQX9ptGH8vA= struct optional_rule_t boost/url/grammar/optional_rule.hpp include/boost/url/grammar/optional_rule.hpp 27 1 record T56AU5rfLjzDT59R+kMpH1selCY= implementation-defined kjqcso5U9E4PFvl5kQX9ptGH8vA= struct range_rule_t boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 238 5 record J8dRb4F9BB1DL+D9Zt9RR+ub9l0= implementation-defined kjqcso5U9E4PFvl5kQX9ptGH8vA= struct range_value_type boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 36 1 record 9s5SPyGDH/DN4NyzMZQe1+pDd5c= implementation-defined kjqcso5U9E4PFvl5kQX9ptGH8vA= struct rule_ref boost/url/grammar/parse.hpp include/boost/url/grammar/parse.hpp 70 1 record J5kxsYNgICiyE+NSIa2FMMmE+PI= implementation-defined kjqcso5U9E4PFvl5kQX9ptGH8vA= struct squelch_rule_t boost/url/grammar/tuple_rule.hpp include/boost/url/grammar/tuple_rule.hpp 146 1 record DhWhEpk9CuLc798VTS0BKCR2OWc= implementation-defined kjqcso5U9E4PFvl5kQX9ptGH8vA= struct specialization 6O5aQPXSgAP2cvCyb006gjh9Zpk= empty_value token_rule_t boost/url/grammar/token_rule.hpp include/boost/url/grammar/token_rule.hpp 26 1 record m+FYUn7TLf2kNtSNExDzwqrsSB4= implementation-defined kjqcso5U9E4PFvl5kQX9ptGH8vA= struct tuple_rule_t boost/url/grammar/tuple_rule.hpp include/boost/url/grammar/tuple_rule.hpp 29 1 record nWoWNVw77zLQ6OOna6+pGGaTIdo= implementation-defined kjqcso5U9E4PFvl5kQX9ptGH8vA= class variant_rule_t boost/url/grammar/variant_rule.hpp include/boost/url/grammar/variant_rule.hpp 25 1 record h8EW/tdUnEu5iJrF1YVO3fGWKNg= implementation-defined kjqcso5U9E4PFvl5kQX9ptGH8vA= class vchars_t boost/url/grammar/vchars.hpp include/boost/url/grammar/vchars.hpp 20 1 record 3dzyJ9uJweYXT1VXLoYXSVyuPqg= implementation-defined kjqcso5U9E4PFvl5kQX9ptGH8vA= struct string_token boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 479 1 namespace-alias 9V9OWFKGAdzyoTAl2TNIxHn9M/Y= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= identifier MOmWJXtSzgLTSr4XFeqs4WKGaYg= string_token identifier dnk5XPfR2OaMpCYaH3cWSxcTdyc= urls identifier +jO0pmMB/RXahxtatVUYoEwUKWs= boost aligned_storage boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 43 1 1 typedef k2EX7IarFscJBSv6Hora+WRxv58= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= code template<class T> struct aligned_storage { /// Return a pointer to the aligned storage area void* addr() noexcept; /// Return a pointer to the aligned storage area void const* addr() const noexcept; }; brief text Provides an aligned storage buffer aligned for T specialization LRfE6XJSvL3V5ROAZvkYO4H/JAU= aligned_storage_impl identifier kjqcso5U9E4PFvl5kQX9ptGH8vA= implementation_defined 1 ci_equal boost/url/grammar/ci_string.hpp include/boost/url/grammar/ci_string.hpp 326 1 1 typedef CjuyvGEHcSn7860a6yvIb6sLSEE= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= paragraph text The function object returns code text true text when two strings are equal, ignoring case. This is a suitable equality predicate for unordered containers. The function is defined only for strings containing low-ASCII characters. heading text Example 1 code boost::unordered_map< std::string, std::string, ci_hash, ci_equal > m1; std::unordered_map < std::string, std::string, ci_hash, ci_equal > m2; // (since C++20) brief text A case-insensitive equals predicate for strings see reference ci_hash Q973ONH3kBp0tyBEy2h5J78Mrjg= text , reference ci_less G4q1ugzl5mM1xE9Wxyzevu6JB+M= text . identifier d4OeqgdLPPZtBxcOd4SVe7om3SY= ci_equal identifier kjqcso5U9E4PFvl5kQX9ptGH8vA= implementation_defined 1 ci_hash boost/url/grammar/ci_string.hpp include/boost/url/grammar/ci_string.hpp 287 1 1 typedef Q973ONH3kBp0tyBEy2h5J78Mrjg= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= paragraph text The hash function is non-cryptographic and not hardened against algorithmic complexity attacks. This is a suitable hash function for unordered containers. The function is defined only for strings containing low-ASCII characters. heading text Example 1 code boost::unordered_map< std::string, std::string, ci_hash, ci_equal > m1; std::unordered_map < std::string, std::string, ci_hash, ci_equal > m2; // (since C++20) brief text A case-insensitive hash function object for strings see reference ci_equal CjuyvGEHcSn7860a6yvIb6sLSEE= text , reference ci_less G4q1ugzl5mM1xE9Wxyzevu6JB+M= text . identifier rozFn9EUSvD+OQ01EGPOx42b3T4= ci_hash identifier kjqcso5U9E4PFvl5kQX9ptGH8vA= implementation_defined 1 ci_less boost/url/grammar/ci_string.hpp include/boost/url/grammar/ci_string.hpp 365 1 1 typedef G4q1ugzl5mM1xE9Wxyzevu6JB+M= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= paragraph text The comparison algorithm implements a case-insensitive total order on the set of all ASCII strings; however, it is not a lexicographical comparison. This is a suitable predicate for ordered containers. The function is defined only for strings containing low-ASCII characters. heading text Example 1 code boost::container::map< std::string, std::string, ci_less > m1; std::map< std::string, std::string, ci_less > m2; // (since C++14) brief text A case-insensitive less predicate for strings see reference ci_equal CjuyvGEHcSn7860a6yvIb6sLSEE= text , reference ci_hash Q973ONH3kBp0tyBEy2h5J78Mrjg= text . identifier OnCcxBqYA2CnO6oQF7zOSRE6mo8= ci_less identifier kjqcso5U9E4PFvl5kQX9ptGH8vA= implementation_defined 1 is_charset boost/url/grammar/charset.hpp include/boost/url/grammar/charset.hpp 67 1 1 typedef 0GCmQo0daSi2/pqQuIRhYWbW6lk= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= paragraph text This metafunction determines if the type code text T text meets these requirements of emph text CharSet text : list paragraph text An instance of code text T text is invocable with this equivalent function signature: unordered code bool T::operator()( char ) const noexcept; heading text Example 1 paragraph text Use with code text enable_if text on the return value: code template< class CharSet > typename std::enable_if< is_charset<T>::value >::type func( CharSet const& cs ); brief text Alias for code text std::true_type text if T satisfies reference CharSet FxMSGnhcpF1/OxJmfRXaS2a37Bo= text . t-param text the type to check. T specialization 0Ut3sHh6/eonI4BcjmvoRJSvnu0= is_charset identifier kjqcso5U9E4PFvl5kQX9ptGH8vA= implementation_defined 1 is_range_rule boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 81 1 typedef igmXj/EJZhF6GH0xFrbNGwojmx4= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= specialization dpB1sUMR76vF8FCDfSaw4s1Ak0c= is_range_rule identifier kjqcso5U9E4PFvl5kQX9ptGH8vA= implementation_defined 1 is_rule boost/url/grammar/type_traits.hpp include/boost/url/grammar/type_traits.hpp 62 1 1 typedef Lqb+A8s0WInDfI5fYlmrSx9QEaU= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= paragraph text This is an alias for code text std::true_type text if code text T text meets the requirements, otherwise it is an alias for code text std::false_type text . heading text Example 1 code struct U { struct value_type; auto parse( char const*& it, char const* end) const -> system::result<value_type> }; static_assert( is_rule<U>::value, "Requirements not met" ); brief text Determine if T meets the requirements of reference Rule cRU3xcDmjFTdAqKX4QDnvPvWuIU= see reference parse laQxW+BBeJINbRrZtau+U15+v7c= text . specialization F4PN1oLk/eYanladpXAuMnkZIuw= is_rule identifier kjqcso5U9E4PFvl5kQX9ptGH8vA= implementation_defined 1 any_rule boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 101 1 boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 98 1 record ukWFUYQUpI0btoZU+USn4FjgQkg= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= class eSXVNYG05A1KWsgzhX319zWeCWE= 3iSIFyz0J9g2dpScAP8SCSqyWdc= CetLe+tEODvsXCNv9r3u0Z1c9C8= G8sR7UkiPL9e7uZiEQMTxy3mC+w= AAIL6TJ7VxLLB9/u85D022Q3mNI= 8fEJe61xfK7bJ4wtBwAig9CaU6w= value_type boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 105 5 typedef eSXVNYG05A1KWsgzhX319zWeCWE= regular ukWFUYQUpI0btoZU+USn4FjgQkg= identifier T 1 any_rule boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 107 5 boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 108 5 boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 109 5 boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 114 5 boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 118 5 overloads 3iSIFyz0J9g2dpScAP8SCSqyWdc= regular ukWFUYQUpI0btoZU+USn4FjgQkg= brief text Constructors constructor 5lY6gkU+PzpE4idKVuipfi4JFaU= QEO543HXiblfgNZa9WG2fhw94Zg= 43Trr3ot5rfOeBKXD/LhU5zzDm8= 4RjyG3rJ4heqMLZdfTFQN2o14dA= MgI8CrnyCSSoREuZXQEutcr2jf0= identifier void any_rule boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 107 5 function 5lY6gkU+PzpE4idKVuipfi4JFaU= regular ukWFUYQUpI0btoZU+USn4FjgQkg= brief text Default constructor identifier void constructor 1 any_rule boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 108 5 function QEO543HXiblfgNZa9WG2fhw94Zg= regular ukWFUYQUpI0btoZU+USn4FjgQkg= brief text Copy constructor param text The object to copy construct from other identifier void 1 identifier ukWFUYQUpI0btoZU+USn4FjgQkg= any_rule other constructor 1 any_rule boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 109 5 function 43Trr3ot5rfOeBKXD/LhU5zzDm8= regular ukWFUYQUpI0btoZU+USn4FjgQkg= brief text Move constructor param text The object to move construct from other identifier void identifier ukWFUYQUpI0btoZU+USn4FjgQkg= any_rule other constructor 1 any_rule boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 114 5 function 4RjyG3rJ4heqMLZdfTFQN2o14dA= regular ukWFUYQUpI0btoZU+USn4FjgQkg= brief text Construct from code text R param text The object to copy construct from next identifier void 1 identifier R next constructor 1 any_rule boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 118 5 function MgI8CrnyCSSoREuZXQEutcr2jf0= regular ukWFUYQUpI0btoZU+USn4FjgQkg= identifier void 1 identifier R0 first 1 identifier R1 next constructor 1 ~any_rule boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 112 5 function CetLe+tEODvsXCNv9r3u0Z1c9C8= regular ukWFUYQUpI0btoZU+USn4FjgQkg= brief text Destructor identifier void destructor 1 operator= boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 110 5 boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 111 5 overloads G8sR7UkiPL9e7uZiEQMTxy3mC+w= regular ukWFUYQUpI0btoZU+USn4FjgQkg= brief text Assignment operators normal zd5NqagltD9oUr4lhLe6lO2KQmU= bpJPZZHuzglAmDEa16LS6TSanYE= identifier ukWFUYQUpI0btoZU+USn4FjgQkg= any_rule operator= boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 110 5 function zd5NqagltD9oUr4lhLe6lO2KQmU= regular ukWFUYQUpI0btoZU+USn4FjgQkg= brief text Copy assignment operator returns text Reference to the current object param text The object to copy assign from other identifier ukWFUYQUpI0btoZU+USn4FjgQkg= any_rule 1 identifier ukWFUYQUpI0btoZU+USn4FjgQkg= any_rule other normal 1 operator= boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 111 5 function bpJPZZHuzglAmDEa16LS6TSanYE= regular ukWFUYQUpI0btoZU+USn4FjgQkg= brief text Move assignment operator returns text Reference to the current object param text The object to move assign from other identifier ukWFUYQUpI0btoZU+USn4FjgQkg= any_rule identifier ukWFUYQUpI0btoZU+USn4FjgQkg= any_rule other normal 1 first boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 123 5 function AAIL6TJ7VxLLB9/u85D022Q3mNI= regular ukWFUYQUpI0btoZU+USn4FjgQkg= specialization O+YzwnquzbCEPErxi2iuhXKphsk= result identifier LWQB+dn+7lsRKPzx/twz66ZcOWI= system 1 identifier char it 1 identifier char end normal 1 1 next boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 128 5 function 8fEJe61xfK7bJ4wtBwAig9CaU6w= regular ukWFUYQUpI0btoZU+USn4FjgQkg= specialization O+YzwnquzbCEPErxi2iuhXKphsk= result identifier LWQB+dn+7lsRKPzx/twz66ZcOWI= system 1 identifier char it 1 identifier char end normal 1 1 literal_rule boost/url/grammar/literal_rule.hpp include/boost/url/grammar/literal_rule.hpp 45 1 1 record XMite/FuGUZ+4DHIikZwrlGV6fA= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= paragraph text If there is no more input, or if the end of the input is reached, and a prefix of the literal matches exactly, the error returned is reference error::need_more a/THTSv6k7njvbh+81BNyu1ppl8= text . heading text Value Type 1 code using value_type = core::string_view; heading text Example 1 paragraph text Rules are used with the function reference parse qlxK9wNfX5MDpvVkZgw2FDLygsg= text . code system::result< core::string_view > rv = parse( "HTTP", literal_rule( "HTTP" ) ); brief text Match a string literal exactly see reference delim_rule qF6kM++zYvuIkL97v/RpKnwOR10= text , reference parse qlxK9wNfX5MDpvVkZgw2FDLygsg= text . class UahLEcXGmRVOh/eXbc0zmLPXzvY= wqG7oeAarOkPxdQp282siLuYsgM= qlxK9wNfX5MDpvVkZgw2FDLygsg= value_type boost/url/grammar/literal_rule.hpp include/boost/url/grammar/literal_rule.hpp 61 5 typedef UahLEcXGmRVOh/eXbc0zmLPXzvY= regular XMite/FuGUZ+4DHIikZwrlGV6fA= identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core 1 literal_rule boost/url/grammar/literal_rule.hpp include/boost/url/grammar/literal_rule.hpp 63 5 function wqG7oeAarOkPxdQp282siLuYsgM= regular XMite/FuGUZ+4DHIikZwrlGV6fA= brief text Construct from code text char param text The value to construct from s identifier void 1 identifier char s constructor 1 parse boost/url/grammar/literal_rule.hpp include/boost/url/grammar/literal_rule.hpp 72 5 function qlxK9wNfX5MDpvVkZgw2FDLygsg= regular XMite/FuGUZ+4DHIikZwrlGV6fA= specialization O+YzwnquzbCEPErxi2iuhXKphsk= result identifier LWQB+dn+7lsRKPzx/twz66ZcOWI= system 1 identifier char it 1 identifier char end normal 1 1 lut_chars boost/url/grammar/lut_chars.hpp include/boost/url/grammar/lut_chars.hpp 64 1 1 record 79IFwv0C40oPrhucou1uA6DC1RI= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= paragraph text The characters defined by instances of this set are provided upon construction. The code text constexpr text implementation allows these to become compile-time constants. heading text Example 1 paragraph text Character sets are used with rules and the functions reference find_if tYu+dbhQn5Jt+oUv1QmBQz+Z4Mk= text and reference find_if_not o4IF1hl0/rSoqWdSZjOKE4MHFjM= text . code constexpr lut_chars vowel_chars = "AEIOU" "aeiou"; system::result< core::string_view > rv = parse( "Aiea", token_rule( vowel_chars ) ); brief text A set of characters see reference find_if tYu+dbhQn5Jt+oUv1QmBQz+Z4Mk= text , reference find_if_not o4IF1hl0/rSoqWdSZjOKE4MHFjM= text , reference parse laQxW+BBeJINbRrZtau+U15+v7c= text , reference token_rule CLa7o0IwRfen+iyqOmlpKhjqAJg= text . class KbWXaWStQylfq+aBjJBcqbkLqLk= k6doPHbyAURLC4MsxIlNkMfobW8= zdfpEKtj3/TfXjBPPFuC5J+8N+I= 7CUoh11FVhxOsS+h3YMv9zT8QAI= RPE7nl0nzHl50NxeKWVlHlj0EEc= lut_chars boost/url/grammar/lut_chars.hpp include/boost/url/grammar/lut_chars.hpp 157 5 1 overloads KbWXaWStQylfq+aBjJBcqbkLqLk= regular 79IFwv0C40oPrhucou1uA6DC1RI= brief text Constructors param text A character. ch param text A null-terminated string. s param text The function object to use for determining membership in the character set. pred constructor eegCO1z+S7KSG1awJXK1jo+q44o= dIJTwI3DskrTCuyIE1Tn2JQ8OaQ= LY5h54qZwduQj4g6AIkddcwQAQ0= identifier void lut_chars boost/url/grammar/lut_chars.hpp include/boost/url/grammar/lut_chars.hpp 157 5 1 function eegCO1z+S7KSG1awJXK1jo+q44o= regular 79IFwv0C40oPrhucou1uA6DC1RI= paragraph text This function constructs a character set which has as a single member, the character code text ch text . heading text Example 1 code constexpr lut_chars asterisk( '*' ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Constructor param text A character. ch identifier void identifier char ch constructor 1 lut_chars boost/url/grammar/lut_chars.hpp include/boost/url/grammar/lut_chars.hpp 188 5 1 function dIJTwI3DskrTCuyIE1Tn2JQ8OaQ= regular 79IFwv0C40oPrhucou1uA6DC1RI= paragraph text This function constructs a character set which has as members, all of the characters present in the null-terminated string code text s text . heading text Example 1 code constexpr lut_chars digits = "0123456789"; heading text Complexity 1 paragraph text Linear in code text ::strlen(s) text , or constant if code text s text is a constant expression. heading text Exception Safety 1 paragraph text Throws nothing. brief text Constructor param text A null-terminated string. s identifier void 1 identifier char s constructor 1 lut_chars boost/url/grammar/lut_chars.hpp include/boost/url/grammar/lut_chars.hpp 227 5 1 function LY5h54qZwduQj4g6AIkddcwQAQ0= regular 79IFwv0C40oPrhucou1uA6DC1RI= paragraph text This function constructs a character set which has as members, every value of code text char ch text for which the expression code text pred(ch) text returns code text true text . heading text Example 1 code struct is_digit { constexpr bool operator()(char c ) const noexcept { return c >= '0' && c <= '9'; } }; constexpr lut_chars digits( is_digit{} ); heading text Complexity 1 paragraph text Linear in code text pred text , or constant if code text pred(ch) text is a constant expression. heading text Exception Safety 1 paragraph text Throws nothing. brief text Constructor. param text The function object to use for determining membership in the character set. pred identifier void 1 identifier Pred pred constructor 1 operator() boost/url/grammar/lut_chars.hpp include/boost/url/grammar/lut_chars.hpp 257 5 1 overloads k6doPHbyAURLC4MsxIlNkMfobW8= regular 79IFwv0C40oPrhucou1uA6DC1RI= brief text Return true if ch is in the character set. operator()(unsigned char) const returns code text true text if code text ch text is in the set. param text The character to test. ch normal 9hXLW55aN05cJRJ5T8t2c7RX714= /uucGiIb78jYPcEaG/dn0be1qIM= identifier bool operator() boost/url/grammar/lut_chars.hpp include/boost/url/grammar/lut_chars.hpp 266 5 1 function 9hXLW55aN05cJRJ5T8t2c7RX714= regular 79IFwv0C40oPrhucou1uA6DC1RI= paragraph text This function returns true if the character code text ch text is in the set, otherwise it returns false. heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return true if ch is in the character set. operator()(unsigned char) const returns code text true text if code text ch text is in the set. param text The character to test. ch identifier bool identifier char ch normal 1 1 operator() boost/url/grammar/lut_chars.hpp include/boost/url/grammar/lut_chars.hpp 257 5 1 function /uucGiIb78jYPcEaG/dn0be1qIM= regular 79IFwv0C40oPrhucou1uA6DC1RI= paragraph text This function returns true if the character code text ch text is in the set, otherwise it returns false. heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return true if ch is in the character set. returns code text true text if code text ch text is in the set. param text The character to test. ch identifier bool identifier unsigned char ch normal 1 1 operator~ boost/url/grammar/lut_chars.hpp include/boost/url/grammar/lut_chars.hpp 372 5 1 function zdfpEKtj3/TfXjBPPFuC5J+8N+I= regular 79IFwv0C40oPrhucou1uA6DC1RI= paragraph text This function returns a new character set which contains all of the characters that are not in code text *this text . heading text Example 1 paragraph text This statement declares a character set containing everything but vowels: code constexpr lut_chars not_vowels = ~lut_chars( "AEIOU" "aeiou" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return a new character set which is the complement of another character set. returns text The new character set. identifier 79IFwv0C40oPrhucou1uA6DC1RI= lut_chars normal 1 1 range boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 205 1 1 record OoA4Z9AuWLA63EMtSC/V6ZU9qgw= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= paragraph text Objects of this type are forward ranges returned when parsing using the reference range_rule KRm16yawSU2JFWabmZP+Z4VVllM= text . Iteration is performed by re-parsing the underlying character buffer. Ownership of the buffer is not transferred; the caller is responsible for ensuring that the lifetime of the buffer extends until it is no longer referenced by the range. paragraph text The implementation may type-erase the rule responsible for iterating the underlying character buffer. Objects of type code text range text are intended to be used ephemerally. That is, for short durations such as within a function scope. If it is necessary to store the range for a long period of time or with static storage duration, it is necessary to copy the contents to an object of a different type. brief text A forward range of parsed elements t-param text The value type of the range T t-param text The implementation used to iterate the range. The default is a type-erased rule. RangeRule see reference parse laQxW+BBeJINbRrZtau+U15+v7c= text , reference range_rule KRm16yawSU2JFWabmZP+Z4VVllM= text . class Qkk60y6BdPTEdgcmlDHG43l3UR4= sPsyUTkTqCMdM1PczRMrkqBNdnA= NXBPA8WMaxSdaATvPq81HscHhuM= 1M7gEryD83oDA0FWx5Ez2eaVphk= s0XkXAxBJSHOSQ5XTAzI5197t5I= INWEsPrAr9SmLB0fR3ON/TYZaqg= DCFbYSDgd3qrd3M0/AM51T3m+lY= mTZEKmTQdpPFhT0c4dvngHkHzqg= VB8Qv5mDP/X85CBHJ8qe+VpplSA= QdKliwfH19zBSTQlk2xAldksn8A= 2pJZAizmYpnPb/LrdNMAwhqCDEw= NgBdruI82B0eMjUIt+p5Wl9BG8A= S+QwuRZkM6HchbWuzoJtfuMBtOk= rSdCFdxXiQcXTGNaerrl9URX2mc= zgFOjeWhzIh1tx3Cvat6aYCHD64= A2quTps3flTzoabfH7FFBhN0i/Q= const_iterator boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 283 5 1 typedef Qkk60y6BdPTEdgcmlDHG43l3UR4= regular OoA4Z9AuWLA63EMtSC/V6ZU9qgw= brief text A constant, forward iterator to elements of the range identifier mTZEKmTQdpPFhT0c4dvngHkHzqg= iterator 1 const_reference boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 263 5 1 typedef sPsyUTkTqCMdM1PczRMrkqBNdnA= regular OoA4Z9AuWLA63EMtSC/V6ZU9qgw= brief text The type of each element of the range 1 identifier T 1 difference_type boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 275 5 1 typedef NXBPA8WMaxSdaATvPq81HscHhuM= regular OoA4Z9AuWLA63EMtSC/V6ZU9qgw= brief text The type used to represent signed integers identifier EH4n8sIj03HafoTNn2U36T1P+Hc= ptrdiff_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std 1 pointer boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 267 5 1 typedef 1M7gEryD83oDA0FWx5Ez2eaVphk= regular OoA4Z9AuWLA63EMtSC/V6ZU9qgw= brief text Provided for compatibility, unused 1 identifier void 1 reference boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 259 5 1 typedef s0XkXAxBJSHOSQ5XTAzI5197t5I= regular OoA4Z9AuWLA63EMtSC/V6ZU9qgw= brief text The type of each element of the range 1 identifier T 1 size_type boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 271 5 1 typedef INWEsPrAr9SmLB0fR3ON/TYZaqg= regular OoA4Z9AuWLA63EMtSC/V6ZU9qgw= brief text The type used to represent unsigned integers identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std 1 value_type boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 255 5 1 typedef DCFbYSDgd3qrd3M0/AM51T3m+lY= regular OoA4Z9AuWLA63EMtSC/V6ZU9qgw= brief text The type of each element of the range identifier T 1 iterator boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 279 5 1 record mTZEKmTQdpPFhT0c4dvngHkHzqg= regular OoA4Z9AuWLA63EMtSC/V6ZU9qgw= brief text A constant, forward iterator to elements of the range class specialization OoA4Z9AuWLA63EMtSC/V6ZU9qgw= range OoA4Z9AuWLA63EMtSC/V6ZU9qgw= range boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 297 5 1 boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 313 5 1 boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 328 5 1 overloads VB8Qv5mDP/X85CBHJ8qe+VpplSA= regular OoA4Z9AuWLA63EMtSC/V6ZU9qgw= brief text Constructor constructor kq5fiemabiu27FT0o2N9CrzwDJg= O0HWrGaeubbZfcGNQQ/cUspy7Zg= yGCBh4uR7oQVYy2OGTFgQUtSUcU= identifier void range boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 297 5 1 function kq5fiemabiu27FT0o2N9CrzwDJg= regular OoA4Z9AuWLA63EMtSC/V6ZU9qgw= paragraph text Default-constructed ranges have zero elements. heading text Exception Safety 1 paragraph text Throws nothing. brief text Constructor identifier void constructor 1 range boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 328 5 1 function O0HWrGaeubbZfcGNQQ/cUspy7Zg= regular OoA4Z9AuWLA63EMtSC/V6ZU9qgw= paragraph text The copy references the same underlying character buffer. Ownership is not transferred; the caller is responsible for ensuring that the lifetime of the buffer extends until it is no longer referenced. heading text Exception Safety 1 paragraph text Throws nothing. brief text Constructor param text The object to copy construct from other identifier void 1 identifier OoA4Z9AuWLA63EMtSC/V6ZU9qgw= range other constructor 1 range boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 313 5 1 function yGCBh4uR7oQVYy2OGTFgQUtSUcU= regular OoA4Z9AuWLA63EMtSC/V6ZU9qgw= paragraph text The new range references the same underlying character buffer. Ownership is not transferred; the caller is responsible for ensuring that the lifetime of the buffer extends until it is no longer referenced. The moved-from object becomes as if default-constructed. heading text Exception Safety 1 paragraph text Throws nothing. brief text Constructor param text The object to move construct from other identifier void identifier OoA4Z9AuWLA63EMtSC/V6ZU9qgw= range other constructor 1 ~range boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 287 5 1 function QdKliwfH19zBSTQlk2xAldksn8A= regular OoA4Z9AuWLA63EMtSC/V6ZU9qgw= brief text Destructor identifier void destructor 1 operator= boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 345 5 1 boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 363 5 1 overloads 2pJZAizmYpnPb/LrdNMAwhqCDEw= regular OoA4Z9AuWLA63EMtSC/V6ZU9qgw= brief text Assignment returns code text *this normal ZIDRgkF5oRXsV0dl5Zhw3u9ZdI4= bi0/hZF8PbGdkYNn7c1TbBy0KrI= identifier OoA4Z9AuWLA63EMtSC/V6ZU9qgw= range operator= boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 363 5 1 function ZIDRgkF5oRXsV0dl5Zhw3u9ZdI4= regular OoA4Z9AuWLA63EMtSC/V6ZU9qgw= paragraph text The copy references the same underlying character buffer. Ownership is not transferred; the caller is responsible for ensuring that the lifetime of the buffer extends until it is no longer referenced. heading text Exception Safety 1 paragraph text Throws nothing. brief text Assignment returns code text *this param text The object to copy assign from other identifier OoA4Z9AuWLA63EMtSC/V6ZU9qgw= range 1 identifier OoA4Z9AuWLA63EMtSC/V6ZU9qgw= range other normal 1 operator= boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 345 5 1 function bi0/hZF8PbGdkYNn7c1TbBy0KrI= regular OoA4Z9AuWLA63EMtSC/V6ZU9qgw= paragraph text After the move, this references the same underlying character buffer. Ownership is not transferred; the caller is responsible for ensuring that the lifetime of the buffer extends until it is no longer referenced. The moved-from object becomes as if default-constructed. heading text Exception Safety 1 paragraph text Throws nothing. brief text Assignment returns code text *this param text The object to move assign from other identifier OoA4Z9AuWLA63EMtSC/V6ZU9qgw= range identifier OoA4Z9AuWLA63EMtSC/V6ZU9qgw= range other normal 1 begin boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 370 5 1 function NgBdruI82B0eMjUIt+p5Wl9BG8A= regular OoA4Z9AuWLA63EMtSC/V6ZU9qgw= brief text Return an iterator to the beginning returns text An iterator to the first element identifier mTZEKmTQdpPFhT0c4dvngHkHzqg= iterator normal 1 1 empty boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 382 5 1 function S+QwuRZkM6HchbWuzoJtfuMBtOk= regular OoA4Z9AuWLA63EMtSC/V6ZU9qgw= brief text Return true if the range is empty returns code text true text if the range is empty identifier bool normal 1 1 end boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 376 5 1 function rSdCFdxXiQcXTGNaerrl9URX2mc= regular OoA4Z9AuWLA63EMtSC/V6ZU9qgw= brief text Return an iterator to the end returns text An iterator to one past the last element identifier mTZEKmTQdpPFhT0c4dvngHkHzqg= iterator normal 1 1 size boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 392 5 1 function zgFOjeWhzIh1tx3Cvat6aYCHD64= regular OoA4Z9AuWLA63EMtSC/V6ZU9qgw= brief text Return the number of elements in the range returns text The number of elements identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 1 string boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 402 5 1 function A2quTps3flTzoabfH7FFBhN0i/Q= regular OoA4Z9AuWLA63EMtSC/V6ZU9qgw= brief text Return the matching part of the string returns text A string view representing the range identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core normal 1 1 recycled boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 71 1 1 record x2v5wd8/Skv+UtDnwS5/F27XMxc= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= paragraph text Instances of this type may be used to control where recycled instances of T come from when used with reference recycled_ptr nzXpJoD/SY/HaQ+j1P4/pDyDfbQ= text . heading text Example 1 code static recycled< std::string > bin; recycled_ptr< std::string > ps( bin ); // Put the string into a known state ps->clear(); brief text A thread-safe collection of instances of T see reference recycled_ptr nzXpJoD/SY/HaQ+j1P4/pDyDfbQ= text . class eMQLSBBNJl/2Q4eW9/OxJcYh6nQ= lJDeADUMZlCfHAArDAEIoiZHv6w= nzXpJoD/SY/HaQ+j1P4/pDyDfbQ= recycled boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 86 5 1 function eMQLSBBNJl/2Q4eW9/OxJcYh6nQ= regular x2v5wd8/Skv+UtDnwS5/F27XMxc= brief text Constructor identifier void constructor 1 1 1 ~recycled boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 82 5 1 function lJDeADUMZlCfHAArDAEIoiZHv6w= regular x2v5wd8/Skv+UtDnwS5/F27XMxc= paragraph text All recycled instances of T are destroyed. Undefined behavior results if there are any reference recycled_ptr nzXpJoD/SY/HaQ+j1P4/pDyDfbQ= text which reference this recycle bin. brief text Destructor identifier void destructor 1 recycled_ptr boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 148 1 1 boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 89 5 record nzXpJoD/SY/HaQ+j1P4/pDyDfbQ= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= paragraph text This is a smart pointer container which can acquire shared ownership of an instance of code text T text upon or after construction. The instance is guaranteed to be in a valid, but unknown state. Every recycled pointer references a valid recycle bin. heading text Example 1 code static recycled< std::string > bin; recycled_ptr< std::string > ps( bin ); // Put the string into a known state ps->clear(); brief text A pointer to a shared instance of T t-param text the type of object to acquire, which must be emph text DefaultConstructible text . T class ePfG6yvLs2ScIX/ZU6NlsMez3OQ= fYaAa1Ns5xDYnbRDkpXg/vguMV8= sdt+bfXmaSFfWFxHWFts5K5fm0o= H7LYt37AqVfhsZjHCGDQEIkojqM= lrCX94ZLdGMotI0oIpKu0tiNZG4= 0uyawsPRLLGbFiuk1Ft9+8socK0= Zim1jhHRKp//mieYxy7DHKnHoZo= pYBSGDOuJ0hkPvlhNnyZKqqXi1E= TET7zmntHAKhMQ1mb9MUGLiWwWI= wqJYmH/gBkRUi2qhQzT8ZrukOu0= 8IZZXERbpllK6bZomLlMb2gvxwg= specialization x2v5wd8/Skv+UtDnwS5/F27XMxc= recycled x2v5wd8/Skv+UtDnwS5/F27XMxc= recycled_ptr boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 208 5 1 boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 242 5 1 boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 271 5 1 boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 300 5 1 boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 321 5 1 boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 341 5 1 overloads ePfG6yvLs2ScIX/ZU6NlsMez3OQ= regular nzXpJoD/SY/HaQ+j1P4/pDyDfbQ= brief text Constructor param text The pointer to copy other param text The recycle bin to use bin see reference recycled x2v5wd8/Skv+UtDnwS5/F27XMxc= text . see reference acquire H7LYt37AqVfhsZjHCGDQEIkojqM= text , reference recycled x2v5wd8/Skv+UtDnwS5/F27XMxc= text , reference release wqJYmH/gBkRUi2qhQzT8ZrukOu0= text . constructor VjHmeTbHs8hQENj7BgAnhmRWQdw= q97hoMIS89HKG50UKgXOeADtEnc= 84CPyDVgw9SFOH0d5xvXZ3GEJ80= XjR852OKdk+x5OgFgWVrVznZ9p4= iyelQG1lI7NxpWmpa7HCkVGiYrY= rIq1sfrqMSv358hn+r/zNp97Brg= identifier void recycled_ptr boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 271 5 1 function VjHmeTbHs8hQENj7BgAnhmRWQdw= regular nzXpJoD/SY/HaQ+j1P4/pDyDfbQ= paragraph text Upon construction, this acquires exclusive access to an object of type code text T text which is either recycled from a global recycle bin, or newly allocated. The object is in an unknown but valid state. heading text Example 1 code recycled_ptr< std::string > ps; // Put the string into a known state ps->clear(); heading text Postconditions 1 code &this->bin() != nullptr && ! this->empty() brief text Constructor see reference recycled x2v5wd8/Skv+UtDnwS5/F27XMxc= text . identifier void constructor 1 recycled_ptr boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 321 5 1 function q97hoMIS89HKG50UKgXOeADtEnc= regular nzXpJoD/SY/HaQ+j1P4/pDyDfbQ= paragraph text If code text other text references an object, the newly constructed pointer acquires shared ownership. Otherwise this is empty. The new pointer references the same recycle bin as code text other text . heading text Postconditions 1 code &this->bin() == &other->bin() && this->get() == other.get() heading text Exception Safety 1 paragraph text Throws nothing. brief text Constructor param text The pointer to copy other identifier void 1 identifier nzXpJoD/SY/HaQ+j1P4/pDyDfbQ= recycled_ptr other constructor 1 recycled_ptr boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 341 5 1 function 84CPyDVgw9SFOH0d5xvXZ3GEJ80= regular nzXpJoD/SY/HaQ+j1P4/pDyDfbQ= paragraph text If code text other text references an object, ownership is transferred including a reference to the recycle bin. After the move, the moved-from object is empty. heading text Postconditions 1 code &this->bin() == &other->bin() && ! this->empty() && other.empty() heading text Exception Safety 1 paragraph text Throws nothing. brief text Constructor param text The pointer to move from other identifier void identifier nzXpJoD/SY/HaQ+j1P4/pDyDfbQ= recycled_ptr other constructor 1 recycled_ptr boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 300 5 1 function XjR852OKdk+x5OgFgWVrVznZ9p4= regular nzXpJoD/SY/HaQ+j1P4/pDyDfbQ= paragraph text After construction, this is empty and refers to a global recycle bin. heading text Example 1 code recycled_ptr< std::string > ps( nullptr ); // Acquire a string and put it into a known state ps->acquire(); ps->clear(); heading text Postconditions 1 code &this->bin() != nullptr && this->empty() heading text Exception Safety 1 paragraph text Throws nothing. brief text Constructor param text The object to construct from value see reference acquire H7LYt37AqVfhsZjHCGDQEIkojqM= text , reference recycled x2v5wd8/Skv+UtDnwS5/F27XMxc= text , reference release wqJYmH/gBkRUi2qhQzT8ZrukOu0= text . identifier void identifier sglnAAn3Uh63NjGq0A1qyc9lE+k= nullptr_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std value constructor 1 recycled_ptr boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 208 5 1 function iyelQG1lI7NxpWmpa7HCkVGiYrY= regular nzXpJoD/SY/HaQ+j1P4/pDyDfbQ= paragraph text Upon construction, this acquires exclusive access to an object of type code text T text which is either recycled from the specified bin, or newly allocated. The object is in an unknown but valid state. heading text Example 1 code static recycled< std::string > bin; recycled_ptr< std::string > ps( bin ); // Put the string into a known state ps->clear(); heading text Postconditions 1 code &this->bin() == &bin && ! this->empty() brief text Constructor param text The recycle bin to use bin see reference recycled x2v5wd8/Skv+UtDnwS5/F27XMxc= text . identifier void specialization x2v5wd8/Skv+UtDnwS5/F27XMxc= recycled bin constructor 1 recycled_ptr boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 242 5 1 function rIq1sfrqMSv358hn+r/zNp97Brg= regular nzXpJoD/SY/HaQ+j1P4/pDyDfbQ= paragraph text After construction, this is empty and refers to the specified recycle bin. heading text Example 1 code static recycled< std::string > bin; recycled_ptr< std::string > ps( bin, nullptr ); // Acquire a string and put it into a known state ps->acquire(); ps->clear(); heading text Postconditions 1 code &this->bin() == &bin && this->empty() heading text Exception Safety 1 paragraph text Throws nothing. brief text Constructor param text The recycle bin to use bin see reference acquire H7LYt37AqVfhsZjHCGDQEIkojqM= text , reference recycled x2v5wd8/Skv+UtDnwS5/F27XMxc= text , reference release wqJYmH/gBkRUi2qhQzT8ZrukOu0= text . identifier void specialization x2v5wd8/Skv+UtDnwS5/F27XMxc= recycled bin identifier sglnAAn3Uh63NjGq0A1qyc9lE+k= nullptr_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std constructor 1 ~recycled_ptr boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 177 5 1 function fYaAa1Ns5xDYnbRDkpXg/vguMV8= regular nzXpJoD/SY/HaQ+j1P4/pDyDfbQ= paragraph text If this is not empty, shared ownership of the pointee is released. If this was the last reference, the object is returned to the original recycle bin. heading text Effects 1 code this->release(); brief text Destructor identifier void destructor 1 operator= boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 367 5 1 boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 395 5 1 overloads sdt+bfXmaSFfWFxHWFts5K5fm0o= regular nzXpJoD/SY/HaQ+j1P4/pDyDfbQ= brief text Assignment returns code text *this param text The pointer to copy from other normal kPCMjQfQ6LeMUk9wpxzd0pKjPR0= tN2V1SD4chb1aq2jfot9PeEVJ2g= identifier nzXpJoD/SY/HaQ+j1P4/pDyDfbQ= recycled_ptr operator= boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 395 5 1 function kPCMjQfQ6LeMUk9wpxzd0pKjPR0= regular nzXpJoD/SY/HaQ+j1P4/pDyDfbQ= paragraph text If code text other text references an object, this acquires shared ownership and references the same recycle bin as code text other text . The previous object if any is released. heading text Effects 1 code this->release() heading text Postconditions 1 code &this->bin() == &other->bin() && this->get() == other.get() heading text Exception Safety 1 paragraph text Throws nothing. brief text Assignment returns code text *this param text The pointer to copy from other identifier nzXpJoD/SY/HaQ+j1P4/pDyDfbQ= recycled_ptr 1 identifier nzXpJoD/SY/HaQ+j1P4/pDyDfbQ= recycled_ptr other normal 1 operator= boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 367 5 1 function tN2V1SD4chb1aq2jfot9PeEVJ2g= regular nzXpJoD/SY/HaQ+j1P4/pDyDfbQ= paragraph text If code text other text references an object, ownership is transferred including a reference to the recycle bin. After the move, the moved-from object is empty. heading text Effects 1 code this->release() heading text Postconditions 1 code &this->bin() == &other->bin() heading text Exception Safety 1 paragraph text Throws nothing. brief text Assignment returns code text *this param text The pointer to move from other identifier nzXpJoD/SY/HaQ+j1P4/pDyDfbQ= recycled_ptr identifier nzXpJoD/SY/HaQ+j1P4/pDyDfbQ= recycled_ptr other normal 1 acquire boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 499 5 1 function H7LYt37AqVfhsZjHCGDQEIkojqM= regular nzXpJoD/SY/HaQ+j1P4/pDyDfbQ= paragraph text If this references an object, it is returned. Otherwise, exclusive ownership of a new object of type code text T text is acquired and returned. heading text Postconditions 1 code not this->empty() brief text Return the referenced object returns text A reference to the object identifier T normal 1 bin boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 437 5 1 function lrCX94ZLdGMotI0oIpKu0tiNZG4= regular nzXpJoD/SY/HaQ+j1P4/pDyDfbQ= heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the referenced recycle bin returns text A reference to the recycle bin specialization x2v5wd8/Skv+UtDnwS5/F27XMxc= recycled normal 1 1 empty boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 406 5 1 function 0uyawsPRLLGbFiuk1Ft9+8socK0= regular nzXpJoD/SY/HaQ+j1P4/pDyDfbQ= heading text Exception Safety 1 paragraph text Throws nothing. brief text Return true if this does not reference an object returns code text p_ == nullptr identifier bool normal 1 1 get boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 452 5 1 function Zim1jhHRKp//mieYxy7DHKnHoZo= regular nzXpJoD/SY/HaQ+j1P4/pDyDfbQ= paragraph text If this is empty, code text nullptr text is returned. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the referenced object returns text A pointer to the object identifier T normal 1 1 operator* boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 480 5 1 function pYBSGDOuJ0hkPvlhNnyZKqqXi1E= regular nzXpJoD/SY/HaQ+j1P4/pDyDfbQ= heading text Preconditions 1 code not this->empty() brief text Return the referenced object returns text A reference to the object identifier T normal 1 1 operator-> boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 466 5 1 function TET7zmntHAKhMQ1mb9MUGLiWwWI= regular nzXpJoD/SY/HaQ+j1P4/pDyDfbQ= paragraph text If this is empty, code text nullptr text is returned. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the referenced object returns text A pointer to the object identifier T normal 1 1 release boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 516 5 1 function wqJYmH/gBkRUi2qhQzT8ZrukOu0= regular nzXpJoD/SY/HaQ+j1P4/pDyDfbQ= paragraph text If this references an object, it is released to the referenced recycle bin. The pointer continues to reference the same recycle bin. heading text Postconditions 1 code this->empty() heading text Exception Safety 1 paragraph text Throws nothing. brief text Release the referenced object identifier void normal 1 operator bool boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 424 5 1 function 8IZZXERbpllK6bZomLlMb2gvxwg= regular nzXpJoD/SY/HaQ+j1P4/pDyDfbQ= heading text Effects 1 code return ! this->empty(); heading text Exception Safety 1 paragraph text Throws nothing. brief text Return true if this references an object returns code text !this->empty() identifier bool conversion 1 1 string_view_base boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 36 1 1 record Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= paragraph text This base class is used to provide common member functions for reference types that behave like string views. This cannot be instantiated directly; instead, derive from the type and provide constructors which offer any desired preconditions and invariants. brief text Common functionality for string views class t9KlfUmMV/Lq0e5tGD9d/eCq+X0= M9nrRq55PVZTWigkof7hlGqhSQs= RPNsNnoyHwmywxuPxn4syH3bXek= foZNP6eKrZGgZPs/IKbd+dOnIuM= cmB6LiOLkFK4MPA38l8T4GLupFw= dmpIlMstDzpGYMTB6B+hurB+mqI= v2Dep12IPAm8omMGyr9KHifBXH4= gbVUBvZPpjoSvvOZqK1W2zhI5AQ= 2BMU5wYwVuaXlVqUpJvke+7MMCM= 14arRDIBq/YgI13qmWwvuybUAb4= aECoDgZjoIcUl2uioc0rf6uRMMc= +tfZtqIc5gHEEmeC/8lIgJYq4fI= b0aWgwrT3AK3/HLk/RWi8rRkN5s= nQC4Y2i6s+wheRlt1v5rJGHNugs= GPSBm+5EDtUTksx88cke1u+q9fA= EZ1FqJVEv6ucG/n1Wsn17g4MDuU= xhLRk2Z+3lJ0NKV/ZzG0ObdE4Vc= Rx+0KJ+TNUnikAkigK/WTETroXU= ZQTFPUvg322n/q0ZtEZm5OZSVFo= p3EjAR6gAGOc4ePB1QhYlzBbVGI= MQMMmX8IqIdfOm6FYDjZZidJvfc= xeK5f2DKhD4FxCGyXOyhullgYmo= 1CpIQ/DMUJBo1D7302C0yEQZuOs= HTcdnV1aiZerjYE3I6KR5Gq7cf0= OzkudhIJlNyjV0TJmLlM1RnFEVc= lnRLWv5zOOX26+6Kh57i38FcfZk= ngMWx8vbRDOd+QVk+vT2HVNj0j8= 6M2F7eR7W7DJYZJvn1ZsFaCUVzA= GyHF3a0RLJoX69ClpJOiy0xBfKs= R9sQCgYBOMnFuaSY8pJOuErwM/o= PkLaqlX95/D18ZgPiZCiz/mPUmQ= sSd4hgvdFuzpE/2bJtwpG243Apo= GCtLfDBN/T6snyktUaiy6XEF9z0= Hl4C4fbIugV95gCntPCSc1vWBh0= Qyt6qjjrJx0hZ8PQ6zdSAvGHKvU= 8YWsfJWY2hTYjFk9Llyg3aJV1hk= L0f4ee/wt58Mb/deFLDyLlyfVGY= RdDaHzncr8vavW/PrNUWQxSXPY4= W3vU/KpFnzLZaPl+o/8Hqt7NAJE= XdOsrY6qbLFskpkyLJ49siyex04= Lf2XYnjs3fR1j0dD8fAs04J7YLw= mRqi8IZOOX0xLFHe28WQ8Zwvmkg= bRcyVQ6ZJghIfxH913mNeaUsZuo= 6BCCiqqFBnxfN5d9Ki/oUcu88Ic= axqsst2fEEr0KskCuLNS6wtH26E= RhJNoEENe8RC3epEbfIY36rrknQ= aIJpv/jZ2tM+tFNkNsdGXClHwE0= y5e2cWu7aRkl+6aRLABfP+waghM= j2zlfB2FMKW7UWEt2w+csPbI5o4= hrpJ3syhXM9TxBwdAWZcTYgV1MM= evQmFIytUm7bsb+yuZJVfaz3lp4= dQbW0x0SHjC6bYCIyGZgDYxSPEc= gNMERW7vBJ5oy0+D5SHS3lJwELE= L/ezmiWj+8oAMQBf/H3xY12Tens= +pTwj7vLxN5lirAmjjLZFLgcAIM= V8wTrpMKuyusSnj0DQUMT3AGjEM= const_iterator boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 111 5 1 typedef M9nrRq55PVZTWigkof7hlGqhSQs= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text The const iterator type 1 identifier char const_pointer boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 105 5 1 typedef RPNsNnoyHwmywxuPxn4syH3bXek= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text The const pointer type 1 identifier char const_reference boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 109 5 1 typedef foZNP6eKrZGgZPs/IKbd+dOnIuM= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text The const reference type 1 identifier char const_reverse_iterator boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 115 5 1 typedef cmB6LiOLkFK4MPA38l8T4GLupFw= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text The const reverse iterator type specialization Obj4HqXdPXV9H/4fRgvui4KiGdk= reverse_iterator identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std difference_type boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 122 5 1 typedef dmpIlMstDzpGYMTB6B+hurB+mqI= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text The difference type identifier EH4n8sIj03HafoTNn2U36T1P+Hc= ptrdiff_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std iterator boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 113 5 1 typedef v2Dep12IPAm8omMGyr9KHifBXH4= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text The iterator type identifier M9nrRq55PVZTWigkof7hlGqhSQs= const_iterator pointer boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 103 5 1 typedef gbVUBvZPpjoSvvOZqK1W2zhI5AQ= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text The pointer type identifier char reference boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 107 5 1 typedef 2BMU5wYwVuaXlVqUpJvke+7MMCM= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text The reference type identifier char reverse_iterator boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 118 5 1 typedef 14arRDIBq/YgI13qmWwvuybUAb4= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text The reverse iterator type identifier cmB6LiOLkFK4MPA38l8T4GLupFw= const_reverse_iterator size_type boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 120 5 1 typedef aECoDgZjoIcUl2uioc0rf6uRMMc= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text The size type identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std traits_type boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 99 5 1 typedef +tfZtqIc5gHEEmeC/8lIgJYq4fI= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text The character traits specialization char_traits identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std value_type boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 101 5 1 typedef b0aWgwrT3AK3/HLk/RWi8rRkN5s= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text The value type identifier char at boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 331 5 1 function nQC4Y2i6s+wheRlt1v5rJGHNugs= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::at brief text Access a character returns text The character at the position param text The position to access pos identifier foZNP6eKrZGgZPs/IKbd+dOnIuM= const_reference identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos normal 1 1 back boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 355 5 1 function GPSBm+5EDtUTksx88cke1u+q9fA= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::back brief text Return the last character returns text The last character identifier foZNP6eKrZGgZPs/IKbd+dOnIuM= const_reference normal 1 1 begin boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 177 5 1 function EZ1FqJVEv6ucG/n1Wsn17g4MDuU= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::begin brief text Return an iterator to the beginning returns text An iterator to the beginning identifier M9nrRq55PVZTWigkof7hlGqhSQs= const_iterator normal 1 1 cbegin boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 199 5 1 function xhLRk2Z+3lJ0NKV/ZzG0ObdE4Vc= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::cbegin brief text Return an iterator to the beginning returns text An iterator to the beginning identifier M9nrRq55PVZTWigkof7hlGqhSQs= const_iterator normal 1 1 cend boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 210 5 1 function Rx+0KJ+TNUnikAkigK/WTETroXU= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::cend brief text Return an iterator to the end returns text An iterator to the end identifier M9nrRq55PVZTWigkof7hlGqhSQs= const_iterator normal 1 1 compare boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 413 5 1 overloads ZQTFPUvg322n/q0ZtEZm5OZSVFo= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text Return the result of comparing to another string returns text The result of the comparison param text The string to compare str param text The string to compare s param text The position to start comparing from pos1 param text The number of characters to compare n1 param text The number of characters to compare n2 param text The position to start comparing from pos2 normal IRvtO34ISMkRvDCtGybUVmg7Mpw= cNRLSdfTDXzapcGN7U2pkhe09u8= p84tStAnLdfQHeETDgnjtJoYiqE= sURljmP39tfuj1ZZWF8Ttf48S6k= wZOXO+R6A3OjQdJiNoaXo0DPlaE= 4gqP5TnZo4twWHg6MUkJBPf8gqo= identifier int compare boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 413 5 1 function IRvtO34ISMkRvDCtGybUVmg7Mpw= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::compare brief text Return the result of comparing to another string returns text The result of the comparison param text The string to compare str identifier int identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core str normal 1 1 compare boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 459 5 1 function cNRLSdfTDXzapcGN7U2pkhe09u8= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::compare brief text Return the result of comparing to another string returns text The result of the comparison param text The string to compare s identifier int 1 identifier char s normal 1 1 compare boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 428 5 1 function p84tStAnLdfQHeETDgnjtJoYiqE= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::compare brief text Return the result of comparing to another string returns text The result of the comparison param text The position to start comparing from pos1 param text The number of characters to compare n1 param text The string to compare str identifier int identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos1 identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type n1 identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core str normal 1 1 compare boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 474 5 1 function sURljmP39tfuj1ZZWF8Ttf48S6k= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::compare brief text Return the result of comparing to another string returns text The result of the comparison param text The position to start comparing from pos1 param text The number of characters to compare n1 param text The string to compare s identifier int identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos1 identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type n1 1 identifier char s normal 1 1 compare boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 490 5 1 function wZOXO+R6A3OjQdJiNoaXo0DPlaE= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::compare brief text Return the result of comparing to another string returns text The result of the comparison param text The position to start comparing from pos1 param text The number of characters to compare n1 param text The string to compare s param text The number of characters to compare n2 identifier int identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos1 identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type n1 1 identifier char s identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type n2 normal 1 1 compare boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 445 5 1 function 4gqP5TnZo4twWHg6MUkJBPf8gqo= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::compare brief text Return the result of comparing to another string returns text The result of the comparison param text The position to start comparing from pos1 param text The number of characters to compare n1 param text The string to compare str param text The position to start comparing from pos2 param text The number of characters to compare n2 identifier int identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos1 identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type n1 identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core str identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos2 identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type n2 normal 1 1 contains boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 942 5 1 overloads p3EjAR6gAGOc4ePB1QhYlzBbVGI= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text Return true if matching characters are found returns code text true text if the string contains the character, otherwise code text false returns code text true text if the string contains the characters, otherwise code text false param text The character to search for c param text The string to search for sv param text The string to search for s normal SANFmu7YhW7sQVghxqUDA0HYZXU= hKoap9FjP5AWE6/DO69KvjFf2GY= MV82Q9BS0ywf/roJrND9qK4OSDk= identifier bool contains boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 954 5 1 function SANFmu7YhW7sQVghxqUDA0HYZXU= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::contains brief text Return true if matching characters are found returns code text true text if the string contains the character, otherwise code text false param text The character to search for c identifier bool identifier char c normal 1 1 contains boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 942 5 1 function hKoap9FjP5AWE6/DO69KvjFf2GY= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::contains brief text Return true if matching characters are found returns code text true text if the string contains the characters, otherwise code text false param text The string to search for sv identifier bool identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core sv normal 1 1 contains boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 966 5 1 function MV82Q9BS0ywf/roJrND9qK4OSDk= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::contains brief text Return true if matching characters are found returns code text true text if the string contains the characters, otherwise code text false param text The string to search for s identifier bool 1 identifier char s normal 1 1 copy boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 384 5 1 function MQMMmX8IqIdfOm6FYDjZZidJvfc= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::copy brief text Copy the characters to another buffer returns text The number of characters copied param text The destination buffer s param text The number of characters to copy n param text The position to start from pos identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type identifier char s identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type n identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos 0 normal 1 1 crbegin boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 245 5 1 function xeK5f2DKhD4FxCGyXOyhullgYmo= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::crbegin brief text Return a reverse iterator to the end returns text A reverse iterator to the end identifier cmB6LiOLkFK4MPA38l8T4GLupFw= const_reverse_iterator normal 1 1 crend boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 257 5 1 function 1CpIQ/DMUJBo1D7302C0yEQZuOs= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::crend brief text Return a reverse iterator to the beginning returns text A reverse iterator to the beginning identifier cmB6LiOLkFK4MPA38l8T4GLupFw= const_reverse_iterator normal 1 1 data boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 367 5 1 function HTcdnV1aiZerjYE3I6KR5Gq7cf0= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::data brief text Return a pointer to the character buffer returns text A pointer to the character buffer identifier RPNsNnoyHwmywxuPxn4syH3bXek= const_pointer normal 1 1 empty boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 304 5 1 function OzkudhIJlNyjV0TJmLlM1RnFEVc= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::size brief text Return true if the string is empty returns code text true text if the string is empty identifier bool normal 1 1 end boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 188 5 1 function lnRLWv5zOOX26+6Kh57i38FcfZk= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::end brief text Return an iterator to the end returns text An iterator to the end identifier M9nrRq55PVZTWigkof7hlGqhSQs= const_iterator normal 1 1 ends_with boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 547 5 1 overloads ngMWx8vbRDOd+QVk+vT2HVNj0j8= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text Return true if a matching suffix exists returns code text true text if the suffix matches param text The character to search for x normal bqqpptdDDphYcnOxoQYZ8bbItrM= qZO0HQe8HcXAyHXcIQg/g3k7/ns= zfWvE3uSkk8/XX+XPIVSaZzh6Ig= identifier bool ends_with boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 560 5 1 function bqqpptdDDphYcnOxoQYZ8bbItrM= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::ends_with brief text Return true if a matching suffix exists returns code text true text if the suffix matches param text The character to search for x identifier bool identifier char x normal 1 1 ends_with boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 547 5 1 function qZO0HQe8HcXAyHXcIQg/g3k7/ns= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::ends_with brief text Return true if a matching suffix exists returns code text true text if the suffix matches param text The string to search for x identifier bool identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core x normal 1 1 ends_with boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 573 5 1 function zfWvE3uSkk8/XX+XPIVSaZzh6Ig= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::ends_with brief text Return true if a matching suffix exists returns code text true text if the suffix matches param text The string to search for x identifier bool 1 identifier char x normal 1 1 find boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 589 5 1 overloads 6M2F7eR7W7DJYZJvn1ZsFaCUVzA= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text Return the position of matching characters returns text The position of the first match param text The character to search for c param text The position to start searching from pos param text The characters to search for str param text The characters to search for s param text The number of characters to search for n normal BOuO0aTf73DXdcvqk1MTaHMpXbo= 2lfO3WOzLvG1bfwozRhCmBlrqrg= xo8geXuOyX+q7RM3qua7kwLktr0= dia+zPAAu3luYQToXoYd7W8/Wic= identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type find boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 603 5 1 function BOuO0aTf73DXdcvqk1MTaHMpXbo= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::find brief text Return the position of matching characters returns text The position of the first match param text The character to search for c param text The position to start searching from pos identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type identifier char c identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos 0 normal 1 1 find boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 589 5 1 function 2lfO3WOzLvG1bfwozRhCmBlrqrg= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::find brief text Return the position of matching characters returns text The position of the first match param text The characters to search for str param text The position to start searching from pos identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core str identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos 0 normal 1 1 find boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 632 5 1 function xo8geXuOyX+q7RM3qua7kwLktr0= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::find brief text Return the position of matching characters returns text The position of the first match param text The characters to search for s param text The position to start searching from pos identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type 1 identifier char s identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos 0 normal 1 1 find boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 618 5 1 function dia+zPAAu3luYQToXoYd7W8/Wic= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::find brief text Return the position of matching characters returns text The position of the first match param text The characters to search for s param text The position to start searching from pos param text The number of characters to search for n identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type 1 identifier char s identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type n normal 1 1 find_first_not_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 825 5 1 overloads GyHF3a0RLJoX69ClpJOiy0xBfKs= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text Return the position of the first non-match returns text The position of the first non-match param text The character to search for c param text The position to start searching from pos param text The characters to search for str param text The characters to search for s param text The number of characters to search for n normal IfcO4L0ztTwJMGHApS0AToDt5Aw= 5d938wswt4edetpV8UL9bD5KDc4= wmKQqbOIrZmJ/7Cp7VJTFNavoow= qeiTNiB98fApJrmQcyF37NoW9j4= identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type find_first_not_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 839 5 1 function IfcO4L0ztTwJMGHApS0AToDt5Aw= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::find_first_not_of brief text Return the position of the first non-match returns text The position of the first non-match param text The character to search for c param text The position to start searching from pos identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type identifier char c identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos 0 normal 1 1 find_first_not_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 825 5 1 function 5d938wswt4edetpV8UL9bD5KDc4= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::find_first_not_of brief text Return the position of the first non-match returns text The position of the first non-match param text The characters to search for str param text The position to start searching from pos identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core str identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos 0 normal 1 1 find_first_not_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 868 5 1 function wmKQqbOIrZmJ/7Cp7VJTFNavoow= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::find_first_not_of brief text Return the position of the first non-match returns text The position of the first non-match param text The characters to search for s param text The position to start searching from pos identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type 1 identifier char s identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos 0 normal 1 1 find_first_not_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 854 5 1 function qeiTNiB98fApJrmQcyF37NoW9j4= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::find_first_not_of brief text Return the position of the first non-match returns text The position of the first non-match param text The characters to search for s param text The position to start searching from pos param text The number of characters to search for n identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type 1 identifier char s identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type n normal 1 1 find_first_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 707 5 1 overloads R9sQCgYBOMnFuaSY8pJOuErwM/o= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text Return the position of the first match returns text The position of the first match param text The character to search for c param text The position to start searching from pos param text The characters to search for str param text The characters to search for s param text The number of characters to search for n normal TcE6uiDkICSzkegC9lzTM87jwlo= q7omXr2uqTr3v1fJVzA94fhapvE= iz2GUCM611IYR/kjQB79q1n872g= r4kUkL0YV/fA06QtJmR/TjXUtao= identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type find_first_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 721 5 1 function TcE6uiDkICSzkegC9lzTM87jwlo= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::find_first_of brief text Return the position of the first match returns text The position of the first match param text The character to search for c param text The position to start searching from pos identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type identifier char c identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos 0 normal 1 1 find_first_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 707 5 1 function q7omXr2uqTr3v1fJVzA94fhapvE= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::find_first_of brief text Return the position of the first match returns text The position of the first match param text The characters to search for str param text The position to start searching from pos identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core str identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos 0 normal 1 1 find_first_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 750 5 1 function iz2GUCM611IYR/kjQB79q1n872g= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::find_first_of brief text Return the position of the first match returns text The position of the first match param text The characters to search for s param text The position to start searching from pos identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type 1 identifier char s identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos 0 normal 1 1 find_first_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 736 5 1 function r4kUkL0YV/fA06QtJmR/TjXUtao= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::find_first_of brief text Return the position of the first match returns text The position of the first match param text The characters to search for s param text The position to start searching from pos param text The number of characters to search for n identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type 1 identifier char s identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type n normal 1 1 find_last_not_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 884 5 1 overloads PkLaqlX95/D18ZgPiZCiz/mPUmQ= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text Return the position of the last non-match returns text The position of the last non-match param text The character to search for c param text The position to start searching from pos param text The characters to search for str param text The characters to search for s param text The number of characters to search for n normal 2AMMYo3v1gttHFufhYHieIj8bdI= Nfr+v2bpMFyORAQhtwLZ5J432w4= ZPpivnq8JwObb7gqwj6DDXtVLJA= Gu5ADf/dTdCmnisbu/DaC5FtlDQ= identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type find_last_not_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 898 5 1 function 2AMMYo3v1gttHFufhYHieIj8bdI= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::find_last_not_of brief text Return the position of the last non-match returns text The position of the last non-match param text The character to search for c param text The position to start searching from pos identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type identifier char c identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos core::string_view::npos normal 1 1 find_last_not_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 884 5 1 function Nfr+v2bpMFyORAQhtwLZ5J432w4= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::find_last_not_of brief text Return the position of the last non-match returns text The position of the last non-match param text The characters to search for str param text The position to start searching from pos identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core str identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos core::string_view::npos normal 1 1 find_last_not_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 927 5 1 function ZPpivnq8JwObb7gqwj6DDXtVLJA= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::find_last_not_of brief text Return the position of the last non-match returns text The position of the last non-match param text The characters to search for s param text The position to start searching from pos identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type 1 identifier char s identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos core::string_view::npos normal 1 1 find_last_not_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 913 5 1 function Gu5ADf/dTdCmnisbu/DaC5FtlDQ= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::find_last_not_of brief text Return the position of the last non-match returns text The position of the last non-match param text The characters to search for s param text The position to start searching from pos param text The number of characters to search for n identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type 1 identifier char s identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type n normal 1 1 find_last_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 766 5 1 overloads sSd4hgvdFuzpE/2bJtwpG243Apo= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text Return the position of the last match returns text The position of the last match param text The character to search for c param text The position to start searching from pos param text The characters to search for str param text The characters to search for s param text The number of characters to search for n normal x9U9ssyIOQKxLkWfX/TBjJwL3gg= AZeST6eCw9rmQ9mUiVCMY8YyfjU= j10zGQ8rw2lMRMG+TCKNGInKHK4= IIJbBmNRXB9cDV2Hodq45rXi+QY= identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type find_last_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 780 5 1 function x9U9ssyIOQKxLkWfX/TBjJwL3gg= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::find_last_of brief text Return the position of the last match returns text The position of the last match param text The character to search for c param text The position to start searching from pos identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type identifier char c identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos core::string_view::npos normal 1 1 find_last_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 766 5 1 function AZeST6eCw9rmQ9mUiVCMY8YyfjU= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::find_last_of brief text Return the position of the last match returns text The position of the last match param text The characters to search for str param text The position to start searching from pos identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core str identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos core::string_view::npos normal 1 1 find_last_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 809 5 1 function j10zGQ8rw2lMRMG+TCKNGInKHK4= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::find_last_of brief text Return the position of the last match returns text The position of the last match param text The characters to search for s param text The position to start searching from pos identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type 1 identifier char s identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos core::string_view::npos normal 1 1 find_last_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 795 5 1 function IIJbBmNRXB9cDV2Hodq45rXi+QY= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::find_last_of brief text Return the position of the last match returns text The position of the last match param text The characters to search for s param text The position to start searching from pos param text The number of characters to search for n identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type 1 identifier char s identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type n normal 1 1 front boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 343 5 1 function GCtLfDBN/T6snyktUaiy6XEF9z0= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::front brief text Return the first character returns text The first character identifier foZNP6eKrZGgZPs/IKbd+dOnIuM= const_reference normal 1 1 length boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 282 5 1 function Hl4C4fbIugV95gCntPCSc1vWBh0= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::length brief text Return the size returns text The size identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type normal 1 1 max_size boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 293 5 1 function Qyt6qjjrJx0hZ8PQ6zdSAvGHKvU= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::max_size brief text Return the maximum allowed size returns text The maximum allowed size identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type normal 1 1 operator[] boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 318 5 1 function 8YWsfJWY2hTYjFk9Llyg3aJV1hk= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::operator[] brief text Access a character returns text The character at the position param text The position to access pos identifier foZNP6eKrZGgZPs/IKbd+dOnIuM= const_reference identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos normal 1 1 rbegin boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 221 5 1 function L0f4ee/wt58Mb/deFLDyLlyfVGY= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::rbegin brief text Return a reverse iterator to the end returns text A reverse iterator to the end identifier cmB6LiOLkFK4MPA38l8T4GLupFw= const_reverse_iterator normal 1 1 rend boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 233 5 1 function RdDaHzncr8vavW/PrNUWQxSXPY4= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::rend brief text Return a reverse iterator to the beginning returns text A reverse iterator to the beginning identifier cmB6LiOLkFK4MPA38l8T4GLupFw= const_reverse_iterator normal 1 1 rfind boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 648 5 1 overloads W3vU/KpFnzLZaPl+o/8Hqt7NAJE= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text Return the position of matching characters returns text The position of the first match param text The character to search for c param text The position to start searching from pos param text The characters to search for str param text The characters to search for s param text The number of characters to search for n normal 67zrufCp4NocNFW+MQmW2AZJHKM= 7eScYOCz/vJ9fpDMMotM0+I8qOE= 18WfSjD0IUf2RSlBRXtH9ZUGgpE= u8pQymbEkfioZr0NHqfpMpKZWho= identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type rfind boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 662 5 1 function 67zrufCp4NocNFW+MQmW2AZJHKM= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::rfind brief text Return the position of matching characters returns text The position of the first match param text The character to search for c param text The position to start searching from pos identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type identifier char c identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos core::string_view::npos normal 1 1 rfind boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 648 5 1 function 7eScYOCz/vJ9fpDMMotM0+I8qOE= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::rfind brief text Return the position of matching characters returns text The position of the first match param text The characters to search for str param text The position to start searching from pos identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core str identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos core::string_view::npos normal 1 1 rfind boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 691 5 1 function 18WfSjD0IUf2RSlBRXtH9ZUGgpE= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::rfind brief text Return the position of matching characters returns text The position of the first match param text The characters to search for s param text The position to start searching from pos identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type 1 identifier char s identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos core::string_view::npos normal 1 1 rfind boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 677 5 1 function u8pQymbEkfioZr0NHqfpMpKZWho= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::rfind brief text Return the position of matching characters returns text The position of the first match param text The characters to search for s param text The position to start searching from pos param text The number of characters to search for n identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type 1 identifier char s identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type n normal 1 1 size boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 271 5 1 function XdOsrY6qbLFskpkyLJ49siyex04= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::size brief text Return the size returns text The size identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type normal 1 1 starts_with boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 506 5 1 overloads Lf2XYnjs3fR1j0dD8fAs04J7YLw= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text Return true if a matching prefix exists returns code text true text if the prefix matches param text The character to search for x normal v3qqifP7Un5JkmpKk4TtAxbqINc= b1zBGpDL1DMowpruv731stD3Vgw= 1Y9DRmbXN1J7HNFxFNed/jYhRcs= identifier bool starts_with boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 519 5 1 function v3qqifP7Un5JkmpKk4TtAxbqINc= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::starts_with brief text Return true if a matching prefix exists returns code text true text if the prefix matches param text The character to search for x identifier bool identifier char x normal 1 1 starts_with boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 506 5 1 function b1zBGpDL1DMowpruv731stD3Vgw= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::starts_with brief text Return true if a matching prefix exists returns code text true text if the prefix matches param text The string to search for x identifier bool identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core x normal 1 1 starts_with boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 532 5 1 function 1Y9DRmbXN1J7HNFxFNed/jYhRcs= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::starts_with brief text Return true if a matching prefix exists returns code text true text if the prefix matches param text The string to search for x identifier bool 1 identifier char x normal 1 1 substr boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 398 5 1 function mRqi8IZOOX0xLFHe28WQ8Zwvmkg= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::substr brief text Return a view to part of the string returns text A view to the substring param text The position to start from pos param text The number of characters n identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos 0 identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type n core::string_view::npos normal 1 1 operator basic_string<char> boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 160 5 1 function bRcyVQ6ZJghIfxH913mNeaUsZuo= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text Conversion to std::string is explicit because assigning to string using an implicit constructor does not preserve capacity. brief text Conversion returns text A string with the same contents identifier UwlFvW1lEI5kSm1M2LJ8livaK7g= string identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std conversion 1 1 operator basic_string_view<char> boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 133 5 1 function 6BCCiqqFBnxfN5d9Ki/oUcu88Ic= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text Conversion returns text A string view with the same contents identifier o9e6TyaeiKXWYT1zlEtJwrwdZys= string_view identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std conversion 1 1 npos boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 125 5 1 variable axqsst2fEEr0KskCuLNS6wtH26E= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text A constant used to represent "no position" identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std core::string_view::npos 1 1 string_view_base boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 47 5 1 overloads RhJNoEENe8RC3epEbfIY36rrknQ= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text Constructor param text The string view s param text The character buffer data param text The number of characters size constructor IV8SmgOCOgWMLsJhq84LpTYoRJw= 4yjEImzOfkZho2Sde3RRkKGe5QQ= nU/e9qf+WxQbwsZV57Tug+HU0xU= oX9zkATN+VHTbI3eiYiNpQ+/aPA= identifier void string_view_base boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 82 5 1 function IV8SmgOCOgWMLsJhq84LpTYoRJw= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text Constructor identifier void constructor 1 1 1 string_view_base boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 86 5 1 function 4yjEImzOfkZho2Sde3RRkKGe5QQ= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text Constructor param text The object to copy construct from other identifier void 1 identifier Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= string_view_base other constructor 1 1 1 string_view_base boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 47 5 1 function nU/e9qf+WxQbwsZV57Tug+HU0xU= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text Constructor param text The string view s identifier void identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s constructor 1 string_view_base boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 59 5 1 function oX9zkATN+VHTbI3eiYiNpQ+/aPA= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text Constructor param text The character buffer data param text The number of characters size identifier void 1 identifier char data identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std size constructor 1 operator= boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 94 5 1 function aIJpv/jZ2tM+tFNkNsdGXClHwE0= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text Assignment returns text A reference to this object param text The object to assign other identifier Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= string_view_base 1 identifier Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= string_view_base other normal 1 1 1 swap boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 73 5 1 function y5e2cWu7aRkl+6aRLABfP+waghM= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text Swap param text The object to swap with s identifier void identifier Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= string_view_base s normal 1 s_ boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 41 5 1 variable j2zlfB2FMKW7UWEt2w+csPbI5o4= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text The referenced character buffer identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core 1 unsigned_rule boost/url/grammar/unsigned_rule.hpp include/boost/url/grammar/unsigned_rule.hpp 52 1 1 record RxDnM7pIw/ahE/QBEDu7T14vtTs= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= paragraph text Extra leading zeroes are disallowed. heading text Value Type 1 code using value_type = Unsigned; heading text Example 1 paragraph text Rules are used with the function reference parse rDDzgULcyKeWVv6ArwS9ei06m8E= text . code system::result< unsigned short > rv = parse( "32767", unsigned_rule< unsigned short >{} ); heading text BNF 1 code unsigned = "0" / ( ["1"..."9"] *DIGIT ) brief text Match an unsigned decimal t-param text The unsigned integer type used to store the result. Unsigned see reference grammar::parse laQxW+BBeJINbRrZtau+U15+v7c= text . struct y37ryxXYrjlxGpVsQjXKxvsbLLs= rDDzgULcyKeWVv6ArwS9ei06m8E= value_type boost/url/grammar/unsigned_rule.hpp include/boost/url/grammar/unsigned_rule.hpp 61 5 typedef y37ryxXYrjlxGpVsQjXKxvsbLLs= regular RxDnM7pIw/ahE/QBEDu7T14vtTs= identifier Unsigned 1 parse boost/url/grammar/unsigned_rule.hpp include/boost/url/grammar/unsigned_rule.hpp 63 5 function rDDzgULcyKeWVv6ArwS9ei06m8E= regular RxDnM7pIw/ahE/QBEDu7T14vtTs= specialization O+YzwnquzbCEPErxi2iuhXKphsk= result identifier LWQB+dn+7lsRKPzx/twz66ZcOWI= system 1 identifier char it 1 identifier char end normal 1 1 1 condition boost/url/grammar/error.hpp include/boost/url/grammar/error.hpp 114 1 1 enum HB8NuzkdJne0JnuamlIzyVfG2z4= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= brief text Error conditions for errors received from rules see reference error /RsVEYVgVIkSjV+EtQuU7JX6dIY= text , reference parse laQxW+BBeJINbRrZtau+U15+v7c= text . 1 identifier int X1swyeizWn5vdUAIFeTZCX2AMtA= fatal boost/url/grammar/error.hpp include/boost/url/grammar/error.hpp 121 5 1 enum-constant X1swyeizWn5vdUAIFeTZCX2AMtA= regular HB8NuzkdJne0JnuamlIzyVfG2z4= paragraph text This indicates that parsing cannot continue. brief text A fatal error in syntax was encountered. 1 error boost/url/grammar/error.hpp include/boost/url/grammar/error.hpp 26 1 1 enum /RsVEYVgVIkSjV+EtQuU7JX6dIY= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= brief text Error codes returned when using rules see reference condition HB8NuzkdJne0JnuamlIzyVfG2z4= text , reference parse laQxW+BBeJINbRrZtau+U15+v7c= text . 1 identifier int a/THTSv6k7njvbh+81BNyu1ppl8= a0UOTldvUpYmePWJT6+iE5qk5DE= 21g3KEjdyvVJs22ysirzt+ZkWDM= bFZ3Y9LHNGyUwrhSzaAWpwu5/do= eKR6AVdlzmA8Hi3rkPa1GzxqRRo= psAY8NapcunlU2KJF9KY2kEhctA= RIi3ChjIouMTYaME852w0wX2S/4= need_more boost/url/grammar/error.hpp include/boost/url/grammar/error.hpp 48 5 1 enum-constant a/THTSv6k7njvbh+81BNyu1ppl8= regular /RsVEYVgVIkSjV+EtQuU7JX6dIY= paragraph text A rule reached the end of the input, resulting in a partial match. The error is recoverable; the caller may obtain more input if possible and attempt to parse the character buffer again. Custom rules should only return this error if it is completely unambiguous that the rule cannot be matched without more input. brief text More input is needed to match the rule 1 mismatch boost/url/grammar/error.hpp include/boost/url/grammar/error.hpp 58 5 1 enum-constant a0UOTldvUpYmePWJT6+iE5qk5DE= regular /RsVEYVgVIkSjV+EtQuU7JX6dIY= paragraph text This error is returned when a rule fails to match the input. The error is recoverable; the caller may rewind the input pointer and attempt to parse again using a different rule. brief text The rule did not match the input. end_of_range boost/url/grammar/error.hpp include/boost/url/grammar/error.hpp 71 5 1 enum-constant 21g3KEjdyvVJs22ysirzt+ZkWDM= regular /RsVEYVgVIkSjV+EtQuU7JX6dIY= paragraph text This indicates that the input was consumed when parsing a reference range OoA4Z9AuWLA63EMtSC/V6ZU9qgw= text . The reference range_rule KRm16yawSU2JFWabmZP+Z4VVllM= text avoids rewinding the input buffer when this error is returned. Thus the consumed characters are be considered part of the range without contributing additional elements. brief text A rule reached the end of a range leftover boost/url/grammar/error.hpp include/boost/url/grammar/error.hpp 76 5 1 enum-constant bFZ3Y9LHNGyUwrhSzaAWpwu5/do= regular /RsVEYVgVIkSjV+EtQuU7JX6dIY= brief text Leftover input remaining after match. invalid boost/url/grammar/error.hpp include/boost/url/grammar/error.hpp 94 5 1 enum-constant eKR6AVdlzmA8Hi3rkPa1GzxqRRo= regular /RsVEYVgVIkSjV+EtQuU7JX6dIY= paragraph text This error is returned when input is matching but one of the requirements is violated. For example if a percent escape is found, but one or both characters that follow are not valid hexadecimal digits. This is usually an unrecoverable error. brief text A rule encountered unrecoverable invalid input. out_of_range boost/url/grammar/error.hpp include/boost/url/grammar/error.hpp 98 5 1 enum-constant psAY8NapcunlU2KJF9KY2kEhctA= regular /RsVEYVgVIkSjV+EtQuU7JX6dIY= brief text An integer overflowed during parsing. syntax boost/url/grammar/error.hpp include/boost/url/grammar/error.hpp 103 5 1 enum-constant RIi3ChjIouMTYaME852w0wX2S/4= regular /RsVEYVgVIkSjV+EtQuU7JX6dIY= brief text An unspecified syntax error was found. ci_compare boost/url/grammar/ci_string.hpp include/boost/url/grammar/ci_string.hpp 120 1 1 function uoHBJFmwhkbiP8wxUin0sZRRl8c= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= paragraph text This returns the lexicographical comparison of two strings, ignoring case. The function is defined only for strings containing low-ASCII characters. heading text Example 1 code assert( ci_compare( "boost", "Boost" ) == 0 ); heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the case-insensitive comparison of s0 and s1 returns text 0 if the strings are equal, -1 if code text s0 text is less than code text s1 text , or 1 if code text s0 text is greater than s1. param text The first string s0 param text The second string s1 see reference ci_is_equal sptDPr3Ix33X6DX8v6cIDLD/zk0= text , reference ci_is_less pvpJA5sq72L2h76KosSqrJ2IccM= text . identifier int identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s0 identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s1 normal ci_digest boost/url/grammar/ci_string.hpp include/boost/url/grammar/ci_string.hpp 140 1 1 function 9LlLzFVP/IbL/LcZtLU7W/WJuXI= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= paragraph text The hash function is non-cryptographic and not hardened against algorithmic complexity attacks. Returned digests are suitable for usage in unordered containers. The function is defined only for strings containing low-ASCII characters. brief text Return the case-insensitive digest of a string returns text The digest param text The string s identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal ci_is_equal boost/url/grammar/ci_string.hpp include/boost/url/grammar/ci_string.hpp 164 1 1 overloads sptDPr3Ix33X6DX8v6cIDLD/zk0= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= brief text Return true if s0 equals s1 using case-insensitive comparison returns code text true text if code text s0 text case-insensitively equals code text s1 text , otherwise code text false param text The first string s0 param text The second string s1 see reference ci_compare uoHBJFmwhkbiP8wxUin0sZRRl8c= text , reference ci_is_less pvpJA5sq72L2h76KosSqrJ2IccM= text . normal uRewWrDK07k8ZT11CL3sNKDqh4s= ab1wPLQTeuA1s8OWUT0Cwshrbfc= ci_is_equal boost/url/grammar/ci_string.hpp include/boost/url/grammar/ci_string.hpp 204 1 1 function uRewWrDK07k8ZT11CL3sNKDqh4s= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= paragraph text The function is defined only for strings containing low-ASCII characters. heading text Example 1 code assert( ci_is_equal( "Boost", "boost" ) ); brief text Return true if s0 equals s1 using case-insensitive comparison returns code text true text if code text s0 text case-insensitively equals code text s1 text , otherwise code text false param text The first string s0 param text The second string s1 see reference ci_compare uoHBJFmwhkbiP8wxUin0sZRRl8c= text , reference ci_is_less pvpJA5sq72L2h76KosSqrJ2IccM= text . identifier bool identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s0 identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s1 normal ci_is_equal boost/url/grammar/ci_string.hpp include/boost/url/grammar/ci_string.hpp 164 1 1 function ab1wPLQTeuA1s8OWUT0Cwshrbfc= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= paragraph text The function is defined only for strings containing low-ASCII characters. heading text Example 1 code assert( ci_is_equal( "Boost", "boost" ) ); brief text Return true if s0 equals s1 using case-insensitive comparison returns code text true text if code text s0 text case-insensitively equals code text s1 text , otherwise code text false param text The first string s0 param text The second string s1 see reference ci_compare uoHBJFmwhkbiP8wxUin0sZRRl8c= text , reference ci_is_less pvpJA5sq72L2h76KosSqrJ2IccM= text . ! std::is_convertible< String0, core::string_view>::value || ! std::is_convertible< String1, core::string_view>::value identifier bool 1 identifier String0 s0 1 identifier String1 s1 normal ! std::is_convertible< String0, core::string_view>::value || ! std::is_convertible< String1, core::string_view>::value 1 ci_is_less boost/url/grammar/ci_string.hpp include/boost/url/grammar/ci_string.hpp 239 1 1 function pvpJA5sq72L2h76KosSqrJ2IccM= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= paragraph text The comparison algorithm implements a case-insensitive total order on the set of all strings; however, it is not a lexicographical comparison. The function is defined only for strings containing low-ASCII characters. heading text Example 1 code assert( ! ci_is_less( "Boost", "boost" ) ); brief text Return true if s0 is less than s1 using case-insensitive comparison returns code text true text if code text s0 text is case-insensitively less than code text s1 text , otherwise code text false param text The first string s0 param text The second string s1 see reference ci_compare uoHBJFmwhkbiP8wxUin0sZRRl8c= text , reference ci_is_equal sptDPr3Ix33X6DX8v6cIDLD/zk0= text . identifier bool identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s0 identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s1 normal delim_rule boost/url/grammar/delim_rule.hpp include/boost/url/grammar/delim_rule.hpp 80 1 1 overloads qF6kM++zYvuIkL97v/RpKnwOR10= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= brief code text delim_rule text overloads returns text A rule which matches the character. returns text A rule which matches a single character from the set. param text The character to match ch param text The character set to use. cs see reference parse laQxW+BBeJINbRrZtau+U15+v7c= text , reference squelch SqrTdaO1Y5GdnwvZBirZfRUnteI= text . see reference alpha_chars d7YdTQNJGO03J/WSHg33UUwcLdU= text , reference parse laQxW+BBeJINbRrZtau+U15+v7c= text , reference squelch SqrTdaO1Y5GdnwvZBirZfRUnteI= text . normal Lf/90CiKWOFbDeU17ozZiB9Q1V8= mrjPXnRGDS/ACI0EhgZ+RLhTU90= delim_rule boost/url/grammar/delim_rule.hpp include/boost/url/grammar/delim_rule.hpp 80 1 1 function Lf/90CiKWOFbDeU17ozZiB9Q1V8= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= paragraph text This matches the specified character. The value is a reference to the character in the underlying buffer, expressed as a code text core::string_view text . The function reference squelch SqrTdaO1Y5GdnwvZBirZfRUnteI= text may be used to turn this into code text void text instead. If there is no more input, the error code reference error::need_more a/THTSv6k7njvbh+81BNyu1ppl8= text is returned. heading text Value Type 1 code using value_type = core::string_view; heading text Example 1 paragraph text Rules are used with the function reference parse laQxW+BBeJINbRrZtau+U15+v7c= text . code system::result< core::string_view > rv = parse( ".", delim_rule('.') ); heading text BNF 1 code char = %00-FF brief text Match a character literal returns text A rule which matches the character. param text The character to match ch see reference parse laQxW+BBeJINbRrZtau+U15+v7c= text , reference squelch SqrTdaO1Y5GdnwvZBirZfRUnteI= text . identifier 3CTA0y/pdHpybn8r5XIQDF7OBlE= ch_delim_rule identifier kjqcso5U9E4PFvl5kQX9ptGH8vA= implementation_defined identifier char ch normal delim_rule boost/url/grammar/delim_rule.hpp include/boost/url/grammar/delim_rule.hpp 158 1 1 function mrjPXnRGDS/ACI0EhgZ+RLhTU90= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= paragraph text This matches exactly one character which belongs to the specified character set. The value is a reference to the character in the underlying buffer, expressed as a code text core::string_view text . The function reference squelch SqrTdaO1Y5GdnwvZBirZfRUnteI= text may be used to turn this into code text void text instead. If there is no more input, the error code reference error::need_more a/THTSv6k7njvbh+81BNyu1ppl8= text is returned. heading text Value Type 1 code using value_type = core::string_view; heading text Example 1 paragraph text Rules are used with the function reference parse laQxW+BBeJINbRrZtau+U15+v7c= text . code system::result< core::string_view > rv = parse( "X", delim_rule( alpha_chars ) ); brief text Match a single character from a character set returns text A rule which matches a single character from the set. param text The character set to use. cs see reference alpha_chars d7YdTQNJGO03J/WSHg33UUwcLdU= text , reference parse laQxW+BBeJINbRrZtau+U15+v7c= text , reference squelch SqrTdaO1Y5GdnwvZBirZfRUnteI= text . ! std::is_convertible< CS, char>::value specialization Mn+TpHAfUsKvpUzJ4XXH4KRW+Hw= cs_delim_rule identifier kjqcso5U9E4PFvl5kQX9ptGH8vA= implementation_defined 1 identifier CS cs normal ! std::is_convertible< CS, char>::value find_if boost/url/grammar/charset.hpp include/boost/url/grammar/charset.hpp 145 1 1 function tYu+dbhQn5Jt+oUv1QmBQz+Z4Mk= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= heading text Exception Safety 1 paragraph text Throws nothing. brief text Find the first character in the string that is in the set. returns text A pointer to the found character, otherwise the value code text last text . param text A pointer to the first character in the string to search. first param text A pointer to one past the last character in the string to search. last param text The character set to use. cs see reference find_if_not o4IF1hl0/rSoqWdSZjOKE4MHFjM= text . 1 identifier char 1 1 identifier char first 1 1 identifier char last 1 identifier CS cs normal find_if_not boost/url/grammar/charset.hpp include/boost/url/grammar/charset.hpp 184 1 1 function o4IF1hl0/rSoqWdSZjOKE4MHFjM= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= heading text Exception Safety 1 paragraph text Throws nothing. brief text Find the first character in the string that is not in CharSet returns text A pointer to the found character, otherwise the value code text last text . param text A pointer to the first character in the string to search. first param text A pointer to one past the last character in the string to search. last param text The character set to use. cs see reference find_if_not o4IF1hl0/rSoqWdSZjOKE4MHFjM= text . 1 identifier char 1 1 identifier char first 1 1 identifier char last 1 identifier CS cs normal hexdig_value boost/url/grammar/hexdig_chars.hpp include/boost/url/grammar/hexdig_chars.hpp 117 1 1 function Euqnbrbiv6WcHygsjJQdaZ1rnhg= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= paragraph text This function returns the decimal value of a hexadecimal character, or -1 if the argument is not a valid hexadecimal digit. heading text BNF 1 code HEXDIG = DIGIT / "A" / "B" / "C" / "D" / "E" / "F" / "a" / "b" / "c" / "d" / "e" / "f" brief text Return the decimal value of a hex character returns text The decimal value or -1 param text The character to check ch identifier signed char identifier char ch normal not_empty_rule boost/url/grammar/not_empty_rule.hpp include/boost/url/grammar/not_empty_rule.hpp 74 1 1 function T0Kj3BI+iG7hOIjh52aUMxjy2vY= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= paragraph text This adapts another rule such that when an empty string is successfully parsed, the result is an error. heading text Value Type 1 code using value_type = typename Rule::value_type; heading text Example 1 paragraph text Rules are used with the function reference parse laQxW+BBeJINbRrZtau+U15+v7c= text . code system::result< decode_view > rv = parse( "Program%20Files", not_empty_rule( pct_encoded_rule( unreserved_chars ) ) ); brief text Match another rule, if the result is not empty returns text The adapted rule param text The rule to match r see reference parse laQxW+BBeJINbRrZtau+U15+v7c= text , reference pct_encoded_rule tqgOJBBmkI71v1H8Vjo+5AjUBNk= text , reference unreserved_chars sPt+l16WQkJLiqM+m+B6d5s9eA0= text . specialization 7Q7zhRx23P+FJ7L7QnHWo4R/dFY= not_empty_rule_t identifier kjqcso5U9E4PFvl5kQX9ptGH8vA= implementation_defined 1 identifier R r normal 1 operator+ boost/url/grammar/lut_chars.hpp include/boost/url/grammar/lut_chars.hpp 300 5 1 function RPE7nl0nzHl50NxeKWVlHlj0EEc= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= paragraph text This function returns a new character set which contains all of the characters in code text cs0 text as well as all of the characters in code text cs text . heading text Example 1 paragraph text This creates a character set which includes all letters and numbers code constexpr lut_chars alpha_chars( "ABCDEFGHIJKLMNOPQRSTUVWXYZ" "abcdefghijklmnopqrstuvwxyz"); constexpr lut_chars alnum_chars = alpha_chars + "0123456789"; heading text Complexity 1 paragraph text Constant. brief text Return the union of two character sets. returns text The new character set. param text A character to join cs0 param text A character to join cs1 identifier 79IFwv0C40oPrhucou1uA6DC1RI= lut_chars 1 identifier 79IFwv0C40oPrhucou1uA6DC1RI= lut_chars cs0 1 identifier 79IFwv0C40oPrhucou1uA6DC1RI= lut_chars cs1 normal operator- boost/url/grammar/lut_chars.hpp include/boost/url/grammar/lut_chars.hpp 337 5 1 function 7CUoh11FVhxOsS+h3YMv9zT8QAI= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= paragraph text This function returns a new character set which is formed from all of the characters in code text cs0 text which are not in code text cs text . heading text Example 1 paragraph text This statement declares a character set containing all the lowercase letters which are not vowels: code constexpr lut_chars consonants = lut_chars("abcdefghijklmnopqrstuvwxyz") - "aeiou"; heading text Complexity 1 paragraph text Constant. brief text Return a new character set by subtracting returns text The new character set. param text A character set to join. cs0 param text A character set to join. cs1 identifier 79IFwv0C40oPrhucou1uA6DC1RI= lut_chars 1 identifier 79IFwv0C40oPrhucou1uA6DC1RI= lut_chars cs0 1 identifier 79IFwv0C40oPrhucou1uA6DC1RI= lut_chars cs1 normal optional_rule boost/url/grammar/optional_rule.hpp include/boost/url/grammar/optional_rule.hpp 87 1 1 function f5cvDgg9R+ZZkGkfvf3EI947ciA= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= paragraph text Optional BNF elements are denoted with square brackets. If the specified rule returns any error it is treated as if the rule did not match. heading text Value Type 1 code using value_type = optional< typename Rule::value_type >; heading text Example 1 paragraph text Rules are used with the function reference grammar::parse laQxW+BBeJINbRrZtau+U15+v7c= text . code system::result< optional< core::string_view > > rv = parse( "", optional_rule( token_rule( alpha_chars ) ) ); heading text BNF 1 code optional = [ rule ] heading text Specification 1 list paragraph link text 3.8. Optional Sequence (rfc5234) https://datatracker.ietf.org/doc/html/rfc5234#section-3.8 unordered brief text Match a rule, or the empty string returns text The adapted rule param text The rule to match r see reference alpha_chars d7YdTQNJGO03J/WSHg33UUwcLdU= text , reference parse laQxW+BBeJINbRrZtau+U15+v7c= text , reference optional oSAYJle80BcL838BBRX63lch/5Q= text , reference token_rule CLa7o0IwRfen+iyqOmlpKhjqAJg= text . specialization T56AU5rfLjzDT59R+kMpH1selCY= optional_rule_t identifier kjqcso5U9E4PFvl5kQX9ptGH8vA= implementation_defined 1 identifier R r normal 1 parse boost/url/grammar/parse.hpp include/boost/url/grammar/parse.hpp 38 1 1 boost/url/grammar/parse.hpp include/boost/url/grammar/parse.hpp 60 1 1 overloads laQxW+BBeJINbRrZtau+U15+v7c= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= brief text Parse a character buffer using a rule returns text The parsed value upon success, otherwise an error. param text The input string s param text The rule to use r param text A pointer to the start. The caller's variable is changed to reflect the amount of input consumed. it param text A pointer to the end. end normal LkyR1hrnEFpG2KNxbVyuvzU0r8w= ZudTltmlmk0cOEqWpYLX29Jb3c8= specialization O+YzwnquzbCEPErxi2iuhXKphsk= result identifier LWQB+dn+7lsRKPzx/twz66ZcOWI= system parse boost/url/grammar/parse.hpp include/boost/url/grammar/parse.hpp 60 1 1 function LkyR1hrnEFpG2KNxbVyuvzU0r8w= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= paragraph text This function parses a complete string into the specified sequence of rules. If the string is not completely consumed, an error is returned instead. brief text Parse a character buffer using a rule returns text The parsed value upon success, otherwise an error. param text The input string s param text The rule to use r specialization O+YzwnquzbCEPErxi2iuhXKphsk= result identifier LWQB+dn+7lsRKPzx/twz66ZcOWI= system identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s 1 identifier R r normal parse boost/url/grammar/parse.hpp include/boost/url/grammar/parse.hpp 38 1 1 function ZudTltmlmk0cOEqWpYLX29Jb3c8= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= brief text Parse a character buffer using a rule returns text The parsed value upon success, otherwise an error. param text A pointer to the start. The caller's variable is changed to reflect the amount of input consumed. it param text A pointer to the end. end param text The rule to use r specialization O+YzwnquzbCEPErxi2iuhXKphsk= result identifier LWQB+dn+7lsRKPzx/twz66ZcOWI= system 1 identifier char it 1 identifier char end 1 identifier R r normal range_rule boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 517 1 1 overloads KRm16yawSU2JFWabmZP+Z4VVllM= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= brief text Match a repeating number of elements returns text A rule that matches the range. param text The rule to use for matching each element. The range extends until this rule returns an error. next param text The minimum number of elements for the range to be valid. If omitted, this defaults to zero. N param text The maximum number of elements for the range to be valid. If omitted, this defaults to unlimited. M param text The rule to use for matching the first element. If this rule returns an error, the range is empty. first see reference alpha_chars d7YdTQNJGO03J/WSHg33UUwcLdU= text , reference delim_rule qF6kM++zYvuIkL97v/RpKnwOR10= text , reference error::end_of_range 21g3KEjdyvVJs22ysirzt+ZkWDM= text , reference parse laQxW+BBeJINbRrZtau+U15+v7c= text , reference range OoA4Z9AuWLA63EMtSC/V6ZU9qgw= text , reference tuple_rule 3dL9L+9O6pMj9teadg4abB/3n2E= text , reference squelch SqrTdaO1Y5GdnwvZBirZfRUnteI= text . normal ANlbUsmeIH4ubuteCfnju8yNgI4= lMrrGMQADkoPtJpJsLxqraXgetg= range_rule boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 517 1 1 function ANlbUsmeIH4ubuteCfnju8yNgI4= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= paragraph text Elements are matched using the passed rule. Normally when the rule returns an error, the range ends and the input is rewound to one past the last character that matched successfully. However, if the rule returns the special value reference error::end_of_range 21g3KEjdyvVJs22ysirzt+ZkWDM= text , the input is not rewound. This allows for rules which consume input without producing elements in the range. For example, to relax the grammar for a comma-delimited list by allowing extra commas in between elements. heading text Value Type 1 code using value_type = range< typename Rule::value_type >; heading text Example 1 paragraph text Rules are used with the function reference parse laQxW+BBeJINbRrZtau+U15+v7c= text . code // range = 1*( ";" token ) system::result< range<core::string_view> > rv = parse( ";alpha;xray;charlie", range_rule( tuple_rule( squelch( delim_rule( ';' ) ), token_rule( alpha_chars ) ), 1 ) ); heading text BNF 1 code range = <N>*<M>next heading text Specification 1 list paragraph link text 3.6. Variable Repetition (rfc5234) https://datatracker.ietf.org/doc/html/rfc5234#section-3.6 unordered brief text Match a repeating number of elements returns text A rule that matches the range. param text The rule to use for matching each element. The range extends until this rule returns an error. next param text The minimum number of elements for the range to be valid. If omitted, this defaults to zero. N param text The maximum number of elements for the range to be valid. If omitted, this defaults to unlimited. M see reference alpha_chars d7YdTQNJGO03J/WSHg33UUwcLdU= text , reference delim_rule qF6kM++zYvuIkL97v/RpKnwOR10= text , reference error::end_of_range 21g3KEjdyvVJs22ysirzt+ZkWDM= text , reference parse laQxW+BBeJINbRrZtau+U15+v7c= text , reference range OoA4Z9AuWLA63EMtSC/V6ZU9qgw= text , reference tuple_rule 3dL9L+9O6pMj9teadg4abB/3n2E= text , reference squelch SqrTdaO1Y5GdnwvZBirZfRUnteI= text . specialization J8dRb4F9BB1DL+D9Zt9RR+ub9l0= range_rule_t identifier kjqcso5U9E4PFvl5kQX9ptGH8vA= implementation_defined 1 identifier R next identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std N 0 identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std M std::size_t(-1) normal range_rule boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 648 1 1 function lMrrGMQADkoPtJpJsLxqraXgetg= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= paragraph text Two rules are used for match. The rule code text first text is used for matching the first element, while the code text next text rule is used to match every subsequent element. Normally when the rule returns an error, the range ends and the input is rewound to one past the last character that matched successfully. However, if the rule returns the special value reference error::end_of_range 21g3KEjdyvVJs22ysirzt+ZkWDM= text , the input is not rewound. This allows for rules which consume input without producing elements in the range. For example, to relax the grammar for a comma-delimited list by allowing extra commas in between elements. heading text Value Type 1 code using value_type = range< typename Rule::value_type >; heading text Example 1 paragraph text Rules are used with the function reference parse laQxW+BBeJINbRrZtau+U15+v7c= text . code // range = [ token ] *( "," token ) system::result< range< core::string_view > > rv = parse( "whiskey,tango,foxtrot", range_rule( token_rule( alpha_chars ), // first tuple_rule( // next squelch( delim_rule(',') ), token_rule( alpha_chars ) ) ) ); heading text BNF 1 code range = <1>*<1>first / first <N-1>*<M-1>next heading text Specification 1 list paragraph link text 3.6. Variable Repetition (rfc5234) https://datatracker.ietf.org/doc/html/rfc5234#section-3.6 unordered brief text Match a repeating number of elements returns text A rule that matches the range. param text The rule to use for matching the first element. If this rule returns an error, the range is empty. first param text The rule to use for matching each subsequent element. The range extends until this rule returns an error. next param text The minimum number of elements for the range to be valid. If omitted, this defaults to zero. N param text The maximum number of elements for the range to be valid. If omitted, this defaults to unlimited. M see reference alpha_chars d7YdTQNJGO03J/WSHg33UUwcLdU= text , reference delim_rule qF6kM++zYvuIkL97v/RpKnwOR10= text , reference error::end_of_range 21g3KEjdyvVJs22ysirzt+ZkWDM= text , reference parse laQxW+BBeJINbRrZtau+U15+v7c= text , reference range OoA4Z9AuWLA63EMtSC/V6ZU9qgw= text , reference tuple_rule 3dL9L+9O6pMj9teadg4abB/3n2E= text , reference squelch SqrTdaO1Y5GdnwvZBirZfRUnteI= text . ! std::is_integral<R2>::value specialization J8dRb4F9BB1DL+D9Zt9RR+ub9l0= range_rule_t identifier kjqcso5U9E4PFvl5kQX9ptGH8vA= implementation_defined 1 identifier R1 first 1 identifier R2 next identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std N 0 identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std M std::size_t(-1) normal ! std::is_integral<R2>::value 1 ref boost/url/grammar/charset.hpp include/boost/url/grammar/charset.hpp 260 1 1 overloads H/8iIA3bdc3RmHv6e6466sm8A4k= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= brief code text ref text overloads returns text The character set as a reference type returns text The rule as a reference type param text The character set to use cs param text The rule to use r t-param text The character set type CharSet normal OTRutHAXLI0unuoXlmiiGZhzcGo= zrlEszs2uwvPw940Y7hAgG6UTPI= ref boost/url/grammar/charset.hpp include/boost/url/grammar/charset.hpp 260 1 1 function OTRutHAXLI0unuoXlmiiGZhzcGo= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= paragraph text This function returns a character set which references the specified object. This is used to reduce the number of bytes of storage ( code text sizeof text ) required by a combinator when it stores a copy of the object. Ownership of the object is not transferred; the caller is responsible for ensuring the lifetime of the object is extended until it is no longer referenced. For best results, code text ref text should only be used with compile-time constants. brief text Return a reference to a character set returns text The character set as a reference type param text The character set to use cs t-param text The character set type CharSet is_charset<CS>::value && ! std::is_same<CS, implementation_defined::charset_ref<CS> >::value specialization 221l+sWJpD23An4Nsc351qg0OBk= charset_ref identifier kjqcso5U9E4PFvl5kQX9ptGH8vA= implementation_defined 1 identifier CS cs normal is_charset<CS>::value && ! std::is_same<CS, implementation_defined::charset_ref<CS> >::value ref boost/url/grammar/parse.hpp include/boost/url/grammar/parse.hpp 106 1 1 function zrlEszs2uwvPw940Y7hAgG6UTPI= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= paragraph text This function returns a rule which references the specified object. This is used to reduce the number of bytes of storage ( code text sizeof text ) required by a combinator when it stores a copy of the object. Ownership of the object is not transferred; the caller is responsible for ensuring the lifetime of the object is extended until it is no longer referenced. For best results, code text ref text should only be used with compile-time constants. brief text Return a reference to a rule returns text The rule as a reference type param text The rule to use r is_rule<R>::value && ! std::is_same<R, implementation_defined::rule_ref<R> >::value specialization J5kxsYNgICiyE+NSIa2FMMmE+PI= rule_ref identifier kjqcso5U9E4PFvl5kQX9ptGH8vA= implementation_defined 1 identifier R r normal is_rule<R>::value && ! std::is_same<R, implementation_defined::rule_ref<R> >::value squelch boost/url/grammar/tuple_rule.hpp include/boost/url/grammar/tuple_rule.hpp 224 1 1 function SqrTdaO1Y5GdnwvZBirZfRUnteI= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= paragraph text This function returns a new rule which matches the specified rule, and converts its value type to code text void text . This is useful for matching delimiters in a grammar, where the value for the delimiter is not needed. heading text Value Type 1 code using value_type = void; heading text Example 1 1 paragraph text With code text squelch text : code system::result< std::tuple< decode_view, core::string_view > > rv = parse( "www.example.com:443", tuple_rule( pct_encoded_rule(unreserved_chars + '-' + '.'), squelch( delim_rule( ':' ) ), token_rule( digit_chars ) ) ); heading text Example 2 1 paragraph text Without code text squelch text : code system::result< std::tuple< decode_view, core::string_view, core::string_view > > rv = parse( "www.example.com:443", tuple_rule( pct_encoded_rule(unreserved_chars + '-' + '.'), delim_rule( ':' ), token_rule( digit_chars ) ) ); brief text Squelch the value of a rule returns text The squelched rule param text The rule to squelch r see reference delim_rule qF6kM++zYvuIkL97v/RpKnwOR10= text , reference digit_chars ookgwXeQg4dQaa4byxIjCl6r61k= text , reference parse laQxW+BBeJINbRrZtau+U15+v7c= text , reference tuple_rule 3dL9L+9O6pMj9teadg4abB/3n2E= text , reference token_rule CLa7o0IwRfen+iyqOmlpKhjqAJg= text , reference decode_view IhE/V16b2wBX2q+s4QtlgzozWlQ= text , reference pct_encoded_rule tqgOJBBmkI71v1H8Vjo+5AjUBNk= text , reference unreserved_chars sPt+l16WQkJLiqM+m+B6d5s9eA0= text . specialization DhWhEpk9CuLc798VTS0BKCR2OWc= squelch_rule_t identifier kjqcso5U9E4PFvl5kQX9ptGH8vA= implementation_defined 1 identifier R r normal to_lower boost/url/grammar/ci_string.hpp include/boost/url/grammar/ci_string.hpp 53 1 1 function uyRz7dsU+AM3TNmwz2kmeP9U+OA= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= paragraph text This function returns the character, converting it to lowercase if it is uppercase. The function is defined only for low-ASCII characters. heading text Example 1 code assert( to_lower( 'A' ) == 'a' ); heading text Exception Safety 1 paragraph text Throws nothing. brief text Return c converted to lowercase returns text The converted character param text The character to convert c see reference to_upper wJ8AXedwlI+rgqL6jyk8IsQ8lzM= text . identifier char identifier char c normal to_upper boost/url/grammar/ci_string.hpp include/boost/url/grammar/ci_string.hpp 83 1 1 function wJ8AXedwlI+rgqL6jyk8IsQ8lzM= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= paragraph text This function returns the character, converting it to uppercase if it is lowercase. The function is defined only for low-ASCII characters. heading text Example 1 code assert( to_upper( 'a' ) == 'A' ); heading text Exception Safety 1 paragraph text Throws nothing. brief text Return c converted to uppercase returns text The converted character param text The character to convert c see reference to_lower uyRz7dsU+AM3TNmwz2kmeP9U+OA= text . identifier char identifier char c normal token_rule boost/url/grammar/token_rule.hpp include/boost/url/grammar/token_rule.hpp 93 1 1 overloads CLa7o0IwRfen+iyqOmlpKhjqAJg= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= brief code text token_rule text overloads returns text The token rule param text The character set to use cs t-param text The character set type to use CharSet see reference alpha_chars d7YdTQNJGO03J/WSHg33UUwcLdU= text , reference parse laQxW+BBeJINbRrZtau+U15+v7c= text . normal Hcpsm94nYjtK4UZBMIkgrhs9/mg= iGgGf2BXynEIj/9+UbOB6VpcqwM= token_rule boost/url/grammar/token_rule.hpp include/boost/url/grammar/token_rule.hpp 134 1 1 function Hcpsm94nYjtK4UZBMIkgrhs9/mg= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= paragraph text This overload is only available when CharSet is default constructible. paragraph text If there is no more input, the error code reference error::need_more a/THTSv6k7njvbh+81BNyu1ppl8= text is returned. heading text Value Type 1 code using value_type = core::string_view; heading text Example 1 paragraph text Rules are used with the function reference parse laQxW+BBeJINbRrZtau+U15+v7c= text . code system::result< core::string_view > rv = parse( "abcdef", token_rule<alpha_chars_t>() ); heading text BNF 1 code token = 1*( ch ) brief text Match a non-empty string of characters from a default-constructible set returns text The token rule t-param text The character set type to use CharSet see reference alpha_chars d7YdTQNJGO03J/WSHg33UUwcLdU= text , reference parse laQxW+BBeJINbRrZtau+U15+v7c= text . std::is_default_constructible<CharSet>::value specialization m+FYUn7TLf2kNtSNExDzwqrsSB4= token_rule_t identifier kjqcso5U9E4PFvl5kQX9ptGH8vA= implementation_defined normal std::is_default_constructible<CharSet>::value 1 token_rule boost/url/grammar/token_rule.hpp include/boost/url/grammar/token_rule.hpp 93 1 1 function iGgGf2BXynEIj/9+UbOB6VpcqwM= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= paragraph text If there is no more input, the error code reference error::need_more a/THTSv6k7njvbh+81BNyu1ppl8= text is returned. heading text Value Type 1 code using value_type = core::string_view; heading text Example 1 paragraph text Rules are used with the function reference parse laQxW+BBeJINbRrZtau+U15+v7c= text . code system::result< core::string_view > rv = parse( "abcdef", token_rule( alpha_chars ) ); heading text BNF 1 code token = 1*( ch ) brief text Match a non-empty string of characters from a set returns text The token rule param text The character set to use cs see reference alpha_chars d7YdTQNJGO03J/WSHg33UUwcLdU= text , reference parse laQxW+BBeJINbRrZtau+U15+v7c= text . specialization m+FYUn7TLf2kNtSNExDzwqrsSB4= token_rule_t identifier kjqcso5U9E4PFvl5kQX9ptGH8vA= implementation_defined 1 identifier CS cs normal 1 tuple_rule boost/url/grammar/tuple_rule.hpp include/boost/url/grammar/tuple_rule.hpp 126 1 1 function 3dL9L+9O6pMj9teadg4abB/3n2E= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= paragraph text This matches a series of rules in the order specified. Upon success the input is adjusted to point to the first unconsumed character. There is no implicit specification of linear white space between each rule. heading text Value Type 1 code using value_type = __see_below__; paragraph text The sequence rule usually returns a code text std::tuple text containing the the code text value_type text of each corresponding rule in the sequence, except that code text void text values are removed. However, if there is exactly one non-void value type code text T text , then the sequence rule returns code text system::result<T> text instead of code text system::result<tuple<...>> text . heading text Example 1 paragraph text Rules are used with the function reference parse laQxW+BBeJINbRrZtau+U15+v7c= text . code system::result< std::tuple< unsigned char, unsigned char, unsigned char, unsigned char > > rv = parse( "192.168.0.1", tuple_rule( dec_octet_rule, squelch( delim_rule('.') ), dec_octet_rule, squelch( delim_rule('.') ), dec_octet_rule, squelch( delim_rule('.') ), dec_octet_rule ) ); heading text BNF 1 code sequence = rule1 rule2 rule3... heading text Specification 1 list paragraph link text 3.1. Concatenation (rfc5234) https://datatracker.ietf.org/doc/html/rfc5234#section-3.1 unordered brief text Match a series of rules in order returns text The sequence rule param text The first rule to match r0 param text A list of one or more rules to match rn see reference dec_octet_rule wGQE3O3P2kijozE1QPKz8pdNszQ= text , reference delim_rule qF6kM++zYvuIkL97v/RpKnwOR10= text , reference parse laQxW+BBeJINbRrZtau+U15+v7c= text , reference squelch SqrTdaO1Y5GdnwvZBirZfRUnteI= text . specialization nWoWNVw77zLQ6OOna6+pGGaTIdo= tuple_rule_t identifier kjqcso5U9E4PFvl5kQX9ptGH8vA= implementation_defined 1 identifier R0 r0 1 1 identifier Rn rn normal 1 variant_rule boost/url/grammar/variant_rule.hpp include/boost/url/grammar/variant_rule.hpp 107 1 1 function nvXVohM9V8Y+LBy840FJ5xMZrOM= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= paragraph text Each specified rule is tried in sequence. When the first match occurs, the result is stored and returned in the variant. If no match occurs, an error is returned. heading text Value Type 1 code using value_type = variant< typename Rules::value_type... >; heading text Example 1 paragraph text Rules are used with the function reference parse laQxW+BBeJINbRrZtau+U15+v7c= text . code // request-target = origin-form // / absolute-form // / authority-form // / asterisk-form system::result< variant< url_view, url_view, authority_view, core::string_view > > rv = grammar::parse( "/index.html?width=full", variant_rule( origin_form_rule, absolute_uri_rule, authority_rule, delim_rule('*') ) ); heading text BNF 1 code variant = rule1 / rule2 / rule3... heading text Specification 1 list paragraph link text 3.2. Alternatives (rfc5234) https://datatracker.ietf.org/doc/html/rfc5234#section-3.2 paragraph link text 5.3. Request Target (rfc7230) https://datatracker.ietf.org/doc/html/rfc7230#section-5.3 unordered brief text Match one of a set of rules returns text The variant rule param text The first rule to match r0 param text A list of one or more rules to match rn see reference absolute_uri_rule 4SGJz+AJ+UhdwU8wP3Xh11mlvBM= text , reference authority_rule kWc6VwnEqWA0KYFMRYavAgCCB4M= text , reference delim_rule qF6kM++zYvuIkL97v/RpKnwOR10= text , reference parse laQxW+BBeJINbRrZtau+U15+v7c= text , reference origin_form_rule nz+wKEzMLKgYPZA/4y/jAJmzf6I= text , reference url_view wh3UbUToX9YDmRmnpcoM9EUEZo8= text . specialization h8EW/tdUnEu5iJrF1YVO3fGWKNg= variant_rule_t identifier kjqcso5U9E4PFvl5kQX9ptGH8vA= implementation_defined 1 identifier R0 r0 1 1 identifier Rn rn normal 1 operator<< boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 1112 5 1 boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 1124 1 1 function hrpJ3syhXM9TxBwdAWZcTYgV1MM= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= paragraph text Format a string to an output stream brief text Format a string to an output stream returns text A reference to the output stream, for chaining param text The output stream to write to os param text The string to write s identifier XKE0Et5ctFFXvBqg+zp74PL65qE= ostream identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std identifier XKE0Et5ctFFXvBqg+zp74PL65qE= ostream identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std os 1 identifier Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= string_view_base s normal operator== boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 999 5 1 function V8wTrpMKuyusSnj0DQUMT3AGjEM= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= paragraph text This function is only enabled if both arguments are convertible to code text core::string_view text and at least one of the arguments is derived from code text string_view_base text . brief text Compare two string views for equality returns code text true text if the strings are equal, otherwise code text false param text The first string s0 param text The second string s1 is_match<S0, S1>::value identifier bool 1 identifier S0 s0 1 identifier S1 s1 normal is_match<S0, S1>::value 1 operator!= boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 1018 5 1 function +pTwj7vLxN5lirAmjjLZFLgcAIM= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= paragraph text This function is only enabled if both arguments are convertible to code text core::string_view text and at least one of the arguments is derived from code text string_view_base text . brief text Compare two string views for inequality returns code text true text if the strings are not equal, otherwise code text false param text The first string s0 param text The second string s1 is_match<S0, S1>::value identifier bool 1 identifier S0 s0 1 identifier S1 s1 normal is_match<S0, S1>::value 1 operator< boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 1037 5 1 function L/ezmiWj+8oAMQBf/H3xY12Tens= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= paragraph text This function is only enabled if both arguments are convertible to code text core::string_view text and at least one of the arguments is derived from code text string_view_base text . brief text Compare two string views for less than returns code text true text if the first string is less than the second, otherwise code text false param text The first string s0 param text The second string s1 is_match<S0, S1>::value identifier bool 1 identifier S0 s0 1 identifier S1 s1 normal is_match<S0, S1>::value 1 operator<= boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 1056 5 1 function gNMERW7vBJ5oy0+D5SHS3lJwELE= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= paragraph text This function is only enabled if both arguments are convertible to code text core::string_view text and at least one of the arguments is derived from code text string_view_base text . brief text Compare two string views for less than or equal returns code text true text if the first string is less than or equal to the second, otherwise code text false param text The first string s0 param text The second string s1 is_match<S0, S1>::value identifier bool 1 identifier S0 s0 1 identifier S1 s1 normal is_match<S0, S1>::value 1 operator> boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 1075 5 1 function dQbW0x0SHjC6bYCIyGZgDYxSPEc= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= paragraph text This function is only enabled if both arguments are convertible to code text core::string_view text and at least one of the arguments is derived from code text string_view_base text . brief text Compare two string views for greater than returns code text true text if the first string is greater than the second, otherwise code text false param text The first string s0 param text The second string s1 is_match<S0, S1>::value identifier bool 1 identifier S0 s0 1 identifier S1 s1 normal is_match<S0, S1>::value 1 operator>= boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 1094 5 1 function evQmFIytUm7bsb+yuZJVfaz3lp4= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= paragraph text This function is only enabled if both arguments are convertible to code text core::string_view text and at least one of the arguments is derived from code text string_view_base text . brief text Compare two string views for greater than or equal returns code text true text if the first string is greater than or equal to the second, otherwise code text false param text The first string s0 param text The second string s1 is_match<S0, S1>::value identifier bool 1 identifier S0 s0 1 identifier S1 s1 normal is_match<S0, S1>::value 1 all_chars boost/url/grammar/all_chars.hpp include/boost/url/grammar/all_chars.hpp 75 1 1 variable XQO24StkYHcztVq6ahPu5A0nO2I= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= heading text Example 1 paragraph text Character sets are used with rules and the functions reference find_if tYu+dbhQn5Jt+oUv1QmBQz+Z4Mk= text and reference find_if_not o4IF1hl0/rSoqWdSZjOKE4MHFjM= text . code system::result< core::string_view > rv = parse( "JohnDoe", token_rule( all_chars ) ); heading text BNF 1 code ALL = %x00-FF brief text The set of all characters see reference find_if tYu+dbhQn5Jt+oUv1QmBQz+Z4Mk= text , reference find_if_not o4IF1hl0/rSoqWdSZjOKE4MHFjM= text , reference parse laQxW+BBeJINbRrZtau+U15+v7c= text , reference token_rule CLa7o0IwRfen+iyqOmlpKhjqAJg= text . identifier nRXavJqZzPf3zVFXWgsPc/IdjN8= all_chars_t identifier kjqcso5U9E4PFvl5kQX9ptGH8vA= implementation_defined all_chars{} 1 1 alnum_chars boost/url/grammar/alnum_chars.hpp include/boost/url/grammar/alnum_chars.hpp 84 1 1 variable KtYcXkgaXTfO7spDy/S3Zqu5+DQ= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= heading text Example 1 paragraph text Character sets are used with rules and the functions reference find_if tYu+dbhQn5Jt+oUv1QmBQz+Z4Mk= text and reference find_if_not o4IF1hl0/rSoqWdSZjOKE4MHFjM= text . code system::result< core::string_view > = parse( "Johnny42", token_rule( alnumchars ) ); heading text BNF 1 code ALNUM = ALPHA / DIGIT ALPHA = %x41-5A / %x61-7A ; A-Z / a-z DIGIT = %x30-39 ; 0-9 heading text Specification 1 list paragraph link text B.1. Core Rules (rfc5234) https://datatracker.ietf.org/doc/html/rfc5234#appendix-B.1 unordered brief text The set of letters and digits see reference find_if tYu+dbhQn5Jt+oUv1QmBQz+Z4Mk= text , reference find_if_not o4IF1hl0/rSoqWdSZjOKE4MHFjM= text , reference parse laQxW+BBeJINbRrZtau+U15+v7c= text , reference token_rule CLa7o0IwRfen+iyqOmlpKhjqAJg= text . identifier PecAmXu5iFbTP95XO6HABBapM0M= alnum_chars_t identifier kjqcso5U9E4PFvl5kQX9ptGH8vA= implementation_defined {} 1 alpha_chars boost/url/grammar/alpha_chars.hpp include/boost/url/grammar/alpha_chars.hpp 81 1 1 variable d7YdTQNJGO03J/WSHg33UUwcLdU= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= heading text Example 1 paragraph text Character sets are used with rules and the functions reference find_if tYu+dbhQn5Jt+oUv1QmBQz+Z4Mk= text and reference find_if_not o4IF1hl0/rSoqWdSZjOKE4MHFjM= text . code system::result< core::string_view > rv = parse( "JohnDoe", token_rule( alpha_chars ) ); heading text BNF 1 code ALPHA = %x41-5A / %x61-7A ; A-Z / a-z heading text Specification 1 list paragraph link text B.1. Core Rules (rfc5234) https://datatracker.ietf.org/doc/html/rfc5234#appendix-B.1 unordered brief text The set of all letters see reference find_if tYu+dbhQn5Jt+oUv1QmBQz+Z4Mk= text , reference find_if_not o4IF1hl0/rSoqWdSZjOKE4MHFjM= text , reference parse laQxW+BBeJINbRrZtau+U15+v7c= text , reference token_rule CLa7o0IwRfen+iyqOmlpKhjqAJg= text . identifier aZ8NmGk2LhJ7q/tOUwi0dMSLAPY= alpha_chars_t identifier kjqcso5U9E4PFvl5kQX9ptGH8vA= implementation_defined alpha_chars{} 1 dec_octet_rule boost/url/grammar/dec_octet_rule.hpp include/boost/url/grammar/dec_octet_rule.hpp 68 1 1 variable wGQE3O3P2kijozE1QPKz8pdNszQ= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= paragraph text A decimal octet is precise way of saying a number from 0 to 255. These are commonly used in IPv4 addresses. heading text Value Type 1 code using value_type = unsigned char; heading text Example 1 paragraph text Rules are used with the function reference parse laQxW+BBeJINbRrZtau+U15+v7c= text . code system::result< unsigned char > rv = parse( "255", dec_octet_rule ); heading text BNF 1 code dec-octet = DIGIT ; 0-9 / %x31-39 DIGIT ; 10-99 / "1" 2DIGIT ; 100-199 / "2" %x30-34 DIGIT ; 200-249 / "25" %x30-35 ; 250-255 heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Match a decimal octet see reference parse laQxW+BBeJINbRrZtau+U15+v7c= text . identifier HxXn4S3XY1ehyjJnmQaLixjJWW4= dec_octet_rule_t identifier kjqcso5U9E4PFvl5kQX9ptGH8vA= implementation_defined {} 1 digit_chars boost/url/grammar/digit_chars.hpp include/boost/url/grammar/digit_chars.hpp 76 1 1 variable ookgwXeQg4dQaa4byxIjCl6r61k= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= heading text Example 1 paragraph text Character sets are used with rules and the functions reference find_if tYu+dbhQn5Jt+oUv1QmBQz+Z4Mk= text and reference find_if_not o4IF1hl0/rSoqWdSZjOKE4MHFjM= text . code system::result< core::string_view > rv = parse( "2022", token_rule( digit_chars ) ); heading text BNF 1 code DIGIT = %x30-39 ; 0-9 heading text Specification 1 list paragraph link text B.1. Core Rules (rfc5234) https://datatracker.ietf.org/doc/html/rfc5234#appendix-B.1 unordered brief text The set of decimal digits see reference find_if tYu+dbhQn5Jt+oUv1QmBQz+Z4Mk= text , reference find_if_not o4IF1hl0/rSoqWdSZjOKE4MHFjM= text , reference parse laQxW+BBeJINbRrZtau+U15+v7c= text , reference token_rule CLa7o0IwRfen+iyqOmlpKhjqAJg= text . identifier RzrXifCkxfQaJRtdGmnkdmkNNCk= digit_chars_t identifier kjqcso5U9E4PFvl5kQX9ptGH8vA= implementation_defined {} 1 hexdig_chars boost/url/grammar/hexdig_chars.hpp include/boost/url/grammar/hexdig_chars.hpp 97 1 1 variable DL6gFomghn24jmaE6CBpvXe7C6k= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= heading text Example 1 paragraph text Character sets are used with rules and the functions reference find_if tYu+dbhQn5Jt+oUv1QmBQz+Z4Mk= text and reference find_if_not o4IF1hl0/rSoqWdSZjOKE4MHFjM= text . code system::result< core::string_view > rv = parse( "8086FC19", token_rule( hexdig_chars ) ); heading text BNF 1 code HEXDIG = DIGIT / "A" / "B" / "C" / "D" / "E" / "F" / "a" / "b" / "c" / "d" / "e" / "f" admonition paragraph text The RFCs are inconsistent on the case sensitivity of hexadecimal digits. Existing uses suggest case-insensitivity is a de-facto standard. note heading text Specification 1 list paragraph link text B.1. Core Rules (rfc5234) https://datatracker.ietf.org/doc/html/rfc5234#appendix-B.1 paragraph link text 1.2. Syntax Notation (rfc7230) https://datatracker.ietf.org/doc/html/rfc7230#section-1.2 paragraph link text 2.3. Uppercase or Lowercase (rfc5952) https://datatracker.ietf.org/doc/html/rfc5952#section-2.3 paragraph link text 4.3. Lowercase (rfc5952) https://datatracker.ietf.org/doc/html/rfc5952#section-4.3 unordered brief text The set of hexadecimal digits see reference find_if tYu+dbhQn5Jt+oUv1QmBQz+Z4Mk= text , reference find_if_not o4IF1hl0/rSoqWdSZjOKE4MHFjM= text , reference hexdig_value Euqnbrbiv6WcHygsjJQdaZ1rnhg= text , reference parse laQxW+BBeJINbRrZtau+U15+v7c= text , reference token_rule CLa7o0IwRfen+iyqOmlpKhjqAJg= text . identifier thD44DGIe9GW1wf4LsqenuROJj0= hexdig_chars_t identifier kjqcso5U9E4PFvl5kQX9ptGH8vA= implementation_defined {} 1 vchars boost/url/grammar/vchars.hpp include/boost/url/grammar/vchars.hpp 76 1 1 variable 5EAOeMjGjcl9HrYrkUHpxzX2ZpM= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= heading text Example 1 paragraph text Character sets are used with rules and the functions reference find_if tYu+dbhQn5Jt+oUv1QmBQz+Z4Mk= text and reference find_if_not o4IF1hl0/rSoqWdSZjOKE4MHFjM= text . code system::result< core::string_view > rv = parse( "JohnDoe", token_rule( vchars ) ); heading text BNF 1 code VCHAR = 0x21-0x7E ; visible (printing) characters heading text Specification 1 list paragraph link text B.1. Core Rules (rfc5234) https://datatracker.ietf.org/doc/html/rfc5234#appendix-B.1 unordered brief text The set of visible characters see reference find_if tYu+dbhQn5Jt+oUv1QmBQz+Z4Mk= text , reference find_if_not o4IF1hl0/rSoqWdSZjOKE4MHFjM= text , reference parse laQxW+BBeJINbRrZtau+U15+v7c= text , reference token_rule CLa7o0IwRfen+iyqOmlpKhjqAJg= text . identifier 3dzyJ9uJweYXT1VXLoYXSVyuPqg= vchars_t identifier kjqcso5U9E4PFvl5kQX9ptGH8vA= implementation_defined {} 1 CharSet boost/url/grammar/charset.hpp include/boost/url/grammar/charset.hpp 115 1 1 concept FxMSGnhcpF1/OxJmfRXaS2a37Bo= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= paragraph text A code text CharSet text is a unary predicate which is invocable with this equivalent signature: code bool( char ch ) const noexcept; paragraph text The predicate returns code text true text if code text ch text is a member of the set, or code text false text otherwise. heading text Exemplar 1 paragraph text For best results, it is suggested that all constructors and member functions for character sets be marked code text constexpr text . code struct CharSet { bool operator()( char c ) const noexcept; // These are both optional. If either or both are left // unspecified, a default implementation will be used. // char const* find_if( char const* first, char const* last ) const noexcept; char const* find_if_not( char const* first, char const* last ) const noexcept; }; heading text Models 1 list paragraph reference alnum_chars KtYcXkgaXTfO7spDy/S3Zqu5+DQ= paragraph reference alpha_chars d7YdTQNJGO03J/WSHg33UUwcLdU= paragraph reference digit_chars ookgwXeQg4dQaa4byxIjCl6r61k= paragraph reference hexdig_chars DL6gFomghn24jmaE6CBpvXe7C6k= paragraph reference lut_chars 79IFwv0C40oPrhucou1uA6DC1RI= unordered brief text Concept for a CharSet see reference is_charset 0GCmQo0daSi2/pqQuIRhYWbW6lk= text , reference find_if tYu+dbhQn5Jt+oUv1QmBQz+Z4Mk= text , reference find_if_not o4IF1hl0/rSoqWdSZjOKE4MHFjM= text . requires (T const t, char c) { { t(c) } -> std::convertible_to<bool>; } RangeRule boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 88 1 concept J9KhyxiHDUbMsQsnkTAcNgru350= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= requires (T r, char const*& it, char const* end) { typename T::value_type; { r.first(it, end) } -> std::same_as<system::result<typename T::value_type>>; { r.next(it, end) } -> std::same_as<system::result<typename T::value_type>>; } Rule boost/url/grammar/type_traits.hpp include/boost/url/grammar/type_traits.hpp 119 1 1 concept cRU3xcDmjFTdAqKX4QDnvPvWuIU= regular 1HiiaUSr2qeoadbVYr8/BZxU47k= paragraph text This concept is satisfied if code text T text is a valid grammar Rule paragraph text A code text Rule text defines an algorithm used to match an input buffer of ASCII characters against a set of syntactical specifications. paragraph text Each rule represents either a terminal symbol or a composition in the represented grammar. paragraph text The library comes with a set of rules for productions typically found in RFC documents. Rules are not invoked directly; instead, rule variables are used with overloads of reference parse laQxW+BBeJINbRrZtau+U15+v7c= text which provide a convenient, uniform front end. heading text Exemplar 1 paragraph text For best results, it is suggested that all constructors for rules be marked code text constexpr text . code struct Rule { struct value_type; constexpr Rule( Rule const& ) noexcept = default; auto parse( char const*& it, char const* end ) const -> result< value_type >; }; // Declare a variable of type Rule for notational convenience constexpr Rule rule{}; heading text Model 1 list paragraph reference dec_octet_rule wGQE3O3P2kijozE1QPKz8pdNszQ= paragraph reference delim_rule qF6kM++zYvuIkL97v/RpKnwOR10= paragraph reference not_empty_rule T0Kj3BI+iG7hOIjh52aUMxjy2vY= paragraph reference optional_rule f5cvDgg9R+ZZkGkfvf3EI947ciA= paragraph reference range_rule KRm16yawSU2JFWabmZP+Z4VVllM= paragraph reference token_rule CLa7o0IwRfen+iyqOmlpKhjqAJg= paragraph reference tuple_rule 3dL9L+9O6pMj9teadg4abB/3n2E= paragraph reference unsigned_rule RxDnM7pIw/ahE/QBEDu7T14vtTs= paragraph reference variant_rule nvXVohM9V8Y+LBy840FJ5xMZrOM= unordered brief text Concept for a grammar Rule see reference parse laQxW+BBeJINbRrZtau+U15+v7c= text , reference is_rule Lqb+A8s0WInDfI5fYlmrSx9QEaU= text . requires (T t, char const*& it, char const* end) { typename T::value_type; { t.parse(it, end) } -> std::same_as<system::result<typename T::value_type>>; } implementation_defined boost/url/rfc/query_rule.hpp include/boost/url/rfc/query_rule.hpp 21 1 boost/url/authority_view.hpp include/boost/url/authority_view.hpp 31 1 boost/url/rfc/authority_rule.hpp include/boost/url/rfc/authority_rule.hpp 20 1 boost/url/rfc/ipv4_address_rule.hpp include/boost/url/rfc/ipv4_address_rule.hpp 20 1 boost/url/rfc/ipv6_address_rule.hpp include/boost/url/rfc/ipv6_address_rule.hpp 20 1 boost/url/rfc/pct_encoded_rule.hpp include/boost/url/rfc/pct_encoded_rule.hpp 21 1 boost/url/ignore_case.hpp include/boost/url/ignore_case.hpp 18 1 boost/url/params_encoded_view.hpp include/boost/url/params_encoded_view.hpp 25 1 boost/url/url_view.hpp include/boost/url/url_view.hpp 21 1 boost/url/rfc/absolute_uri_rule.hpp include/boost/url/rfc/absolute_uri_rule.hpp 22 1 boost/url/rfc/relative_ref_rule.hpp include/boost/url/rfc/relative_ref_rule.hpp 22 1 boost/url/rfc/uri_rule.hpp include/boost/url/rfc/uri_rule.hpp 22 1 boost/url/rfc/uri_reference_rule.hpp include/boost/url/rfc/uri_reference_rule.hpp 22 1 boost/url/rfc/origin_form_rule.hpp include/boost/url/rfc/origin_form_rule.hpp 22 1 namespace xCd2tUlylXT9zvj8ZcHXybU4P/k= implementation-defined dnk5XPfR2OaMpCYaH3cWSxcTdyc= ULWu8e+1y5m/ZQncGkLNDTIjCng= K+GE1hzkSGKOq3ThCLWBwd5DTuE= X8bO9PzAZhZe4KoaCSz4/o1kias= oNcW0Zh+zvzi9SUKiAhcndAKBL0= A26koPySRJKlDatdXQouZa07zD4= A87uUMvaeqqseND6B+bppJkjKco= CQTpJwwMukasfaQaxylb5piRLpU= 6BnTFtZi8y58Qk6SU1LtvEpeCy0= tojwBud9+1o/12apbTevwuH6eng= Xicirg+nwaf6LsTkCuUaRNAJdRU= HtzG2IcqWtOoDM4HjT7YflVbDwI= absolute_uri_rule_t boost/url/rfc/absolute_uri_rule.hpp include/boost/url/rfc/absolute_uri_rule.hpp 23 1 record ULWu8e+1y5m/ZQncGkLNDTIjCng= implementation-defined xCd2tUlylXT9zvj8ZcHXybU4P/k= struct authority_rule_t boost/url/rfc/authority_rule.hpp include/boost/url/rfc/authority_rule.hpp 21 1 record K+GE1hzkSGKOq3ThCLWBwd5DTuE= implementation-defined xCd2tUlylXT9zvj8ZcHXybU4P/k= struct ignore_case_t boost/url/ignore_case.hpp include/boost/url/ignore_case.hpp 19 1 record X8bO9PzAZhZe4KoaCSz4/o1kias= implementation-defined xCd2tUlylXT9zvj8ZcHXybU4P/k= struct ipv4_address_rule_t boost/url/rfc/ipv4_address_rule.hpp include/boost/url/rfc/ipv4_address_rule.hpp 21 1 record oNcW0Zh+zvzi9SUKiAhcndAKBL0= implementation-defined xCd2tUlylXT9zvj8ZcHXybU4P/k= struct ipv6_address_rule_t boost/url/rfc/ipv6_address_rule.hpp include/boost/url/rfc/ipv6_address_rule.hpp 21 1 record A26koPySRJKlDatdXQouZa07zD4= implementation-defined xCd2tUlylXT9zvj8ZcHXybU4P/k= struct origin_form_rule_t boost/url/rfc/origin_form_rule.hpp include/boost/url/rfc/origin_form_rule.hpp 23 1 record A87uUMvaeqqseND6B+bppJkjKco= implementation-defined xCd2tUlylXT9zvj8ZcHXybU4P/k= struct pct_encoded_rule_t boost/url/rfc/pct_encoded_rule.hpp include/boost/url/rfc/pct_encoded_rule.hpp 22 1 record CQTpJwwMukasfaQaxylb5piRLpU= implementation-defined xCd2tUlylXT9zvj8ZcHXybU4P/k= struct query_rule_t boost/url/rfc/query_rule.hpp include/boost/url/rfc/query_rule.hpp 22 1 record 6BnTFtZi8y58Qk6SU1LtvEpeCy0= implementation-defined xCd2tUlylXT9zvj8ZcHXybU4P/k= struct relative_ref_rule_t boost/url/rfc/relative_ref_rule.hpp include/boost/url/rfc/relative_ref_rule.hpp 23 1 record tojwBud9+1o/12apbTevwuH6eng= implementation-defined xCd2tUlylXT9zvj8ZcHXybU4P/k= struct uri_reference_rule_t boost/url/rfc/uri_reference_rule.hpp include/boost/url/rfc/uri_reference_rule.hpp 23 1 record Xicirg+nwaf6LsTkCuUaRNAJdRU= implementation-defined xCd2tUlylXT9zvj8ZcHXybU4P/k= struct uri_rule_t boost/url/rfc/uri_rule.hpp include/boost/url/rfc/uri_rule.hpp 23 1 record HtzG2IcqWtOoDM4HjT7YflVbDwI= implementation-defined xCd2tUlylXT9zvj8ZcHXybU4P/k= struct string_token boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 21 1 namespace MOmWJXtSzgLTSr4XFeqs4WKGaYg= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= O+lYzaE50zG6Wg5LleV++3OOUEs= tg/ApK6TM6XpySJns5Q9zB1S60E= +eBzDECNPyuTkJuxLUTMVIkHGO0= /Ms5TE7Usr0vyzWIpbiWwwjHmsQ= 657Y/qnBMdOobmCovZEJGWakbuQ= JadNPSlWP76bKc9Cq5seHXWit8I= CAKXRQIef8SLa5IvBeYCoXyvTfA= fM86dXw+ZpKZYpM3FEPTWTfxPrg= implementation_defined boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 96 1 boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 244 1 boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 281 1 boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 347 1 boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 410 1 namespace O+lYzaE50zG6Wg5LleV++3OOUEs= implementation-defined MOmWJXtSzgLTSr4XFeqs4WKGaYg= qk3wRWnqc04moCliBfKp16M/BmI= p1tCSXxSDvT3AW53bCFq0imv3FM= iH1VM9nUmajjxJ8dOC2jkBlhtEk= vVkR3dwQYI3GG+xXTTanjEx0N8E= nV2aMdRFK2/efNzMlYylkOQ9NaA= append_to_t boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 282 1 record qk3wRWnqc04moCliBfKp16M/BmI= implementation-defined O+lYzaE50zG6Wg5LleV++3OOUEs= struct identifier /Ms5TE7Usr0vyzWIpbiWwwjHmsQ= arg assign_to_t boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 348 1 record p1tCSXxSDvT3AW53bCFq0imv3FM= implementation-defined O+lYzaE50zG6Wg5LleV++3OOUEs= struct identifier /Ms5TE7Usr0vyzWIpbiWwwjHmsQ= arg is_token boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 97 1 record iH1VM9nUmajjxJ8dOC2jkBlhtEk= implementation-defined O+lYzaE50zG6Wg5LleV++3OOUEs= struct identifier lTUoA6OkHYQaJQjJcb3WGNd183s= false_type identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std preserve_size_t boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 411 1 record vVkR3dwQYI3GG+xXTTanjEx0N8E= implementation-defined O+lYzaE50zG6Wg5LleV++3OOUEs= struct identifier /Ms5TE7Usr0vyzWIpbiWwwjHmsQ= arg return_string boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 245 1 record nV2aMdRFK2/efNzMlYylkOQ9NaA= implementation-defined O+lYzaE50zG6Wg5LleV++3OOUEs= struct identifier /Ms5TE7Usr0vyzWIpbiWwwjHmsQ= arg is_token boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 130 1 1 typedef tg/ApK6TM6XpySJns5Q9zB1S60E= regular MOmWJXtSzgLTSr4XFeqs4WKGaYg= paragraph text This trait returns code text true text if code text T text is a valid reference StringToken fM86dXw+ZpKZYpM3FEPTWTfxPrg= text type, and code text false text otherwise. heading text Example 1 code static_assert( string_token::is_token<T>::value ); brief text Trait to determine if a type is a string token specialization iH1VM9nUmajjxJ8dOC2jkBlhtEk= is_token identifier O+lYzaE50zG6Wg5LleV++3OOUEs= implementation_defined 1 return_string boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 277 1 1 typedef +eBzDECNPyuTkJuxLUTMVIkHGO0= regular MOmWJXtSzgLTSr4XFeqs4WKGaYg= paragraph text This reference StringToken fM86dXw+ZpKZYpM3FEPTWTfxPrg= text is used to customize a function to return a plain string. paragraph text This is default token type used by the methods of reference url_view_base UEVNhDEjkZMXfjN1DxbtX0n2rCg= text that return decoded strings. brief text A string token for returning a plain string identifier nV2aMdRFK2/efNzMlYylkOQ9NaA= return_string identifier O+lYzaE50zG6Wg5LleV++3OOUEs= implementation_defined 1 arg boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 51 1 1 record /Ms5TE7Usr0vyzWIpbiWwwjHmsQ= regular MOmWJXtSzgLTSr4XFeqs4WKGaYg= paragraph text This abstract interface provides a means for an algorithm to generically obtain a modifiable, contiguous character buffer of prescribed size. paragraph text A reference StringToken fM86dXw+ZpKZYpM3FEPTWTfxPrg= text should be derived from this class. As the author of an algorithm using a reference StringToken fM86dXw+ZpKZYpM3FEPTWTfxPrg= text , simply declare an rvalue reference as a parameter type. paragraph text Instances of this type are intended only to be used once and then destroyed. heading text Example 1 paragraph text The declared function accepts any temporary instance of code text arg text to be used for writing: code void algorithm( string_token::arg&& dest ); paragraph text To implement the interface for your type or use-case, derive from the class and implement the prepare function. brief text Base class for string tokens, and algorithm parameters struct aCcI9OhG0nKybstr3nn/6mfXdDU= zSRqibM9SncGIoNN6BiVsHpXjRE= ggzA/79W9YI7+guIMkpJ4kEurvw= xQSGtCyEyObIGl1DVrkpHN8POo8= arg boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 79 5 1 overloads aCcI9OhG0nKybstr3nn/6mfXdDU= regular /Ms5TE7Usr0vyzWIpbiWwwjHmsQ= brief text Constructors constructor Eqc3G+vU4onpogKjNx2FnzVWVRY= UWs4u9jWkIa48I4XPUfUExqrKaY= z4BOjAdOsfR07Q4W2YMFvpLJp64= identifier void arg boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 79 5 1 function Eqc3G+vU4onpogKjNx2FnzVWVRY= regular /Ms5TE7Usr0vyzWIpbiWwwjHmsQ= brief text Default constructor identifier void constructor 1 1 1 arg boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 85 5 1 function UWs4u9jWkIa48I4XPUfUExqrKaY= regular /Ms5TE7Usr0vyzWIpbiWwwjHmsQ= brief text Deleted copy constructor param text The object to copy construct from other identifier void 1 identifier /Ms5TE7Usr0vyzWIpbiWwwjHmsQ= arg other constructor 1 1 1 arg boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 82 5 1 function z4BOjAdOsfR07Q4W2YMFvpLJp64= regular /Ms5TE7Usr0vyzWIpbiWwwjHmsQ= brief text Default move constructor param text The object to move construct from other identifier void identifier /Ms5TE7Usr0vyzWIpbiWwwjHmsQ= arg other constructor 1 1 1 ~arg boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 76 5 1 function zSRqibM9SncGIoNN6BiVsHpXjRE= regular /Ms5TE7Usr0vyzWIpbiWwwjHmsQ= brief text Virtual destructor identifier void destructor 1 1 1 1 1 operator= boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 88 5 1 overloads ggzA/79W9YI7+guIMkpJ4kEurvw= regular /Ms5TE7Usr0vyzWIpbiWwwjHmsQ= brief text Assignment operators normal FW5efXSRGX7IqtbPH7xSoVbGoZo= 8yIy2NSmgVSsLpNu9up2hjpSZJA= identifier /Ms5TE7Usr0vyzWIpbiWwwjHmsQ= arg operator= boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 91 5 1 function FW5efXSRGX7IqtbPH7xSoVbGoZo= regular /Ms5TE7Usr0vyzWIpbiWwwjHmsQ= brief text Deleted copy assignment returns text Reference to the current object param text The object to copy assign from other identifier /Ms5TE7Usr0vyzWIpbiWwwjHmsQ= arg 1 identifier /Ms5TE7Usr0vyzWIpbiWwwjHmsQ= arg other normal 1 1 1 operator= boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 88 5 1 function 8yIy2NSmgVSsLpNu9up2hjpSZJA= regular /Ms5TE7Usr0vyzWIpbiWwwjHmsQ= brief text Deleted move assignment returns text Reference to the current object param text The object to move assign from other identifier /Ms5TE7Usr0vyzWIpbiWwwjHmsQ= arg identifier /Ms5TE7Usr0vyzWIpbiWwwjHmsQ= arg other normal 1 1 1 prepare boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 73 5 1 function xQSGtCyEyObIGl1DVrkpHN8POo8= regular /Ms5TE7Usr0vyzWIpbiWwwjHmsQ= paragraph text This function attempts to obtain a character buffer with space for at least code text n text characters. Upon success, a pointer to the beginning of the buffer is returned. Ownership is not transferred; the caller should not attempt to free the storage. The buffer shall remain valid until code text this text is destroyed. admonition paragraph text This function may only be called once. After invoking the function, the only valid operation is destruction. note brief text Return a modifiable character buffer returns text A pointer to the buffer param text The number of characters needed n identifier char identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std n normal 1 1 1 1 append_to boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 332 1 1 function 657Y/qnBMdOobmCovZEJGWakbuQ= regular MOmWJXtSzgLTSr4XFeqs4WKGaYg= paragraph text This function creates a reference StringToken fM86dXw+ZpKZYpM3FEPTWTfxPrg= text which appends to an existing plain string. paragraph text Functions using this token will append the result to the existing string and return a reference to it. brief text Create a string token for appending to a plain string returns text A string token param text The string to append s specialization qk3wRWnqc04moCliBfKp16M/BmI= append_to_t identifier O+lYzaE50zG6Wg5LleV++3OOUEs= implementation_defined specialization kYE4IglJHJ8WYSpLchudIQDah/o= basic_string identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std s normal assign_to boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 395 1 1 function JadNPSlWP76bKc9Cq5seHXWit8I= regular MOmWJXtSzgLTSr4XFeqs4WKGaYg= paragraph text This function creates a reference StringToken fM86dXw+ZpKZYpM3FEPTWTfxPrg= text which assigns to an existing plain string. paragraph text Functions using this token will assign the result to the existing string and return a reference to it. brief text Create a string token for assigning to a plain string returns text A string token param text The string to assign s specialization p1tCSXxSDvT3AW53bCFq0imv3FM= assign_to_t identifier O+lYzaE50zG6Wg5LleV++3OOUEs= implementation_defined specialization kYE4IglJHJ8WYSpLchudIQDah/o= basic_string identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std s normal preserve_size boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 464 1 1 function CAKXRQIef8SLa5IvBeYCoXyvTfA= regular MOmWJXtSzgLTSr4XFeqs4WKGaYg= paragraph text This function creates a reference StringToken fM86dXw+ZpKZYpM3FEPTWTfxPrg= text which assigns to an existing plain string. paragraph text Functions using this token will assign the result to the existing string and return a code text core::string_view text to it. brief text Create a string token for a durable core::string_view returns text A string token param text The string to preserve s specialization vVkR3dwQYI3GG+xXTTanjEx0N8E= preserve_size_t identifier O+lYzaE50zG6Wg5LleV++3OOUEs= implementation_defined specialization kYE4IglJHJ8WYSpLchudIQDah/o= basic_string identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std s normal StringToken boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 231 1 1 concept fM86dXw+ZpKZYpM3FEPTWTfxPrg= regular MOmWJXtSzgLTSr4XFeqs4WKGaYg= paragraph text This concept is satisfied if code text T text is a valid string token type. paragraph text A string token is an rvalue passed to a function template which customizes the return type of the function and also controls how a modifiable character buffer is obtained and presented. paragraph text The string token's lifetime extends only for the duration of the function call in which it appears as a parameter. paragraph text A string token cannot be copied, moved, or assigned, and must be destroyed when the function returns or throws. heading text Semantics 1 paragraph code text T::result_type text determines the return type of functions that accept a string token. paragraph text The code text prepare() text function overrides the virtual function in the base class reference arg /Ms5TE7Usr0vyzWIpbiWwwjHmsQ= text . It must return a pointer to a character buffer of at least size code text n text , otherwise throw an exception. This function is called only once or not at all. paragraph text The code text result() text function is invoked by the algorithm to receive the result from the string token. It is only invoked if code text prepare() text returned successfully and the string token was not destroyed. It is only called after code text prepare() text returns successfully, and the string token is destroyed when the algorithm completes or if an exception is thrown. paragraph text String tokens cannot be reused. heading text Exemplars 1 paragraph text String token prototype: code struct StringToken : string_token::arg { using result_type = std::string; char* prepare( std::size_t n ) override; result_type result(); }; paragraph text Algorithm prototype: code namespace detail { // Algorithm implementation may be placed // out of line, and written as an ordinary // function (no template required). void algorithm_impl( string_token::arg& token ) { std::size_t n = 0; // calculate space needed in n // ... // acquire a destination buffer char* dest = token.prepare( n ); // write the characters to the buffer } } // detail // public interface is a function template, // defaulting to return std::string. template< class StringToken = string_token::return_string > auto algorithm( StringToken&& token = {} ) -> typename StringToken::result_type { // invoke the algorithm with the token algorithm_impl( token ); // return the result from the token return token.result(); } heading text Models 1 paragraph text The following classes and functions implement and generate string tokens. list paragraph reference return_string +eBzDECNPyuTkJuxLUTMVIkHGO0= paragraph reference assign_to JadNPSlWP76bKc9Cq5seHXWit8I= paragraph reference preserve_size CAKXRQIef8SLa5IvBeYCoXyvTfA= unordered brief text Concept for a string token std::derived_from<T, string_token::arg> && requires (T t, std::size_t n) { typename T::result_type; { t.prepare(n) } -> std::same_as<char*>; { t.result() } -> std::convertible_to<typename T::result_type>; } format_arg boost/url/format.hpp include/boost/url/format.hpp 72 1 1 typedef SSBC59C6XUs+gwNHiw2EV5oj4Pg= see-below dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text This class represents a temporary reference to a formatting argument used by the reference format ZTww0Dx20RT0z0QTruz8U8gZuIY= text function. paragraph text A reference format ZTww0Dx20RT0z0QTruz8U8gZuIY= text argument should always be created by passing the argument to be formatted directly to the reference format ZTww0Dx20RT0z0QTruz8U8gZuIY= text function. paragraph text Any type that can be formatted into a URL with the reference format ZTww0Dx20RT0z0QTruz8U8gZuIY= text function is convertible to this type. paragraph text This includes basic types, types convertible to code text core::string_view text , and reference named_arg HO2ZXp4PSbe153fApaGEDkq0ks0= text . brief text A temporary reference to a formatting argument see reference format ZTww0Dx20RT0z0QTruz8U8gZuIY= text , reference format_to FNXbTBfIxbiM2pjYEryMCZH+yoY= text , reference arg IQym8fO7DIG67s+M2rtFQszkoaY= text . identifier /zMrc2EfowBhSEHWufUSB6T3OeI= format_arg identifier N0a0PcWBzeWPZcu7RT7dbUuOvwU= detail 1 named_arg boost/url/format.hpp include/boost/url/format.hpp 47 1 1 typedef HO2ZXp4PSbe153fApaGEDkq0ks0= see-below dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text This class represents a temporary reference to a named formatting argument used by the reference format ZTww0Dx20RT0z0QTruz8U8gZuIY= text function. paragraph text Named arguments should always be created with the reference arg IQym8fO7DIG67s+M2rtFQszkoaY= text function. paragraph text Any type that can be formatted into a URL with the reference format ZTww0Dx20RT0z0QTruz8U8gZuIY= text function can also be used in a named argument. All named arguments are convertible to reference format_arg SSBC59C6XUs+gwNHiw2EV5oj4Pg= text and can be used in the reference format ZTww0Dx20RT0z0QTruz8U8gZuIY= text function. brief text A temporary reference to a named formatting argument see reference arg IQym8fO7DIG67s+M2rtFQszkoaY= text , reference format ZTww0Dx20RT0z0QTruz8U8gZuIY= text , reference format_to FNXbTBfIxbiM2pjYEryMCZH+yoY= text , reference format_arg SSBC59C6XUs+gwNHiw2EV5oj4Pg= text . specialization 81sFU1ap8/xDfdip9jIZTHzrnZc= named_arg identifier N0a0PcWBzeWPZcu7RT7dbUuOvwU= detail 1 optional boost/url/optional.hpp include/boost/url/optional.hpp 38 1 1 typedef oSAYJle80BcL838BBRX63lch/5Q= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= admonition paragraph text This alias is no longer supported and should not be used in new code. Please use code text boost::optional text instead. warning paragraph text This alias is included for backwards compatibility with earlier versions of the library. paragraph text However, it will be removed in future releases, and using it in new code is not recommended. paragraph text Please use the updated version instead to ensure compatibility with future versions of the library. brief text The type of optional used by the library specialization pvbTh8h5rATyXjIZZScz9NuTDj8= optional identifier +jO0pmMB/RXahxtatVUYoEwUKWs= boost 1 string_view boost/url/string_view.hpp include/boost/url/string_view.hpp 45 1 1 typedef eTmWJVJVu1SBdk3eyejLHvdkz6o= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text String views are used to pass character buffers into or out of functions. Ownership of the underlying character buffer is not transferred; the caller is responsible for ensuring that the lifetime of character buffer extends until it is no longer referenced. admonition paragraph text This alias is no longer supported and should not be used in new code. Please use code text core::string_view text instead. warning paragraph text This alias is included for backwards compatibility with earlier versions of the library. paragraph text However, it will be removed in future releases, and using it in new code is not recommended. paragraph text Please use the updated version instead to ensure compatibility with future versions of the library. brief text The type of string_view used by the library identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core identifier +jO0pmMB/RXahxtatVUYoEwUKWs= boost 1 variant boost/url/variant.hpp include/boost/url/variant.hpp 37 1 1 typedef FhVAnUhR1V4cDQt6TPQXGyakQHc= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= admonition paragraph text This alias is no longer supported and should not be used in new code. Please use code text boost::variant2::variant text instead. warning paragraph text This alias is included for backwards compatibility with earlier versions of the library. paragraph text However, it will be removed in future releases, and using it in new code is not recommended. paragraph text Please use the updated version instead to ensure compatibility with future versions of the library. brief text The type of variant used by the library specialization QtGP2EEaL9TZCpBhc3ngTWkaUfQ= variant identifier 4XJlIWBo4vCVWjuTJ0zRUf6DK6U= variant2 identifier +jO0pmMB/RXahxtatVUYoEwUKWs= boost 1 authority_view boost/url/authority_view.hpp include/boost/url/authority_view.hpp 92 1 1 boost/url/detail/url_impl.hpp include/boost/url/detail/url_impl.hpp 27 1 record d/hMlyyC3Ave6L9McUD7B4TwENA= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text Objects of this type represent valid authority strings constructed from a parsed, external character buffer whose storage is managed by the caller. That is, it acts like a code text core::string_view text in terms of ownership. The caller is responsible for ensuring that the lifetime of the underlying character buffer extends until it is no longer referenced. heading text Example 1 1 paragraph text Construction from a string parses the input as an emph text authority text and throws an exception on error. Upon success, the constructed object points to the passed character buffer; ownership is not transferred. code authority_view a( "user:pass@www.example.com:8080" ); heading text Example 2 1 paragraph text The parsing function reference parse_authority dl7C/yP8Suze9+hv0RfYWxZaWCY= text returns a code text boost::system::result text containing either a valid reference authority_view VG25Omuk4IV1p0/lkJXq0DRNeh8= text upon success, otherwise it contains an error. The error can be converted to an exception by the caller if desired: code system::result< authority_view > rv = parse_authority( "user:pass@www.example.com:8080" ); heading text BNF 1 code authority = [ userinfo "@" ] host [ ":" port ] userinfo = user [ ":" [ password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) host = IP-literal / IPv4address / reg-name port = *DIGIT heading text Specification 1 list paragraph link text 3.2. Authority (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2 unordered brief text A non-owning reference to a valid authority see reference parse_authority dl7C/yP8Suze9+hv0RfYWxZaWCY= text . reference parse_authority dl7C/yP8Suze9+hv0RfYWxZaWCY= class VG25Omuk4IV1p0/lkJXq0DRNeh8= kUygN07qrKzz6xqsD2JO6tNbXRI= uU1W5xbMeHDGB5MqSuuAAAYhZjg= P11NP4P7YOcRNK3kZisALpUqCEQ= ib5/wfiEadKVMAM8qFs77UqtQfs= xZrp4JdBQftr1jfEJocAOyzN32c= M1x440VyVqSlmfc5lWyOZfepvb4= Zb+sv7mtlA9nc7tOl2UKjDFlFbU= LPU+syg+CdCexu20vM5i/h+g8MA= 5N16Bqd0+ZgJHR1NiZKAJK9EqwU= h9voFAeGtZlYmI+yXt56u3fAJIU= 664kp4dyV0Fx8/OmpypdBDspW4w= WjFBzWA+QC4kWYmVk8wQqzyzjsY= mHvLEk+wU7kVqeR1MftB7V7RXj8= kld0eiD6C4e3P/TIBG1sVBTu9EI= IphAWosew2EkzMVgRvkC/OAJ0xw= ufGAEpjGVrDAR7Z/aWObLlB+/Fw= 1LoM2HiWtDiQycXsUvfWZhe6Hvc= OTOc1CgK/GuawlFPXjjcK6odYOE= kVlbEpr6oa5by3+amQ8PBNKaZjA= xMoi4KmbAmlKw5kq0RD+z3ZhDuM= hIAl5fITeDqPWPPjGVlSz2zibgA= GMMqkVh5s3w58Fu0mI0lczX9Y3Q= IyzTSrM6qF8ExmSAjRe6jouLT5w= ROTG9938TiCaHNr0Rzc3CrPNSQc= k1FyNKXMpBVt6GfboIAkuHq+/3I= Io13bUCUJtWDXQuR23TbsYoTs5s= QoOOAaTfBdgqXsOWD90X3tltfF4= k0L9aRcMAFLBOG3fVUZA4rt/Q5k= E7fOFpu0yWBp7ZqmLKZ88iVethA= jdf31mkMT4HmL3GV0YxqKuoRYXU= 8LLQ58GINNJYjJuDZhOUl9JIi1c= 62w3cvZ1uSKt/7VWLepmVSNqb5s= hFJopnR14fIqBpDu1GGpNyp3Y5c= jlb8m5L+4Dp3wPZXOocje2gAGok= F1TeTah5Uxojczk8Fz++HrM66vU= qFHmi5LkvIRpILiiWOHp9hOpYQA= NxK2yg1Y7T4SxurWSwoUG97wrN0= ktBT7dVJ8LGHL6lYOr37Ts3gI4I= identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base aHkFCWJbYb0t+7FT+A5gCI0krpU= identifier UEVNhDEjkZMXfjN1DxbtX0n2rCg= url_view_base UEVNhDEjkZMXfjN1DxbtX0n2rCg= authority_view boost/url/authority_view.hpp include/boost/url/authority_view.hpp 145 5 1 boost/url/authority_view.hpp include/boost/url/authority_view.hpp 188 5 1 overloads VG25Omuk4IV1p0/lkJXq0DRNeh8= regular d/hMlyyC3Ave6L9McUD7B4TwENA= brief text Constructors param text The string to parse s see reference parse_authority dl7C/yP8Suze9+hv0RfYWxZaWCY= text . constructor 7hcySrM84Ao7kfBT3tInlrFE2mk= Qh3kGhIBnWwC5OdtBXHEX7oxk9g= Mggxod/TZ1rIFXqnjEPBAT5FCb8= identifier void authority_view boost/url/authority_view.hpp include/boost/url/authority_view.hpp 145 5 1 function 7hcySrM84Ao7kfBT3tInlrFE2mk= regular d/hMlyyC3Ave6L9McUD7B4TwENA= paragraph text Default constructed authorities refer to a string with zero length, which is always valid. This matches the grammar for a zero-length host. heading text Exception Safety 1 paragraph text Throws nothing. heading text Specification 1 brief text Constructor identifier void constructor 1 authority_view boost/url/authority_view.hpp include/boost/url/authority_view.hpp 194 5 1 function Qh3kGhIBnWwC5OdtBXHEX7oxk9g= regular d/hMlyyC3Ave6L9McUD7B4TwENA= brief text Constructor param text The object to copy construct from other identifier void 1 identifier d/hMlyyC3Ave6L9McUD7B4TwENA= authority_view other constructor 1 1 1 authority_view boost/url/authority_view.hpp include/boost/url/authority_view.hpp 188 5 1 function Mggxod/TZ1rIFXqnjEPBAT5FCb8= regular d/hMlyyC3Ave6L9McUD7B4TwENA= paragraph text This function attempts to construct an authority from the string code text s text , which must be a valid authority or else an exception is thrown. Upon successful construction, the view refers to the characters in the buffer pointed to by code text s text . Ownership is not transferred; the caller is responsible for ensuring that the lifetime of the buffer extends until the view is destroyed. heading text BNF 1 code authority = [ userinfo "@" ] host [ ":" port ] userinfo = user [ ":" [ password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) host = IP-literal / IPv4address / reg-name port = *DIGIT heading text Specification 1 list paragraph link text 3.2. Authority (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2 unordered brief text Construct from a string. param text The string to parse s see reference parse_authority dl7C/yP8Suze9+hv0RfYWxZaWCY= text . identifier void identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s constructor 1 ~authority_view boost/url/authority_view.hpp include/boost/url/authority_view.hpp 123 5 1 function kUygN07qrKzz6xqsD2JO6tNbXRI= regular d/hMlyyC3Ave6L9McUD7B4TwENA= brief text Destructor identifier void destructor 1 1 1 operator= boost/url/authority_view.hpp include/boost/url/authority_view.hpp 209 5 1 function uU1W5xbMeHDGB5MqSuuAAAYhZjg= regular d/hMlyyC3Ave6L9McUD7B4TwENA= paragraph text This function assigns the contents of code text other text to this object. heading text Exception Safety 1 paragraph text Throws nothing. brief text Assignment returns text A reference to this object param text The object to assign other identifier d/hMlyyC3Ave6L9McUD7B4TwENA= authority_view 1 identifier d/hMlyyC3Ave6L9McUD7B4TwENA= authority_view other normal 1 1 1 buffer boost/url/authority_view.hpp include/boost/url/authority_view.hpp 303 5 1 function P11NP4P7YOcRNK3kZisALpUqCEQ= regular d/hMlyyC3Ave6L9McUD7B4TwENA= paragraph text This function returns the authority as a percent-encoded string. heading text Example 1 code assert( parse_authority( "www.example.com" ).value().buffer() == "www.example.com" ); heading text BNF 1 code authority = [ userinfo "@" ] host [ ":" port ] heading text Exception Safety 1 paragraph text Throws nothing. heading text Specification 1 list paragraph link text 3.2. Authority (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2 unordered brief text Return the complete authority returns text The complete authority identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core normal 1 1 compare boost/url/authority_view.hpp include/boost/url/authority_view.hpp 1349 5 1 function ib5/wfiEadKVMAM8qFs77UqtQfs= regular d/hMlyyC3Ave6L9McUD7B4TwENA= paragraph text This function compares two authorities according to Syntax-Based comparison algorithm. heading text Exception Safety 1 paragraph text Throws nothing. heading text Specification 1 list paragraph link text 6.2.2 Syntax-Based Normalization (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-6.2.2 unordered brief text Return the result of comparing this with another authority returns code text -1 text if code text *this < other text , code text 0 text if code text this == other text , and 1 if code text this > other text . param text The authority to compare other identifier int 1 identifier d/hMlyyC3Ave6L9McUD7B4TwENA= authority_view other normal 1 1 data boost/url/authority_view.hpp include/boost/url/authority_view.hpp 273 5 1 function xZrp4JdBQftr1jfEJocAOyzN32c= regular d/hMlyyC3Ave6L9McUD7B4TwENA= paragraph text This function returns a pointer to the beginning of the view, which is not guaranteed to be null-terminated. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return a pointer to the first character returns text A pointer to the first character 1 identifier char normal 1 1 empty boost/url/authority_view.hpp include/boost/url/authority_view.hpp 256 5 1 function M1x440VyVqSlmfc5lWyOZfepvb4= regular d/hMlyyC3Ave6L9McUD7B4TwENA= paragraph text An empty authority has an empty host, no userinfo, and no port. heading text Example 1 code assert( authority_view( "" ).empty() ); heading text Exception Safety 1 paragraph text Throws nothing. brief text Return true if the authority is empty returns code text true text if the authority is empty identifier bool normal 1 1 encoded_host boost/url/authority_view.hpp include/boost/url/authority_view.hpp 824 5 1 function Zb+sv7mtlA9nc7tOl2UKjDFlFbU= regular d/hMlyyC3Ave6L9McUD7B4TwENA= paragraph text This function returns the host portion of the authority as a string, or the empty string if there is no authority. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "https://www%2droot.example.com/" ).encoded_host() == "www%2droot.example.com" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPvFuture ) "]" reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host returns text The host identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_host_address boost/url/authority_view.hpp include/boost/url/authority_view.hpp 944 5 1 function LPU+syg+CdCexu20vM5i/h+g8MA= regular d/hMlyyC3Ave6L9McUD7B4TwENA= paragraph text The value returned by this function depends on the type of host returned from the function reference host_type IyzTSrM6qF8ExmSAjRe6jouLT5w= text . list paragraph text If the type is reference host_type::ipv4 49F64dAiji9HVbP6MxLQiqot7AY= text , then the IPv4 address string is returned. paragraph text If the type is reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= text , then the IPv6 address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::ipvfuture TcYJaTwDFsx+0S2CkvHHARcCqWc= text , then the IPvFuture address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= text , then the host name string is returned. Any percent-escapes in the string are decoded first. paragraph text If the type is reference host_type::none QyoMTu07h232/Sxqovu2mGoPgTo= text , then an empty string is returned. The returned string may contain percent escapes. unordered heading text Example 1 code assert( url_view( "https://www%2droot.example.com/" ).encoded_host_address() == "www%2droot.example.com" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPvFuture ) "]" reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host returns text The host address identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_host_and_port boost/url/authority_view.hpp include/boost/url/authority_view.hpp 1321 5 1 function 5N16Bqd0+ZgJHR1NiZKAJK9EqwU= regular d/hMlyyC3Ave6L9McUD7B4TwENA= paragraph text If an authority is present, this function returns the host and optional port as a string, which may be empty. Otherwise it returns an empty string. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "http://www.example.com:8080/index.htm" ).encoded_host_and_port() == "www.example.com:8080" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code authority = [ userinfo "@" ] host [ ":" port ] heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 paragraph link text 3.2.3. Port (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.3 unordered brief text Return the host and port returns text The host and port see reference has_port IphAWosew2EkzMVgRvkC/OAJ0xw= text , reference port k1FyNKXMpBVt6GfboIAkuHq+/3I= text , reference port_number Io13bUCUJtWDXQuR23TbsYoTs5s= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_host_name boost/url/authority_view.hpp include/boost/url/authority_view.hpp 1159 5 1 function h9voFAeGtZlYmI+yXt56u3fAJIU= regular d/hMlyyC3Ave6L9McUD7B4TwENA= paragraph text If the host type is reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= text , this function returns the name as a string. Otherwise, if the host type is not an name, it returns an empty string. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "https://www%2droot.example.com/" ).encoded_host_name() == "www%2droot.example.com" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPvFuture ) "]" reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host name returns text The host name identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_password boost/url/authority_view.hpp include/boost/url/authority_view.hpp 700 5 1 function 664kp4dyV0Fx8/OmpypdBDspW4w= regular d/hMlyyC3Ave6L9McUD7B4TwENA= paragraph text This function returns the password portion of the userinfo as a percent-encoded string. heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).encoded_password() == "pass" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code userinfo = user [ ":" [ password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return the password returns text The password see reference has_password kld0eiD6C4e3P/TIBG1sVBTu9EI= text , reference has_userinfo ufGAEpjGVrDAR7Z/aWObLlB+/Fw= text , reference encoded_user WjFBzWA+QC4kWYmVk8wQqzyzjsY= text , reference encoded_userinfo mHvLEk+wU7kVqeR1MftB7V7RXj8= text , reference password ROTG9938TiCaHNr0Rzc3CrPNSQc= text , reference user k0L9aRcMAFLBOG3fVUZA4rt/Q5k= text , reference userinfo E7fOFpu0yWBp7ZqmLKZ88iVethA= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_user boost/url/authority_view.hpp include/boost/url/authority_view.hpp 558 5 1 function WjFBzWA+QC4kWYmVk8wQqzyzjsY= regular d/hMlyyC3Ave6L9McUD7B4TwENA= paragraph text If present, this function returns a string representing the user (which may be empty). Otherwise it returns an empty string. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).encoded_user() == "jane%2Ddoe" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code userinfo = user [ ":" [ password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return the user returns text The user see reference has_password kld0eiD6C4e3P/TIBG1sVBTu9EI= text , reference has_userinfo ufGAEpjGVrDAR7Z/aWObLlB+/Fw= text , reference encoded_password 664kp4dyV0Fx8/OmpypdBDspW4w= text , reference encoded_userinfo mHvLEk+wU7kVqeR1MftB7V7RXj8= text , reference password ROTG9938TiCaHNr0Rzc3CrPNSQc= text , reference user k0L9aRcMAFLBOG3fVUZA4rt/Q5k= text , reference userinfo E7fOFpu0yWBp7ZqmLKZ88iVethA= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_userinfo boost/url/authority_view.hpp include/boost/url/authority_view.hpp 454 5 1 function mHvLEk+wU7kVqeR1MftB7V7RXj8= regular d/hMlyyC3Ave6L9McUD7B4TwENA= paragraph text If present, this function returns a string representing the userinfo (which may be empty). Otherwise it returns an empty string. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).encoded_userinfo() == "jane%2Ddoe:pass" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing heading text BNF 1 code userinfo = user [ ":" [ password ] ] authority = [ userinfo "@" ] host [ ":" port ] heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return the userinfo returns text The userinfo see reference has_password kld0eiD6C4e3P/TIBG1sVBTu9EI= text , reference has_userinfo ufGAEpjGVrDAR7Z/aWObLlB+/Fw= text , reference encoded_password 664kp4dyV0Fx8/OmpypdBDspW4w= text , reference encoded_user WjFBzWA+QC4kWYmVk8wQqzyzjsY= text , reference password ROTG9938TiCaHNr0Rzc3CrPNSQc= text , reference user k0L9aRcMAFLBOG3fVUZA4rt/Q5k= text , reference userinfo E7fOFpu0yWBp7ZqmLKZ88iVethA= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 has_password boost/url/authority_view.hpp include/boost/url/authority_view.hpp 602 5 1 function kld0eiD6C4e3P/TIBG1sVBTu9EI= regular d/hMlyyC3Ave6L9McUD7B4TwENA= paragraph text This function returns true if the userinfo is present and contains a password. heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).has_password() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code userinfo = user [ ":" [ password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return true if a password is present returns code text true text if a password is present see reference has_userinfo ufGAEpjGVrDAR7Z/aWObLlB+/Fw= text , reference encoded_password 664kp4dyV0Fx8/OmpypdBDspW4w= text , reference encoded_user WjFBzWA+QC4kWYmVk8wQqzyzjsY= text , reference encoded_userinfo mHvLEk+wU7kVqeR1MftB7V7RXj8= text , reference password ROTG9938TiCaHNr0Rzc3CrPNSQc= text , reference user k0L9aRcMAFLBOG3fVUZA4rt/Q5k= text , reference userinfo E7fOFpu0yWBp7ZqmLKZ88iVethA= text . identifier bool normal 1 1 has_port boost/url/authority_view.hpp include/boost/url/authority_view.hpp 1203 5 1 function IphAWosew2EkzMVgRvkC/OAJ0xw= regular d/hMlyyC3Ave6L9McUD7B4TwENA= paragraph text This function returns true if an authority is present and contains a port. heading text Example 1 code assert( url_view( "wss://www.example.com:443" ).has_port() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code authority = [ userinfo "@" ] host [ ":" port ] port = *DIGIT heading text Specification 1 list paragraph link text 3.2.3. Port (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.3 unordered brief text Return true if a port is present returns code text true text if a port is present, otherwise code text false see reference encoded_host_and_port 5N16Bqd0+ZgJHR1NiZKAJK9EqwU= text , reference port k1FyNKXMpBVt6GfboIAkuHq+/3I= text , reference port_number Io13bUCUJtWDXQuR23TbsYoTs5s= text . identifier bool normal 1 1 has_userinfo boost/url/authority_view.hpp include/boost/url/authority_view.hpp 354 5 1 function ufGAEpjGVrDAR7Z/aWObLlB+/Fw= regular d/hMlyyC3Ave6L9McUD7B4TwENA= paragraph text This function returns true if this contains a userinfo. heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).has_userinfo() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code userinfo = user [ ":" [ password ] ] authority = [ userinfo "@" ] host [ ":" port ] heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return true if a userinfo is present returns code text true text if a userinfo is present see reference has_password kld0eiD6C4e3P/TIBG1sVBTu9EI= text , reference encoded_password 664kp4dyV0Fx8/OmpypdBDspW4w= text , reference encoded_user WjFBzWA+QC4kWYmVk8wQqzyzjsY= text , reference encoded_userinfo mHvLEk+wU7kVqeR1MftB7V7RXj8= text , reference password ROTG9938TiCaHNr0Rzc3CrPNSQc= text , reference user k0L9aRcMAFLBOG3fVUZA4rt/Q5k= text , reference userinfo E7fOFpu0yWBp7ZqmLKZ88iVethA= text . identifier bool normal 1 1 host boost/url/authority_view.hpp include/boost/url/authority_view.hpp 779 5 1 function 1LoM2HiWtDiQycXsUvfWZhe6Hvc= regular d/hMlyyC3Ave6L9McUD7B4TwENA= paragraph text This function returns the host portion of the authority as a string, or the empty string if there is no authority. Any percent-escapes in the string are decoded first. heading text Example 1 code assert( url_view( "https://www%2droot.example.com/" ).host() == "www-root.example.com" ); heading text Complexity 1 paragraph text Linear in code text this->host().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPvFuture ) "]" reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host returns text The host param text A string token to receive the result. token identifier result_type identifier StringToken identifier StringToken token normal 1 1 host_address boost/url/authority_view.hpp include/boost/url/authority_view.hpp 880 5 1 function OTOc1CgK/GuawlFPXjjcK6odYOE= regular d/hMlyyC3Ave6L9McUD7B4TwENA= paragraph text The value returned by this function depends on the type of host returned from the function reference host_type IyzTSrM6qF8ExmSAjRe6jouLT5w= text . list paragraph text If the type is reference host_type::ipv4 49F64dAiji9HVbP6MxLQiqot7AY= text , then the IPv4 address string is returned. paragraph text If the type is reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= text , then the IPv6 address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::ipvfuture TcYJaTwDFsx+0S2CkvHHARcCqWc= text , then the IPvFuture address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= text , then the host name string is returned. Any percent-escapes in the string are decoded first. paragraph text If the type is reference host_type::none QyoMTu07h232/Sxqovu2mGoPgTo= text , then an empty string is returned. unordered heading text Example 1 code assert( url_view( "https://[1::6:c0a8:1]/" ).host_address() == "1::6:c0a8:1" ); heading text Complexity 1 paragraph text Linear in code text this->host_address().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPvFuture ) "]" reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host returns text The host address param text A string token to receive the result. token identifier result_type identifier StringToken identifier StringToken token normal 1 1 host_ipv4_address boost/url/authority_view.hpp include/boost/url/authority_view.hpp 986 5 1 function kVlbEpr6oa5by3+amQ8PBNKaZjA= regular d/hMlyyC3Ave6L9McUD7B4TwENA= paragraph text If the host type is reference host_type::ipv4 49F64dAiji9HVbP6MxLQiqot7AY= text , this function returns the address as a value of type reference ipv4_address /Wpp3ZZDp3kUHzbULeDoaOEhnVs= text . Otherwise, if the host type is not an IPv4 address, it returns a default-constructed value which is equal to the unspecified address "0.0.0.0". heading text Example 1 code assert( url_view( "http://127.0.0.1/index.htm?user=win95" ).host_ipv4_address() == ipv4_address( "127.0.0.1" ) ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code IPv4address = dec-octet "." dec-octet "." dec-octet "." dec-octet dec-octet = DIGIT ; 0-9 / %x31-39 DIGIT ; 10-99 / "1" 2DIGIT ; 100-199 / "2" %x30-34 DIGIT ; 200-249 / "25" %x30-35 ; 250-255 heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host IPv4 address returns text The host IPv4 address identifier /Wpp3ZZDp3kUHzbULeDoaOEhnVs= ipv4_address normal 1 1 host_ipv6_address boost/url/authority_view.hpp include/boost/url/authority_view.hpp 1036 5 1 function xMoi4KmbAmlKw5kq0RD+z3ZhDuM= regular d/hMlyyC3Ave6L9McUD7B4TwENA= paragraph text If the host type is reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= text , this function returns the address as a value of type reference ipv6_address dhMSRVBIIIItY0URHSc8rwHcdTQ= text . Otherwise, if the host type is not an IPv6 address, it returns a default-constructed value which is equal to the unspecified address "0:0:0:0:0:0:0:0". heading text Example 1 code assert( url_view( "ftp://[::1]/" ).host_ipv6_address() == ipv6_address( "::1" ) ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code IPv6address = 6( h16 ":" ) ls32 / "::" 5( h16 ":" ) ls32 / [ h16 ] "::" 4( h16 ":" ) ls32 / [ *1( h16 ":" ) h16 ] "::" 3( h16 ":" ) ls32 / [ *2( h16 ":" ) h16 ] "::" 2( h16 ":" ) ls32 / [ *3( h16 ":" ) h16 ] "::" h16 ":" ls32 / [ *4( h16 ":" ) h16 ] "::" ls32 / [ *5( h16 ":" ) h16 ] "::" h16 / [ *6( h16 ":" ) h16 ] "::" ls32 = ( h16 ":" h16 ) / IPv4address ; least-significant 32 bits of address h16 = 1*4HEXDIG ; 16 bits of address represented in hexadecimal heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host IPv6 address returns text The host IPv6 address identifier dhMSRVBIIIItY0URHSc8rwHcdTQ= ipv6_address normal 1 1 host_ipvfuture boost/url/authority_view.hpp include/boost/url/authority_view.hpp 1071 5 1 function hIAl5fITeDqPWPPjGVlSz2zibgA= regular d/hMlyyC3Ave6L9McUD7B4TwENA= paragraph text If the host type is reference host_type::ipvfuture TcYJaTwDFsx+0S2CkvHHARcCqWc= text , this function returns the address as a string. Otherwise, if the host type is not an IPvFuture address, it returns an empty string. heading text Example 1 code assert( url_view( "http://[v1fe.d:9]/index.htm" ).host_ipvfuture() == "v1fe.d:9" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code IPvFuture = "v" 1*HEXDIG "." 1*( unreserved / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host IPvFuture address returns text The host IPvFuture address identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core normal 1 1 host_name boost/url/authority_view.hpp include/boost/url/authority_view.hpp 1112 5 1 function GMMqkVh5s3w58Fu0mI0lczX9Y3Q= regular d/hMlyyC3Ave6L9McUD7B4TwENA= paragraph text If the host type is reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= text , this function returns the name as a string. Otherwise, if the host type is not a name, it returns an empty string. Any percent-escapes in the string are decoded first. heading text Example 1 code assert( url_view( "https://www%2droot.example.com/" ).host_name() == "www-root.example.com" ); heading text Complexity 1 paragraph text Linear in code text this->host_name().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPvFuture ) "]" reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host name returns text The host name param text A string token to receive the result token identifier result_type identifier StringToken identifier StringToken token normal 1 1 host_type boost/url/authority_view.hpp include/boost/url/authority_view.hpp 738 5 1 function IyzTSrM6qF8ExmSAjRe6jouLT5w= regular d/hMlyyC3Ave6L9McUD7B4TwENA= paragraph text This function returns one of the following constants representing the type of host present. list paragraph reference host_type::ipv4 49F64dAiji9HVbP6MxLQiqot7AY= paragraph reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= paragraph reference host_type::ipvfuture TcYJaTwDFsx+0S2CkvHHARcCqWc= paragraph reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= unordered heading text Example 1 code assert( url_view( "https://192.168.0.1/local.htm" ).host_type() == host_type::ipv4 ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host type returns text The host type identifier YLHFVyAYZGSFQe18DPGjn6XsAMs= host_type identifier dnk5XPfR2OaMpCYaH3cWSxcTdyc= urls normal 1 1 password boost/url/authority_view.hpp include/boost/url/authority_view.hpp 650 5 1 function ROTG9938TiCaHNr0Rzc3CrPNSQc= regular d/hMlyyC3Ave6L9McUD7B4TwENA= paragraph text If present, this function returns a string representing the password (which may be an empty string). Otherwise it returns an empty string. Any percent-escapes in the string are decoded first. heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).password() == "pass" ); heading text Complexity 1 paragraph text Linear in code text this->password().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code userinfo = user [ ":" [ password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return the password returns text The password param text A string token to receive the result. token see reference has_password kld0eiD6C4e3P/TIBG1sVBTu9EI= text , reference has_userinfo ufGAEpjGVrDAR7Z/aWObLlB+/Fw= text , reference encoded_password 664kp4dyV0Fx8/OmpypdBDspW4w= text , reference encoded_user WjFBzWA+QC4kWYmVk8wQqzyzjsY= text , reference encoded_userinfo mHvLEk+wU7kVqeR1MftB7V7RXj8= text , reference user k0L9aRcMAFLBOG3fVUZA4rt/Q5k= text , reference userinfo E7fOFpu0yWBp7ZqmLKZ88iVethA= text . identifier result_type identifier StringToken identifier StringToken token normal 1 1 port boost/url/authority_view.hpp include/boost/url/authority_view.hpp 1241 5 1 function k1FyNKXMpBVt6GfboIAkuHq+/3I= regular d/hMlyyC3Ave6L9McUD7B4TwENA= paragraph text If present, this function returns a string representing the port (which may be empty). Otherwise it returns an empty string. heading text Example 1 code assert( url_view( "http://localhost.com:8080" ).port() == "8080" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code port = *DIGIT heading text Specification 1 list paragraph link text 3.2.3. Port (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.3 unordered brief text Return the port returns text The port as a string see reference encoded_host_and_port 5N16Bqd0+ZgJHR1NiZKAJK9EqwU= text , reference has_port IphAWosew2EkzMVgRvkC/OAJ0xw= text , reference port_number Io13bUCUJtWDXQuR23TbsYoTs5s= text . identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core normal 1 1 port_number boost/url/authority_view.hpp include/boost/url/authority_view.hpp 1279 5 1 function Io13bUCUJtWDXQuR23TbsYoTs5s= regular d/hMlyyC3Ave6L9McUD7B4TwENA= paragraph text If a port is present and the numerical value is representable, it is returned as an unsigned integer. Otherwise, the number zero is returned. heading text Example 1 code assert( url_view( "http://localhost.com:8080" ).port_number() == 8080 ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code port = *DIGIT heading text Specification 1 list paragraph link text 3.2.3. Port (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.3 unordered brief text Return the port returns text The port number see reference encoded_host_and_port 5N16Bqd0+ZgJHR1NiZKAJK9EqwU= text , reference has_port IphAWosew2EkzMVgRvkC/OAJ0xw= text , reference port k1FyNKXMpBVt6GfboIAkuHq+/3I= text . identifier Qvo2fOST20EZC7bSOAFZr+u3ITg= uint16_t normal 1 1 size boost/url/authority_view.hpp include/boost/url/authority_view.hpp 235 5 1 function QoOOAaTfBdgqXsOWD90X3tltfF4= regular d/hMlyyC3Ave6L9McUD7B4TwENA= paragraph text This function returns the number of characters in the authority. heading text Example 1 code assert( authority_view( "user:pass@www.example.com:8080" ).size() == 30 ); heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the number of characters in the authority returns text The number of characters in the authority identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 1 user boost/url/authority_view.hpp include/boost/url/authority_view.hpp 504 5 1 function k0L9aRcMAFLBOG3fVUZA4rt/Q5k= regular d/hMlyyC3Ave6L9McUD7B4TwENA= paragraph text If present, this function returns a string representing the user (which may be empty). Otherwise it returns an empty string. Any percent-escapes in the string are decoded first. heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).user() == "jane-doe" ); heading text Complexity 1 paragraph text Linear in code text this->user().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code userinfo = user [ ":" [ password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return the user returns text The user param text A string token to receive the result. token see reference has_password kld0eiD6C4e3P/TIBG1sVBTu9EI= text , reference has_userinfo ufGAEpjGVrDAR7Z/aWObLlB+/Fw= text , reference encoded_password 664kp4dyV0Fx8/OmpypdBDspW4w= text , reference encoded_user WjFBzWA+QC4kWYmVk8wQqzyzjsY= text , reference encoded_userinfo mHvLEk+wU7kVqeR1MftB7V7RXj8= text , reference password ROTG9938TiCaHNr0Rzc3CrPNSQc= text , reference userinfo E7fOFpu0yWBp7ZqmLKZ88iVethA= text . identifier result_type identifier StringToken identifier StringToken token normal 1 1 userinfo boost/url/authority_view.hpp include/boost/url/authority_view.hpp 401 5 1 function E7fOFpu0yWBp7ZqmLKZ88iVethA= regular d/hMlyyC3Ave6L9McUD7B4TwENA= paragraph text If present, this function returns a string representing the userinfo (which may be empty). Otherwise it returns an empty string. Any percent-escapes in the string are decoded first. heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).userinfo() == "jane-doe:pass" ); heading text Complexity 1 paragraph text Linear in code text this->userinfo().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code userinfo = user [ ":" [ password ] ] authority = [ userinfo "@" ] host [ ":" port ] heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return the userinfo returns text The userinfo param text A string token to receive the result. token see reference has_password kld0eiD6C4e3P/TIBG1sVBTu9EI= text , reference has_userinfo ufGAEpjGVrDAR7Z/aWObLlB+/Fw= text , reference encoded_password 664kp4dyV0Fx8/OmpypdBDspW4w= text , reference encoded_user WjFBzWA+QC4kWYmVk8wQqzyzjsY= text , reference encoded_userinfo mHvLEk+wU7kVqeR1MftB7V7RXj8= text , reference password ROTG9938TiCaHNr0Rzc3CrPNSQc= text , reference user k0L9aRcMAFLBOG3fVUZA4rt/Q5k= text . identifier result_type identifier StringToken identifier StringToken token normal 1 1 decode_view boost/url/decode_view.hpp include/boost/url/decode_view.hpp 70 1 1 boost/url/pct_string_view.hpp include/boost/url/pct_string_view.hpp 32 1 boost/url/decode_view.hpp include/boost/url/decode_view.hpp 26 1 record IhE/V16b2wBX2q+s4QtlgzozWlQ= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text These views reference strings in parts of URLs or other components that are percent-encoded. The special characters (those not in the allowed character set) are stored as three character escapes that consist of a percent sign ('%%') followed by a two-digit hexadecimal number of the corresponding unescaped character code, which may be part of a UTF-8 code point depending on the context. paragraph text The view refers to the original character buffer and only decodes escaped sequences when needed. In particular these operations perform percent-decoding automatically without the need to allocate memory: list paragraph text Iteration of the string paragraph text Accessing the encoded character buffer paragraph text Comparison to encoded or plain strings unordered paragraph text These objects can only be constructed from strings that have a valid percent-encoding, otherwise construction fails. The caller is responsible for ensuring that the lifetime of the character buffer from which the view is constructed extends unmodified until the view is no longer accessed. brief text A reference to a valid, percent-encoded string class +WFGa/Npazkk2KQxJFMCObnV1ys= dsoXs8+IEzA2gxkXsKc05jhx6i8= ITBKnjnb+u9SjtqEBf3ZGhgPMug= LM/YiIa7wGjCUI6gFgqSOYdXFiI= WUarjL7s5UjYPh79iCrkYCBGvys= O/soISCAhETK++CfqOUnFdf5Yew= RJjaGOGrDXihzByQ5SCUDOMvJUQ= gnw9KaivvgZioGQFCOkx3Bdbng0= v2MvnLejOCbc7GCMe4SUCqYdzuw= iQLLg5LXS5HS59iawKegjBizWrs= 0wC7Pa8mA4JjbyqRTxgEAYtDOhw= QTP+smKy42IX23/bha0/lCZuKvA= 4wmBqe+LhDEIACWF3EGP0Bd6HAY= g+COBlowEzZtqeTFHMzreBImwMs= hkeL0A/pJ2UIzzTmm96nKrt+LBs= De4rjcxEx6Iu5WjQwYtqucglfeU= sz1hEG7HjWYfKnVM/UYsW1p+Oac= effH9yxIklQocxw3XKF/4ett1w4= 1R4DUvuQwKv6WlHxyYjr93Kkscw= C6JRbh3doXEX3onBJSrJ0o10rjY= ptE1sYaL1GIlVlRsxzTe47e7hKA= T+aVwnzcNk6SDIkWQ90IHYqwPT8= Rq3dRXMGOM1zfmg72uddgjVtVqQ= nFUncXFoKaz6GC1HbXnibuE8ezg= njx8Q7wnnD1jPqxCgk6VjUufNlY= aAj/wyLdJMro0+uVDfExz9lDP2g= B0rnFLRkOT6fyREi83RvdsGZIlQ= pRqLvkaFw0SG1RpbGWAKWhVi+kY= Oc4RZ743cU0XGETas6CbQ6l8OeU= bZeyA134srRl+e70k55k9xdabWM= 4vZx12Tkx7fqOjRW/LuvhFPLbNQ= DnQyjGJxZiJY8aCECV80mE2qduU= OVm8/SgmvpzcmT0wU0//KbTy63M= R4RSA/p1I3uroTWbOqtfvFR/cF0= UbZF/ZfCDoPCOIiSZu6q2PC/Edk= vSmsDLb1jKJxuRaLWtT+wXrZDEQ= YH1cQI8sFN/t7l0ziTbCiZ8hyKc= gnCCLTp9Yc1Gqma6vl3Zy+AGvl8= LXfbkHmiZLmAZU/h8W/FYVwBH3o= kAkiATsPkDLw0dMpRFfiCYb0Nb0= kUOudipymtwCZViHCF1w2siMg5M= const_iterator boost/url/decode_view.hpp include/boost/url/decode_view.hpp 128 5 1 typedef +WFGa/Npazkk2KQxJFMCObnV1ys= regular IhE/V16b2wBX2q+s4QtlgzozWlQ= paragraph text This iterator is used to access the encoded string as a emph text bidirectional text range of characters with percent-decoding applied. Escape sequences are not decoded until the iterator is dereferenced. brief text An iterator of constant, decoded characters. iterator identifier RJjaGOGrDXihzByQ5SCUDOMvJUQ= iterator 1 const_reference boost/url/decode_view.hpp include/boost/url/decode_view.hpp 107 5 1 typedef dsoXs8+IEzA2gxkXsKc05jhx6i8= regular IhE/V16b2wBX2q+s4QtlgzozWlQ= brief text The reference type reference identifier char 1 difference_type boost/url/decode_view.hpp include/boost/url/decode_view.hpp 115 5 1 typedef ITBKnjnb+u9SjtqEBf3ZGhgPMug= regular IhE/V16b2wBX2q+s4QtlgzozWlQ= brief text The signed integer type identifier EH4n8sIj03HafoTNn2U36T1P+Hc= ptrdiff_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std 1 reference boost/url/decode_view.hpp include/boost/url/decode_view.hpp 104 5 1 typedef LM/YiIa7wGjCUI6gFgqSOYdXFiI= regular IhE/V16b2wBX2q+s4QtlgzozWlQ= brief text The reference type identifier char 1 size_type boost/url/decode_view.hpp include/boost/url/decode_view.hpp 111 5 1 typedef WUarjL7s5UjYPh79iCrkYCBGvys= regular IhE/V16b2wBX2q+s4QtlgzozWlQ= brief text The unsigned integer type identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std 1 value_type boost/url/decode_view.hpp include/boost/url/decode_view.hpp 100 5 1 typedef O/soISCAhETK++CfqOUnFdf5Yew= regular IhE/V16b2wBX2q+s4QtlgzozWlQ= brief text The value type identifier char 1 iterator boost/url/decode_view.hpp include/boost/url/decode_view.hpp 125 5 1 record RJjaGOGrDXihzByQ5SCUDOMvJUQ= see-below IhE/V16b2wBX2q+s4QtlgzozWlQ= paragraph text This iterator is used to access the encoded string as a emph text bidirectional text range of characters with percent-decoding applied. Escape sequences are not decoded until the iterator is dereferenced. brief text An iterator of constant, decoded characters. class identifier IhE/V16b2wBX2q+s4QtlgzozWlQ= decode_view IhE/V16b2wBX2q+s4QtlgzozWlQ= decode_view boost/url/decode_view.hpp include/boost/url/decode_view.hpp 157 5 1 overloads gnw9KaivvgZioGQFCOkx3Bdbng0= regular IhE/V16b2wBX2q+s4QtlgzozWlQ= brief text Constructor param text A percent-encoded string that has already been validated. Implicit conversion from other string types is supported but may throw exceptions. s param text The options for decoding. If this parameter is omitted, the default options are used. opt constructor eAPVm8NQBej8p5oB1rosq8FXRJ8= NJSj5E+0oy7t+s0NXR2ZXjQ9xtI= identifier void decode_view boost/url/decode_view.hpp include/boost/url/decode_view.hpp 157 5 1 function eAPVm8NQBej8p5oB1rosq8FXRJ8= regular IhE/V16b2wBX2q+s4QtlgzozWlQ= paragraph text Default-constructed views represent empty strings. heading text Example 1 code decode_view ds; heading text Postconditions 1 code this->empty() == true heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Constructor identifier void constructor 1 1 1 decode_view boost/url/decode_view.hpp include/boost/url/decode_view.hpp 195 5 1 function NJSj5E+0oy7t+s0NXR2ZXjQ9xtI= regular IhE/V16b2wBX2q+s4QtlgzozWlQ= paragraph text This constructs a view from the character buffer code text s text , which must remain valid and unmodified until the view is no longer accessed. heading text Example 1 code decode_view ds( "Program%20Files" ); heading text Postconditions 1 code this->encoded() == s heading text Complexity 1 paragraph text Linear in code text s.size() text . heading text Exception Safety 1 paragraph text Although this function does not throw exceptions, implicitly constructing a reference pct_string_view t9KlfUmMV/Lq0e5tGD9d/eCq+X0= text for the first argument can throw exceptions on invalid input. brief text Constructor param text A percent-encoded string that has already been validated. Implicit conversion from other string types is supported but may throw exceptions. s param text The options for decoding. If this parameter is omitted, the default options are used. opt identifier void identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view s identifier Bb04pNwExynJkzlY9a9GCeeB13k= encoding_opts opt {} constructor 1 back boost/url/decode_view.hpp include/boost/url/decode_view.hpp 339 5 1 function v2MvnLejOCbc7GCMe4SUCqYdzuw= regular IhE/V16b2wBX2q+s4QtlgzozWlQ= heading text Example 1 code assert( decode_view( "Program%20Files" ).back() == 's' ); heading text Preconditions 1 code not this->empty() heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the last character returns text The last decoded character identifier LM/YiIa7wGjCUI6gFgqSOYdXFiI= reference normal 1 1 begin boost/url/decode_view.hpp include/boost/url/decode_view.hpp 275 5 1 function iQLLg5LXS5HS59iawKegjBizWrs= regular IhE/V16b2wBX2q+s4QtlgzozWlQ= heading text Example 1 code auto it = this->begin(); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return an iterator to the beginning returns text An iterator to the first decoded character identifier RJjaGOGrDXihzByQ5SCUDOMvJUQ= iterator normal 1 1 compare boost/url/decode_view.hpp include/boost/url/decode_view.hpp 533 5 1 boost/url/decode_view.hpp include/boost/url/decode_view.hpp 554 5 1 overloads 0wC7Pa8mA4JjbyqRTxgEAYtDOhw= regular IhE/V16b2wBX2q+s4QtlgzozWlQ= brief text Return the result of comparing to another string returns text Negative value if this string is less than the other character sequence, zero if the both character sequences are equal, positive value if this string is greater than the other character sequence param text string to compare other normal FDIGmTcdvZb4fiCd43F/oGgGwBo= Kb6J2yY/SCb3BaJqiBQ1RbA9hi8= identifier int compare boost/url/decode_view.hpp include/boost/url/decode_view.hpp 554 5 1 function FDIGmTcdvZb4fiCd43F/oGgGwBo= regular IhE/V16b2wBX2q+s4QtlgzozWlQ= paragraph text The length of the sequences to compare is the smaller of code text size() text and code text other.size() text . paragraph text The function compares the two strings as if by calling code text char_traits<char>::compare(to_string().data(), v.to_string().data(), rlen) text . This means the comparison is performed with percent-decoding applied to the current string. brief text Return the result of comparing to another string returns text Negative value if this string is less than the other character sequence, zero if the both character sequences are equal, positive value if this string is greater than the other character sequence param text string to compare other identifier int identifier IhE/V16b2wBX2q+s4QtlgzozWlQ= decode_view other normal 1 1 compare boost/url/decode_view.hpp include/boost/url/decode_view.hpp 533 5 1 function Kb6J2yY/SCb3BaJqiBQ1RbA9hi8= regular IhE/V16b2wBX2q+s4QtlgzozWlQ= paragraph text The length of the sequences to compare is the smaller of code text size() text and code text other.size() text . paragraph text The function compares the two strings as if by calling code text char_traits<char>::compare(to_string().data(), v.data(), rlen) text . This means the comparison is performed with percent-decoding applied to the current string. brief text Return the result of comparing to another string returns text Negative value if this string is less than the other character sequence, zero if the both character sequences are equal, positive value if this string is greater than the other character sequence param text string to compare other identifier int identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core other normal 1 1 empty boost/url/decode_view.hpp include/boost/url/decode_view.hpp 228 5 1 function QTP+smKy42IX23/bha0/lCZuKvA= regular IhE/V16b2wBX2q+s4QtlgzozWlQ= heading text Example 1 code assert( decode_view( "" ).empty() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return true if the string is empty returns code text true text if the string is empty identifier bool normal 1 1 end boost/url/decode_view.hpp include/boost/url/decode_view.hpp 293 5 1 function 4wmBqe+LhDEIACWF3EGP0Bd6HAY= regular IhE/V16b2wBX2q+s4QtlgzozWlQ= heading text Example 1 code auto it = this->end(); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return an iterator to the end returns text An iterator to one past the last decoded character identifier RJjaGOGrDXihzByQ5SCUDOMvJUQ= iterator normal 1 1 ends_with boost/url/decode_view.hpp include/boost/url/decode_view.hpp 379 5 1 boost/url/decode_view.hpp include/boost/url/decode_view.hpp 419 5 1 overloads g+COBlowEzZtqeTFHMzreBImwMs= regular IhE/V16b2wBX2q+s4QtlgzozWlQ= brief text Checks if the string ends with the given prefix returns code text true text if the decoded string ends with code text ch returns code text true text if the decoded string ends with code text s param text The character to search for ch param text The string to search for s normal 0sYolzp16RbCmWwB4be5Gy+vvww= SD4KpfDtgThHckp4c8NPgXJKNkk= identifier bool ends_with boost/url/decode_view.hpp include/boost/url/decode_view.hpp 419 5 1 function 0sYolzp16RbCmWwB4be5Gy+vvww= regular IhE/V16b2wBX2q+s4QtlgzozWlQ= heading text Example 1 code assert( decode_view( "Program%20Files" ).ends_with('s') ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Checks if the string ends with the given prefix returns code text true text if the decoded string ends with code text ch param text The character to search for ch identifier bool identifier char ch normal 1 1 ends_with boost/url/decode_view.hpp include/boost/url/decode_view.hpp 379 5 1 function SD4KpfDtgThHckp4c8NPgXJKNkk= regular IhE/V16b2wBX2q+s4QtlgzozWlQ= heading text Example 1 code assert( decode_view( "Program%20Files" ).ends_with("Files") ); heading text Complexity 1 paragraph text Linear. heading text Exception Safety 1 paragraph text Throws nothing. brief text Checks if the string ends with the given prefix returns code text true text if the decoded string ends with code text s param text The string to search for s identifier bool identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 1 find boost/url/decode_view.hpp include/boost/url/decode_view.hpp 434 5 1 function hkeL0A/pJ2UIzzTmm96nKrt+LBs= regular IhE/V16b2wBX2q+s4QtlgzozWlQ= heading text Complexity 1 paragraph text Linear. heading text Exception Safety 1 paragraph text Throws nothing. brief text Finds the first occurrence of character in this view returns text An iterator to the first decoded occurrence of code text ch text or code text end() param text The character to search for ch identifier +WFGa/Npazkk2KQxJFMCObnV1ys= const_iterator identifier char ch normal 1 1 front boost/url/decode_view.hpp include/boost/url/decode_view.hpp 316 5 1 function De4rjcxEx6Iu5WjQwYtqucglfeU= regular IhE/V16b2wBX2q+s4QtlgzozWlQ= heading text Example 1 code assert( decode_view( "Program%20Files" ).front() == 'P' ); heading text Preconditions 1 code not this->empty() heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the first character returns text The first decoded character identifier LM/YiIa7wGjCUI6gFgqSOYdXFiI= reference normal 1 1 options boost/url/decode_view.hpp include/boost/url/decode_view.hpp 502 5 1 function sz1hEG7HjWYfKnVM/UYsW1p+Oac= regular IhE/V16b2wBX2q+s4QtlgzozWlQ= brief text Return the decoding options returns text The decoding options used by this view identifier Bb04pNwExynJkzlY9a9GCeeB13k= encoding_opts normal 1 1 remove_prefix boost/url/decode_view.hpp include/boost/url/decode_view.hpp 472 5 1 function effH9yxIklQocxw3XKF/4ett1w4= regular IhE/V16b2wBX2q+s4QtlgzozWlQ= heading text Example 1 code decode_view d( "Program%20Files" ); d.remove_prefix( 8 ); assert( d == "Files" ); heading text Preconditions 1 code n <= this->size() heading text Complexity 1 paragraph text Linear. brief text Remove the first characters param text The number of characters to remove n identifier void identifier WUarjL7s5UjYPh79iCrkYCBGvys= size_type n normal 1 remove_suffix boost/url/decode_view.hpp include/boost/url/decode_view.hpp 495 5 1 function 1R4DUvuQwKv6WlHxyYjr93Kkscw= regular IhE/V16b2wBX2q+s4QtlgzozWlQ= heading text Example 1 code decode_view d( "Program%20Files" ); d.remove_suffix( 6 ); assert( d == "Program" ); heading text Preconditions 1 code n <= this->size() heading text Complexity 1 paragraph text Linear. brief text Remove the last characters param text The number of characters to remove n identifier void identifier WUarjL7s5UjYPh79iCrkYCBGvys= size_type n normal 1 rfind boost/url/decode_view.hpp include/boost/url/decode_view.hpp 449 5 1 function C6JRbh3doXEX3onBJSrJ0o10rjY= regular IhE/V16b2wBX2q+s4QtlgzozWlQ= heading text Complexity 1 paragraph text Linear. heading text Exception Safety 1 paragraph text Throws nothing. brief text Finds the first occurrence of character in this view returns text An iterator to the last occurrence of code text ch text or code text end() param text The character to search for ch identifier +WFGa/Npazkk2KQxJFMCObnV1ys= const_iterator identifier char ch normal 1 1 size boost/url/decode_view.hpp include/boost/url/decode_view.hpp 254 5 1 function ptE1sYaL1GIlVlRsxzTe47e7hKA= regular IhE/V16b2wBX2q+s4QtlgzozWlQ= heading text Example 1 code assert( decode_view( "Program%20Files" ).size() == 13 ); heading text Effects 1 code return std::distance( this->begin(), this->end() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the number of decoded characters returns text The number of decoded characters identifier WUarjL7s5UjYPh79iCrkYCBGvys= size_type normal 1 1 starts_with boost/url/decode_view.hpp include/boost/url/decode_view.hpp 359 5 1 boost/url/decode_view.hpp include/boost/url/decode_view.hpp 399 5 1 overloads T+aVwnzcNk6SDIkWQ90IHYqwPT8= regular IhE/V16b2wBX2q+s4QtlgzozWlQ= brief text Checks if the string begins with the given prefix returns code text true text if the decoded string starts with code text ch returns code text true text if the decoded string starts with code text s param text The character to search for ch param text The string to search for s normal tFrTSrWJPm4x57tvMriM/hN4uuU= F+yFoNgUzmS6yORtPEWliD3Vu9c= identifier bool starts_with boost/url/decode_view.hpp include/boost/url/decode_view.hpp 399 5 1 function tFrTSrWJPm4x57tvMriM/hN4uuU= regular IhE/V16b2wBX2q+s4QtlgzozWlQ= heading text Example 1 code assert( decode_view( "Program%20Files" ).starts_with('P') ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Checks if the string begins with the given prefix returns code text true text if the decoded string starts with code text ch param text The character to search for ch identifier bool identifier char ch normal 1 1 starts_with boost/url/decode_view.hpp include/boost/url/decode_view.hpp 359 5 1 function F+yFoNgUzmS6yORtPEWliD3Vu9c= regular IhE/V16b2wBX2q+s4QtlgzozWlQ= heading text Example 1 code assert( decode_view( "Program%20Files" ).starts_with("Program") ); heading text Complexity 1 paragraph text Linear. heading text Exception Safety 1 paragraph text Throws nothing. brief text Checks if the string begins with the given prefix returns code text true text if the decoded string starts with code text s param text The string to search for s identifier bool identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 1 encoding_opts boost/url/encoding_opts.hpp include/boost/url/encoding_opts.hpp 31 1 1 record Bb04pNwExynJkzlY9a9GCeeB13k= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text These options are used to customize the behavior of algorithms which use percent escapes, such as encoding or decoding. brief text Percent-encoding options see reference encode 09aIpdxxNNYbVZSULaBGficRxZ4= text , reference encoded_size Xq8kBc9a/F5Bpmn1q4OszstzJ4g= text , reference pct_string_view t9KlfUmMV/Lq0e5tGD9d/eCq+X0= text . struct 2VvdPVwN/ooLfPHJMJ6u2y7wrd8= W8lLIQ0OxCY0KjdFXSivr+lwjnQ= daFUEqcxAu4wd2geA6ibb6XUilg= pzxkqgCIpSWae1U9TUQWUjO2iqE= encoding_opts boost/url/encoding_opts.hpp include/boost/url/encoding_opts.hpp 117 5 1 function 2VvdPVwN/ooLfPHJMJ6u2y7wrd8= regular Bb04pNwExynJkzlY9a9GCeeB13k= brief text Constructs an code text encoding_opts text object with the specified options. param text If true, spaces will be encoded as plus signs. space_as_plus param text If true, hexadecimal digits will be emitted as lower case. lower_case param text If true, null characters will not be allowed. disallow_null identifier void 1 identifier bool space_as_plus false 1 identifier bool lower_case false 1 identifier bool disallow_null false constructor 1 disallow_null boost/url/encoding_opts.hpp include/boost/url/encoding_opts.hpp 109 5 1 variable W8lLIQ0OxCY0KjdFXSivr+lwjnQ= regular Bb04pNwExynJkzlY9a9GCeeB13k= paragraph text Normally all possible character values (from 0 to 255) are allowed, with reserved characters being replaced with escapes upon encoding. When this option is true, attempting to decode a null will result in an error. brief text True if nulls are not allowed identifier bool false 1 lower_case boost/url/encoding_opts.hpp include/boost/url/encoding_opts.hpp 98 5 1 variable daFUEqcxAu4wd2geA6ibb6XUilg= regular Bb04pNwExynJkzlY9a9GCeeB13k= paragraph text By default, percent-encoding algorithms emit hexadecimal digits A through F as uppercase letters. When this option is code text true text , lowercase letters are used. brief text True if hexadecimal digits are emitted as lower case identifier bool false 1 space_as_plus boost/url/encoding_opts.hpp include/boost/url/encoding_opts.hpp 89 5 1 variable pzxkqgCIpSWae1U9TUQWUjO2iqE= regular Bb04pNwExynJkzlY9a9GCeeB13k= paragraph text Although not prescribed by RFC 3986, many applications decode plus signs in URL queries as spaces. In particular, the form-urlencoded Media Type in HTML for submitting forms uses this convention. paragraph text This option controls whether the PLUS character ("+") is used to represent the SP character (" ") when encoding or decoding. paragraph text When this option is code text true text , both the encoded SP ("%20") and the PLUS character ("+") represent a space (" ") when decoding. To represent a plus sign, its encoded form ("%2B") is used. paragraph text The reference encode 09aIpdxxNNYbVZSULaBGficRxZ4= text and reference encoded_size Xq8kBc9a/F5Bpmn1q4OszstzJ4g= text functions will encode spaces as plus signs when this option is code text true text , regardless of the allowed character set. They will also encode plus signs as "%2B" when this option is code text true text , regardless of the allowed character set. paragraph text Note that when a URL is normalized, all unreserved percent-encoded characters are replaced with their unreserved equivalents. However, normalizing the URL query maintains the decoded and encoded "&=+" as they are because they might have different meanings. paragraph text This behavior is not optional because normalization can only mitigate false negatives, but it should eliminate false positives. Making it optional would allow a false positive because there's at least one very relevant schema (HTTP) where a decoded or encoded "&=+" has different meanings and represents different resources. paragraph text The same considerations apply to URL comparison algorithms in the library, as they treat URLs as if they were normalized. heading text Specification 1 list paragraph link text application/x-www-form-urlencoded (w3.org) https://www.w3.org/TR/html401/interact/forms.html#h-17.13.4.1 paragraph link text The form-urlencoded Media Type (RFC 1866) https://datatracker.ietf.org/doc/html/rfc1866#section-8.2.1 paragraph link text Section 6.2.2.2. Percent-Encoding Normalization (RFC 3986) https://datatracker.ietf.org/doc/html/rfc3986#section-6.2.2.2 unordered brief text True if spaces encode to and from plus signs identifier bool false 1 ignore_case_param boost/url/ignore_case.hpp include/boost/url/ignore_case.hpp 43 1 1 record RATceEbebMWrhFXGkG2RDFi+7WY= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text Functions may use parameters of this type to allow the user to optionally indicate that comparisons should be case-insensitive when the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed. brief text An optional parameter to determine case-sensitivity see reference params_ref 8S83BKvWBCDdTktlY8X93Mlo9E0= class rgyOQNBTwPan40L7RVenh+UhjJw= lXpAYsiIRGoZg3fANCJGIa1E0bY= lBt+sPq6B9l/jszrPs1UFDg9l9E= ignore_case_param boost/url/ignore_case.hpp include/boost/url/ignore_case.hpp 68 5 1 overloads rgyOQNBTwPan40L7RVenh+UhjJw= regular RATceEbebMWrhFXGkG2RDFi+7WY= brief text Constructor constructor OgZndABYifoxB4gRablGbBI5fg4= A+hfu3tyH700EXj/A44KkHYwBZ0= identifier void ignore_case_param boost/url/ignore_case.hpp include/boost/url/ignore_case.hpp 68 5 1 function OgZndABYifoxB4gRablGbBI5fg4= regular RATceEbebMWrhFXGkG2RDFi+7WY= paragraph text By default, comparisons are case-sensitive. heading text Example 1 paragraph text This function performs case-sensitive comparisons when called with no arguments: code void f( ignore_case_param = {} ); brief text Constructor identifier void constructor 1 1 1 ignore_case_param boost/url/ignore_case.hpp include/boost/url/ignore_case.hpp 89 5 1 function A+hfu3tyH700EXj/A44KkHYwBZ0= regular RATceEbebMWrhFXGkG2RDFi+7WY= paragraph text Construction from reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text indicates that comparisons should be case-insensitive. paragraph text The first parameter to this function should be the variable reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text . heading text Example 1 paragraph text When reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed as an argument, this function ignores case when performing comparisons: code void f( ignore_case_param(ignore_case) ); brief text Constructor param text The object to construct from value identifier void identifier X8bO9PzAZhZe4KoaCSz4/o1kias= ignore_case_t identifier xCd2tUlylXT9zvj8ZcHXybU4P/k= implementation_defined value constructor 1 operator bool boost/url/ignore_case.hpp include/boost/url/ignore_case.hpp 106 5 1 function lXpAYsiIRGoZg3fANCJGIa1E0bY= regular RATceEbebMWrhFXGkG2RDFi+7WY= paragraph text Values of type code text ignore_case_param text evaluate to true when constructed with the constant reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text . Otherwise, they are default-constructed and evaluate to code text false text . brief text True if an algorithm should ignore case returns code text true text if case should be ignored identifier bool conversion 1 1 ipv4_address boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 53 1 1 boost/url/ipv6_address.hpp include/boost/url/ipv6_address.hpp 26 1 record /Wpp3ZZDp3kUHzbULeDoaOEhnVs= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text Objects of this type are used to construct, parse, and manipulate IP version 6 addresses. heading text BNF 1 code IPv4address = dec-octet "." dec-octet "." dec-octet "." dec-octet dec-octet = DIGIT ; 0-9 / %x31-39 DIGIT ; 10-99 / "1" 2DIGIT ; 100-199 / "2" %x30-34 DIGIT ; 200-249 / "25" %x30-35 ; 250-255 heading text Specification 1 list paragraph link text IPv4 (Wikipedia) https://en.wikipedia.org/wiki/IPv4 paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text An IP version 4 style address. see reference parse_ipv4_address 3H1nFll3jIwKtiUjrAoL1itMXS8= text , reference ipv6_address dhMSRVBIIIItY0URHSc8rwHcdTQ= text . reference parse_ipv4_address 3H1nFll3jIwKtiUjrAoL1itMXS8= class K1Ec2DqsA1sP9/ZiWr9xXxLTWmc= gmFwLFTtOAD/QhqgQ5gVWIkwfqE= CjlQXCULAZXuospOP9qDJwihyL4= 3eS9MgTYDwQQzKa7ec0u01AAKlk= yIu3SCo9OYk8ihlq2QUpl59vU5I= RhR9qztBnmIo5dp/yMR/Dxo6sGE= v6jOcZd9sFpSijOm3jH6PikYlfM= LEr2z93gPK9hDl27bqMsxNYx1GI= hG+Han3p/bpn3XDjzJeEon2Wy30= iunqRmAnQNdGCAQuPEeWrF4oKTM= sGEjPwyf9VhDEZc80rdhomT49gQ= QVRcQKVos5VYBTTWZx53+bb+fic= z0vlZykhfnZ9AtSNCNEcCCXxTIA= 23+xtsBhwg+Sz8fF41qaRCKLPLw= opjoR3Y3GXEbaNYk0xifdxnGTx8= identifier dhMSRVBIIIItY0URHSc8rwHcdTQ= ipv6_address dhMSRVBIIIItY0URHSc8rwHcdTQ= CD4PSGOm3yi6rHmmIS6wEJujXKY= Lk6u1xBQtbEyGW+iFcIykNQyhVo= 8obEUnt+lW3Tn+hrzU1C0MkLqg0= bytes_type boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 71 5 1 typedef K1Ec2DqsA1sP9/ZiWr9xXxLTWmc= regular /Wpp3ZZDp3kUHzbULeDoaOEhnVs= brief text The type used to represent an address as an array of bytes specialization eMPh5HoE0c3tZE55aYeZ9sUQnAs= array identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std 1 uint_type boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 66 5 1 typedef gmFwLFTtOAD/QhqgQ5gVWIkwfqE= regular /Wpp3ZZDp3kUHzbULeDoaOEhnVs= brief text The type used to represent an address as an unsigned integer identifier 7oVuEnhtvBxEe7A4rvwLtoVcL6g= uint_least32_t 1 ipv4_address boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 76 5 1 boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 106 5 1 boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 119 5 1 boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 148 5 1 overloads CjlQXCULAZXuospOP9qDJwihyL4= regular /Wpp3ZZDp3kUHzbULeDoaOEhnVs= brief text Constructors param text The string to parse. s param text The integer to construct from. u param text The value to construct from. bytes throws text The input failed to parse correctly. reference system_error see reference parse_ipv4_address 3H1nFll3jIwKtiUjrAoL1itMXS8= text . constructor yl0UOHuSxHom06qa0b8lfcld6Dg= 2cq8c2vzuDpA/hkdQG4szL6NZKo= jpD0S+uCl/0/GH4pCJUXCyRH1eg= aB6a40BtSJOo6VPaSj6d1VeV/nw= 9rEWPy6GZqSFiaU8nmE9QTRR7EM= identifier void ipv4_address boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 76 5 1 function yl0UOHuSxHom06qa0b8lfcld6Dg= regular /Wpp3ZZDp3kUHzbULeDoaOEhnVs= brief text Constructor. identifier void constructor 1 1 1 ipv4_address boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 80 5 1 function 2cq8c2vzuDpA/hkdQG4szL6NZKo= regular /Wpp3ZZDp3kUHzbULeDoaOEhnVs= brief text Constructor. param text The object to copy construct from other identifier void 1 identifier /Wpp3ZZDp3kUHzbULeDoaOEhnVs= ipv4_address other constructor 1 1 1 ipv4_address boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 148 5 1 function jpD0S+uCl/0/GH4pCJUXCyRH1eg= regular /Wpp3ZZDp3kUHzbULeDoaOEhnVs= paragraph text This function constructs an address from the string code text s text , which must contain a valid IPv4 address string or else an exception is thrown. admonition paragraph text For a non-throwing parse function, use reference parse_ipv4_address 3H1nFll3jIwKtiUjrAoL1itMXS8= text . note heading text Exception Safety 1 paragraph text Exceptions thrown on invalid input. heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Construct from a string. param text The string to parse. s throws text The input failed to parse correctly. reference system_error see reference parse_ipv4_address 3H1nFll3jIwKtiUjrAoL1itMXS8= text . identifier void identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s constructor 1 ipv4_address boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 106 5 1 function aB6a40BtSJOo6VPaSj6d1VeV/nw= regular /Wpp3ZZDp3kUHzbULeDoaOEhnVs= paragraph text This function constructs an address from the unsigned integer code text u text , where the most significant byte forms the first octet of the resulting address. brief text Construct from an unsigned integer. param text The integer to construct from. u identifier void identifier gmFwLFTtOAD/QhqgQ5gVWIkwfqE= uint_type u constructor 1 ipv4_address boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 119 5 1 function 9rEWPy6GZqSFiaU8nmE9QTRR7EM= regular /Wpp3ZZDp3kUHzbULeDoaOEhnVs= paragraph text This function constructs an address from the array in code text bytes text , which is interpreted in big-endian. brief text Construct from an array of bytes. param text The value to construct from. bytes identifier void 1 identifier K1Ec2DqsA1sP9/ZiWr9xXxLTWmc= bytes_type bytes constructor 1 operator= boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 88 5 1 function 3eS9MgTYDwQQzKa7ec0u01AAKlk= regular /Wpp3ZZDp3kUHzbULeDoaOEhnVs= brief text Copy Assignment. returns text A reference to this object. param text The object to copy. other identifier /Wpp3ZZDp3kUHzbULeDoaOEhnVs= ipv4_address 1 identifier /Wpp3ZZDp3kUHzbULeDoaOEhnVs= ipv4_address other normal 1 1 1 is_loopback boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 233 5 1 function yIu3SCo9OYk8ihlq2QUpl59vU5I= regular /Wpp3ZZDp3kUHzbULeDoaOEhnVs= brief text Return true if the address is a loopback address returns code text true text if the address is a loopback address identifier bool normal 1 1 is_multicast boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 249 5 1 function RhR9qztBnmIo5dp/yMR/Dxo6sGE= regular /Wpp3ZZDp3kUHzbULeDoaOEhnVs= brief text Return true if the address is a multicast address returns code text true text if the address is a multicast address identifier bool normal 1 1 is_unspecified boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 241 5 1 function v6jOcZd9sFpSijOm3jH6PikYlfM= regular /Wpp3ZZDp3kUHzbULeDoaOEhnVs= brief text Return true if the address is unspecified returns code text true text if the address is unspecified identifier bool normal 1 1 to_buffer boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 223 5 1 function LEr2z93gPK9hDl27bqMsxNYx1GI= regular /Wpp3ZZDp3kUHzbULeDoaOEhnVs= paragraph text The resulting buffer is not null-terminated. brief text Write a dotted decimal string representing the address to a buffer returns text The formatted string param text The buffer in which to write, which must have at least code text dest_size text space. dest param text The size of the output buffer. dest_size throws code text dest_size < ipv4_address::max_str_len reference std::length_error identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core identifier char dest identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std dest_size normal 1 1 to_bytes boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 157 5 1 function hG+Han3p/bpn3XDjzJeEon2Wy30= regular /Wpp3ZZDp3kUHzbULeDoaOEhnVs= brief text Return the address as bytes, in network byte order. returns text The address as an array of bytes. identifier K1Ec2DqsA1sP9/ZiWr9xXxLTWmc= bytes_type normal 1 1 to_string boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 201 5 1 function iunqRmAnQNdGCAQuPEeWrF4oKTM= regular /Wpp3ZZDp3kUHzbULeDoaOEhnVs= paragraph text When called with no arguments, the return type is code text std::string text . Otherwise, the return type and style of output is determined by which string token is passed. heading text Example 1 code assert( ipv4_address(0x01020304).to_string() == "1.2.3.4" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. String tokens may throw exceptions. heading text Specification 1 list paragraph link text 2.2. Text Representation of Addresses (rfc4291) https://datatracker.ietf.org/doc/html/rfc4291#section-2.2 unordered brief text Return the address as a string in dotted decimal format returns text The return type of the string token. If the token parameter is omitted, then a new code text std::string text is returned. Otherwise, the function return type is the result type of the token. param text An optional string token. token identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 to_uint boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 165 5 1 function sGEjPwyf9VhDEZc80rdhomT49gQ= regular /Wpp3ZZDp3kUHzbULeDoaOEhnVs= brief text Return the address as an unsigned integer. returns text The address as an unsigned integer. identifier gmFwLFTtOAD/QhqgQ5gVWIkwfqE= uint_type normal 1 1 any boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 287 5 1 function QVRcQKVos5VYBTTWZx53+bb+fic= regular /Wpp3ZZDp3kUHzbULeDoaOEhnVs= brief text Return an address object that represents any address returns text The any address. identifier /Wpp3ZZDp3kUHzbULeDoaOEhnVs= ipv4_address normal 1 broadcast boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 309 5 1 function z0vlZykhfnZ9AtSNCNEcCCXxTIA= regular /Wpp3ZZDp3kUHzbULeDoaOEhnVs= brief text Return an address object that represents the broadcast address returns text The broadcast address. identifier /Wpp3ZZDp3kUHzbULeDoaOEhnVs= ipv4_address normal 1 loopback boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 298 5 1 function 23+xtsBhwg+Sz8fF41qaRCKLPLw= regular /Wpp3ZZDp3kUHzbULeDoaOEhnVs= brief text Return an address object that represents the loopback address returns text The loopback address. identifier /Wpp3ZZDp3kUHzbULeDoaOEhnVs= ipv4_address normal 1 max_str_len boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 60 5 1 variable opjoR3Y3GXEbaNYk0xifdxnGTx8= regular /Wpp3ZZDp3kUHzbULeDoaOEhnVs= paragraph text The longest ipv4 address string is "255.255.255.255". brief text The number of characters in the longest possible IPv4 string. identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std 15 1 1 ipv6_address boost/url/ipv6_address.hpp include/boost/url/ipv6_address.hpp 62 1 1 record dhMSRVBIIIItY0URHSc8rwHcdTQ= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text Objects of this type are used to construct, parse, and manipulate IP version 6 addresses. heading text BNF 1 code IPv6address = 6( h16 ":" ) ls32 / "::" 5( h16 ":" ) ls32 / [ h16 ] "::" 4( h16 ":" ) ls32 / [ *1( h16 ":" ) h16 ] "::" 3( h16 ":" ) ls32 / [ *2( h16 ":" ) h16 ] "::" 2( h16 ":" ) ls32 / [ *3( h16 ":" ) h16 ] "::" h16 ":" ls32 / [ *4( h16 ":" ) h16 ] "::" ls32 / [ *5( h16 ":" ) h16 ] "::" h16 / [ *6( h16 ":" ) h16 ] "::" ls32 = ( h16 ":" h16 ) / IPv4address ; least-significant 32 bits of address h16 = 1*4HEXDIG ; 16 bits of address represented in hexadecimal heading text Specification 1 list paragraph link text IP Version 6 Addressing Architecture (rfc4291) https://datatracker.ietf.org/doc/html/rfc4291 paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text An IP version 6 style address. see reference ipv4_address /Wpp3ZZDp3kUHzbULeDoaOEhnVs= text , reference parse_ipv6_address bEw/qaAlNfZy1QraETx5dipoF+I= text . reference parse_ipv6_address bEw/qaAlNfZy1QraETx5dipoF+I= class 3HLniRaTZARS/qsIh1WH0IPNx7E= lIn0ANRa2ERdXJ25J6RfpOsnO2M= mrs1+u9ux/as1SWpxt5acP82xUI= 3CAIYwRL/lOXbVPvVDAG1wmwB6o= ogO/p3Rsy76ZR5BBjd+JT5p9mAI= KPFd8cjF5Ss9pYOOq8WhES+hzjA= i3fY28R+qnkP8zKn2cOQrWnjNWo= ImUwdZB8YlRRGBoT4IIxXUe/wd8= 2zV4QmjxJ0lPqiBQDYB3ewBXEtk= 01VFEJ5nUH+9Q1IRe+r7pqG6OY8= 9qVxLX0gbXaA+Qu5TJlcZdIdmd8= 7SnSl6aZZhCFjo7lgvG8WsV8gII= csLyGn9tW7OfykvQd5h+ko1ejWE= yhQ5N1ExDQYr0NjN7JI8i1H6Quw= UZpl+qwB04WBCFZVngHir5AMi4Y= AQru1yEUVgiZfLKcjFmVLcOmOik= cqaXRu9n2E1Aq+fNQVQILaVo/Ss= /Rx5cBJ8hgc8Yigu7zsZeyTHTTc= bytes_type boost/url/ipv6_address.hpp include/boost/url/ipv6_address.hpp 87 5 1 typedef 3HLniRaTZARS/qsIh1WH0IPNx7E= regular dhMSRVBIIIItY0URHSc8rwHcdTQ= paragraph text Octets are stored in network byte order. brief text The type used to represent an address as an array of bytes. specialization eMPh5HoE0c3tZE55aYeZ9sUQnAs= array identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std 1 ipv6_address boost/url/ipv6_address.hpp include/boost/url/ipv6_address.hpp 101 5 1 boost/url/ipv6_address.hpp include/boost/url/ipv6_address.hpp 144 5 1 boost/url/ipv6_address.hpp include/boost/url/ipv6_address.hpp 173 5 1 overloads lIn0ANRa2ERdXJ25J6RfpOsnO2M= regular dhMSRVBIIIItY0URHSc8rwHcdTQ= brief text Constructors param text The string to parse. s param text The value to construct from. bytes param text The address to construct from. addr throws text The input failed to parse correctly. reference system_error see reference is_unspecified ogO/p3Rsy76ZR5BBjd+JT5p9mAI= see reference parse_ipv6_address bEw/qaAlNfZy1QraETx5dipoF+I= text . constructor SMQrQdasCvP7xFVD5OpcHN7Rao8= akXF+HlgiEVzawbJVW+kTfdVx8A= AvcoK23WHDbGR+iOtQJRebxgDgw= rKQkXaXamXVM4kRtPKdmG1+LcFw= jUKtD+hBU5HohlZsk0aE9sD4+9o= identifier void ipv6_address boost/url/ipv6_address.hpp include/boost/url/ipv6_address.hpp 101 5 1 function SMQrQdasCvP7xFVD5OpcHN7Rao8= regular dhMSRVBIIIItY0URHSc8rwHcdTQ= paragraph text Default constructed objects represent the unspecified address. list paragraph link text 2.5.2. The Unspecified Address https://datatracker.ietf.org/doc/html/rfc4291#section-2.5.2 unordered brief text Constructor. see reference is_unspecified ogO/p3Rsy76ZR5BBjd+JT5p9mAI= identifier void constructor 1 1 1 ipv6_address boost/url/ipv6_address.hpp include/boost/url/ipv6_address.hpp 105 5 1 function akXF+HlgiEVzawbJVW+kTfdVx8A= regular dhMSRVBIIIItY0URHSc8rwHcdTQ= brief text Constructor. param text The object to copy construct from other identifier void 1 identifier dhMSRVBIIIItY0URHSc8rwHcdTQ= ipv6_address other constructor 1 1 1 ipv6_address boost/url/ipv6_address.hpp include/boost/url/ipv6_address.hpp 173 5 1 function AvcoK23WHDbGR+iOtQJRebxgDgw= regular dhMSRVBIIIItY0URHSc8rwHcdTQ= paragraph text This function constructs an address from the string code text s text , which must contain a valid IPv6 address string or else an exception is thrown. admonition paragraph text For a non-throwing parse function, use reference parse_ipv6_address bEw/qaAlNfZy1QraETx5dipoF+I= text . note heading text Exception Safety 1 paragraph text Exceptions thrown on invalid input. heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Construct from a string. param text The string to parse. s throws text The input failed to parse correctly. reference system_error see reference parse_ipv6_address bEw/qaAlNfZy1QraETx5dipoF+I= text . identifier void identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s constructor 1 ipv6_address boost/url/ipv6_address.hpp include/boost/url/ipv6_address.hpp 124 5 1 function rKQkXaXamXVM4kRtPKdmG1+LcFw= regular dhMSRVBIIIItY0URHSc8rwHcdTQ= paragraph text This function constructs an address from the array in code text bytes text , which is interpreted in big-endian. brief text Construct from an array of bytes. param text The value to construct from. bytes identifier void 1 identifier 3HLniRaTZARS/qsIh1WH0IPNx7E= bytes_type bytes constructor 1 ipv6_address boost/url/ipv6_address.hpp include/boost/url/ipv6_address.hpp 144 5 1 function jUKtD+hBU5HohlZsk0aE9sD4+9o= regular dhMSRVBIIIItY0URHSc8rwHcdTQ= paragraph text This function constructs an IPv6 address from the IPv4 address code text addr text . The resulting address is an IPv4-Mapped IPv6 Address. heading text Specification 1 list paragraph link text 2.5.5.2. IPv4-Mapped IPv6 Address (rfc4291) https://datatracker.ietf.org/doc/html/rfc4291#section-2.5.5.2 unordered brief text Construct from an IPv4 address. param text The address to construct from. addr identifier void 1 identifier /Wpp3ZZDp3kUHzbULeDoaOEhnVs= ipv4_address addr constructor 1 operator= boost/url/ipv6_address.hpp include/boost/url/ipv6_address.hpp 112 5 1 function mrs1+u9ux/as1SWpxt5acP82xUI= regular dhMSRVBIIIItY0URHSc8rwHcdTQ= brief text Copy Assignment returns code text *this param text The object to copy assign from other identifier dhMSRVBIIIItY0URHSc8rwHcdTQ= ipv6_address 1 identifier dhMSRVBIIIItY0URHSc8rwHcdTQ= ipv6_address other normal 1 1 1 is_loopback boost/url/ipv6_address.hpp include/boost/url/ipv6_address.hpp 284 5 1 function 3CAIYwRL/lOXbVPvVDAG1wmwB6o= regular dhMSRVBIIIItY0URHSc8rwHcdTQ= paragraph text The unicast address 0:0:0:0:0:0:0:1 is called the loopback address. It may be used by a node to send an IPv6 packet to itself. heading text Specification 1 list paragraph link text 2.5.3. The Loopback Address (rfc4291) https://datatracker.ietf.org/doc/html/rfc4291#section-2.5.3 unordered brief text Return true if the address is a loopback address returns code text true text if the address is a loopback address identifier bool normal 1 1 is_unspecified boost/url/ipv6_address.hpp include/boost/url/ipv6_address.hpp 268 5 1 function ogO/p3Rsy76ZR5BBjd+JT5p9mAI= regular dhMSRVBIIIItY0URHSc8rwHcdTQ= paragraph text The address 0:0:0:0:0:0:0:0 is called the unspecified address. It indicates the absence of an address. heading text Specification 1 list paragraph link text 2.5.2. The Unspecified Address (rfc4291) https://datatracker.ietf.org/doc/html/rfc4291#section-2.5.2 unordered brief text Return true if the address is unspecified returns code text true text if the address is unspecified identifier bool normal 1 1 is_v4_mapped boost/url/ipv6_address.hpp include/boost/url/ipv6_address.hpp 299 5 1 function KPFd8cjF5Ss9pYOOq8WhES+hzjA= regular dhMSRVBIIIItY0URHSc8rwHcdTQ= paragraph text This address type is used to represent the addresses of IPv4 nodes as IPv6 addresses. heading text Specification 1 list paragraph link text 2.5.5.2. IPv4-Mapped IPv6 Address (rfc4291) https://datatracker.ietf.org/doc/html/rfc4291#section-2.5.5.2 unordered brief text Return true if the address is a mapped IPv4 address returns code text true text if the address is a mapped IPv4 address identifier bool normal 1 1 to_buffer boost/url/ipv6_address.hpp include/boost/url/ipv6_address.hpp 250 5 1 function i3fY28R+qnkP8zKn2cOQrWnjNWo= regular dhMSRVBIIIItY0URHSc8rwHcdTQ= paragraph text The resulting buffer is not null-terminated. brief text Write a dotted decimal string representing the address to a buffer returns text The formatted string param text The buffer in which to write, which must have at least code text dest_size text space. dest param text The size of the output buffer. dest_size throws code text dest_size < ipv6_address::max_str_len reference std::length_error identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core identifier char dest identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std dest_size normal 1 1 to_bytes boost/url/ipv6_address.hpp include/boost/url/ipv6_address.hpp 180 5 1 function ImUwdZB8YlRRGBoT4IIxXUe/wd8= regular dhMSRVBIIIItY0URHSc8rwHcdTQ= brief text Return the address as bytes, in network byte order returns text The address as an array of bytes. identifier 3HLniRaTZARS/qsIh1WH0IPNx7E= bytes_type normal 1 1 to_string boost/url/ipv6_address.hpp include/boost/url/ipv6_address.hpp 227 5 1 function 2zV4QmjxJ0lPqiBQDYB3ewBXEtk= regular dhMSRVBIIIItY0URHSc8rwHcdTQ= paragraph text The returned string does not contain surrounding square brackets. paragraph text When called with no arguments, the return type is code text std::string text . Otherwise, the return type and style of output is determined by which string token is passed. heading text Example 1 code ipv6_address::bytes_type b = {{ 0, 1, 0, 2, 0, 3, 0, 4, 0, 5, 0, 6, 0, 7, 0, 8 }}; ipv6_address a(b); assert(a.to_string() == "1:2:3:4:5:6:7:8"); assert( ipv4_address(0x01020304).to_string() == "1.2.3.4" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. String tokens may throw exceptions. heading text Specification 1 list paragraph link text 2.2. Text Representation of Addresses (rfc4291) https://datatracker.ietf.org/doc/html/rfc4291#section-2.2 unordered brief text Return the address as a string. returns text The return type of the string token. If the token parameter is omitted, then a new code text std::string text is returned. Otherwise, the function return type is the result type of the token. param text An optional string token. token identifier result_type identifier StringToken identifier StringToken token normal 1 1 loopback boost/url/ipv6_address.hpp include/boost/url/ipv6_address.hpp 345 5 1 function 01VFEJ5nUH+9Q1IRe+r7pqG6OY8= regular dhMSRVBIIIItY0URHSc8rwHcdTQ= paragraph text The unicast address 0:0:0:0:0:0:0:1 is called the loopback address. It may be used by a node to send an IPv6 packet to itself. heading text Specification 1 list paragraph link text 2.5.3. The Loopback Address (rfc4291) https://datatracker.ietf.org/doc/html/rfc4291#section-2.5.3 unordered brief text Return an address object that represents the loopback address returns text The loopback address. identifier dhMSRVBIIIItY0URHSc8rwHcdTQ= ipv6_address normal 1 max_str_len boost/url/ipv6_address.hpp include/boost/url/ipv6_address.hpp 79 5 1 variable 9qVxLX0gbXaA+Qu5TJlcZdIdmd8= regular dhMSRVBIIIItY0URHSc8rwHcdTQ= paragraph text The longest IPv6 address is: code ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff brief text The number of characters in the longest possible IPv6 string. see reference to_buffer i3fY28R+qnkP8zKn2cOQrWnjNWo= text . identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std 49 1 1 no_value_t boost/url/param.hpp include/boost/url/param.hpp 30 1 1 boost/url/detail/optional_string.hpp include/boost/url/detail/optional_string.hpp 20 1 record 51rV2xfhRV96h9L23+q8lPiw4x8= see-below dnk5XPfR2OaMpCYaH3cWSxcTdyc= brief text The type of reference no_value INQ2ouuVlRY3LsAsb8F4jYk7wBA= struct param boost/url/param.hpp include/boost/url/param.hpp 75 1 1 record fsdT8sbwW/lniPI5gqvIf2JMGBM= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text Objects of this type represent a single key and value pair in a query string where a key is always present and may be empty, while the presence of a value is indicated by reference has_value m6PwaZFpoqvv4Zklub5FwD4kMNU= text equal to true. An empty value is distinct from no value. paragraph text Depending on where the object was obtained, the strings may or may not contain percent escapes. paragraph text For most usages, key comparisons are case-sensitive and duplicate keys in a query are possible. However, it is the authority that has final control over how the query is interpreted. heading text BNF 1 code query-params = query-param *( "&" query-param ) query-param = key [ "=" value ] key = *qpchar value = *( qpchar / "=" ) heading text Specification 1 list paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text A query parameter see reference param_view C+IWBHRl3NluE4QVhoCkgb59VAc= text , reference param_pct_view SMbLJWxhkkCMp2sPkBpWmdnoNGI= text . struct RkMOusSn5P6oHMONLzdAkNMOCl0= sptvZUmXsnhRPTGckSU2FcQOx/U= HG2dqGDFjgWJE2OkgOAoRAs3puo= m6PwaZFpoqvv4Zklub5FwD4kMNU= 0dpgjf96RsW8NPBIyoLJHOaKlxQ= LWUlaPLa2eFsggicMKMN/EabI44= lx4IgIyOw+Bj9HQTUsF+bXRH8Jw= param boost/url/param.hpp include/boost/url/param.hpp 124 5 1 overloads RkMOusSn5P6oHMONLzdAkNMOCl0= regular fsdT8sbwW/lniPI5gqvIf2JMGBM= brief text Constructors returns text A reference to this object. param text The object to construct from. other param text The key to set. key param text The value to set. value param text True if a value is present. has_value t-param text An optional string type, such as code text core::string_view text , code text std::nullptr text , reference no_value_t 51rV2xfhRV96h9L23+q8lPiw4x8= text , or code text optional<core::string_view> text . OptionalString constructor m31qeAg+a+7PPxMDmwQbII+5IKk= 39skGZPf1jMIho6Qkxv0xCLsZFE= eI2QornVUnf4Eq3LH5m7TUwIS4o= usV8KIxAJDuXi0Vk+raUQOmujmo= okb99+iEelSdg117LuwoY8LP16w= identifier void param boost/url/param.hpp include/boost/url/param.hpp 124 5 1 function m31qeAg+a+7PPxMDmwQbII+5IKk= regular fsdT8sbwW/lniPI5gqvIf2JMGBM= paragraph text Default constructed query parameters have an empty key and no value. heading text Example 1 code param qp; heading text Postconditions 1 code this->key == "" && this->value == "" && this->has_value == false heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Constructor identifier void constructor 1 1 1 param boost/url/param.hpp include/boost/url/param.hpp 174 5 1 function 39skGZPf1jMIho6Qkxv0xCLsZFE= regular fsdT8sbwW/lniPI5gqvIf2JMGBM= paragraph text Upon construction, this becomes a copy of code text other text . heading text Postconditions 1 code this->key == other.key && this->value == other.value && this->has_value == other.has_value heading text Complexity 1 paragraph text Linear in code text other.key.size() + other.value.size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. brief text Constructor returns text A reference to this object. param text The object to construct from. other identifier void 1 identifier fsdT8sbwW/lniPI5gqvIf2JMGBM= param other constructor 1 1 1 param boost/url/param.hpp include/boost/url/param.hpp 142 5 1 function eI2QornVUnf4Eq3LH5m7TUwIS4o= regular fsdT8sbwW/lniPI5gqvIf2JMGBM= paragraph text Upon construction, this acquires ownership of the members of other via move construction. The moved from object is as if default constructed. heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Constructor param text The object to construct from. other identifier void identifier fsdT8sbwW/lniPI5gqvIf2JMGBM= param other constructor 1 param boost/url/param.hpp include/boost/url/param.hpp 283 5 1 function usV8KIxAJDuXi0Vk+raUQOmujmo= regular fsdT8sbwW/lniPI5gqvIf2JMGBM= paragraph text This constructs a parameter with a key and value. paragraph text No validation is performed on the strings. Ownership of the key and value is acquired by making copies. heading text Example 1 code param qp( "key", "value" ); code param qp( "key", optional<core::string_view>("value") ); code param qp( "key", boost::none ); code param qp( "key", nullptr ); code param qp( "key", no_value ); heading text Postconditions 1 code this->key == key && this->value == value && this->has_value == true heading text Complexity 1 paragraph text Linear in code text key.size() + value.size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. brief text Constructor param text The key to set. key param text The value to set. value t-param text An optional string type, such as code text core::string_view text , code text std::nullptr text , reference no_value_t 51rV2xfhRV96h9L23+q8lPiw4x8= text , or code text optional<core::string_view> text . OptionalString identifier void identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core key 1 identifier OptionalString value constructor 1 param boost/url/param.hpp include/boost/url/param.hpp 356 5 1 function okb99+iEelSdg117LuwoY8LP16w= regular fsdT8sbwW/lniPI5gqvIf2JMGBM= brief text Aggregate construction param text The key to set. key param text The value to set. value param text True if a value is present. has_value identifier void identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core key identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core value identifier bool has_value constructor 1 operator= boost/url/param.hpp include/boost/url/param.hpp 194 5 1 boost/url/param.hpp include/boost/url/param.hpp 310 5 1 boost/url/param.hpp include/boost/url/param.hpp 332 5 1 overloads sptvZUmXsnhRPTGckSU2FcQOx/U= regular fsdT8sbwW/lniPI5gqvIf2JMGBM= brief text Assignment returns text A reference to this object. param text The object to assign from. other normal zfGeu0K1/F+mX0XzUpds0ZSFzfM= s+7WqEnccxgNiV6x5Kd112RoZ2g= NFsUyybYjDW1e6c+YNVvNNhysqg= yzzq+JDcBEA/hUXXkuwHJENlGnE= identifier fsdT8sbwW/lniPI5gqvIf2JMGBM= param operator= boost/url/param.hpp include/boost/url/param.hpp 229 5 1 function zfGeu0K1/F+mX0XzUpds0ZSFzfM= regular fsdT8sbwW/lniPI5gqvIf2JMGBM= paragraph text Upon assignment, this becomes a copy of code text other text . heading text Postconditions 1 code this->key == other.key && this->value == other.value && this->has_value == other.has_value heading text Complexity 1 paragraph text Linear in code text other.key.size() + other.value.size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. brief text Assignment returns text A reference to this object. param text The object to assign from. other identifier fsdT8sbwW/lniPI5gqvIf2JMGBM= param 1 identifier fsdT8sbwW/lniPI5gqvIf2JMGBM= param other normal 1 1 1 operator= boost/url/param.hpp include/boost/url/param.hpp 194 5 1 function s+7WqEnccxgNiV6x5Kd112RoZ2g= regular fsdT8sbwW/lniPI5gqvIf2JMGBM= paragraph text Upon assignment, this acquires ownership of the members of other via move assignment. The moved from object is as if default constructed. heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Assignment returns text A reference to this object. param text The object to assign from. other identifier fsdT8sbwW/lniPI5gqvIf2JMGBM= param identifier fsdT8sbwW/lniPI5gqvIf2JMGBM= param other normal 1 operator= boost/url/param.hpp include/boost/url/param.hpp 997 1 boost/url/param.hpp include/boost/url/param.hpp 332 5 1 function NFsUyybYjDW1e6c+YNVvNNhysqg= regular fsdT8sbwW/lniPI5gqvIf2JMGBM= paragraph text The members of code text other text are copied, re-using already existing string capacity. heading text Postconditions 1 code this->key == other.key && this->value == other.value && this->has_value == other.has_value heading text Complexity 1 paragraph text Linear in code text other.key.size() + other.value.size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. brief text Assignment returns text A reference to this object. param text The parameter to copy. other identifier fsdT8sbwW/lniPI5gqvIf2JMGBM= param 1 identifier SMbLJWxhkkCMp2sPkBpWmdnoNGI= param_pct_view other normal 1 operator= boost/url/param.hpp include/boost/url/param.hpp 973 1 boost/url/param.hpp include/boost/url/param.hpp 310 5 1 function yzzq+JDcBEA/hUXXkuwHJENlGnE= regular fsdT8sbwW/lniPI5gqvIf2JMGBM= paragraph text The members of code text other text are copied, re-using already existing string capacity. heading text Postconditions 1 code this->key == other.key && this->value == other.value && this->has_value == other.has_value heading text Complexity 1 paragraph text Linear in code text other.key.size() + other.value.size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. brief text Assignment returns text A reference to this object. param text The parameter to copy. other identifier fsdT8sbwW/lniPI5gqvIf2JMGBM= param 1 identifier C+IWBHRl3NluE4QVhoCkgb59VAc= param_view other normal 1 operator-> boost/url/param.hpp include/boost/url/param.hpp 344 5 1 function HG2dqGDFjgWJE2OkgOAoRAs3puo= regular fsdT8sbwW/lniPI5gqvIf2JMGBM= paragraph text This operator returns the address of the object so that it can be used in pointer contexts. brief text Arrow support returns text A pointer to the object. 1 identifier fsdT8sbwW/lniPI5gqvIf2JMGBM= param normal 1 1 has_value boost/url/param.hpp include/boost/url/param.hpp 101 5 1 variable m6PwaZFpoqvv4Zklub5FwD4kMNU= regular fsdT8sbwW/lniPI5gqvIf2JMGBM= paragraph text The presence of a value is indicated by code text has_value == true text . An empty value is distinct from no value. brief text True if a value is present identifier bool false 1 key boost/url/param.hpp include/boost/url/param.hpp 85 5 1 variable 0dpgjf96RsW8NPBIyoLJHOaKlxQ= regular fsdT8sbwW/lniPI5gqvIf2JMGBM= paragraph text For most usages, key comparisons are case-sensitive and duplicate keys in a query are possible. However, it is the authority that has final control over how the query is interpreted. brief text The key identifier UwlFvW1lEI5kSm1M2LJ8livaK7g= string identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std 1 value boost/url/param.hpp include/boost/url/param.hpp 93 5 1 variable LWUlaPLa2eFsggicMKMN/EabI44= regular fsdT8sbwW/lniPI5gqvIf2JMGBM= paragraph text The presence of a value is indicated by reference has_value m6PwaZFpoqvv4Zklub5FwD4kMNU= text equal to true. An empty value is distinct from no value. brief text The value identifier UwlFvW1lEI5kSm1M2LJ8livaK7g= string identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std 1 param_pct_view boost/url/param.hpp include/boost/url/param.hpp 695 1 1 boost/url/param.hpp include/boost/url/param.hpp 24 1 record SMbLJWxhkkCMp2sPkBpWmdnoNGI= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text Objects of this type represent a single key and value pair in a query string where a key is always present and may be empty, while the presence of a value is indicated by reference has_value rmK2qEC9xNfHnl1z55UZ4m4mQkM= text equal to true. An empty value is distinct from no value. paragraph text The strings may have percent escapes, and offer an additional invariant: they never contain an invalid percent-encoding. paragraph text For most usages, key comparisons are case-sensitive and duplicate keys in a query are possible. However, it is the authority that has final control over how the query is interpreted. paragraph text Keys and values in this object reference external character buffers. Ownership of the buffers is not transferred; the caller is responsible for ensuring that the assigned buffers remain valid until they are no longer referenced. heading text BNF 1 code query-params = query-param *( "&" query-param ) query-param = key [ "=" value ] key = *qpchar value = *( qpchar / "=" ) heading text Specification 1 list paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text A view of a percent-encoded query parameter see reference param fsdT8sbwW/lniPI5gqvIf2JMGBM= text , reference param_view C+IWBHRl3NluE4QVhoCkgb59VAc= text . struct 3XfTE0CxJvdyGRqsCPLnIGybeuo= CdHMmHQfPjNS3AePE+tI+GtTRjA= AZd6M/W3LSYytCpQVhHudMjCzdM= xdQEoGMl95niJ7mohiOA2sXYuA8= rmK2qEC9xNfHnl1z55UZ4m4mQkM= owa9c8Ec+TQH5zkJ5xLQlW3RC1g= iU+8e6+V5sZG1u7SJEiC7m9XX7Y= g3noxRpXL1AZpBA6mm6pybflH0s= param_pct_view boost/url/param.hpp include/boost/url/param.hpp 746 5 1 overloads 3XfTE0CxJvdyGRqsCPLnIGybeuo= regular SMbLJWxhkkCMp2sPkBpWmdnoNGI= brief text Constructors returns text A param object param text The param to construct from. p param text The key to set. key param text The value to set. value param text True if a value is present has_value t-param text An optional code text core::string_view text type, such as code text boost::optional<core::string_view> text or code text std::optional<core::string_view> text . OptionalString throws code text key text or code text value text contains an invalid percent escape. reference system_error constructor Di79WdN/8AhKxcm8BbbzQnxTEx4= N7W4Sl+nozJV0loY9It6DjN1YDg= 6GAN49c4bX2HIjELHwtLSHta+n4= XX0MaMoegWB2X0gtPEZLHdh0dEY= IuJneRMhurFJcPnj8ZjmDfETSmc= identifier void param_pct_view boost/url/param.hpp include/boost/url/param.hpp 746 5 1 function Di79WdN/8AhKxcm8BbbzQnxTEx4= regular SMbLJWxhkkCMp2sPkBpWmdnoNGI= paragraph text Default constructed query parameters have an empty key and no value. heading text Example 1 code param_pct_view qp; heading text Postconditions 1 code this->key == "" && this->value == "" && this->has_value == false heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Constructor identifier void constructor 1 1 1 param_pct_view boost/url/param.hpp include/boost/url/param.hpp 876 5 1 function N7W4Sl+nozJV0loY9It6DjN1YDg= regular SMbLJWxhkkCMp2sPkBpWmdnoNGI= paragraph text This converts a param which may contain unvalidated percent-escapes into a param whose key and value are guaranteed to contain strings with no invalid percent-escapes, otherwise an exception is thrown. paragraph text The new key and value reference the same corresponding underlying character buffers. Ownership of the buffers is not transferred; the caller is responsible for ensuring that the assigned buffers remain valid until they are no longer referenced. heading text Example 1 code param_pct_view qp( param_view( "key", "value" ) ); heading text Complexity 1 paragraph text Linear in code text key.size() + value.size() text . heading text Exception Safety 1 paragraph text Exceptions thrown on invalid input. brief text Construction param text The param to construct from. p throws code text key text or code text value text contains an invalid percent escape. reference system_error identifier void 1 identifier C+IWBHRl3NluE4QVhoCkgb59VAc= param_view p constructor 1 param_pct_view boost/url/param.hpp include/boost/url/param.hpp 783 5 1 function 6GAN49c4bX2HIjELHwtLSHta+n4= regular SMbLJWxhkkCMp2sPkBpWmdnoNGI= paragraph text This constructs a parameter with a key and value, which may both contain percent escapes. The new key and value reference the same corresponding underlying character buffers. Ownership of the buffers is not transferred; the caller is responsible for ensuring that the assigned buffers remain valid until they are no longer referenced. heading text Example 1 code param_pct_view qp( "key", "value" ); heading text Postconditions 1 code this->key.data() == key.data() && this->value.data() == value.data() && this->has_value == true heading text Complexity 1 paragraph text Linear in code text key.size() + value.size() text . heading text Exception Safety 1 paragraph text Exceptions thrown on invalid input. brief text Constructor param text The key to set. key param text The value to set. value throws code text key text or code text value text contains an invalid percent-encoding. reference system_error identifier void identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view key identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view value constructor 1 param_pct_view boost/url/param.hpp include/boost/url/param.hpp 835 5 1 function XX0MaMoegWB2X0gtPEZLHdh0dEY= regular SMbLJWxhkkCMp2sPkBpWmdnoNGI= paragraph text This constructs a parameter with a key and optional value, which may both contain percent escapes. paragraph text The new key and value reference the same corresponding underlying character buffers. paragraph text Ownership of the buffers is not transferred; the caller is responsible for ensuring that the assigned buffers remain valid until they are no longer referenced. heading text Example 1 code param_pct_view qp( "key", optional<core::string_view>("value") ); heading text Postconditions 1 code this->key.data() == key.data() && this->value->data() == value->data() && this->has_value == true heading text Complexity 1 paragraph text Linear in code text key.size() + value->size() text . heading text Exception Safety 1 paragraph text Exceptions thrown on invalid input. brief text Constructor returns text A param object param text The key to set. key param text The optional value to set. value t-param text An optional code text core::string_view text type, such as code text boost::optional<core::string_view> text or code text std::optional<core::string_view> text . OptionalString throws code text key text or code text value text contains an invalid percent-encoding. reference system_error identifier void identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view key 1 identifier OptionalString value constructor 1 param_pct_view boost/url/param.hpp include/boost/url/param.hpp 950 5 1 function IuJneRMhurFJcPnj8ZjmDfETSmc= regular SMbLJWxhkkCMp2sPkBpWmdnoNGI= brief text Aggregate construction param text The key key param text The value value param text True if a value is present has_value identifier void identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view key identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view value identifier bool has_value constructor 1 operator-> boost/url/param.hpp include/boost/url/param.hpp 938 5 1 function CdHMmHQfPjNS3AePE+tI+GtTRjA= regular SMbLJWxhkkCMp2sPkBpWmdnoNGI= paragraph text This operator returns the address of the object so that it can be used in pointer contexts. brief text Arrow support returns text A pointer to this object 1 identifier SMbLJWxhkkCMp2sPkBpWmdnoNGI= param_pct_view normal 1 1 operator param boost/url/param.hpp include/boost/url/param.hpp 902 5 1 function AZd6M/W3LSYytCpQVhHudMjCzdM= regular SMbLJWxhkkCMp2sPkBpWmdnoNGI= paragraph text This function performs a conversion from a reference-like query parameter to one retaining ownership of the strings by making a copy. heading text Complexity 1 paragraph text Linear in code text this->key.size() + this->value.size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. brief text Conversion returns text A param object identifier fsdT8sbwW/lniPI5gqvIf2JMGBM= param conversion 1 1 operator param_view boost/url/param.hpp include/boost/url/param.hpp 923 5 1 function xdQEoGMl95niJ7mohiOA2sXYuA8= regular SMbLJWxhkkCMp2sPkBpWmdnoNGI= paragraph text This function performs a conversion from a pct_string_view query parameter to one using a simple string_view. heading text Exception Safety 1 paragraph text Calls to allocate may throw. brief text Conversion to param_view returns text A param_view object identifier C+IWBHRl3NluE4QVhoCkgb59VAc= param_view conversion 1 1 has_value boost/url/param.hpp include/boost/url/param.hpp 721 5 1 variable rmK2qEC9xNfHnl1z55UZ4m4mQkM= regular SMbLJWxhkkCMp2sPkBpWmdnoNGI= paragraph text The presence of a value is indicated by code text has_value == true text . An empty value is distinct from no value. brief text True if a value is present identifier bool false 1 key boost/url/param.hpp include/boost/url/param.hpp 705 5 1 variable owa9c8Ec+TQH5zkJ5xLQlW3RC1g= regular SMbLJWxhkkCMp2sPkBpWmdnoNGI= paragraph text For most usages, key comparisons are case-sensitive and duplicate keys in a query are possible. However, it is the authority that has final control over how the query is interpreted. brief text The key identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view 1 value boost/url/param.hpp include/boost/url/param.hpp 713 5 1 variable iU+8e6+V5sZG1u7SJEiC7m9XX7Y= regular SMbLJWxhkkCMp2sPkBpWmdnoNGI= paragraph text The presence of a value is indicated by reference has_value rmK2qEC9xNfHnl1z55UZ4m4mQkM= text equal to true. An empty value is distinct from no value. brief text The value identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view 1 param_view boost/url/param.hpp include/boost/url/param.hpp 427 1 1 boost/url/param.hpp include/boost/url/param.hpp 25 1 record C+IWBHRl3NluE4QVhoCkgb59VAc= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text Objects of this type represent a single key and value pair in a query string where a key is always present and may be empty, while the presence of a value is indicated by reference has_value 5qdp3uhNRJQmOCy91Ie1r9Wod8c= text equal to true. An empty value is distinct from no value. paragraph text Depending on where the object was obtained, the strings may or may not contain percent escapes. Some functions and objects might expect encoded strings in this view, while others expect decoded strings. The caller should be aware of the context in which the object will be used. paragraph text For most usages, key comparisons are case-sensitive and duplicate keys in a query are possible. However, it is the authority that has final control over how the query is interpreted. paragraph text Keys and values in this object reference external character buffers. Ownership of the buffers is not transferred; the caller is responsible for ensuring that the assigned buffers remain valid until they are no longer referenced. heading text BNF 1 code query-params = query-param *( "&" query-param ) query-param = key [ "=" value ] key = *qpchar value = *( qpchar / "=" ) heading text Specification 1 list paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text A view of a query parameter see reference param fsdT8sbwW/lniPI5gqvIf2JMGBM= text , reference param_pct_view SMbLJWxhkkCMp2sPkBpWmdnoNGI= text . struct 6OKdF9B0XT6XAo7fiVCMo+e9BOI= SyeSz+EOTfJojbhMH5e929glZME= j4zn5vmDnlIInrMNdQvhbH7pd8A= 5qdp3uhNRJQmOCy91Ie1r9Wod8c= 0w9Q3dEVwZ2B+pha3LDXacGaN8U= jSR+FziEeMh2Ue2Gpy/FfW7Bdl8= OWm0fdcZ1VBNjS071iCYtRFODbY= param_view boost/url/param.hpp include/boost/url/param.hpp 478 5 1 overloads 6OKdF9B0XT6XAo7fiVCMo+e9BOI= regular C+IWBHRl3NluE4QVhoCkgb59VAc= brief text Constructors param text The param to reference other param text The key to set. key param text The value to set. value param text True if a value is present. has_value t-param text An optional string type, such as code text core::string_view text , code text std::nullptr text , reference no_value_t 51rV2xfhRV96h9L23+q8lPiw4x8= text , or code text optional<core::string_view> text . OptionalString constructor eq0SF4UQaNBZbYdivlCWsVA5Lc4= fj5gN0ldQtYkAUvxIrujcFVadCA= GRgc3qbuxNz2lViEWv9ClZsU0Lc= NSR96oc02lbW4sL/WGkyIWtbgKg= identifier void param_view boost/url/param.hpp include/boost/url/param.hpp 478 5 1 function eq0SF4UQaNBZbYdivlCWsVA5Lc4= regular C+IWBHRl3NluE4QVhoCkgb59VAc= paragraph text Default constructed query parameters have an empty key and no value. heading text Example 1 code param_view qp; heading text Postconditions 1 code this->key == "" && this->value == "" && this->has_value == false heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Constructor identifier void constructor 1 1 1 param_view boost/url/param.hpp include/boost/url/param.hpp 555 5 1 function fj5gN0ldQtYkAUvxIrujcFVadCA= regular C+IWBHRl3NluE4QVhoCkgb59VAc= paragraph text This function constructs a param which references the character buffers representing the key and value in another container. Ownership of the buffers is not transferred; the caller is responsible for ensuring that the assigned buffers remain valid until they are no longer referenced. heading text Example 1 code param qp( "key", "value" ); param_view qpv( qp ); heading text Postconditions 1 code this->key == key && this->value == value && this->has_value == other.has_value heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Constructor param text The param to reference other identifier void 1 identifier fsdT8sbwW/lniPI5gqvIf2JMGBM= param other constructor 1 param_view boost/url/param.hpp include/boost/url/param.hpp 517 5 1 function GRgc3qbuxNz2lViEWv9ClZsU0Lc= regular C+IWBHRl3NluE4QVhoCkgb59VAc= paragraph text This constructs a parameter with a key and value. No validation is performed on the strings. The new key and value reference the same corresponding underlying character buffers. Ownership of the buffers is not transferred; the caller is responsible for ensuring that the assigned buffers remain valid until they are no longer referenced. heading text Example 1 code param_view qp( "key", "value" ); heading text Postconditions 1 code this->key.data() == key.data() && this->value.data() == value.data() && this->has_value == true heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Constructor param text The key to set. key param text The value to set. value t-param text An optional string type, such as code text core::string_view text , code text std::nullptr text , reference no_value_t 51rV2xfhRV96h9L23+q8lPiw4x8= text , or code text optional<core::string_view> text . OptionalString identifier void identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core key 1 identifier OptionalString value constructor 1 param_view boost/url/param.hpp include/boost/url/param.hpp 619 5 1 function NSR96oc02lbW4sL/WGkyIWtbgKg= regular C+IWBHRl3NluE4QVhoCkgb59VAc= brief text Aggregate construction param text The key to set. key param text The value to set. value param text True if a value is present. has_value identifier void identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core key identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core value identifier bool has_value constructor 1 operator-> boost/url/param.hpp include/boost/url/param.hpp 595 5 1 function SyeSz+EOTfJojbhMH5e929glZME= regular C+IWBHRl3NluE4QVhoCkgb59VAc= paragraph text This operator returns the address of the object so that it can be used in pointer contexts. brief text Arrow support returns text A pointer to the object. 1 identifier C+IWBHRl3NluE4QVhoCkgb59VAc= param_view normal 1 1 operator param boost/url/param.hpp include/boost/url/param.hpp 580 5 1 function j4zn5vmDnlIInrMNdQvhbH7pd8A= regular C+IWBHRl3NluE4QVhoCkgb59VAc= paragraph text This function performs a conversion from a reference-like query parameter to one retaining ownership of the strings by making a copy. No validation is performed on the strings. heading text Complexity 1 paragraph text Linear in code text this->key.size() + this->value.size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. brief text Conversion returns text A new query parameter. identifier fsdT8sbwW/lniPI5gqvIf2JMGBM= param conversion 1 has_value boost/url/param.hpp include/boost/url/param.hpp 453 5 1 variable 5qdp3uhNRJQmOCy91Ie1r9Wod8c= regular C+IWBHRl3NluE4QVhoCkgb59VAc= paragraph text The presence of a value is indicated by code text has_value == true text . An empty value is distinct from no value. brief text True if a value is present identifier bool false 1 key boost/url/param.hpp include/boost/url/param.hpp 437 5 1 variable 0w9Q3dEVwZ2B+pha3LDXacGaN8U= regular C+IWBHRl3NluE4QVhoCkgb59VAc= paragraph text For most usages, key comparisons are case-sensitive and duplicate keys in a query are possible. However, it is the authority that has final control over how the query is interpreted. brief text The key identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core 1 value boost/url/param.hpp include/boost/url/param.hpp 445 5 1 variable jSR+FziEeMh2Ue2Gpy/FfW7Bdl8= regular C+IWBHRl3NluE4QVhoCkgb59VAc= paragraph text The presence of a value is indicated by reference has_value 5qdp3uhNRJQmOCy91Ie1r9Wod8c= text equal to true. An empty value is distinct from no value. brief text The value identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core 1 params_base boost/url/params_base.hpp include/boost/url/params_base.hpp 42 1 1 record paRP7A1SOQlKcnfXhxL4FgbVXKs= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text This base centralizes the read-only, percent-decoded query parameter algorithms (iteration, lookup, counting) that are shared by reference params_view DzqMpaJX2O25vPFxEN5EDTyU6uw= text and reference params_ref 8S83BKvWBCDdTktlY8X93Mlo9E0= text . paragraph text This class should not be instantiated directly; Instead, use one of the containers or functions: heading text Containers 1 list paragraph reference params_ref 8S83BKvWBCDdTktlY8X93Mlo9E0= paragraph reference params_view DzqMpaJX2O25vPFxEN5EDTyU6uw= paragraph reference params_encoded_ref oR5B5D0/JYTOQYvyFXRv+at91JE= paragraph reference params_encoded_view 0nSfM4mK92fIx58KtzdWGiHuq2w= unordered brief text Decoded query parameter helper base class 8S83BKvWBCDdTktlY8X93Mlo9E0= DzqMpaJX2O25vPFxEN5EDTyU6uw= 4XRIDzJtD8YcNf6ybgP1JlmdPbE= /aPvkkBZhzgeMb2UCNaJ1s5c6oQ= 4jo6j51QPa7nfAiEWAM6LJc4fLs= 8Hg/5b5RDYgIk/T6aP0tPj0HbSc= cFqtE5widJnnA8qwGOBnkhkdR6Y= /wVpdYewE+NKvN60EGcgNiIZ+Mc= maJcbp53hfhQNovBi8QEK/+HTzw= rgFjw9W6rMjgEYkGOVMDiLJIIdE= cpczYPJifQzreeaLMlFMrIk8geU= +m1VjI0xtgykFmvRxecqZkXJBNg= SUQ73EvVipRYcJ2Sg24T8d60qeQ= VQ4Gk4oWz8OorSDPtJoAWpHsFaI= NYG2/rgQQuH/CSw2qObuDUB3DYo= /lfP4NtGxUDEYF5NvxdZQKO226I= S17pkFUExaqRFD9HA5cryLnWVG8= GhT3qpAk3WuPisnAoeMMKNguVco= u/w33vX8w/yA/9Gl176lDHdQs4k= JAc718f//bzvETv8VNPf4ujJ2G8= xVQ9Dnv4XIVarte/JE0+2jQbUVI= zixvx9TyICX0ERE+dfSM1EM2StQ= TeDvymLSAZHr8JSzdhkzOi9uKdE= 98YlORx4JBM3hsv5MdkETfkyXew= /AtA7/kfIGTrmKKwB/CzM/bITT8= 2orabj8t+Rp3TcAvzImYqwcdssk= identifier DzqMpaJX2O25vPFxEN5EDTyU6uw= params_view DzqMpaJX2O25vPFxEN5EDTyU6uw= identifier 8S83BKvWBCDdTktlY8X93Mlo9E0= params_ref 8S83BKvWBCDdTktlY8X93Mlo9E0= identifier UEVNhDEjkZMXfjN1DxbtX0n2rCg= url_view_base UEVNhDEjkZMXfjN1DxbtX0n2rCg= const_iterator boost/url/params_base.hpp include/boost/url/params_base.hpp 94 5 1 typedef 4XRIDzJtD8YcNf6ybgP1JlmdPbE= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= paragraph text Objects of this type allow iteration through the parameters in the query. Any percent-escapes in returned strings are decoded first. The values returned are read-only; changes to parameters must be made through the container instead, if the container supports modification. paragraph text The strings produced when iterators are dereferenced belong to the iterator and become invalidated when that particular iterator is incremented, decremented, or destroyed. paragraph text The implementation may use temporary, recycled storage to store decoded strings. These iterators are meant to be used ephemerally. That is, for short durations such as within a function scope. Do not store iterators with static storage duration or as long-lived objects. brief text A Bidirectional iterator to a query parameter iterator identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator 1 const_reference boost/url/params_base.hpp include/boost/url/params_base.hpp 123 5 1 typedef /aPvkkBZhzgeMb2UCNaJ1s5c6oQ= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= paragraph text This is the type of value returned when iterators of the view are dereferenced. brief text The reference type reference see reference param_view C+IWBHRl3NluE4QVhoCkgb59VAc= text . identifier fsdT8sbwW/lniPI5gqvIf2JMGBM= param 1 difference_type boost/url/params_base.hpp include/boost/url/params_base.hpp 131 5 1 typedef 4jo6j51QPa7nfAiEWAM6LJc4fLs= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= brief text A signed integer type used to represent differences. identifier EH4n8sIj03HafoTNn2U36T1P+Hc= ptrdiff_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std 1 reference boost/url/params_base.hpp include/boost/url/params_base.hpp 120 5 1 typedef 8Hg/5b5RDYgIk/T6aP0tPj0HbSc= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= paragraph text This is the type of value returned when iterators of the view are dereferenced. brief text The reference type see reference param_view C+IWBHRl3NluE4QVhoCkgb59VAc= text . identifier fsdT8sbwW/lniPI5gqvIf2JMGBM= param 1 size_type boost/url/params_base.hpp include/boost/url/params_base.hpp 127 5 1 typedef cFqtE5widJnnA8qwGOBnkhkdR6Y= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= brief text An unsigned integer type to represent sizes. identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std 1 value_type boost/url/params_base.hpp include/boost/url/params_base.hpp 110 5 1 typedef /wVpdYewE+NKvN60EGcgNiIZ+Mc= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= paragraph text Values of this type represent parameters whose strings retain unique ownership by making a copy. heading text Example 1 code params_view::value_type qp( *url_view( "?first=John&last=Doe" ).params().find( "first" ) ); brief text The value type see reference param fsdT8sbwW/lniPI5gqvIf2JMGBM= text . identifier fsdT8sbwW/lniPI5gqvIf2JMGBM= param 1 iterator boost/url/impl/params_base.hpp include/boost/url/impl/params_base.hpp 26 1 boost/url/params_base.hpp include/boost/url/params_base.hpp 91 5 1 record maJcbp53hfhQNovBi8QEK/+HTzw= see-below paRP7A1SOQlKcnfXhxL4FgbVXKs= paragraph text Objects of this type allow iteration through the parameters in the query. Any percent-escapes in returned strings are decoded first. The values returned are read-only; changes to parameters must be made through the container instead, if the container supports modification. paragraph text The strings produced when iterators are dereferenced belong to the iterator and become invalidated when that particular iterator is incremented, decremented, or destroyed. paragraph text The implementation may use temporary, recycled storage to store decoded strings. These iterators are meant to be used ephemerally. That is, for short durations such as within a function scope. Do not store iterators with static storage duration or as long-lived objects. brief text A Bidirectional iterator to a query parameter class identifier 8S83BKvWBCDdTktlY8X93Mlo9E0= params_ref 8S83BKvWBCDdTktlY8X93Mlo9E0= identifier paRP7A1SOQlKcnfXhxL4FgbVXKs= params_base paRP7A1SOQlKcnfXhxL4FgbVXKs= begin boost/url/params_base.hpp include/boost/url/params_base.hpp 227 5 1 function rgFjw9W6rMjgEYkGOVMDiLJIIdE= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= heading text Complexity 1 paragraph text Linear in the size of the first param. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return an iterator to the beginning returns text An iterator to the beginning. identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator normal 1 1 buffer boost/url/params_base.hpp include/boost/url/params_base.hpp 178 5 1 function cpczYPJifQzreeaLMlFMrIk8geU= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= paragraph text This function returns the character buffer referenced by the view. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "?first=John&last=Doe" ).params().buffer() == "?first=John&last=Doe" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the referenced character buffer. returns text The buffer. identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 contains boost/url/params_base.hpp include/boost/url/params_base.hpp 275 5 1 function +m1VjI0xtgykFmvRxecqZkXJBNg= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= paragraph text This function examines the parameters in the container to find a match for the specified key. The comparison is performed as if all escaped characters were decoded first. heading text Example 1 code assert( url_view( "?first=John&last=Doe" ).params().contains( "first" ) ); heading text Complexity 1 paragraph text Linear in code text this->buffer().size() text . heading text Exception Safety 1 paragraph text Throws nothing. brief text Return true if a matching key exists returns code text true text if a matching key exists. param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic identifier bool identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core key identifier RATceEbebMWrhFXGkG2RDFi+7WY= ignore_case_param ic {} normal 1 1 count boost/url/params_base.hpp include/boost/url/params_base.hpp 311 5 1 function SUQ73EvVipRYcJ2Sg24T8d60qeQ= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= paragraph text This function examines the parameters in the container to find the number of matches for the specified key. The comparison is performed as if all escaped characters were decoded first. heading text Example 1 code assert( url_view( "?first=John&last=Doe" ).params().count( "first" ) == 1 ); heading text Complexity 1 paragraph text Linear in code text this->buffer().size() text . heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the number of matching keys returns text The number of matching keys. param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core key identifier RATceEbebMWrhFXGkG2RDFi+7WY= ignore_case_param ic {} normal 1 1 empty boost/url/params_base.hpp include/boost/url/params_base.hpp 196 5 1 function VQ4Gk4oWz8OorSDPtJoAWpHsFaI= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= heading text Example 1 code assert( ! url_view( "?key=value" ).params().empty() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return true if there are no params returns code text true text if there are no params. identifier bool normal 1 1 end boost/url/params_base.hpp include/boost/url/params_base.hpp 240 5 1 function NYG2/rgQQuH/CSw2qObuDUB3DYo= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return an iterator to the end returns text An iterator to the end. identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator normal 1 1 find boost/url/params_base.hpp include/boost/url/params_base.hpp 395 5 1 boost/url/params_base.hpp include/boost/url/params_base.hpp 440 5 1 overloads /lfP4NtGxUDEYF5NvxdZQKO226I= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= brief text Find a matching key returns text an iterator to the param param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic param text The position to begin the search from. This can be code text end() text . from normal mSdbytykajruHQy1W8iyrWbbOmM= Q/NxQl0WFzXMzvRmJDH5BghXp5M= identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator find boost/url/params_base.hpp include/boost/url/params_base.hpp 395 5 1 function mSdbytykajruHQy1W8iyrWbbOmM= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= paragraph text This function examines the parameters in the container to find a match for the specified key. The comparison is performed as if all escaped characters were decoded first. paragraph text The search starts from the first param and proceeds forward until either the key is found or the end of the range is reached, in which case code text end() text is returned. heading text Example 1 code assert( (*url_view( "?first=John&last=Doe" ).params().find( "First", ignore_case )).value == "John" ); heading text Effects 1 code return this->find( this->begin(), key, ic ); heading text Complexity 1 paragraph text Linear in code text this->buffer().size() text . brief text Find a matching key returns text an iterator to the param param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core key identifier RATceEbebMWrhFXGkG2RDFi+7WY= ignore_case_param ic {} normal 1 1 find boost/url/params_base.hpp include/boost/url/params_base.hpp 440 5 1 function Q/NxQl0WFzXMzvRmJDH5BghXp5M= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= paragraph text This function examines the parameters in the container to find a match for the specified key. The comparison is performed as if all escaped characters were decoded first. paragraph text The search starts at code text from text and proceeds forward until either the key is found or the end of the range is reached, in which case code text end() text is returned. heading text Example 1 code url_view u( "?First=John&Last=Doe" ); assert( u.params().find( "first" ) != u.params().find( "first", ignore_case ) ); heading text Complexity 1 paragraph text Linear in code text this->buffer().size() text . brief text Find a matching key returns text an iterator to the param param text The position to begin the search from. This can be code text end() text . from param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator from identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core key identifier RATceEbebMWrhFXGkG2RDFi+7WY= ignore_case_param ic {} normal 1 1 find_last boost/url/params_base.hpp include/boost/url/params_base.hpp 481 5 1 boost/url/params_base.hpp include/boost/url/params_base.hpp 527 5 1 overloads S17pkFUExaqRFD9HA5cryLnWVG8= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= brief text Find a matching key returns text an iterator to the param param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic param text One past the position to begin the search from. This can be code text end() text . before normal T7jam5dZRMsS/ZHAEHdP05Fqlug= 2y2ewlvaEuZkWtKX4p7xlBO2wXU= identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator find_last boost/url/params_base.hpp include/boost/url/params_base.hpp 481 5 1 function T7jam5dZRMsS/ZHAEHdP05Fqlug= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= paragraph text This function examines the parameters in the container to find a match for the specified key. The comparison is performed as if all escaped characters were decoded first. paragraph text The search starts from the last param and proceeds backwards until either the key is found or the beginning of the range is reached, in which case code text end() text is returned. heading text Example 1 code assert( (*url_view( "?first=John&last=Doe" ).params().find_last( "last" )).value == "Doe" ); heading text Complexity 1 paragraph text Linear in code text this->buffer().size() text . brief text Find a matching key returns text an iterator to the param param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core key identifier RATceEbebMWrhFXGkG2RDFi+7WY= ignore_case_param ic {} normal 1 1 find_last boost/url/params_base.hpp include/boost/url/params_base.hpp 527 5 1 function 2y2ewlvaEuZkWtKX4p7xlBO2wXU= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= paragraph text This function examines the parameters in the container to find a match for the specified key. The comparison is performed as if all escaped characters were decoded first. paragraph text The search starts prior to code text before text and proceeds backwards until either the key is found or the beginning of the range is reached, in which case code text end() text is returned. heading text Example 1 code url_view u( "?First=John&Last=Doe" ); assert( u.params().find_last( "last" ) != u.params().find_last( "last", ignore_case ) ); heading text Complexity 1 paragraph text Linear in code text this->buffer().size() text . brief text Find a matching key returns text an iterator to the param param text One past the position to begin the search from. This can be code text end() text . before param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator before identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core key identifier RATceEbebMWrhFXGkG2RDFi+7WY= ignore_case_param ic {} normal 1 1 get_or boost/url/params_base.hpp include/boost/url/params_base.hpp 349 5 1 function GhT3qpAk3WuPisnAoeMMKNguVco= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= paragraph text This convenience function searches for the first parameter matching code text key text and returns its decoded value. If no parameter with the specified key exists, the provided fallback code text value text is returned instead. When the key is found but the parameter has no value, an empty string is returned. heading text Example 1 code url_view u( "/path?first=John&last=Doe" ); assert( u.params().get_or( "first", "n/a" ) == "John" ); assert( u.params().get_or( "missing", "n/a" ) == "n/a" ); heading text Complexity 1 paragraph text Linear in code text this->buffer().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. brief text Return the value for a key or a fallback returns text The decoded value or the fallback. param text The key to match. key param text The fallback string returned when no matching key exists. If this parameter is omitted, an empty string is used. value param text Optional case-insensitive compare indicator. ic identifier UwlFvW1lEI5kSm1M2LJ8livaK7g= string identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core key identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core value {} identifier RATceEbebMWrhFXGkG2RDFi+7WY= ignore_case_param ic {} normal 1 1 size boost/url/params_base.hpp include/boost/url/params_base.hpp 214 5 1 function u/w33vX8w/yA/9Gl176lDHdQs4k= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= heading text Example 1 code assert( url_view( "?key=value").params().size() == 1 ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the number of params returns text The number of params. identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 1 max_size boost/url/params_base.hpp include/boost/url/params_base.hpp 150 5 1 function JAc718f//bzvETv8VNPf4ujJ2G8= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= paragraph text This represents the largest number of characters that are possible in a path, not including any null terminator. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the maximum number of characters possible returns text The maximum number of characters possible. identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 params_encoded_base boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 40 1 1 record 2+L1/+BrjUzoccWPIYkGu108y1I= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text This base implements the shared percent-encoded query parameter view functionality used by reference params_encoded_view 0nSfM4mK92fIx58KtzdWGiHuq2w= text and reference params_encoded_ref oR5B5D0/JYTOQYvyFXRv+at91JE= text . It cannot be instantiated directly; instead, use one of those containers or the corresponding ref adaptors. heading text Containers 1 list paragraph reference params_ref 8S83BKvWBCDdTktlY8X93Mlo9E0= paragraph reference params_view DzqMpaJX2O25vPFxEN5EDTyU6uw= paragraph reference params_encoded_ref oR5B5D0/JYTOQYvyFXRv+at91JE= paragraph reference params_encoded_view 0nSfM4mK92fIx58KtzdWGiHuq2w= unordered brief text Percent-encoded query helper base class oR5B5D0/JYTOQYvyFXRv+at91JE= 0nSfM4mK92fIx58KtzdWGiHuq2w= XJpUUNCpigJ1xkT7ZTlbU72H/Ak= dZWEqr9OGQvjwxniXvQD5gJgpjs= Jgooe8CMHSLBI54qjRb0o6d/8/o= BU4ImK4QmuraTcmiVgUZHD9EeSc= GqAV1Lhk5ZQyP+b5jBK+ATBZPKo= TadRKN4c6SRe/Yk1CsRORJw1qkM= ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= H11d1XIdchNVENPAXFI29FSpdmA= pXB7x4tVHvcwWbxezFAda5sgdHI= ytgJ9icra/4vSaD7yJY5ki4BrNY= dYTek2kRS43hktBruYZHns13CqM= FAnUbM3orQ8EQ3bA6cM0MPKqnzs= MTKGTeb7OLB4syv3KjZV9NsdSuA= zj0dzqqDoXAn/IpKEmcRq2Ez/X0= sU6Wyw2mc8hB6qluzOF1BY1QMT4= xzDNyNoWABjJO6PP8LTuDGqYKaE= zF7kAsctYJbzsEd/ye9VQDTlad8= YhJEdM/9SyCZ1JSUhp09kwAEwsw= j2prfemhp6BNz9ok4qB/jaAilR4= QKiPd9CwpcQFA/vIIwm7jtsfkCM= Hsl72ddKrsu3iaBlbpx0dWOjWFg= s1pLOorKsWXzF2FD1pq9t1lGrkg= tXpv52j936oYLIk8+VD74tImT0Q= identifier 0nSfM4mK92fIx58KtzdWGiHuq2w= params_encoded_view 0nSfM4mK92fIx58KtzdWGiHuq2w= identifier oR5B5D0/JYTOQYvyFXRv+at91JE= params_encoded_ref oR5B5D0/JYTOQYvyFXRv+at91JE= identifier UEVNhDEjkZMXfjN1DxbtX0n2rCg= url_view_base UEVNhDEjkZMXfjN1DxbtX0n2rCg= const_iterator boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 82 5 1 typedef XJpUUNCpigJ1xkT7ZTlbU72H/Ak= regular 2+L1/+BrjUzoccWPIYkGu108y1I= paragraph text Objects of this type allow iteration through the parameters in the query. Strings returned by iterators may contain percent escapes. The values returned are read-only; changes to parameters must be made through the container instead, if the container supports modification. paragraph text The strings produced when iterators are dereferenced refer to the underlying character buffer. Ownership is not transferred; the caller is responsible for ensuring that the lifetime of the buffer extends until it is no longer referenced by any container or iterator. brief text A Bidirectional iterator to a query parameter iterator identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator 1 const_reference boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 111 5 1 typedef dZWEqr9OGQvjwxniXvQD5gJgpjs= regular 2+L1/+BrjUzoccWPIYkGu108y1I= paragraph text This is the type of value returned when iterators of the view are dereferenced. brief text The reference type reference see reference param_view C+IWBHRl3NluE4QVhoCkgb59VAc= text . identifier SMbLJWxhkkCMp2sPkBpWmdnoNGI= param_pct_view 1 difference_type boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 119 5 1 typedef Jgooe8CMHSLBI54qjRb0o6d/8/o= regular 2+L1/+BrjUzoccWPIYkGu108y1I= brief text A signed integer type used to represent differences. identifier EH4n8sIj03HafoTNn2U36T1P+Hc= ptrdiff_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std 1 reference boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 108 5 1 typedef BU4ImK4QmuraTcmiVgUZHD9EeSc= regular 2+L1/+BrjUzoccWPIYkGu108y1I= paragraph text This is the type of value returned when iterators of the view are dereferenced. brief text The reference type see reference param_view C+IWBHRl3NluE4QVhoCkgb59VAc= text . identifier SMbLJWxhkkCMp2sPkBpWmdnoNGI= param_pct_view 1 size_type boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 115 5 1 typedef GqAV1Lhk5ZQyP+b5jBK+ATBZPKo= regular 2+L1/+BrjUzoccWPIYkGu108y1I= brief text An unsigned integer type to represent sizes. identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std 1 value_type boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 98 5 1 typedef TadRKN4c6SRe/Yk1CsRORJw1qkM= regular 2+L1/+BrjUzoccWPIYkGu108y1I= paragraph text Values of this type represent parameters whose strings retain unique ownership by making a copy. heading text Example 1 code params_encoded_view::value_type qp( *url_view( "?first=John&last=Doe" ).params().find( "first" ) ); brief text The value type see reference param fsdT8sbwW/lniPI5gqvIf2JMGBM= text . identifier fsdT8sbwW/lniPI5gqvIf2JMGBM= param 1 iterator boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 79 5 1 record ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= see-below 2+L1/+BrjUzoccWPIYkGu108y1I= paragraph text Objects of this type allow iteration through the parameters in the query. Strings returned by iterators may contain percent escapes. The values returned are read-only; changes to parameters must be made through the container instead, if the container supports modification. paragraph text The strings produced when iterators are dereferenced refer to the underlying character buffer. Ownership is not transferred; the caller is responsible for ensuring that the lifetime of the buffer extends until it is no longer referenced by any container or iterator. brief text A Bidirectional iterator to a query parameter class +mbgraIEKxYlGRnrtbl+juVak7Y= 3b8LtWJdyf2AUFgD88j68/LgT7s= identifier oR5B5D0/JYTOQYvyFXRv+at91JE= params_encoded_ref oR5B5D0/JYTOQYvyFXRv+at91JE= identifier 2+L1/+BrjUzoccWPIYkGu108y1I= params_encoded_base 2+L1/+BrjUzoccWPIYkGu108y1I= begin boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 228 5 1 function H11d1XIdchNVENPAXFI29FSpdmA= regular 2+L1/+BrjUzoccWPIYkGu108y1I= heading text Complexity 1 paragraph text Linear in the size of the first param. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return an iterator to the beginning returns text An iterator to the beginning. identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator normal 1 1 buffer boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 179 5 1 function pXB7x4tVHvcwWbxezFAda5sgdHI= regular 2+L1/+BrjUzoccWPIYkGu108y1I= paragraph text This function returns the query string referenced by the container. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "?first=John&last=Doe" ).encoded_params().buffer() == "first=John&last=Doe" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code query-params = query-param *( "&" query-param ) query-param = key [ "=" value ] key = *qpchar value = *( qpchar / "=" ) heading text Specification 1 list paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Return the query corresponding to these params returns text The query string. identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 contains boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 280 5 1 function ytgJ9icra/4vSaD7yJY5ki4BrNY= regular 2+L1/+BrjUzoccWPIYkGu108y1I= paragraph text This function examines the parameters in the container to find a match for the specified key, which may contain percent escapes. The comparison is performed as if all escaped characters were decoded first. heading text Example 1 code assert( url_view( "?first=John&last=Doe" ).encoded_params().contains( "first" ) ); heading text Complexity 1 paragraph text Linear in code text this->buffer().size() text . heading text Exception Safety 1 paragraph text Exceptions thrown on invalid input. brief text Return true if a matching key exists returns code text true text if a matching key exists. param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic throws code text key text contains an invalid percent-encoding. reference system_error identifier bool identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view key identifier RATceEbebMWrhFXGkG2RDFi+7WY= ignore_case_param ic {} normal 1 1 count boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 319 5 1 function dYTek2kRS43hktBruYZHns13CqM= regular 2+L1/+BrjUzoccWPIYkGu108y1I= paragraph text This function examines the parameters in the container to find the number of matches for the specified key, which may contain percent escapes. The comparison is performed as if all escaped characters were decoded first. heading text Example 1 code assert( url_view( "?first=John&last=Doe" ).encoded_params().count( "first" ) == 1 ); heading text Complexity 1 paragraph text Linear in code text this->buffer().size() text . heading text Exception Safety 1 paragraph text Exceptions thrown on invalid input. brief text Return the number of matching keys returns text The number of matching keys. param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic throws code text key text contains an invalid percent-encoding. reference system_error identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view key identifier RATceEbebMWrhFXGkG2RDFi+7WY= ignore_case_param ic {} normal 1 1 empty boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 197 5 1 function FAnUbM3orQ8EQ3bA6cM0MPKqnzs= regular 2+L1/+BrjUzoccWPIYkGu108y1I= heading text Example 1 code assert( ! url_view( "?key=value" ).encoded_params().empty() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return true if there are no params returns code text true text if there are no params. identifier bool normal 1 1 end boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 241 5 1 function MTKGTeb7OLB4syv3KjZV9NsdSuA= regular 2+L1/+BrjUzoccWPIYkGu108y1I= heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return an iterator to the end returns text An iterator to the end. identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator normal 1 1 find boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 411 5 1 boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 463 5 1 overloads zj0dzqqDoXAn/IpKEmcRq2Ez/X0= regular 2+L1/+BrjUzoccWPIYkGu108y1I= brief text Find a matching key returns text an iterator to the param param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic param text The position to begin the search from. This can be code text end() text . from throws code text key text contains an invalid percent-encoding. reference system_error normal Oklu+7vHgxQ6cOEG4FHBmj+mMzo= BlQpocjN9pdc1/MZ4dbq8RLQlzM= identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator find boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 411 5 1 function Oklu+7vHgxQ6cOEG4FHBmj+mMzo= regular 2+L1/+BrjUzoccWPIYkGu108y1I= paragraph text This function examines the parameters in the container to find a match for the specified key, which may contain percent escapes. The comparison is performed as if all escaped characters were decoded first. paragraph text The search starts from the first param and proceeds forward until either the key is found or the end of the range is reached, in which case code text end() text is returned. heading text Example 1 code assert( url_view( "?first=John&last=Doe" ).encoded_params().find( "First", ignore_case )->value == "John" ); heading text Effects 1 code return this->find( this->begin(), key, ic ); heading text Complexity 1 paragraph text Linear in code text this->buffer().size() text . heading text Exception Safety 1 paragraph text Exceptions thrown on invalid input. brief text Find a matching key returns text an iterator to the param param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic throws code text key text contains an invalid percent-encoding. reference system_error identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view key identifier RATceEbebMWrhFXGkG2RDFi+7WY= ignore_case_param ic {} normal 1 1 find boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 463 5 1 function BlQpocjN9pdc1/MZ4dbq8RLQlzM= regular 2+L1/+BrjUzoccWPIYkGu108y1I= paragraph text This function examines the parameters in the container to find a match for the specified key, which may contain percent escapes. The comparison is performed as if all escaped characters were decoded first. paragraph text The search starts at code text from text and proceeds forward until either the key is found or the end of the range is reached, in which case code text end() text is returned. heading text Example 1 code url_view u( "?First=John&Last=Doe" ); assert( u.encoded_params().find( "first" ) != u.encoded_params().find( "first", ignore_case ) ); heading text Complexity 1 paragraph text Linear in code text this->buffer().size() text . heading text Exception Safety 1 paragraph text Exceptions thrown on invalid input. brief text Find a matching key returns text an iterator to the param param text The position to begin the search from. This can be code text end() text . from param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic throws code text key text contains an invalid percent-encoding. reference system_error identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator from identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view key identifier RATceEbebMWrhFXGkG2RDFi+7WY= ignore_case_param ic {} normal 1 1 find_last boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 511 5 1 boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 558 5 1 overloads sU6Wyw2mc8hB6qluzOF1BY1QMT4= regular 2+L1/+BrjUzoccWPIYkGu108y1I= brief text Find a matching key returns text an iterator to the param param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic param text One past the position to begin the search from. This can be code text end() text . before throws code text key text contains an invalid percent-encoding. reference system_error normal XVsgicnxdzp/0fDKXn/F2rEFNTs= 0IIl26IWllZFiR+8ic5UAM5bg6A= identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator find_last boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 511 5 1 function XVsgicnxdzp/0fDKXn/F2rEFNTs= regular 2+L1/+BrjUzoccWPIYkGu108y1I= paragraph text This function examines the parameters in the container to find a match for the specified key, which may contain percent escapes. The comparison is performed as if all escaped characters were decoded first. paragraph text The search starts from the last param and proceeds backwards until either the key is found or the beginning of the range is reached, in which case code text end() text is returned. heading text Example 1 code assert( url_view( "?first=John&last=Doe" ).encoded_params().find_last( "last" )->value == "Doe" ); heading text Complexity 1 paragraph text Linear in code text this->buffer().size() text . heading text Exception Safety 1 paragraph text Exceptions thrown on invalid input. brief text Find a matching key returns text an iterator to the param param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic throws code text key text contains an invalid percent-encoding. reference system_error identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view key identifier RATceEbebMWrhFXGkG2RDFi+7WY= ignore_case_param ic {} normal 1 1 find_last boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 558 5 1 function 0IIl26IWllZFiR+8ic5UAM5bg6A= regular 2+L1/+BrjUzoccWPIYkGu108y1I= paragraph text This function examines the parameters in the container to find a match for the specified key, which may contain percent escapes. The comparison is performed as if all escaped characters were decoded first. paragraph text The search starts prior to code text before text and proceeds backwards until either the key is found or the beginning of the range is reached, in which case code text end() text is returned. heading text Example 1 code url_view u( "?First=John&Last=Doe" ); assert( u.encoded_params().find_last( "last" ) != u.encoded_params().find_last( "last", ignore_case ) ); heading text Complexity 1 paragraph text Linear in code text this->buffer().size() text . brief text Find a matching key returns text an iterator to the param param text One past the position to begin the search from. This can be code text end() text . before param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator before identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view key identifier RATceEbebMWrhFXGkG2RDFi+7WY= ignore_case_param ic {} normal 1 1 get_or boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 358 5 1 function xzDNyNoWABjJO6PP8LTuDGqYKaE= regular 2+L1/+BrjUzoccWPIYkGu108y1I= paragraph text This convenience function searches for the first parameter matching code text key text and returns its percent-encoded value. If no parameter with the specified key exists, the provided fallback code text value text is returned instead. When the key is found but the corresponding parameter has no value, an empty string is returned. heading text Example 1 code url_view u( "/path?first=John&last=Doe" ); assert( u.encoded_params().get_or( "missing", "n%2Fa" ) == "n%2Fa" ); heading text Complexity 1 paragraph text Linear in code text this->buffer().size() text . heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the value for a key or a fallback returns text The encoded value or the fallback. param text The key to match. key param text The fallback string returned when no matching key exists. If this parameter is omitted, an empty string is used. value param text Optional case-insensitive compare indicator. ic identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view key identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view value {} identifier RATceEbebMWrhFXGkG2RDFi+7WY= ignore_case_param ic {} normal 1 1 size boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 215 5 1 function zF7kAsctYJbzsEd/ye9VQDTlad8= regular 2+L1/+BrjUzoccWPIYkGu108y1I= heading text Example 1 code assert( url_view( "?key=value").encoded_params().size() == 1 ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the number of params returns text The number of params. identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 1 max_size boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 138 5 1 function YhJEdM/9SyCZ1JSUhp09kwAEwsw= regular 2+L1/+BrjUzoccWPIYkGu108y1I= paragraph text This represents the largest number of characters that are possible in a path, not including any null terminator. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the maximum number of characters possible returns text The maximum number of characters possible. identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 params_encoded_ref boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 77 1 1 record oR5B5D0/JYTOQYvyFXRv+at91JE= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text This container exposes the percent-encoded query parameters of a reference url_base aHkFCWJbYb0t+7FT+A5gCI0krpU= text as a bidirectional range while allowing mutation of the underlying URL. It references the URL’s buffer directly, so the url must stay alive for the lifetime of the proxy. heading text Example 1 code url u( "?first=John&last=Doe" ); params_encoded_ref p = u.encoded_params(); paragraph text Strings produced when elements are returned have type reference param_pct_view SMbLJWxhkkCMp2sPkBpWmdnoNGI= text and represent encoded strings. Strings passed to member functions may contain percent escapes, and throw exceptions on invalid inputs. heading text Iterator Invalidation 1 paragraph text Changes to the underlying character buffer can invalidate iterators which reference it. Modifications made through the container invalidate some iterators to the underlying character buffer: list paragraph reference append lbnNIIzY6chPWgsRMQ6NNqB+O/o= text : Only code text end() text . paragraph reference assign VxeeosfZr3m+XNifJ8GCcAeeGik= text , reference clear k2dlYXL3mSTiVHHuz/hORJcr2ek= text , code text operator= text : All params. paragraph reference erase NWKOejIV5NbumFAcEo9+4J6O71E= text : Erased params and all params after (including code text end() text ). paragraph reference insert 4Pvu4JeHaZbjBWGSdwUWKm66gi0= text : All params at or after the insertion point (including code text end() text ). paragraph reference replace G1kXk5Vp9YWeXKVsPP706yJUm4o= text , reference set bl2d2vrnoHMFn9SnAHv9ifRmy6k= text : Modified params and all params after (including code text end() text ). unordered heading text Reads vs. writes 1 paragraph text Even though this type can be used to mutate the referenced URL, this is still a proxy and every observer function inherited from reference params_encoded_base 2+L1/+BrjUzoccWPIYkGu108y1I= text (for example reference contains ytgJ9icra/4vSaD7yJY5ki4BrNY= text , reference find zj0dzqqDoXAn/IpKEmcRq2Ez/X0= text , and reference get_or xzDNyNoWABjJO6PP8LTuDGqYKaE= text ) behaves like the corresponding function on reference params_encoded_view 0nSfM4mK92fIx58KtzdWGiHuq2w= text : it inspects the current encoded query and does not perform any modifications. brief text Mutable encoded query parameter proxy class identifier 2+L1/+BrjUzoccWPIYkGu108y1I= params_encoded_base XJpUUNCpigJ1xkT7ZTlbU72H/Ak= dZWEqr9OGQvjwxniXvQD5gJgpjs= Jgooe8CMHSLBI54qjRb0o6d/8/o= BU4ImK4QmuraTcmiVgUZHD9EeSc= GqAV1Lhk5ZQyP+b5jBK+ATBZPKo= TadRKN4c6SRe/Yk1CsRORJw1qkM= Dywncfi8QKpWNxG7nKrryQCsu6Y= GfFxsJ7oaUsWi2Atb9cDUj0e/+o= FJTqDticq1kGYlZLsMDMoztMYxo= lbnNIIzY6chPWgsRMQ6NNqB+O/o= VxeeosfZr3m+XNifJ8GCcAeeGik= H11d1XIdchNVENPAXFI29FSpdmA= pXB7x4tVHvcwWbxezFAda5sgdHI= k2dlYXL3mSTiVHHuz/hORJcr2ek= ytgJ9icra/4vSaD7yJY5ki4BrNY= dYTek2kRS43hktBruYZHns13CqM= FAnUbM3orQ8EQ3bA6cM0MPKqnzs= MTKGTeb7OLB4syv3KjZV9NsdSuA= NWKOejIV5NbumFAcEo9+4J6O71E= zj0dzqqDoXAn/IpKEmcRq2Ez/X0= sU6Wyw2mc8hB6qluzOF1BY1QMT4= xzDNyNoWABjJO6PP8LTuDGqYKaE= 4Pvu4JeHaZbjBWGSdwUWKm66gi0= G1kXk5Vp9YWeXKVsPP706yJUm4o= bl2d2vrnoHMFn9SnAHv9ifRmy6k= zF7kAsctYJbzsEd/ye9VQDTlad8= 4DuZaumhHSqti6UuC3Ut+Z6NSqo= RbMrqKDUBMsQeBETnWQ7ufUzfpg= 4Bmj96upudccSNe5hQA3qbrOtOY= YhJEdM/9SyCZ1JSUhp09kwAEwsw= VSs9a2pPLEH8ZbTry/+bcABK7bc= KfeP+hZPV84ednsPziXprTRGIx4= qBGPCdSpjMR8OY40o7a/4yFtlTk= aZnRzyUQCiC0d3VbcjeuipAcDq0= identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base aHkFCWJbYb0t+7FT+A5gCI0krpU= const_iterator boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 82 5 1 typedef XJpUUNCpigJ1xkT7ZTlbU72H/Ak= regular 2+L1/+BrjUzoccWPIYkGu108y1I= paragraph text Objects of this type allow iteration through the parameters in the query. Strings returned by iterators may contain percent escapes. The values returned are read-only; changes to parameters must be made through the container instead, if the container supports modification. paragraph text The strings produced when iterators are dereferenced refer to the underlying character buffer. Ownership is not transferred; the caller is responsible for ensuring that the lifetime of the buffer extends until it is no longer referenced by any container or iterator. brief text A Bidirectional iterator to a query parameter iterator identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator 1 const_reference boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 111 5 1 typedef dZWEqr9OGQvjwxniXvQD5gJgpjs= regular 2+L1/+BrjUzoccWPIYkGu108y1I= paragraph text This is the type of value returned when iterators of the view are dereferenced. brief text The reference type reference see reference param_view C+IWBHRl3NluE4QVhoCkgb59VAc= text . identifier SMbLJWxhkkCMp2sPkBpWmdnoNGI= param_pct_view 1 difference_type boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 119 5 1 typedef Jgooe8CMHSLBI54qjRb0o6d/8/o= regular 2+L1/+BrjUzoccWPIYkGu108y1I= brief text A signed integer type used to represent differences. identifier EH4n8sIj03HafoTNn2U36T1P+Hc= ptrdiff_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std 1 reference boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 108 5 1 typedef BU4ImK4QmuraTcmiVgUZHD9EeSc= regular 2+L1/+BrjUzoccWPIYkGu108y1I= paragraph text This is the type of value returned when iterators of the view are dereferenced. brief text The reference type see reference param_view C+IWBHRl3NluE4QVhoCkgb59VAc= text . identifier SMbLJWxhkkCMp2sPkBpWmdnoNGI= param_pct_view 1 size_type boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 115 5 1 typedef GqAV1Lhk5ZQyP+b5jBK+ATBZPKo= regular 2+L1/+BrjUzoccWPIYkGu108y1I= brief text An unsigned integer type to represent sizes. identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std 1 value_type boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 98 5 1 typedef TadRKN4c6SRe/Yk1CsRORJw1qkM= regular 2+L1/+BrjUzoccWPIYkGu108y1I= paragraph text Values of this type represent parameters whose strings retain unique ownership by making a copy. heading text Example 1 code params_encoded_view::value_type qp( *url_view( "?first=John&last=Doe" ).params().find( "first" ) ); brief text The value type see reference param fsdT8sbwW/lniPI5gqvIf2JMGBM= text . identifier fsdT8sbwW/lniPI5gqvIf2JMGBM= param 1 iterator boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 79 5 1 record Dywncfi8QKpWNxG7nKrryQCsu6Y= see-below 1 oR5B5D0/JYTOQYvyFXRv+at91JE= paragraph text Objects of this type allow iteration through the parameters in the query. Strings returned by iterators may contain percent escapes. The values returned are read-only; changes to parameters must be made through the container instead, if the container supports modification. paragraph text The strings produced when iterators are dereferenced refer to the underlying character buffer. Ownership is not transferred; the caller is responsible for ensuring that the lifetime of the buffer extends until it is no longer referenced by any container or iterator. brief text A Bidirectional iterator to a query parameter class +mbgraIEKxYlGRnrtbl+juVak7Y= 3b8LtWJdyf2AUFgD88j68/LgT7s= identifier oR5B5D0/JYTOQYvyFXRv+at91JE= params_encoded_ref oR5B5D0/JYTOQYvyFXRv+at91JE= identifier 2+L1/+BrjUzoccWPIYkGu108y1I= params_encoded_base 2+L1/+BrjUzoccWPIYkGu108y1I= params_encoded_ref boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 116 5 1 function GfFxsJ7oaUsWi2Atb9cDUj0e/+o= regular oR5B5D0/JYTOQYvyFXRv+at91JE= paragraph text After construction, both views reference the same url. Ownership is not transferred; the caller is responsible for ensuring the lifetime of the url extends until it is no longer referenced. heading text Postconditions 1 code &this->url() == &other.url(); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Constructor param text The other view. other identifier void 1 identifier oR5B5D0/JYTOQYvyFXRv+at91JE= params_encoded_ref other constructor 1 1 1 operator= boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 147 5 1 boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 185 5 1 overloads FJTqDticq1kGYlZLsMDMoztMYxo= regular oR5B5D0/JYTOQYvyFXRv+at91JE= brief text Assignment returns code text *this param text The params to assign. other param text The list of params to assign. init throws code text init text contains an invalid percent-encoding. reference system_error normal KeK0ndlDZktv6kEdPIKUbI+NDTM= Peyrb4LuZH0F5ToJdmzPIH4CGcI= identifier oR5B5D0/JYTOQYvyFXRv+at91JE= params_encoded_ref operator= boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 147 5 1 function KeK0ndlDZktv6kEdPIKUbI+NDTM= regular oR5B5D0/JYTOQYvyFXRv+at91JE= paragraph text The previous contents of this are replaced by the contents of `other. paragraph text All iterators are invalidated. admonition paragraph text The strings referenced by code text other text must not come from the underlying url, or else the behavior is undefined. note heading text Effects 1 code this->assign( other.begin(), other.end() ); heading text Complexity 1 paragraph text Linear in code text other.buffer().size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. brief text Assignment returns code text *this param text The params to assign. other identifier oR5B5D0/JYTOQYvyFXRv+at91JE= params_encoded_ref 1 identifier oR5B5D0/JYTOQYvyFXRv+at91JE= params_encoded_ref other normal 1 operator= boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 185 5 1 function Peyrb4LuZH0F5ToJdmzPIH4CGcI= regular oR5B5D0/JYTOQYvyFXRv+at91JE= paragraph text After assignment, the previous contents of the query parameters are replaced by the contents of the initializer-list. paragraph text All iterators are invalidated. heading text Preconditions 1 paragraph text None of character buffers referenced by code text init text may overlap the character buffer of the underlying url, or else the behavior is undefined. heading text Effects 1 code this->assign( init.begin(), init.end() ); heading text Complexity 1 paragraph text Linear in code text init.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. brief text Assignment returns code text *this param text The list of params to assign. init throws code text init text contains an invalid percent-encoding. reference system_error identifier oR5B5D0/JYTOQYvyFXRv+at91JE= params_encoded_ref specialization 3tT5Y8vozttMWXrA/fNw4NcDYTE= initializer_list identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std init normal 1 append boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 372 5 1 boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 406 5 1 boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 446 5 1 overloads lbnNIIzY6chPWgsRMQ6NNqB+O/o= regular oR5B5D0/JYTOQYvyFXRv+at91JE= brief text Append params returns text An iterator to the first new element. returns text An iterator to the new element. param text The list of params to append. init param text The param to append. p param text The first element to append. first param text One past the last element to append. last throws code text init text contains an invalid percent-encoding. reference system_error normal 6QkRgGSOrlBj9w3oCsWoh8eKStA= cUWKKuKzmLs4Ewu9K8KiczTvi2o= itLgaeHmpBVULdah7dilIs38xrA= identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator append boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 406 5 1 function 6QkRgGSOrlBj9w3oCsWoh8eKStA= regular oR5B5D0/JYTOQYvyFXRv+at91JE= paragraph text This function appends the params in an emph text initializer-list text to the view. paragraph text The code text end() text iterator is invalidated. heading text Example 1 code url u; u.encoded_params().append({ {"first", "John"}, {"last", "Doe"} }); heading text Complexity 1 paragraph text Linear in code text this->url().encoded_query().size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. brief text Append params returns text An iterator to the first new element. param text The list of params to append. init throws code text init text contains an invalid percent-encoding. reference system_error identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator specialization 3tT5Y8vozttMWXrA/fNw4NcDYTE= initializer_list identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std init normal 1 append boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 372 5 1 function cUWKKuKzmLs4Ewu9K8KiczTvi2o= regular oR5B5D0/JYTOQYvyFXRv+at91JE= paragraph text This function appends a param to the view. paragraph text The code text end() text iterator is invalidated. heading text Example 1 code url u; u.encoded_params().append( { "first", "John" } ); heading text Complexity 1 paragraph text Linear in code text this->url().encoded_query().size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. brief text Append params returns text An iterator to the new element. param text The param to append. p throws code text p text contains an invalid percent-encoding. reference system_error identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator 1 identifier SMbLJWxhkkCMp2sPkBpWmdnoNGI= param_pct_view p normal 1 append boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 446 5 1 function itLgaeHmpBVULdah7dilIs38xrA= regular oR5B5D0/JYTOQYvyFXRv+at91JE= paragraph text This function appends a range of params to the view. paragraph text The code text end() text iterator is invalidated. admonition paragraph text The strings referenced by the inputs must not come from the underlying url, or else the behavior is undefined. note heading text Mandates 1 code std::is_convertible< std::iterator_traits< FwdIt >::reference_type, param_pct_view >::value == true heading text Complexity 1 paragraph text Linear in code text this->url().encoded_query().size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. brief text Append params returns text An iterator to the first new element. returns text An iterator to the first new element. param text The first element to append. first param text One past the last element to append. last throws text The range contains an invalid percent-encoding. reference system_error identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator identifier FwdIt first identifier FwdIt last normal 1 assign boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 299 5 1 boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 337 5 1 overloads VxeeosfZr3m+XNifJ8GCcAeeGik= regular oR5B5D0/JYTOQYvyFXRv+at91JE= brief text Assign params param text The list of params to assign. init param text The first element to assign. first param text One past the last element to assign. last throws code text init text contains an invalid percent-encoding. reference system_error normal DKYH7OjwbXYGNBDRivSladQ8znE= cWOBrJCopQJpvPvUKrg66sU2cKw= identifier void assign boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 299 5 1 function DKYH7OjwbXYGNBDRivSladQ8znE= regular oR5B5D0/JYTOQYvyFXRv+at91JE= paragraph text This function replaces the entire contents of the view with the params in the emph text initializer-list text . paragraph text All iterators are invalidated. admonition paragraph text The strings referenced by the inputs must not come from the underlying url, or else the behavior is undefined. note heading text Example 1 code url u; u.encoded_params().assign({ { "first", "John" }, { "last", "Doe" } }); heading text Complexity 1 paragraph text Linear in code text init.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. brief text Assign params param text The list of params to assign. init throws code text init text contains an invalid percent-encoding. reference system_error identifier void specialization 3tT5Y8vozttMWXrA/fNw4NcDYTE= initializer_list identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std init normal 1 assign boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 337 5 1 function cWOBrJCopQJpvPvUKrg66sU2cKw= regular oR5B5D0/JYTOQYvyFXRv+at91JE= paragraph text This function replaces the entire contents of the view with the params in the range. paragraph text All iterators are invalidated. admonition paragraph text The strings referenced by the inputs must not come from the underlying url, or else the behavior is undefined. note heading text Mandates 1 code std::is_convertible< std::iterator_traits< FwdIt >::reference_type, param_pct_view >::value == true heading text Complexity 1 paragraph text Linear in the size of the range. heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. brief text Assign params param text The first element to assign. first param text One past the last element to assign. last throws text The range contains an invalid percent-encoding. reference system_error identifier void identifier FwdIt first identifier FwdIt last normal 1 begin boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 228 5 1 function H11d1XIdchNVENPAXFI29FSpdmA= regular 2+L1/+BrjUzoccWPIYkGu108y1I= heading text Complexity 1 paragraph text Linear in the size of the first param. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return an iterator to the beginning returns text An iterator to the beginning. identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator normal 1 1 buffer boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 179 5 1 function pXB7x4tVHvcwWbxezFAda5sgdHI= regular 2+L1/+BrjUzoccWPIYkGu108y1I= paragraph text This function returns the query string referenced by the container. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "?first=John&last=Doe" ).encoded_params().buffer() == "first=John&last=Doe" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code query-params = query-param *( "&" query-param ) query-param = key [ "=" value ] key = *qpchar value = *( qpchar / "=" ) heading text Specification 1 list paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Return the query corresponding to these params returns text The query string. identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 clear boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 260 5 1 function k2dlYXL3mSTiVHHuz/hORJcr2ek= regular oR5B5D0/JYTOQYvyFXRv+at91JE= paragraph text All iterators are invalidated. heading text Effects 1 code this->url().remove_query(); heading text Postconditions 1 code this->empty() == true && this->url().has_query() == false heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Clear the contents of the container identifier void normal 1 contains boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 280 5 1 function ytgJ9icra/4vSaD7yJY5ki4BrNY= regular 2+L1/+BrjUzoccWPIYkGu108y1I= paragraph text This function examines the parameters in the container to find a match for the specified key, which may contain percent escapes. The comparison is performed as if all escaped characters were decoded first. heading text Example 1 code assert( url_view( "?first=John&last=Doe" ).encoded_params().contains( "first" ) ); heading text Complexity 1 paragraph text Linear in code text this->buffer().size() text . heading text Exception Safety 1 paragraph text Exceptions thrown on invalid input. brief text Return true if a matching key exists returns code text true text if a matching key exists. param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic throws code text key text contains an invalid percent-encoding. reference system_error identifier bool identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view key identifier RATceEbebMWrhFXGkG2RDFi+7WY= ignore_case_param ic {} normal 1 1 count boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 319 5 1 function dYTek2kRS43hktBruYZHns13CqM= regular 2+L1/+BrjUzoccWPIYkGu108y1I= paragraph text This function examines the parameters in the container to find the number of matches for the specified key, which may contain percent escapes. The comparison is performed as if all escaped characters were decoded first. heading text Example 1 code assert( url_view( "?first=John&last=Doe" ).encoded_params().count( "first" ) == 1 ); heading text Complexity 1 paragraph text Linear in code text this->buffer().size() text . heading text Exception Safety 1 paragraph text Exceptions thrown on invalid input. brief text Return the number of matching keys returns text The number of matching keys. param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic throws code text key text contains an invalid percent-encoding. reference system_error identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view key identifier RATceEbebMWrhFXGkG2RDFi+7WY= ignore_case_param ic {} normal 1 1 empty boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 197 5 1 function FAnUbM3orQ8EQ3bA6cM0MPKqnzs= regular 2+L1/+BrjUzoccWPIYkGu108y1I= heading text Example 1 code assert( ! url_view( "?key=value" ).encoded_params().empty() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return true if there are no params returns code text true text if there are no params. identifier bool normal 1 1 end boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 241 5 1 function MTKGTeb7OLB4syv3KjZV9NsdSuA= regular 2+L1/+BrjUzoccWPIYkGu108y1I= heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return an iterator to the end returns text An iterator to the end. identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator normal 1 1 erase boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 609 5 1 boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 634 5 1 boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 670 5 1 overloads NWKOejIV5NbumFAcEo9+4J6O71E= regular oR5B5D0/JYTOQYvyFXRv+at91JE= brief text Erase params returns text An iterator to one past the removed element. returns text An iterator to one past the removed range. returns text An iterator to one past the removed range. returns text The number of params removed from the container. param text An iterator to the element. pos param text The first element to remove. first param text One past the last element to remove. last param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic throws code text key text contains an invalid percent-encoding. reference system_error normal ihRZyyN6EfxpZfwp7BbiY5mm4Po= tDEaV9JBSGxyAyqNR92gfnZMeeA= AOrklUyQt6Ym1GagAEiRtUS81Vo= erase boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 609 5 1 function ihRZyyN6EfxpZfwp7BbiY5mm4Po= regular oR5B5D0/JYTOQYvyFXRv+at91JE= paragraph text This function removes an element from the container. paragraph text All iterators that are equal to code text pos text or come after are invalidated. heading text Example 1 code url u( "?first=John&last=Doe" ); params_encoded_ref::iterator it = u.encoded_params().erase( u.encoded_params().begin() ); assert( u.encoded_query() == "last=Doe" ); heading text Complexity 1 paragraph text Linear in code text this->url().encoded_query().size() text . heading text Exception Safety 1 paragraph text Throws nothing. brief text Erase params returns text An iterator to one past the removed element. param text An iterator to the element. pos identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator pos normal 1 erase boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 634 5 1 function tDEaV9JBSGxyAyqNR92gfnZMeeA= regular oR5B5D0/JYTOQYvyFXRv+at91JE= paragraph text This function removes a range of params from the container. paragraph text All iterators that are equal to code text first text or come after are invalidated. heading text Complexity 1 paragraph text Linear in code text this->url().encoded_query().size() text . heading text Exception Safety 1 paragraph text Throws nothing. brief text Erase params returns text An iterator to one past the removed range. returns text An iterator to one past the removed range. param text The first element to remove. first param text One past the last element to remove. last identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator first identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator last normal 1 erase boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 670 5 1 function AOrklUyQt6Ym1GagAEiRtUS81Vo= regular oR5B5D0/JYTOQYvyFXRv+at91JE= paragraph text All iterators are invalidated. heading text Postconditions 1 code this->count( key, ic ) == 0 heading text Complexity 1 paragraph text Linear in code text this->url().encoded_query().size() text . heading text Exception Safety 1 paragraph text Exceptions thrown on invalid input. brief text Erase params returns text The number of params removed from the container. param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic throws code text key text contains an invalid percent-encoding. reference system_error identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view key identifier RATceEbebMWrhFXGkG2RDFi+7WY= ignore_case_param ic {} normal 1 find boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 411 5 1 boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 463 5 1 overloads zj0dzqqDoXAn/IpKEmcRq2Ez/X0= regular 2+L1/+BrjUzoccWPIYkGu108y1I= brief text Find a matching key returns text an iterator to the param param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic param text The position to begin the search from. This can be code text end() text . from throws code text key text contains an invalid percent-encoding. reference system_error normal Oklu+7vHgxQ6cOEG4FHBmj+mMzo= BlQpocjN9pdc1/MZ4dbq8RLQlzM= identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator find boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 411 5 1 function Oklu+7vHgxQ6cOEG4FHBmj+mMzo= regular 2+L1/+BrjUzoccWPIYkGu108y1I= paragraph text This function examines the parameters in the container to find a match for the specified key, which may contain percent escapes. The comparison is performed as if all escaped characters were decoded first. paragraph text The search starts from the first param and proceeds forward until either the key is found or the end of the range is reached, in which case code text end() text is returned. heading text Example 1 code assert( url_view( "?first=John&last=Doe" ).encoded_params().find( "First", ignore_case )->value == "John" ); heading text Effects 1 code return this->find( this->begin(), key, ic ); heading text Complexity 1 paragraph text Linear in code text this->buffer().size() text . heading text Exception Safety 1 paragraph text Exceptions thrown on invalid input. brief text Find a matching key returns text an iterator to the param param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic throws code text key text contains an invalid percent-encoding. reference system_error identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view key identifier RATceEbebMWrhFXGkG2RDFi+7WY= ignore_case_param ic {} normal 1 1 find boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 463 5 1 function BlQpocjN9pdc1/MZ4dbq8RLQlzM= regular 2+L1/+BrjUzoccWPIYkGu108y1I= paragraph text This function examines the parameters in the container to find a match for the specified key, which may contain percent escapes. The comparison is performed as if all escaped characters were decoded first. paragraph text The search starts at code text from text and proceeds forward until either the key is found or the end of the range is reached, in which case code text end() text is returned. heading text Example 1 code url_view u( "?First=John&Last=Doe" ); assert( u.encoded_params().find( "first" ) != u.encoded_params().find( "first", ignore_case ) ); heading text Complexity 1 paragraph text Linear in code text this->buffer().size() text . heading text Exception Safety 1 paragraph text Exceptions thrown on invalid input. brief text Find a matching key returns text an iterator to the param param text The position to begin the search from. This can be code text end() text . from param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic throws code text key text contains an invalid percent-encoding. reference system_error identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator from identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view key identifier RATceEbebMWrhFXGkG2RDFi+7WY= ignore_case_param ic {} normal 1 1 find_last boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 511 5 1 boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 558 5 1 overloads sU6Wyw2mc8hB6qluzOF1BY1QMT4= regular 2+L1/+BrjUzoccWPIYkGu108y1I= brief text Find a matching key returns text an iterator to the param param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic param text One past the position to begin the search from. This can be code text end() text . before throws code text key text contains an invalid percent-encoding. reference system_error normal XVsgicnxdzp/0fDKXn/F2rEFNTs= 0IIl26IWllZFiR+8ic5UAM5bg6A= identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator find_last boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 511 5 1 function XVsgicnxdzp/0fDKXn/F2rEFNTs= regular 2+L1/+BrjUzoccWPIYkGu108y1I= paragraph text This function examines the parameters in the container to find a match for the specified key, which may contain percent escapes. The comparison is performed as if all escaped characters were decoded first. paragraph text The search starts from the last param and proceeds backwards until either the key is found or the beginning of the range is reached, in which case code text end() text is returned. heading text Example 1 code assert( url_view( "?first=John&last=Doe" ).encoded_params().find_last( "last" )->value == "Doe" ); heading text Complexity 1 paragraph text Linear in code text this->buffer().size() text . heading text Exception Safety 1 paragraph text Exceptions thrown on invalid input. brief text Find a matching key returns text an iterator to the param param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic throws code text key text contains an invalid percent-encoding. reference system_error identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view key identifier RATceEbebMWrhFXGkG2RDFi+7WY= ignore_case_param ic {} normal 1 1 find_last boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 558 5 1 function 0IIl26IWllZFiR+8ic5UAM5bg6A= regular 2+L1/+BrjUzoccWPIYkGu108y1I= paragraph text This function examines the parameters in the container to find a match for the specified key, which may contain percent escapes. The comparison is performed as if all escaped characters were decoded first. paragraph text The search starts prior to code text before text and proceeds backwards until either the key is found or the beginning of the range is reached, in which case code text end() text is returned. heading text Example 1 code url_view u( "?First=John&Last=Doe" ); assert( u.encoded_params().find_last( "last" ) != u.encoded_params().find_last( "last", ignore_case ) ); heading text Complexity 1 paragraph text Linear in code text this->buffer().size() text . brief text Find a matching key returns text an iterator to the param param text One past the position to begin the search from. This can be code text end() text . before param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator before identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view key identifier RATceEbebMWrhFXGkG2RDFi+7WY= ignore_case_param ic {} normal 1 1 get_or boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 358 5 1 function xzDNyNoWABjJO6PP8LTuDGqYKaE= regular 2+L1/+BrjUzoccWPIYkGu108y1I= paragraph text This convenience function searches for the first parameter matching code text key text and returns its percent-encoded value. If no parameter with the specified key exists, the provided fallback code text value text is returned instead. When the key is found but the corresponding parameter has no value, an empty string is returned. heading text Example 1 code url_view u( "/path?first=John&last=Doe" ); assert( u.encoded_params().get_or( "missing", "n%2Fa" ) == "n%2Fa" ); heading text Complexity 1 paragraph text Linear in code text this->buffer().size() text . heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the value for a key or a fallback returns text The encoded value or the fallback. param text The key to match. key param text The fallback string returned when no matching key exists. If this parameter is omitted, an empty string is used. value param text Optional case-insensitive compare indicator. ic identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view key identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view value {} identifier RATceEbebMWrhFXGkG2RDFi+7WY= ignore_case_param ic {} normal 1 1 insert boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 482 5 1 boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 523 5 1 boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 571 5 1 overloads 4Pvu4JeHaZbjBWGSdwUWKm66gi0= regular oR5B5D0/JYTOQYvyFXRv+at91JE= brief text Insert params returns text An iterator to the first element inserted, or code text before text if code text init.size() == 0 text . returns text An iterator to the inserted element. returns text An iterator to the first element inserted, or code text before text if code text first == last text . returns text An iterator to the first element inserted. param text An iterator before which the element is inserted. This may be equal to code text end() text . before param text The list of params to insert. init param text The param to insert. p param text The first element to insert. first param text One past the last element to insert. last throws code text init text contains an invalid percent-encoding. reference system_error normal tMheSUrnUYvPC86oW//XVnzWbAM= PtbdIr+62ULTxu/fsxHxGDuYSqo= UmIU95+V7SOzXxA2IhPZz/1JYso= identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator insert boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 523 5 1 function tMheSUrnUYvPC86oW//XVnzWbAM= regular oR5B5D0/JYTOQYvyFXRv+at91JE= paragraph text This function inserts the params in an emph text initializer-list text before the specified position. paragraph text All iterators that are equal to code text before text or come after are invalidated. admonition paragraph text The strings referenced by the inputs must not come from the underlying url, or else the behavior is undefined. note heading text Complexity 1 paragraph text Linear in code text this->url().encoded_query().size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. brief text Insert params returns text An iterator to the first element inserted, or code text before text if code text init.size() == 0 text . param text An iterator before which the element is inserted. This may be equal to code text end() text . before param text The list of params to insert. init throws code text init text contains an invalid percent-encoding. reference system_error identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator before specialization 3tT5Y8vozttMWXrA/fNw4NcDYTE= initializer_list identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std init normal 1 insert boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 482 5 1 function PtbdIr+62ULTxu/fsxHxGDuYSqo= regular oR5B5D0/JYTOQYvyFXRv+at91JE= paragraph text This function inserts a param before the specified position. paragraph text All iterators that are equal to code text before text or come after are invalidated. heading text Complexity 1 paragraph text Linear in code text this->url().encoded_query().size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. brief text Insert params returns text An iterator to the inserted element. param text An iterator before which the param is inserted. This may be equal to code text end() text . before param text The param to insert. p throws code text p text contains an invalid percent-encoding. reference system_error identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator before 1 identifier SMbLJWxhkkCMp2sPkBpWmdnoNGI= param_pct_view p normal 1 insert boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 571 5 1 function UmIU95+V7SOzXxA2IhPZz/1JYso= regular oR5B5D0/JYTOQYvyFXRv+at91JE= paragraph text This function inserts a range of params before the specified position. paragraph text All iterators that are equal to code text before text or come after are invalidated. admonition paragraph text The strings referenced by the inputs must not come from the underlying url, or else the behavior is undefined. note heading text Mandates 1 code std::is_convertible< std::iterator_traits< FwdIt >::reference_type, param_pct_view >::value == true heading text Complexity 1 paragraph text Linear in code text this->url().encoded_query().size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. brief text Insert params returns text An iterator to the first element inserted, or code text before text if code text first == last text . returns text An iterator to the first element inserted. param text An iterator before which the element is inserted. This may be equal to code text end() text . before param text The first element to insert. first param text One past the last element to insert. last throws text The range contains an invalid percent-encoding. reference system_error identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator before identifier FwdIt first identifier FwdIt last normal 1 replace boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 718 5 1 boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 758 5 1 boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 806 5 1 overloads G1kXk5Vp9YWeXKVsPP706yJUm4o= regular oR5B5D0/JYTOQYvyFXRv+at91JE= brief text Replace params returns text An iterator to the element. returns text An iterator to the first element inserted, or one past code text to text if code text init.size() == 0 text . returns text An iterator to the first element inserted, or one past code text to text if code text first == last text . returns text An iterator to the first element inserted, or one past code text to text if code text first == last text . param text An iterator to the element. pos param text The param to assign. p param text The range of params to replace. from,to param text The list of params to assign. init param text The first element to replace. from param text One past the last element to replace. to param text The first element to insert. first param text One past the last element to insert. last throws code text p text contains an invalid percent-encoding. reference system_error normal 8oufJgtT98mojZVb+QU8zehwHTw= hlARmWRoMKFnzL6swJay7BuFxvA= b9I+/qZxIyE66HAZkrDeQo+Amgg= identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator replace boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 718 5 1 function 8oufJgtT98mojZVb+QU8zehwHTw= regular oR5B5D0/JYTOQYvyFXRv+at91JE= paragraph text This function replaces the contents of the element at code text pos text with the specified param. paragraph text All iterators that are equal to code text pos text or come after are invalidated. admonition paragraph text The strings passed in must not come from the element being replaced, or else the behavior is undefined. note heading text Example 1 code url u( "?first=John&last=Doe" ); u.encoded_params().replace( u.encoded_params().begin(), { "title", "Mr" }); assert( u.encoded_query() == "title=Mr&last=Doe" ); heading text Complexity 1 paragraph text Linear in code text this->url().encoded_query().size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. brief text Replace params returns text An iterator to the element. param text An iterator to the element. pos param text The param to assign. p throws code text p text contains an invalid percent-encoding. reference system_error identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator pos 1 identifier SMbLJWxhkkCMp2sPkBpWmdnoNGI= param_pct_view p normal 1 replace boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 758 5 1 function hlARmWRoMKFnzL6swJay7BuFxvA= regular oR5B5D0/JYTOQYvyFXRv+at91JE= paragraph text This function replaces a range of params with the params in an emph text initializer-list text . paragraph text All iterators that are equal to code text from text or come after are invalidated. admonition paragraph text The strings referenced by the inputs must not come from the underlying url, or else the behavior is undefined. note heading text Complexity 1 paragraph text Linear in code text this->url().encoded_query().size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. brief text Replace params returns text An iterator to the first element inserted, or one past code text to text if code text init.size() == 0 text . param text The range of params to replace. from,to param text The list of params to assign. init throws code text init text contains an invalid percent-encoding. reference system_error identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator from identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator to specialization 3tT5Y8vozttMWXrA/fNw4NcDYTE= initializer_list identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std init normal 1 replace boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 806 5 1 function b9I+/qZxIyE66HAZkrDeQo+Amgg= regular oR5B5D0/JYTOQYvyFXRv+at91JE= paragraph text This function replaces a range of params with a range of params. paragraph text All iterators that are equal to code text from text or come after are invalidated. admonition paragraph text The strings referenced by the inputs must not come from the underlying url, or else the behavior is undefined. note heading text Mandates 1 code std::is_convertible< std::iterator_traits< FwdIt >::reference_type, param_pct_view >::value == true heading text Complexity 1 paragraph text Linear in code text this->url().encoded_query().size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. brief text Replace params returns text An iterator to the first element inserted, or one past code text to text if code text first == last text . returns text An iterator to the first element inserted, or one past code text to text if code text first == last text . param text The first element to replace. from param text One past the last element to replace. to param text The first element to insert. first param text One past the last element to insert. last throws text The range contains an invalid percent-encoding. reference system_error identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator from identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator to identifier FwdIt first identifier FwdIt last normal 1 set boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 893 5 1 boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 965 5 1 overloads bl2d2vrnoHMFn9SnAHv9ifRmy6k= regular oR5B5D0/JYTOQYvyFXRv+at91JE= brief text Set a value returns text An iterator to the element. returns text An iterator to the appended or modified element. param text An iterator to the element. pos param text The value to assign. The empty string still counts as a value. That is, code text has_value text for the element is true. value param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic throws code text value text contains an invalid percent-encoding. reference system_error normal 2b4N/IEoLB/FO/023k5bqZjt6Pk= fC9Q+OHMANroVBOY/O2BIrt2iNI= identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator set boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 893 5 1 function 2b4N/IEoLB/FO/023k5bqZjt6Pk= regular oR5B5D0/JYTOQYvyFXRv+at91JE= paragraph text This function replaces the value of an element at the specified position. paragraph text All iterators that are equal to code text pos text or come after are invalidated. admonition paragraph text The string passed in must not come from the element being replaced, or else the behavior is undefined. note heading text Example 1 code url u( "?id=42&id=69" ); u.encoded_params().set( u.encoded_params().begin(), "none" ); assert( u.encoded_query() == "id=none&id=69" ); heading text Complexity 1 paragraph text Linear in code text this->url().encoded_query().size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. brief text Set a value returns text An iterator to the element. param text An iterator to the element. pos param text The value to assign. The empty string still counts as a value. That is, code text has_value text for the element is true. value throws code text value text contains an invalid percent-encoding. reference system_error identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator pos identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view value normal 1 set boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 965 5 1 function fC9Q+OHMANroVBOY/O2BIrt2iNI= regular oR5B5D0/JYTOQYvyFXRv+at91JE= paragraph text This function performs one of two actions depending on the value of code text this->contains( key, ic ) text . list paragraph text If key is contained in the view then one of the matching params has its value changed to the specified value. The remaining params with a matching key are erased. Otherwise, paragraph text If code text key text is not contained in the view, then the function apppends the param code text { key, value } text . unordered paragraph text All iterators are invalidated. admonition paragraph text The strings passed in must not come from the element being replaced, or else the behavior is undefined. note heading text Example 1 code url u( "?id=42&id=69" ); u.encoded_params().set( "id", "none" ); assert( u.encoded_params().count( "id" ) == 1 ); heading text Postconditions 1 code this->count( key, ic ) == 1 && this->find( key, ic )->value == value heading text Complexity 1 paragraph text Linear in code text this->url().encoded_query().size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. brief text Set a value returns text An iterator to the appended or modified element. param text The key to match. By default, a case-sensitive comparison is used. key param text The value to assign. The empty string still counts as a value. That is, code text has_value text for the element is true. value param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic throws code text key text or code text value text contain an invalid percent-encoding. reference system_error identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view key identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view value identifier RATceEbebMWrhFXGkG2RDFi+7WY= ignore_case_param ic {} normal 1 size boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 215 5 1 function zF7kAsctYJbzsEd/ye9VQDTlad8= regular 2+L1/+BrjUzoccWPIYkGu108y1I= heading text Example 1 code assert( url_view( "?key=value").encoded_params().size() == 1 ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the number of params returns text The number of params. identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 1 unset boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 846 5 1 function 4DuZaumhHSqti6UuC3Ut+Z6NSqo= regular oR5B5D0/JYTOQYvyFXRv+at91JE= paragraph text This function removes the value of an element at the specified position. After the call returns, code text has_value text for the element is false. paragraph text All iterators that are equal to code text pos text or come after are invalidated. heading text Example 1 code url u( "?first=John&last=Doe" ); u.encoded_params().unset( u.encoded_params().begin() ); assert( u.encoded_query() == "first&last=Doe" ); heading text Complexity 1 paragraph text Linear in code text this->url().encoded_query().size() text . heading text Exception Safety 1 paragraph text Throws nothing. brief text Remove the value on an element returns text An iterator to the element. param text An iterator to the element. pos identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator pos normal 1 url boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 227 5 1 function RbMrqKDUBMsQeBETnWQ7ufUzfpg= regular oR5B5D0/JYTOQYvyFXRv+at91JE= paragraph text This function returns the url referenced by the view. heading text Example 1 code url u( "?key=value" ); assert( &u.encoded_params().url() == &u ); heading text Exception Safety 1 code Throws nothing. brief text Return the referenced url returns text A reference to the url. identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base normal 1 1 operator params_encoded_view boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 199 5 1 function 4Bmj96upudccSNe5hQA3qbrOtOY= regular oR5B5D0/JYTOQYvyFXRv+at91JE= heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Conversion returns text A view of the params. identifier 0nSfM4mK92fIx58KtzdWGiHuq2w= params_encoded_view conversion 1 1 max_size boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 138 5 1 function YhJEdM/9SyCZ1JSUhp09kwAEwsw= regular 2+L1/+BrjUzoccWPIYkGu108y1I= paragraph text This represents the largest number of characters that are possible in a path, not including any null terminator. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the maximum number of characters possible returns text The maximum number of characters possible. identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 params_encoded_view boost/url/params_encoded_view.hpp include/boost/url/params_encoded_view.hpp 52 1 1 boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 24 1 record 0nSfM4mK92fIx58KtzdWGiHuq2w= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text This read-only range exposes the raw percent-encoded key/value pairs stored in a query string. It does not copy the underlying buffer; callers must ensure the referenced character storage outlives the view. heading text Example 1 code url_view u( "?first=John&last=Doe" ); params_encoded_view p = u.encoded_params(); paragraph text Iteration yields reference param_pct_view SMbLJWxhkkCMp2sPkBpWmdnoNGI= text values, so encoded strings and escape validation are preserved for callers that want exact bytes. heading text Iterator Invalidation 1 paragraph text Changes to the underlying character buffer can invalidate iterators which reference it. brief text Non-owning encoded query parameter view class identifier 2+L1/+BrjUzoccWPIYkGu108y1I= params_encoded_base XJpUUNCpigJ1xkT7ZTlbU72H/Ak= dZWEqr9OGQvjwxniXvQD5gJgpjs= Jgooe8CMHSLBI54qjRb0o6d/8/o= BU4ImK4QmuraTcmiVgUZHD9EeSc= GqAV1Lhk5ZQyP+b5jBK+ATBZPKo= TadRKN4c6SRe/Yk1CsRORJw1qkM= 9ORRYXeatD8alBABuRIoLv1ghiA= vetlZbgIgAVMEucP7vVTDLbbL7k= vLdk8N8yRTrTP1yBKiBB4xmgGxI= H11d1XIdchNVENPAXFI29FSpdmA= pXB7x4tVHvcwWbxezFAda5sgdHI= ytgJ9icra/4vSaD7yJY5ki4BrNY= dYTek2kRS43hktBruYZHns13CqM= FAnUbM3orQ8EQ3bA6cM0MPKqnzs= MTKGTeb7OLB4syv3KjZV9NsdSuA= zj0dzqqDoXAn/IpKEmcRq2Ez/X0= sU6Wyw2mc8hB6qluzOF1BY1QMT4= xzDNyNoWABjJO6PP8LTuDGqYKaE= zF7kAsctYJbzsEd/ye9VQDTlad8= PKsENmwPsWTiRP6EZEJnw3PnCJg= YhJEdM/9SyCZ1JSUhp09kwAEwsw= 3GkWnwjMTCC6KwCLTxUNwer/V0Y= uNT8hVd3FIORJnihg+axBbyOnBE= identifier oR5B5D0/JYTOQYvyFXRv+at91JE= params_encoded_ref oR5B5D0/JYTOQYvyFXRv+at91JE= identifier DzqMpaJX2O25vPFxEN5EDTyU6uw= params_view DzqMpaJX2O25vPFxEN5EDTyU6uw= identifier UEVNhDEjkZMXfjN1DxbtX0n2rCg= url_view_base UEVNhDEjkZMXfjN1DxbtX0n2rCg= const_iterator boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 82 5 1 typedef XJpUUNCpigJ1xkT7ZTlbU72H/Ak= regular 2+L1/+BrjUzoccWPIYkGu108y1I= paragraph text Objects of this type allow iteration through the parameters in the query. Strings returned by iterators may contain percent escapes. The values returned are read-only; changes to parameters must be made through the container instead, if the container supports modification. paragraph text The strings produced when iterators are dereferenced refer to the underlying character buffer. Ownership is not transferred; the caller is responsible for ensuring that the lifetime of the buffer extends until it is no longer referenced by any container or iterator. brief text A Bidirectional iterator to a query parameter iterator identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator 1 const_reference boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 111 5 1 typedef dZWEqr9OGQvjwxniXvQD5gJgpjs= regular 2+L1/+BrjUzoccWPIYkGu108y1I= paragraph text This is the type of value returned when iterators of the view are dereferenced. brief text The reference type reference see reference param_view C+IWBHRl3NluE4QVhoCkgb59VAc= text . identifier SMbLJWxhkkCMp2sPkBpWmdnoNGI= param_pct_view 1 difference_type boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 119 5 1 typedef Jgooe8CMHSLBI54qjRb0o6d/8/o= regular 2+L1/+BrjUzoccWPIYkGu108y1I= brief text A signed integer type used to represent differences. identifier EH4n8sIj03HafoTNn2U36T1P+Hc= ptrdiff_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std 1 reference boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 108 5 1 typedef BU4ImK4QmuraTcmiVgUZHD9EeSc= regular 2+L1/+BrjUzoccWPIYkGu108y1I= paragraph text This is the type of value returned when iterators of the view are dereferenced. brief text The reference type see reference param_view C+IWBHRl3NluE4QVhoCkgb59VAc= text . identifier SMbLJWxhkkCMp2sPkBpWmdnoNGI= param_pct_view 1 size_type boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 115 5 1 typedef GqAV1Lhk5ZQyP+b5jBK+ATBZPKo= regular 2+L1/+BrjUzoccWPIYkGu108y1I= brief text An unsigned integer type to represent sizes. identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std 1 value_type boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 98 5 1 typedef TadRKN4c6SRe/Yk1CsRORJw1qkM= regular 2+L1/+BrjUzoccWPIYkGu108y1I= paragraph text Values of this type represent parameters whose strings retain unique ownership by making a copy. heading text Example 1 code params_encoded_view::value_type qp( *url_view( "?first=John&last=Doe" ).params().find( "first" ) ); brief text The value type see reference param fsdT8sbwW/lniPI5gqvIf2JMGBM= text . identifier fsdT8sbwW/lniPI5gqvIf2JMGBM= param 1 iterator boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 79 5 1 record 9ORRYXeatD8alBABuRIoLv1ghiA= see-below 1 0nSfM4mK92fIx58KtzdWGiHuq2w= paragraph text Objects of this type allow iteration through the parameters in the query. Strings returned by iterators may contain percent escapes. The values returned are read-only; changes to parameters must be made through the container instead, if the container supports modification. paragraph text The strings produced when iterators are dereferenced refer to the underlying character buffer. Ownership is not transferred; the caller is responsible for ensuring that the lifetime of the buffer extends until it is no longer referenced by any container or iterator. brief text A Bidirectional iterator to a query parameter class +mbgraIEKxYlGRnrtbl+juVak7Y= 3b8LtWJdyf2AUFgD88j68/LgT7s= identifier oR5B5D0/JYTOQYvyFXRv+at91JE= params_encoded_ref oR5B5D0/JYTOQYvyFXRv+at91JE= identifier 2+L1/+BrjUzoccWPIYkGu108y1I= params_encoded_base 2+L1/+BrjUzoccWPIYkGu108y1I= params_encoded_view boost/url/params_encoded_view.hpp include/boost/url/params_encoded_view.hpp 85 5 1 boost/url/params_encoded_view.hpp include/boost/url/params_encoded_view.hpp 165 5 1 overloads vetlZbgIgAVMEucP7vVTDLbbL7k= regular 0nSfM4mK92fIx58KtzdWGiHuq2w= brief text Constructor param text The object to copy other param text The string to parse. s throws code text s text contains an invalid query parameter string. reference system_error constructor LejvgDggo/vR+pFyu/AlYsXpLaQ= a/y/9CSq2/5Q0GjRPaP5vlWjuPI= y1I49n7xdADNaymdSPDs20JUyV0= identifier void params_encoded_view boost/url/params_encoded_view.hpp include/boost/url/params_encoded_view.hpp 85 5 1 function LejvgDggo/vR+pFyu/AlYsXpLaQ= regular 0nSfM4mK92fIx58KtzdWGiHuq2w= paragraph text Default-constructed params have zero elements. heading text Example 1 code params_encoded_view qp; heading text Effects 1 code return params_encoded_view( "" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Constructor identifier void constructor 1 1 1 params_encoded_view boost/url/params_encoded_view.hpp include/boost/url/params_encoded_view.hpp 110 5 1 function a/y/9CSq2/5Q0GjRPaP5vlWjuPI= regular 0nSfM4mK92fIx58KtzdWGiHuq2w= paragraph text After construction both views reference the same character buffer. paragraph text Ownership is not transferred; the caller is responsible for ensuring the lifetime of the buffer extends until it is no longer referenced. heading text Postconditions 1 code this->buffer().data() == other.buffer().data() heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing brief text Constructor param text The object to copy other identifier void 1 identifier 0nSfM4mK92fIx58KtzdWGiHuq2w= params_encoded_view other constructor 1 1 1 params_encoded_view boost/url/params_encoded_view.hpp include/boost/url/params_encoded_view.hpp 165 5 1 function y1I49n7xdADNaymdSPDs20JUyV0= regular 0nSfM4mK92fIx58KtzdWGiHuq2w= paragraph text This function constructs params from a valid query parameter string, which can contain percent escapes. Unlike the parameters in URLs, the string passed here should not start with "?". Upon construction, the view references the character buffer pointed to by code text s text . The caller is responsible for ensuring that the lifetime of the buffer extends until it is no longer referenced. heading text Example 1 code params_encoded_view qp( "first=John&last=Doe" ); heading text Effects 1 code return parse_query( s ).value(); heading text Postconditions 1 code this->buffer().data() == s.data() heading text Complexity 1 paragraph text Linear in code text s text . heading text Exception Safety 1 paragraph text Exceptions thrown on invalid input. heading text BNF 1 code query-params = [ query-param ] *( "&" query-param ) query-param = key [ "=" value ] heading text Specification 1 list paragraph link text 3.4. Query https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 unordered brief text Constructor param text The string to parse. s throws code text s text contains an invalid query parameter string. reference system_error identifier void identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s constructor 1 operator= boost/url/params_encoded_view.hpp include/boost/url/params_encoded_view.hpp 193 5 1 function vLdk8N8yRTrTP1yBKiBB4xmgGxI= regular 0nSfM4mK92fIx58KtzdWGiHuq2w= paragraph text After assignment, both views reference the same underlying character buffer. paragraph text Ownership is not transferred; the caller is responsible for ensuring the lifetime of the buffer extends until it is no longer referenced. heading text Postconditions 1 code this->buffer().data() == other.buffer().data() heading text Complexity 1 paragraph text Constant heading text Exception Safety 1 paragraph text Throws nothing brief text Assignment returns code text *this param text The object to assign other identifier 0nSfM4mK92fIx58KtzdWGiHuq2w= params_encoded_view 1 identifier 0nSfM4mK92fIx58KtzdWGiHuq2w= params_encoded_view other normal 1 1 1 begin boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 228 5 1 function H11d1XIdchNVENPAXFI29FSpdmA= regular 2+L1/+BrjUzoccWPIYkGu108y1I= heading text Complexity 1 paragraph text Linear in the size of the first param. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return an iterator to the beginning returns text An iterator to the beginning. identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator normal 1 1 buffer boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 179 5 1 function pXB7x4tVHvcwWbxezFAda5sgdHI= regular 2+L1/+BrjUzoccWPIYkGu108y1I= paragraph text This function returns the query string referenced by the container. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "?first=John&last=Doe" ).encoded_params().buffer() == "first=John&last=Doe" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code query-params = query-param *( "&" query-param ) query-param = key [ "=" value ] key = *qpchar value = *( qpchar / "=" ) heading text Specification 1 list paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Return the query corresponding to these params returns text The query string. identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 contains boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 280 5 1 function ytgJ9icra/4vSaD7yJY5ki4BrNY= regular 2+L1/+BrjUzoccWPIYkGu108y1I= paragraph text This function examines the parameters in the container to find a match for the specified key, which may contain percent escapes. The comparison is performed as if all escaped characters were decoded first. heading text Example 1 code assert( url_view( "?first=John&last=Doe" ).encoded_params().contains( "first" ) ); heading text Complexity 1 paragraph text Linear in code text this->buffer().size() text . heading text Exception Safety 1 paragraph text Exceptions thrown on invalid input. brief text Return true if a matching key exists returns code text true text if a matching key exists. param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic throws code text key text contains an invalid percent-encoding. reference system_error identifier bool identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view key identifier RATceEbebMWrhFXGkG2RDFi+7WY= ignore_case_param ic {} normal 1 1 count boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 319 5 1 function dYTek2kRS43hktBruYZHns13CqM= regular 2+L1/+BrjUzoccWPIYkGu108y1I= paragraph text This function examines the parameters in the container to find the number of matches for the specified key, which may contain percent escapes. The comparison is performed as if all escaped characters were decoded first. heading text Example 1 code assert( url_view( "?first=John&last=Doe" ).encoded_params().count( "first" ) == 1 ); heading text Complexity 1 paragraph text Linear in code text this->buffer().size() text . heading text Exception Safety 1 paragraph text Exceptions thrown on invalid input. brief text Return the number of matching keys returns text The number of matching keys. param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic throws code text key text contains an invalid percent-encoding. reference system_error identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view key identifier RATceEbebMWrhFXGkG2RDFi+7WY= ignore_case_param ic {} normal 1 1 empty boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 197 5 1 function FAnUbM3orQ8EQ3bA6cM0MPKqnzs= regular 2+L1/+BrjUzoccWPIYkGu108y1I= heading text Example 1 code assert( ! url_view( "?key=value" ).encoded_params().empty() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return true if there are no params returns code text true text if there are no params. identifier bool normal 1 1 end boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 241 5 1 function MTKGTeb7OLB4syv3KjZV9NsdSuA= regular 2+L1/+BrjUzoccWPIYkGu108y1I= heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return an iterator to the end returns text An iterator to the end. identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator normal 1 1 find boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 411 5 1 boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 463 5 1 overloads zj0dzqqDoXAn/IpKEmcRq2Ez/X0= regular 2+L1/+BrjUzoccWPIYkGu108y1I= brief text Find a matching key returns text an iterator to the param param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic param text The position to begin the search from. This can be code text end() text . from throws code text key text contains an invalid percent-encoding. reference system_error normal Oklu+7vHgxQ6cOEG4FHBmj+mMzo= BlQpocjN9pdc1/MZ4dbq8RLQlzM= identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator find boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 411 5 1 function Oklu+7vHgxQ6cOEG4FHBmj+mMzo= regular 2+L1/+BrjUzoccWPIYkGu108y1I= paragraph text This function examines the parameters in the container to find a match for the specified key, which may contain percent escapes. The comparison is performed as if all escaped characters were decoded first. paragraph text The search starts from the first param and proceeds forward until either the key is found or the end of the range is reached, in which case code text end() text is returned. heading text Example 1 code assert( url_view( "?first=John&last=Doe" ).encoded_params().find( "First", ignore_case )->value == "John" ); heading text Effects 1 code return this->find( this->begin(), key, ic ); heading text Complexity 1 paragraph text Linear in code text this->buffer().size() text . heading text Exception Safety 1 paragraph text Exceptions thrown on invalid input. brief text Find a matching key returns text an iterator to the param param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic throws code text key text contains an invalid percent-encoding. reference system_error identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view key identifier RATceEbebMWrhFXGkG2RDFi+7WY= ignore_case_param ic {} normal 1 1 find boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 463 5 1 function BlQpocjN9pdc1/MZ4dbq8RLQlzM= regular 2+L1/+BrjUzoccWPIYkGu108y1I= paragraph text This function examines the parameters in the container to find a match for the specified key, which may contain percent escapes. The comparison is performed as if all escaped characters were decoded first. paragraph text The search starts at code text from text and proceeds forward until either the key is found or the end of the range is reached, in which case code text end() text is returned. heading text Example 1 code url_view u( "?First=John&Last=Doe" ); assert( u.encoded_params().find( "first" ) != u.encoded_params().find( "first", ignore_case ) ); heading text Complexity 1 paragraph text Linear in code text this->buffer().size() text . heading text Exception Safety 1 paragraph text Exceptions thrown on invalid input. brief text Find a matching key returns text an iterator to the param param text The position to begin the search from. This can be code text end() text . from param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic throws code text key text contains an invalid percent-encoding. reference system_error identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator from identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view key identifier RATceEbebMWrhFXGkG2RDFi+7WY= ignore_case_param ic {} normal 1 1 find_last boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 511 5 1 boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 558 5 1 overloads sU6Wyw2mc8hB6qluzOF1BY1QMT4= regular 2+L1/+BrjUzoccWPIYkGu108y1I= brief text Find a matching key returns text an iterator to the param param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic param text One past the position to begin the search from. This can be code text end() text . before throws code text key text contains an invalid percent-encoding. reference system_error normal XVsgicnxdzp/0fDKXn/F2rEFNTs= 0IIl26IWllZFiR+8ic5UAM5bg6A= identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator find_last boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 511 5 1 function XVsgicnxdzp/0fDKXn/F2rEFNTs= regular 2+L1/+BrjUzoccWPIYkGu108y1I= paragraph text This function examines the parameters in the container to find a match for the specified key, which may contain percent escapes. The comparison is performed as if all escaped characters were decoded first. paragraph text The search starts from the last param and proceeds backwards until either the key is found or the beginning of the range is reached, in which case code text end() text is returned. heading text Example 1 code assert( url_view( "?first=John&last=Doe" ).encoded_params().find_last( "last" )->value == "Doe" ); heading text Complexity 1 paragraph text Linear in code text this->buffer().size() text . heading text Exception Safety 1 paragraph text Exceptions thrown on invalid input. brief text Find a matching key returns text an iterator to the param param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic throws code text key text contains an invalid percent-encoding. reference system_error identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view key identifier RATceEbebMWrhFXGkG2RDFi+7WY= ignore_case_param ic {} normal 1 1 find_last boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 558 5 1 function 0IIl26IWllZFiR+8ic5UAM5bg6A= regular 2+L1/+BrjUzoccWPIYkGu108y1I= paragraph text This function examines the parameters in the container to find a match for the specified key, which may contain percent escapes. The comparison is performed as if all escaped characters were decoded first. paragraph text The search starts prior to code text before text and proceeds backwards until either the key is found or the beginning of the range is reached, in which case code text end() text is returned. heading text Example 1 code url_view u( "?First=John&Last=Doe" ); assert( u.encoded_params().find_last( "last" ) != u.encoded_params().find_last( "last", ignore_case ) ); heading text Complexity 1 paragraph text Linear in code text this->buffer().size() text . brief text Find a matching key returns text an iterator to the param param text One past the position to begin the search from. This can be code text end() text . before param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator identifier ZtVyiX/PxtD1ydy6wMFxWQ6zNWo= iterator before identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view key identifier RATceEbebMWrhFXGkG2RDFi+7WY= ignore_case_param ic {} normal 1 1 get_or boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 358 5 1 function xzDNyNoWABjJO6PP8LTuDGqYKaE= regular 2+L1/+BrjUzoccWPIYkGu108y1I= paragraph text This convenience function searches for the first parameter matching code text key text and returns its percent-encoded value. If no parameter with the specified key exists, the provided fallback code text value text is returned instead. When the key is found but the corresponding parameter has no value, an empty string is returned. heading text Example 1 code url_view u( "/path?first=John&last=Doe" ); assert( u.encoded_params().get_or( "missing", "n%2Fa" ) == "n%2Fa" ); heading text Complexity 1 paragraph text Linear in code text this->buffer().size() text . heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the value for a key or a fallback returns text The encoded value or the fallback. param text The key to match. key param text The fallback string returned when no matching key exists. If this parameter is omitted, an empty string is used. value param text Optional case-insensitive compare indicator. ic identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view key identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view value {} identifier RATceEbebMWrhFXGkG2RDFi+7WY= ignore_case_param ic {} normal 1 1 size boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 215 5 1 function zF7kAsctYJbzsEd/ye9VQDTlad8= regular 2+L1/+BrjUzoccWPIYkGu108y1I= heading text Example 1 code assert( url_view( "?key=value").encoded_params().size() == 1 ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the number of params returns text The number of params. identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 1 operator params_view boost/url/params_encoded_view.hpp include/boost/url/params_encoded_view.hpp 228 5 1 function PKsENmwPsWTiRP6EZEJnw3PnCJg= regular 0nSfM4mK92fIx58KtzdWGiHuq2w= paragraph text This conversion returns a new view which references the same underlying character buffer, and whose iterators and members return ordinary strings with decoding applied to any percent escapes. paragraph text Ownership is not transferred; the caller is responsible for ensuring the lifetime of the buffer extends until it is no longer referenced. heading text Example 1 code params_view qp = parse_path( "/path/to/file.txt" ).value(); heading text Postconditions 1 code params_view( *this ).buffer().data() == this->buffer().data() heading text Complexity 1 paragraph text Constant heading text Exception Safety 1 paragraph text Throws nothing brief text Conversion returns text A new view with percent escapes decoded. identifier DzqMpaJX2O25vPFxEN5EDTyU6uw= params_view conversion 1 1 max_size boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 138 5 1 function YhJEdM/9SyCZ1JSUhp09kwAEwsw= regular 2+L1/+BrjUzoccWPIYkGu108y1I= paragraph text This represents the largest number of characters that are possible in a path, not including any null terminator. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the maximum number of characters possible returns text The maximum number of characters possible. identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 params_ref boost/url/params_ref.hpp include/boost/url/params_ref.hpp 86 1 1 record 8S83BKvWBCDdTktlY8X93Mlo9E0= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text This container presents the decoded query parameters of a reference url_base aHkFCWJbYb0t+7FT+A5gCI0krpU= text as a bidirectional range whose modifying operations update the underlying URL in-place. It references (but does not own) the character buffer, so the referenced URL must stay alive while the proxy is used. paragraph text Percent escapes in strings returned when dereferencing iterators are automatically decoded. Reserved characters in strings supplied to modifier functions are automatically percent-escaped. heading text Example 1 code url u( "?first=John&last=Doe" ); params_ref p = u.params(); heading text Iterator Invalidation 1 paragraph text Changes to the underlying character buffer can invalidate iterators which reference it. Modifications made through the container invalidate some or all iterators: list paragraph reference append C+zC5NOoDsWWotFdEpehZpN0UKY= text : Only code text end() text . paragraph reference assign Uufp6Zdm6pKZEyVgZi+wJkRNsvk= text , reference clear /ZH/B/Ue7rMuRZ41OiOL9pCngTk= text , code text operator= text : All elements. paragraph reference erase +wzf9WWabjrjCA2Y5TCum6SkHjo= text : Erased elements and all elements after (including code text end() text ). paragraph reference insert 30OuP3B1jZIt3bTl0RhIrVeyrNo= text : All elements at or after the insertion point (including code text end() text ). paragraph reference replace lfq3Mrh+3Tlp3S5S2EtjZSckfAg= text , reference set +yTWdOiG8FvzLfVFF16r/ZqyEX8= text : Modified elements and all elements after (including code text end() text ). unordered heading text Reads vs. writes 1 paragraph text Although this is a mutable proxy, all observer helpers inherited from reference params_base paRP7A1SOQlKcnfXhxL4FgbVXKs= text (such as reference contains +m1VjI0xtgykFmvRxecqZkXJBNg= text , reference find /lfP4NtGxUDEYF5NvxdZQKO226I= text , and reference get_or GhT3qpAk3WuPisnAoeMMKNguVco= text ) operate in the same way as they do on reference params_view DzqMpaJX2O25vPFxEN5EDTyU6uw= text : they perform their lookup against the current contents of the referenced URL without modifying it. brief text Mutable decoded query parameter proxy class identifier paRP7A1SOQlKcnfXhxL4FgbVXKs= params_base 4XRIDzJtD8YcNf6ybgP1JlmdPbE= /aPvkkBZhzgeMb2UCNaJ1s5c6oQ= 4jo6j51QPa7nfAiEWAM6LJc4fLs= 8Hg/5b5RDYgIk/T6aP0tPj0HbSc= cFqtE5widJnnA8qwGOBnkhkdR6Y= /wVpdYewE+NKvN60EGcgNiIZ+Mc= Y9GAFEi96MKTJZzYfr3TVD9B3LM= 63gWLrVMYiiI82tBiP5L05lBH6c= v5DgF6q1dfcGdabPJh5FlpvEJUg= C+zC5NOoDsWWotFdEpehZpN0UKY= Uufp6Zdm6pKZEyVgZi+wJkRNsvk= rgFjw9W6rMjgEYkGOVMDiLJIIdE= cpczYPJifQzreeaLMlFMrIk8geU= /ZH/B/Ue7rMuRZ41OiOL9pCngTk= +m1VjI0xtgykFmvRxecqZkXJBNg= SUQ73EvVipRYcJ2Sg24T8d60qeQ= VQ4Gk4oWz8OorSDPtJoAWpHsFaI= NYG2/rgQQuH/CSw2qObuDUB3DYo= +wzf9WWabjrjCA2Y5TCum6SkHjo= /lfP4NtGxUDEYF5NvxdZQKO226I= S17pkFUExaqRFD9HA5cryLnWVG8= GhT3qpAk3WuPisnAoeMMKNguVco= 30OuP3B1jZIt3bTl0RhIrVeyrNo= lfq3Mrh+3Tlp3S5S2EtjZSckfAg= +yTWdOiG8FvzLfVFF16r/ZqyEX8= u/w33vX8w/yA/9Gl176lDHdQs4k= jxURKYVSYJoxZiuBOnhDenCs1rA= 40HPQpiad5IvD+unAuZCj3AHuA0= N+s3ZvmEa8MkvVluiPBiQWSSM4U= JAc718f//bzvETv8VNPf4ujJ2G8= /uxiB0cCcYbD8a3RNffuR02xDaQ= dSfl1fNcg7xyote+lik7mtZVW0E= NBcHagLxe3dRtmI3+xcXdHu+obY= z18XdP/knBL9+XBBYlbtBek0WZ4= identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base aHkFCWJbYb0t+7FT+A5gCI0krpU= const_iterator boost/url/params_base.hpp include/boost/url/params_base.hpp 94 5 1 typedef 4XRIDzJtD8YcNf6ybgP1JlmdPbE= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= paragraph text Objects of this type allow iteration through the parameters in the query. Any percent-escapes in returned strings are decoded first. The values returned are read-only; changes to parameters must be made through the container instead, if the container supports modification. paragraph text The strings produced when iterators are dereferenced belong to the iterator and become invalidated when that particular iterator is incremented, decremented, or destroyed. paragraph text The implementation may use temporary, recycled storage to store decoded strings. These iterators are meant to be used ephemerally. That is, for short durations such as within a function scope. Do not store iterators with static storage duration or as long-lived objects. brief text A Bidirectional iterator to a query parameter iterator identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator 1 const_reference boost/url/params_base.hpp include/boost/url/params_base.hpp 123 5 1 typedef /aPvkkBZhzgeMb2UCNaJ1s5c6oQ= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= paragraph text This is the type of value returned when iterators of the view are dereferenced. brief text The reference type reference see reference param_view C+IWBHRl3NluE4QVhoCkgb59VAc= text . identifier fsdT8sbwW/lniPI5gqvIf2JMGBM= param 1 difference_type boost/url/params_base.hpp include/boost/url/params_base.hpp 131 5 1 typedef 4jo6j51QPa7nfAiEWAM6LJc4fLs= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= brief text A signed integer type used to represent differences. identifier EH4n8sIj03HafoTNn2U36T1P+Hc= ptrdiff_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std 1 reference boost/url/params_base.hpp include/boost/url/params_base.hpp 120 5 1 typedef 8Hg/5b5RDYgIk/T6aP0tPj0HbSc= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= paragraph text This is the type of value returned when iterators of the view are dereferenced. brief text The reference type see reference param_view C+IWBHRl3NluE4QVhoCkgb59VAc= text . identifier fsdT8sbwW/lniPI5gqvIf2JMGBM= param 1 size_type boost/url/params_base.hpp include/boost/url/params_base.hpp 127 5 1 typedef cFqtE5widJnnA8qwGOBnkhkdR6Y= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= brief text An unsigned integer type to represent sizes. identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std 1 value_type boost/url/params_base.hpp include/boost/url/params_base.hpp 110 5 1 typedef /wVpdYewE+NKvN60EGcgNiIZ+Mc= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= paragraph text Values of this type represent parameters whose strings retain unique ownership by making a copy. heading text Example 1 code params_view::value_type qp( *url_view( "?first=John&last=Doe" ).params().find( "first" ) ); brief text The value type see reference param fsdT8sbwW/lniPI5gqvIf2JMGBM= text . identifier fsdT8sbwW/lniPI5gqvIf2JMGBM= param 1 iterator boost/url/impl/params_base.hpp include/boost/url/impl/params_base.hpp 26 1 boost/url/params_base.hpp include/boost/url/params_base.hpp 91 5 1 record Y9GAFEi96MKTJZzYfr3TVD9B3LM= see-below 1 8S83BKvWBCDdTktlY8X93Mlo9E0= paragraph text Objects of this type allow iteration through the parameters in the query. Any percent-escapes in returned strings are decoded first. The values returned are read-only; changes to parameters must be made through the container instead, if the container supports modification. paragraph text The strings produced when iterators are dereferenced belong to the iterator and become invalidated when that particular iterator is incremented, decremented, or destroyed. paragraph text The implementation may use temporary, recycled storage to store decoded strings. These iterators are meant to be used ephemerally. That is, for short durations such as within a function scope. Do not store iterators with static storage duration or as long-lived objects. brief text A Bidirectional iterator to a query parameter class identifier 8S83BKvWBCDdTktlY8X93Mlo9E0= params_ref 8S83BKvWBCDdTktlY8X93Mlo9E0= identifier paRP7A1SOQlKcnfXhxL4FgbVXKs= params_base paRP7A1SOQlKcnfXhxL4FgbVXKs= params_ref boost/url/params_ref.hpp include/boost/url/params_ref.hpp 126 5 1 boost/url/params_ref.hpp include/boost/url/params_ref.hpp 159 5 1 overloads 63gWLrVMYiiI82tBiP5L05lBH6c= regular 8S83BKvWBCDdTktlY8X93Mlo9E0= brief text Constructor param text The other view. other param text The options for decoding. If this parameter is omitted, code text space_as_plus text is used. opt constructor sEFiwKk140EO8Nr99+hbevJSBAY= nMkYq7qSUKlxmHWVMHNJz50kvFE= identifier void params_ref boost/url/params_ref.hpp include/boost/url/params_ref.hpp 126 5 1 function sEFiwKk140EO8Nr99+hbevJSBAY= regular 8S83BKvWBCDdTktlY8X93Mlo9E0= paragraph text After construction, both views reference the same url. Ownership is not transferred; the caller is responsible for ensuring the lifetime of the url extends until it is no longer referenced. heading text Postconditions 1 code &this->url() == &other.url() heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Constructor param text The other view. other identifier void 1 identifier 8S83BKvWBCDdTktlY8X93Mlo9E0= params_ref other constructor 1 1 1 params_ref boost/url/params_ref.hpp include/boost/url/params_ref.hpp 159 5 1 function nMkYq7qSUKlxmHWVMHNJz50kvFE= regular 8S83BKvWBCDdTktlY8X93Mlo9E0= paragraph text After construction, both views will reference the same url but this instance will use the specified reference encoding_opts Bb04pNwExynJkzlY9a9GCeeB13k= text when the values are decoded. paragraph text Ownership is not transferred; the caller is responsible for ensuring the lifetime of the url extends until it is no longer referenced. heading text Postconditions 1 code &this->url() == &other.url() heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Constructor param text The other view. other param text The options for decoding. If this parameter is omitted, code text space_as_plus text is used. opt identifier void 1 identifier 8S83BKvWBCDdTktlY8X93Mlo9E0= params_ref other identifier Bb04pNwExynJkzlY9a9GCeeB13k= encoding_opts opt constructor 1 operator= boost/url/params_ref.hpp include/boost/url/params_ref.hpp 191 5 1 boost/url/params_ref.hpp include/boost/url/params_ref.hpp 222 5 1 overloads v5DgF6q1dfcGdabPJh5FlpvEJUg= regular 8S83BKvWBCDdTktlY8X93Mlo9E0= brief text Assignment returns code text *this param text The params to assign. other param text The list of params to assign. init normal y7lcSqZgZM2dEqOvc9CWe1OF10c= M5JVAM7+RTTSS2rASnsI5EUT3nE= identifier 8S83BKvWBCDdTktlY8X93Mlo9E0= params_ref operator= boost/url/params_ref.hpp include/boost/url/params_ref.hpp 191 5 1 function y7lcSqZgZM2dEqOvc9CWe1OF10c= regular 8S83BKvWBCDdTktlY8X93Mlo9E0= paragraph text The previous contents of this are replaced by the contents of `other. paragraph text All iterators are invalidated. admonition paragraph text The strings referenced by code text other text must not come from the underlying url, or else the behavior is undefined. note heading text Effects 1 code this->assign( other.begin(), other.end() ); heading text Complexity 1 paragraph text Linear in code text other.buffer().size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. brief text Assignment returns code text *this param text The params to assign. other identifier 8S83BKvWBCDdTktlY8X93Mlo9E0= params_ref 1 identifier 8S83BKvWBCDdTktlY8X93Mlo9E0= params_ref other normal 1 operator= boost/url/params_ref.hpp include/boost/url/params_ref.hpp 222 5 1 function M5JVAM7+RTTSS2rASnsI5EUT3nE= regular 8S83BKvWBCDdTktlY8X93Mlo9E0= paragraph text After assignment, the previous contents of the query parameters are replaced by the contents of the initializer-list. heading text Preconditions 1 paragraph text None of character buffers referenced by code text init text may overlap the character buffer of the underlying url, or else the behavior is undefined. heading text Effects 1 code this->assign( init ); heading text Complexity 1 paragraph text Linear in code text init.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. brief text Assignment returns code text *this param text The list of params to assign. init identifier 8S83BKvWBCDdTktlY8X93Mlo9E0= params_ref specialization 3tT5Y8vozttMWXrA/fNw4NcDYTE= initializer_list identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std init normal 1 append boost/url/params_ref.hpp include/boost/url/params_ref.hpp 392 5 1 boost/url/params_ref.hpp include/boost/url/params_ref.hpp 422 5 1 boost/url/params_ref.hpp include/boost/url/params_ref.hpp 456 5 1 overloads C+zC5NOoDsWWotFdEpehZpN0UKY= regular 8S83BKvWBCDdTktlY8X93Mlo9E0= brief text Append elements returns text An iterator to the first new element. returns text An iterator to the new element. param text The list of params to append. init param text The param to append. p param text The first element to append. first param text One past the last element to append. last normal fjlyWxUJQyQcMmoOTMLD7pArcvU= 9dmdqhFa/biHl8nWL0gfEGmBUo8= yoPRc7gpSHSSVGYMIP4R2eDg8IM= identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator append boost/url/params_ref.hpp include/boost/url/params_ref.hpp 422 5 1 function fjlyWxUJQyQcMmoOTMLD7pArcvU= regular 8S83BKvWBCDdTktlY8X93Mlo9E0= paragraph text This function appends the params in an emph text initializer-list text to the view. paragraph text The code text end() text iterator is invalidated. heading text Example 1 code url u; u.params().append({ { "first", "John" }, { "last", "Doe" } }); heading text Complexity 1 paragraph text Linear in code text this->url().encoded_query().size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. brief text Append elements returns text An iterator to the first new element. param text The list of params to append. init identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator specialization 3tT5Y8vozttMWXrA/fNw4NcDYTE= initializer_list identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std init normal 1 append boost/url/params_ref.hpp include/boost/url/params_ref.hpp 392 5 1 function 9dmdqhFa/biHl8nWL0gfEGmBUo8= regular 8S83BKvWBCDdTktlY8X93Mlo9E0= paragraph text This function appends a param to the view. paragraph text The code text end() text iterator is invalidated. heading text Example 1 code url u; u.params().append( { "first", "John" } ); heading text Complexity 1 paragraph text Linear in code text this->url().encoded_query().size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. brief text Append elements returns text An iterator to the new element. param text The param to append. p identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator 1 identifier C+IWBHRl3NluE4QVhoCkgb59VAc= param_view p normal 1 append boost/url/params_ref.hpp include/boost/url/params_ref.hpp 456 5 1 function yoPRc7gpSHSSVGYMIP4R2eDg8IM= regular 8S83BKvWBCDdTktlY8X93Mlo9E0= paragraph text This function appends a range of params to the view. paragraph text The code text end() text iterator is invalidated. admonition paragraph text The strings referenced by the inputs must not come from the underlying url, or else the behavior is undefined. note heading text Mandates 1 code std::is_convertible< std::iterator_traits< FwdIt >::reference_type, param_view >::value == true heading text Complexity 1 paragraph text Linear in code text this->url().encoded_query().size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. brief text Append elements returns text An iterator to the first new element. param text The first element to append. first param text One past the last element to append. last identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator identifier FwdIt first identifier FwdIt last normal 1 assign boost/url/params_ref.hpp include/boost/url/params_ref.hpp 327 5 1 boost/url/params_ref.hpp include/boost/url/params_ref.hpp 361 5 1 overloads Uufp6Zdm6pKZEyVgZi+wJkRNsvk= regular 8S83BKvWBCDdTktlY8X93Mlo9E0= brief text Assign elements param text The list of params to assign. init param text The first element to assign. first param text One past the last element to assign. last normal mLxo7H9l4Px927KeVSp49qknJt4= LwZqprqmiVZ1AhFQAYs6kPgTFmM= identifier void assign boost/url/params_ref.hpp include/boost/url/params_ref.hpp 327 5 1 function mLxo7H9l4Px927KeVSp49qknJt4= regular 8S83BKvWBCDdTktlY8X93Mlo9E0= paragraph text This function replaces the entire contents of the view with the params in the emph text initializer-list text . paragraph text All iterators are invalidated. admonition paragraph text The strings referenced by the inputs must not come from the underlying url, or else the behavior is undefined. note heading text Example 1 code url u; u.params().assign( {{ "first", "John" }, { "last", "Doe" }} ); heading text Complexity 1 paragraph text Linear in code text init.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. brief text Assign elements param text The list of params to assign. init identifier void specialization 3tT5Y8vozttMWXrA/fNw4NcDYTE= initializer_list identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std init normal 1 assign boost/url/params_ref.hpp include/boost/url/params_ref.hpp 361 5 1 function LwZqprqmiVZ1AhFQAYs6kPgTFmM= regular 8S83BKvWBCDdTktlY8X93Mlo9E0= paragraph text This function replaces the entire contents of the view with the params in the range. paragraph text All iterators are invalidated. admonition paragraph text The strings referenced by the inputs must not come from the underlying url, or else the behavior is undefined. note heading text Mandates 1 code std::is_convertible< std::iterator_traits< FwdIt >::reference_type, param_view >::value == true heading text Complexity 1 paragraph text Linear in the size of the range. heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. brief text Assign elements param text The first element to assign. first param text One past the last element to assign. last identifier void identifier FwdIt first identifier FwdIt last normal 1 begin boost/url/params_base.hpp include/boost/url/params_base.hpp 227 5 1 function rgFjw9W6rMjgEYkGOVMDiLJIIdE= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= heading text Complexity 1 paragraph text Linear in the size of the first param. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return an iterator to the beginning returns text An iterator to the beginning. identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator normal 1 1 buffer boost/url/params_base.hpp include/boost/url/params_base.hpp 178 5 1 function cpczYPJifQzreeaLMlFMrIk8geU= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= paragraph text This function returns the character buffer referenced by the view. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "?first=John&last=Doe" ).params().buffer() == "?first=John&last=Doe" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the referenced character buffer. returns text The buffer. identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 clear boost/url/params_ref.hpp include/boost/url/params_ref.hpp 292 5 1 function /ZH/B/Ue7rMuRZ41OiOL9pCngTk= regular 8S83BKvWBCDdTktlY8X93Mlo9E0= paragraph text All iterators are invalidated. heading text Effects 1 code this->url().remove_query(); heading text Postconditions 1 code this->empty() == true && this->url().has_query() == false heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Clear the contents of the container identifier void normal 1 contains boost/url/params_base.hpp include/boost/url/params_base.hpp 275 5 1 function +m1VjI0xtgykFmvRxecqZkXJBNg= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= paragraph text This function examines the parameters in the container to find a match for the specified key. The comparison is performed as if all escaped characters were decoded first. heading text Example 1 code assert( url_view( "?first=John&last=Doe" ).params().contains( "first" ) ); heading text Complexity 1 paragraph text Linear in code text this->buffer().size() text . heading text Exception Safety 1 paragraph text Throws nothing. brief text Return true if a matching key exists returns code text true text if a matching key exists. param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic identifier bool identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core key identifier RATceEbebMWrhFXGkG2RDFi+7WY= ignore_case_param ic {} normal 1 1 count boost/url/params_base.hpp include/boost/url/params_base.hpp 311 5 1 function SUQ73EvVipRYcJ2Sg24T8d60qeQ= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= paragraph text This function examines the parameters in the container to find the number of matches for the specified key. The comparison is performed as if all escaped characters were decoded first. heading text Example 1 code assert( url_view( "?first=John&last=Doe" ).params().count( "first" ) == 1 ); heading text Complexity 1 paragraph text Linear in code text this->buffer().size() text . heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the number of matching keys returns text The number of matching keys. param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core key identifier RATceEbebMWrhFXGkG2RDFi+7WY= ignore_case_param ic {} normal 1 1 empty boost/url/params_base.hpp include/boost/url/params_base.hpp 196 5 1 function VQ4Gk4oWz8OorSDPtJoAWpHsFaI= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= heading text Example 1 code assert( ! url_view( "?key=value" ).params().empty() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return true if there are no params returns code text true text if there are no params. identifier bool normal 1 1 end boost/url/params_base.hpp include/boost/url/params_base.hpp 240 5 1 function NYG2/rgQQuH/CSw2qObuDUB3DYo= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return an iterator to the end returns text An iterator to the end. identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator normal 1 1 erase boost/url/params_ref.hpp include/boost/url/params_ref.hpp 606 5 1 boost/url/params_ref.hpp include/boost/url/params_ref.hpp 628 5 1 boost/url/params_ref.hpp include/boost/url/params_ref.hpp 661 5 1 overloads +wzf9WWabjrjCA2Y5TCum6SkHjo= regular 8S83BKvWBCDdTktlY8X93Mlo9E0= brief text Erase elements returns text An iterator to one past the removed element. returns text An iterator to one past the removed range. returns text The number of elements removed from the container. param text An iterator to the element. pos param text The first element to remove. first param text One past the last element to remove. last param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic normal WmulA0OfqfxzcY4Wk4glpm6tbMs= +dVMjzbVrt65BpN7a/wkVYfHY7Q= B2A7bnSaKkVCI5zd9gB1DuklqpI= erase boost/url/params_ref.hpp include/boost/url/params_ref.hpp 606 5 1 function WmulA0OfqfxzcY4Wk4glpm6tbMs= regular 8S83BKvWBCDdTktlY8X93Mlo9E0= paragraph text This function removes an element from the container. paragraph text All iterators that are equal to code text pos text or come after are invalidated. heading text Example 1 code url u( "?first=John&last=Doe" ); params_ref::iterator it = u.params().erase( u.params().begin() ); assert( u.encoded_query() == "last=Doe" ); heading text Complexity 1 paragraph text Linear in code text this->url().encoded_query().size() text . heading text Exception Safety 1 paragraph text Throws nothing. brief text Erase elements returns text An iterator to one past the removed element. param text An iterator to the element. pos identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator pos normal 1 erase boost/url/params_ref.hpp include/boost/url/params_ref.hpp 628 5 1 function +dVMjzbVrt65BpN7a/wkVYfHY7Q= regular 8S83BKvWBCDdTktlY8X93Mlo9E0= paragraph text This function removes a range of elements from the container. paragraph text All iterators that are equal to code text first text or come after are invalidated. heading text Complexity 1 paragraph text Linear in code text this->url().encoded_query().size() text . heading text Exception Safety 1 paragraph text Throws nothing. brief text Erase elements returns text An iterator to one past the removed range. param text The first element to remove. first param text One past the last element to remove. last identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator first identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator last normal 1 erase boost/url/params_ref.hpp include/boost/url/params_ref.hpp 661 5 1 function B2A7bnSaKkVCI5zd9gB1DuklqpI= regular 8S83BKvWBCDdTktlY8X93Mlo9E0= paragraph text All iterators are invalidated. heading text Postconditions 1 code this->count( key, ic ) == 0 heading text Complexity 1 paragraph text Linear in code text this->url().encoded_query().size() text . heading text Exception Safety 1 paragraph text Throws nothing. brief text Erase elements returns text The number of elements removed from the container. param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core key identifier RATceEbebMWrhFXGkG2RDFi+7WY= ignore_case_param ic {} normal 1 find boost/url/params_base.hpp include/boost/url/params_base.hpp 395 5 1 boost/url/params_base.hpp include/boost/url/params_base.hpp 440 5 1 overloads /lfP4NtGxUDEYF5NvxdZQKO226I= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= brief text Find a matching key returns text an iterator to the param param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic param text The position to begin the search from. This can be code text end() text . from normal mSdbytykajruHQy1W8iyrWbbOmM= Q/NxQl0WFzXMzvRmJDH5BghXp5M= identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator find boost/url/params_base.hpp include/boost/url/params_base.hpp 395 5 1 function mSdbytykajruHQy1W8iyrWbbOmM= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= paragraph text This function examines the parameters in the container to find a match for the specified key. The comparison is performed as if all escaped characters were decoded first. paragraph text The search starts from the first param and proceeds forward until either the key is found or the end of the range is reached, in which case code text end() text is returned. heading text Example 1 code assert( (*url_view( "?first=John&last=Doe" ).params().find( "First", ignore_case )).value == "John" ); heading text Effects 1 code return this->find( this->begin(), key, ic ); heading text Complexity 1 paragraph text Linear in code text this->buffer().size() text . brief text Find a matching key returns text an iterator to the param param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core key identifier RATceEbebMWrhFXGkG2RDFi+7WY= ignore_case_param ic {} normal 1 1 find boost/url/params_base.hpp include/boost/url/params_base.hpp 440 5 1 function Q/NxQl0WFzXMzvRmJDH5BghXp5M= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= paragraph text This function examines the parameters in the container to find a match for the specified key. The comparison is performed as if all escaped characters were decoded first. paragraph text The search starts at code text from text and proceeds forward until either the key is found or the end of the range is reached, in which case code text end() text is returned. heading text Example 1 code url_view u( "?First=John&Last=Doe" ); assert( u.params().find( "first" ) != u.params().find( "first", ignore_case ) ); heading text Complexity 1 paragraph text Linear in code text this->buffer().size() text . brief text Find a matching key returns text an iterator to the param param text The position to begin the search from. This can be code text end() text . from param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator from identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core key identifier RATceEbebMWrhFXGkG2RDFi+7WY= ignore_case_param ic {} normal 1 1 find_last boost/url/params_base.hpp include/boost/url/params_base.hpp 481 5 1 boost/url/params_base.hpp include/boost/url/params_base.hpp 527 5 1 overloads S17pkFUExaqRFD9HA5cryLnWVG8= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= brief text Find a matching key returns text an iterator to the param param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic param text One past the position to begin the search from. This can be code text end() text . before normal T7jam5dZRMsS/ZHAEHdP05Fqlug= 2y2ewlvaEuZkWtKX4p7xlBO2wXU= identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator find_last boost/url/params_base.hpp include/boost/url/params_base.hpp 481 5 1 function T7jam5dZRMsS/ZHAEHdP05Fqlug= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= paragraph text This function examines the parameters in the container to find a match for the specified key. The comparison is performed as if all escaped characters were decoded first. paragraph text The search starts from the last param and proceeds backwards until either the key is found or the beginning of the range is reached, in which case code text end() text is returned. heading text Example 1 code assert( (*url_view( "?first=John&last=Doe" ).params().find_last( "last" )).value == "Doe" ); heading text Complexity 1 paragraph text Linear in code text this->buffer().size() text . brief text Find a matching key returns text an iterator to the param param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core key identifier RATceEbebMWrhFXGkG2RDFi+7WY= ignore_case_param ic {} normal 1 1 find_last boost/url/params_base.hpp include/boost/url/params_base.hpp 527 5 1 function 2y2ewlvaEuZkWtKX4p7xlBO2wXU= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= paragraph text This function examines the parameters in the container to find a match for the specified key. The comparison is performed as if all escaped characters were decoded first. paragraph text The search starts prior to code text before text and proceeds backwards until either the key is found or the beginning of the range is reached, in which case code text end() text is returned. heading text Example 1 code url_view u( "?First=John&Last=Doe" ); assert( u.params().find_last( "last" ) != u.params().find_last( "last", ignore_case ) ); heading text Complexity 1 paragraph text Linear in code text this->buffer().size() text . brief text Find a matching key returns text an iterator to the param param text One past the position to begin the search from. This can be code text end() text . before param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator before identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core key identifier RATceEbebMWrhFXGkG2RDFi+7WY= ignore_case_param ic {} normal 1 1 get_or boost/url/params_base.hpp include/boost/url/params_base.hpp 349 5 1 function GhT3qpAk3WuPisnAoeMMKNguVco= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= paragraph text This convenience function searches for the first parameter matching code text key text and returns its decoded value. If no parameter with the specified key exists, the provided fallback code text value text is returned instead. When the key is found but the parameter has no value, an empty string is returned. heading text Example 1 code url_view u( "/path?first=John&last=Doe" ); assert( u.params().get_or( "first", "n/a" ) == "John" ); assert( u.params().get_or( "missing", "n/a" ) == "n/a" ); heading text Complexity 1 paragraph text Linear in code text this->buffer().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. brief text Return the value for a key or a fallback returns text The decoded value or the fallback. param text The key to match. key param text The fallback string returned when no matching key exists. If this parameter is omitted, an empty string is used. value param text Optional case-insensitive compare indicator. ic identifier UwlFvW1lEI5kSm1M2LJ8livaK7g= string identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core key identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core value {} identifier RATceEbebMWrhFXGkG2RDFi+7WY= ignore_case_param ic {} normal 1 1 insert boost/url/params_ref.hpp include/boost/url/params_ref.hpp 488 5 1 boost/url/params_ref.hpp include/boost/url/params_ref.hpp 525 5 1 boost/url/params_ref.hpp include/boost/url/params_ref.hpp 568 5 1 overloads 30OuP3B1jZIt3bTl0RhIrVeyrNo= regular 8S83BKvWBCDdTktlY8X93Mlo9E0= brief text Insert elements returns text An iterator to the first element inserted, or code text before text if code text init.size() == 0 text . returns text An iterator to the inserted element. returns text An iterator to the first element inserted, or code text before text if code text first == last text . returns text An iterator to the first element inserted, or code text before text if code text first == last text . param text An iterator before which the element is inserted. This may be equal to code text end() text . before param text The list of params to insert. init param text The param to insert. p param text The first element to insert. first param text One past the last element to insert. last normal IRCrEu1TQqmMtrFIkqKWnML3s+I= inqCN/guAaHuyerzHhXfXMB8zGE= WG2hvXXhfS6dlnyW9UY3PkUCvgQ= identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator insert boost/url/params_ref.hpp include/boost/url/params_ref.hpp 525 5 1 function IRCrEu1TQqmMtrFIkqKWnML3s+I= regular 8S83BKvWBCDdTktlY8X93Mlo9E0= paragraph text This function inserts the params in an emph text initializer-list text before the specified position. paragraph text All iterators that are equal to code text before text or come after are invalidated. admonition paragraph text The strings referenced by the inputs must not come from the underlying url, or else the behavior is undefined. note heading text Complexity 1 paragraph text Linear in code text this->url().encoded_query().size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. brief text Insert elements returns text An iterator to the first element inserted, or code text before text if code text init.size() == 0 text . param text An iterator before which the element is inserted. This may be equal to code text end() text . before param text The list of params to insert. init identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator before specialization 3tT5Y8vozttMWXrA/fNw4NcDYTE= initializer_list identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std init normal 1 insert boost/url/params_ref.hpp include/boost/url/params_ref.hpp 488 5 1 function inqCN/guAaHuyerzHhXfXMB8zGE= regular 8S83BKvWBCDdTktlY8X93Mlo9E0= paragraph text This function inserts a param before the specified position. paragraph text All iterators that are equal to code text before text or come after are invalidated. heading text Complexity 1 paragraph text Linear in code text this->url().encoded_query().size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. brief text Insert elements returns text An iterator to the inserted element. param text An iterator before which the param is inserted. This may be equal to code text end() text . before param text The param to insert. p identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator before 1 identifier C+IWBHRl3NluE4QVhoCkgb59VAc= param_view p normal 1 insert boost/url/params_ref.hpp include/boost/url/params_ref.hpp 568 5 1 function WG2hvXXhfS6dlnyW9UY3PkUCvgQ= regular 8S83BKvWBCDdTktlY8X93Mlo9E0= paragraph text This function inserts a range of params before the specified position. paragraph text All iterators that are equal to code text before text or come after are invalidated. admonition paragraph text The strings referenced by the inputs must not come from the underlying url, or else the behavior is undefined. note heading text Mandates 1 code std::is_convertible< std::iterator_traits< FwdIt >::reference_type, param_view >::value == true heading text Complexity 1 paragraph text Linear in code text this->url().encoded_query().size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. brief text Insert elements returns text An iterator to the first element inserted, or code text before text if code text first == last text . returns text An iterator to the first element inserted, or code text before text if code text first == last text . param text An iterator before which the element is inserted. This may be equal to code text end() text . before param text The first element to insert. first param text One past the last element to insert. last identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator before identifier FwdIt first identifier FwdIt last normal 1 replace boost/url/params_ref.hpp include/boost/url/params_ref.hpp 700 5 1 boost/url/params_ref.hpp include/boost/url/params_ref.hpp 736 5 1 boost/url/params_ref.hpp include/boost/url/params_ref.hpp 779 5 1 overloads lfq3Mrh+3Tlp3S5S2EtjZSckfAg= regular 8S83BKvWBCDdTktlY8X93Mlo9E0= brief text Replace elements returns text An iterator to the element. returns text An iterator to the first element inserted, or one past code text to text if code text init.size() == 0 text . returns text An iterator to the first element inserted, or one past code text to text if code text first == last text . returns text An iterator to the first element inserted, or one past code text to text if code text first == last text . param text An iterator to the element. pos param text The param to assign. p param text The range of elements to replace. from,to param text The list of params to assign. init param text The first element to replace. from param text One past the last element to replace. to param text The first element to insert. first param text One past the last element to insert. last normal 3Ong3jX1kscAlsfcWm5LXW6Filc= s9ZmYRgGWJePYL0aEbZJYvns6xo= EJy3xCbYPsCPW98ynKOOoB4ZWmM= identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator replace boost/url/params_ref.hpp include/boost/url/params_ref.hpp 700 5 1 function 3Ong3jX1kscAlsfcWm5LXW6Filc= regular 8S83BKvWBCDdTktlY8X93Mlo9E0= paragraph text This function replaces the contents of the element at code text pos text with the specified param. paragraph text All iterators that are equal to code text pos text or come after are invalidated. heading text Example 1 code url u( "?first=John&last=Doe" ); u.params().replace( u.params().begin(), { "title", "Mr" }); assert( u.encoded_query() == "title=Mr&last=Doe" ); heading text Complexity 1 paragraph text Linear in code text this->url().encoded_query().size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. brief text Replace elements returns text An iterator to the element. param text An iterator to the element. pos param text The param to assign. p identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator pos 1 identifier C+IWBHRl3NluE4QVhoCkgb59VAc= param_view p normal 1 replace boost/url/params_ref.hpp include/boost/url/params_ref.hpp 736 5 1 function s9ZmYRgGWJePYL0aEbZJYvns6xo= regular 8S83BKvWBCDdTktlY8X93Mlo9E0= paragraph text This function replaces a range of elements with the params in an emph text initializer-list text . paragraph text All iterators that are equal to code text from text or come after are invalidated. admonition paragraph text The strings referenced by the inputs must not come from the underlying url, or else the behavior is undefined. note heading text Complexity 1 paragraph text Linear in code text this->url().encoded_query().size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. brief text Replace elements returns text An iterator to the first element inserted, or one past code text to text if code text init.size() == 0 text . param text The range of elements to replace. from,to param text The list of params to assign. init identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator from identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator to specialization 3tT5Y8vozttMWXrA/fNw4NcDYTE= initializer_list identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std init normal 1 replace boost/url/params_ref.hpp include/boost/url/params_ref.hpp 779 5 1 function EJy3xCbYPsCPW98ynKOOoB4ZWmM= regular 8S83BKvWBCDdTktlY8X93Mlo9E0= paragraph text This function replaces a range of elements with a range of params. paragraph text All iterators that are equal to code text from text or come after are invalidated. admonition paragraph text The strings referenced by the inputs must not come from the underlying url, or else the behavior is undefined. note heading text Mandates 1 code std::is_convertible< std::iterator_traits< FwdIt >::reference_type, param_view >::value == true heading text Complexity 1 paragraph text Linear in code text this->url().encoded_query().size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. brief text Replace elements returns text An iterator to the first element inserted, or one past code text to text if code text first == last text . returns text An iterator to the first element inserted, or one past code text to text if code text first == last text . param text The first element to replace. from param text One past the last element to replace. to param text The first element to insert. first param text One past the last element to insert. last identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator from identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator to identifier FwdIt first identifier FwdIt last normal 1 set boost/url/params_ref.hpp include/boost/url/params_ref.hpp 857 5 1 boost/url/params_ref.hpp include/boost/url/params_ref.hpp 919 5 1 overloads +yTWdOiG8FvzLfVFF16r/ZqyEX8= regular 8S83BKvWBCDdTktlY8X93Mlo9E0= brief text Set a value returns text An iterator to the element. returns text An iterator to the appended or modified element. param text An iterator to the element. pos param text The value to assign. The empty string still counts as a value. That is, code text has_value text for the element is true. value param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic normal mCYtesr8JFdY7xoHpmszJaRsXUo= EGjhOkY1INrpzeQENVRQb2nwmx8= identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator set boost/url/params_ref.hpp include/boost/url/params_ref.hpp 857 5 1 function mCYtesr8JFdY7xoHpmszJaRsXUo= regular 8S83BKvWBCDdTktlY8X93Mlo9E0= paragraph text This function replaces the value of an element at the specified position. paragraph text All iterators that are equal to code text pos text or come after are invalidated. heading text Example 1 code url u( "?id=42&id=69" ); u.params().set( u.params().begin(), "none" ); assert( u.encoded_query() == "id=none&id=69" ); heading text Complexity 1 paragraph text Linear in code text this->url().encoded_query().size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. brief text Set a value returns text An iterator to the element. param text An iterator to the element. pos param text The value to assign. The empty string still counts as a value. That is, code text has_value text for the element is true. value identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator pos identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core value normal 1 set boost/url/params_ref.hpp include/boost/url/params_ref.hpp 919 5 1 function EGjhOkY1INrpzeQENVRQb2nwmx8= regular 8S83BKvWBCDdTktlY8X93Mlo9E0= paragraph text This function performs one of two actions depending on the value of code text this->contains( key, ic ) text . list paragraph text If key is contained in the view then one of the matching elements has its value changed to the specified value. The remaining elements with a matching key are erased. Otherwise, paragraph text If code text key text is not contained in the view, then the function apppends the param code text { key, value } text . unordered paragraph text All iterators are invalidated. heading text Example 1 code url u( "?id=42&id=69" ); u.params().set( "id", "none" ); assert( u.params().count( "id" ) == 1 ); heading text Postconditions 1 code this->count( key, ic ) == 1 && this->find( key, ic )->value == value heading text Complexity 1 paragraph text Linear in code text this->url().encoded_query().size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. brief text Set a value returns text An iterator to the appended or modified element. param text The key to match. By default, a case-sensitive comparison is used. key param text The value to assign. The empty string still counts as a value. That is, code text has_value text for the element is true. value param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core key identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core value identifier RATceEbebMWrhFXGkG2RDFi+7WY= ignore_case_param ic {} normal 1 size boost/url/params_base.hpp include/boost/url/params_base.hpp 214 5 1 function u/w33vX8w/yA/9Gl176lDHdQs4k= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= heading text Example 1 code assert( url_view( "?key=value").params().size() == 1 ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the number of params returns text The number of params. identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 1 unset boost/url/params_ref.hpp include/boost/url/params_ref.hpp 819 5 1 function jxURKYVSYJoxZiuBOnhDenCs1rA= regular 8S83BKvWBCDdTktlY8X93Mlo9E0= paragraph text This function removes the value of an element at the specified position. After the call returns, code text has_value text for the element is false. paragraph text All iterators that are equal to code text pos text or come after are invalidated. heading text Example 1 code url u( "?first=John&last=Doe" ); u.params().unset( u.params().begin() ); assert( u.encoded_query() == "first&last=Doe" ); heading text Complexity 1 paragraph text Linear in code text this->url().encoded_query().size() text . heading text Exception Safety 1 paragraph text Throws nothing. brief text Remove the value on an element returns text An iterator to the element. param text An iterator to the element. pos identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator pos normal 1 url boost/url/params_ref.hpp include/boost/url/params_ref.hpp 259 5 1 function 40HPQpiad5IvD+unAuZCj3AHuA0= regular 8S83BKvWBCDdTktlY8X93Mlo9E0= paragraph text This function returns the url referenced by the view. heading text Example 1 code url u( "?key=value" ); assert( &u.segments().url() == &u ); heading text Exception Safety 1 code Throws nothing. brief text Return the referenced url returns text A reference to the url. identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base normal 1 1 operator params_view boost/url/params_ref.hpp include/boost/url/params_ref.hpp 231 5 1 function N+s3ZvmEa8MkvVluiPBiQWSSM4U= regular 8S83BKvWBCDdTktlY8X93Mlo9E0= brief text Conversion returns text A view of the query parameters. identifier DzqMpaJX2O25vPFxEN5EDTyU6uw= params_view conversion 1 1 max_size boost/url/params_base.hpp include/boost/url/params_base.hpp 150 5 1 function JAc718f//bzvETv8VNPf4ujJ2G8= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= paragraph text This represents the largest number of characters that are possible in a path, not including any null terminator. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the maximum number of characters possible returns text The maximum number of characters possible. identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 params_view boost/url/params_view.hpp include/boost/url/params_view.hpp 43 1 1 boost/url/params_ref.hpp include/boost/url/params_ref.hpp 25 1 record DzqMpaJX2O25vPFxEN5EDTyU6uw= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text This read-only range interprets the query string of a URL as bidirectional key/value pairs with percent-decoding applied on access. It merely references the original character buffer; callers must keep that buffer alive while the view is used. heading text Example 1 code url_view u( "?first=John&last=Doe" ); params_view p = u.params(); paragraph text Strings retrieved from the iterators are automatically percent-decoded. heading text Iterator Invalidation 1 paragraph text Changes to the underlying character buffer can invalidate iterators which reference it. brief text Non-owning decoded query parameter view class identifier paRP7A1SOQlKcnfXhxL4FgbVXKs= params_base 4XRIDzJtD8YcNf6ybgP1JlmdPbE= /aPvkkBZhzgeMb2UCNaJ1s5c6oQ= 4jo6j51QPa7nfAiEWAM6LJc4fLs= 8Hg/5b5RDYgIk/T6aP0tPj0HbSc= cFqtE5widJnnA8qwGOBnkhkdR6Y= /wVpdYewE+NKvN60EGcgNiIZ+Mc= yQvwWZx48v8Nw4e9GT31DZi5Y8s= bK8bTOUyZ24WuHreHo8Q8cP8/8Q= jC0rL5Q8ggiLsnKp6Xy0GRt4XbI= rgFjw9W6rMjgEYkGOVMDiLJIIdE= cpczYPJifQzreeaLMlFMrIk8geU= +m1VjI0xtgykFmvRxecqZkXJBNg= SUQ73EvVipRYcJ2Sg24T8d60qeQ= VQ4Gk4oWz8OorSDPtJoAWpHsFaI= NYG2/rgQQuH/CSw2qObuDUB3DYo= /lfP4NtGxUDEYF5NvxdZQKO226I= S17pkFUExaqRFD9HA5cryLnWVG8= GhT3qpAk3WuPisnAoeMMKNguVco= u/w33vX8w/yA/9Gl176lDHdQs4k= JAc718f//bzvETv8VNPf4ujJ2G8= p038aUfVLHpqHpQHemmKx8WBFj8= identifier 8S83BKvWBCDdTktlY8X93Mlo9E0= params_ref 8S83BKvWBCDdTktlY8X93Mlo9E0= identifier 0nSfM4mK92fIx58KtzdWGiHuq2w= params_encoded_view 0nSfM4mK92fIx58KtzdWGiHuq2w= identifier UEVNhDEjkZMXfjN1DxbtX0n2rCg= url_view_base UEVNhDEjkZMXfjN1DxbtX0n2rCg= const_iterator boost/url/params_base.hpp include/boost/url/params_base.hpp 94 5 1 typedef 4XRIDzJtD8YcNf6ybgP1JlmdPbE= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= paragraph text Objects of this type allow iteration through the parameters in the query. Any percent-escapes in returned strings are decoded first. The values returned are read-only; changes to parameters must be made through the container instead, if the container supports modification. paragraph text The strings produced when iterators are dereferenced belong to the iterator and become invalidated when that particular iterator is incremented, decremented, or destroyed. paragraph text The implementation may use temporary, recycled storage to store decoded strings. These iterators are meant to be used ephemerally. That is, for short durations such as within a function scope. Do not store iterators with static storage duration or as long-lived objects. brief text A Bidirectional iterator to a query parameter iterator identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator 1 const_reference boost/url/params_base.hpp include/boost/url/params_base.hpp 123 5 1 typedef /aPvkkBZhzgeMb2UCNaJ1s5c6oQ= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= paragraph text This is the type of value returned when iterators of the view are dereferenced. brief text The reference type reference see reference param_view C+IWBHRl3NluE4QVhoCkgb59VAc= text . identifier fsdT8sbwW/lniPI5gqvIf2JMGBM= param 1 difference_type boost/url/params_base.hpp include/boost/url/params_base.hpp 131 5 1 typedef 4jo6j51QPa7nfAiEWAM6LJc4fLs= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= brief text A signed integer type used to represent differences. identifier EH4n8sIj03HafoTNn2U36T1P+Hc= ptrdiff_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std 1 reference boost/url/params_base.hpp include/boost/url/params_base.hpp 120 5 1 typedef 8Hg/5b5RDYgIk/T6aP0tPj0HbSc= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= paragraph text This is the type of value returned when iterators of the view are dereferenced. brief text The reference type see reference param_view C+IWBHRl3NluE4QVhoCkgb59VAc= text . identifier fsdT8sbwW/lniPI5gqvIf2JMGBM= param 1 size_type boost/url/params_base.hpp include/boost/url/params_base.hpp 127 5 1 typedef cFqtE5widJnnA8qwGOBnkhkdR6Y= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= brief text An unsigned integer type to represent sizes. identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std 1 value_type boost/url/params_base.hpp include/boost/url/params_base.hpp 110 5 1 typedef /wVpdYewE+NKvN60EGcgNiIZ+Mc= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= paragraph text Values of this type represent parameters whose strings retain unique ownership by making a copy. heading text Example 1 code params_view::value_type qp( *url_view( "?first=John&last=Doe" ).params().find( "first" ) ); brief text The value type see reference param fsdT8sbwW/lniPI5gqvIf2JMGBM= text . identifier fsdT8sbwW/lniPI5gqvIf2JMGBM= param 1 iterator boost/url/impl/params_base.hpp include/boost/url/impl/params_base.hpp 26 1 boost/url/params_base.hpp include/boost/url/params_base.hpp 91 5 1 record yQvwWZx48v8Nw4e9GT31DZi5Y8s= see-below 1 DzqMpaJX2O25vPFxEN5EDTyU6uw= paragraph text Objects of this type allow iteration through the parameters in the query. Any percent-escapes in returned strings are decoded first. The values returned are read-only; changes to parameters must be made through the container instead, if the container supports modification. paragraph text The strings produced when iterators are dereferenced belong to the iterator and become invalidated when that particular iterator is incremented, decremented, or destroyed. paragraph text The implementation may use temporary, recycled storage to store decoded strings. These iterators are meant to be used ephemerally. That is, for short durations such as within a function scope. Do not store iterators with static storage duration or as long-lived objects. brief text A Bidirectional iterator to a query parameter class identifier 8S83BKvWBCDdTktlY8X93Mlo9E0= params_ref 8S83BKvWBCDdTktlY8X93Mlo9E0= identifier paRP7A1SOQlKcnfXhxL4FgbVXKs= params_base paRP7A1SOQlKcnfXhxL4FgbVXKs= params_view boost/url/params_view.hpp include/boost/url/params_view.hpp 76 5 1 boost/url/params_view.hpp include/boost/url/params_view.hpp 131 5 1 boost/url/params_view.hpp include/boost/url/params_view.hpp 186 5 1 boost/url/params_view.hpp include/boost/url/params_view.hpp 252 5 1 overloads bK8bTOUyZ24WuHreHo8Q8cP8/8Q= regular DzqMpaJX2O25vPFxEN5EDTyU6uw= brief text Constructor param text The object to copy other param text The string to parse. s param text The options for decoding. If this parameter is omitted, code text space_as_plus text is used. opt throws code text s text contains an invalid query parameter string. reference system_error constructor 1164/Ok6Ouw7H1B2XyRWiYBHRqI= kbyYjwWKQMGVCz9z5J6cuaxT3wI= mtZAb/TqqVclweoRDpFPAwb+pPA= QTr9aDRMSQUV86floR9rnK66D1Q= Hgdj76635HFJyoq5j2uinpxH+/c= identifier void params_view boost/url/params_view.hpp include/boost/url/params_view.hpp 76 5 1 function 1164/Ok6Ouw7H1B2XyRWiYBHRqI= regular DzqMpaJX2O25vPFxEN5EDTyU6uw= paragraph text Default-constructed params have zero elements. heading text Example 1 code params_view qp; heading text Effects 1 code return params_view( "" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Constructor identifier void constructor 1 1 1 params_view boost/url/params_view.hpp include/boost/url/params_view.hpp 101 5 1 function kbyYjwWKQMGVCz9z5J6cuaxT3wI= regular DzqMpaJX2O25vPFxEN5EDTyU6uw= paragraph text After construction both views reference the same character buffer. paragraph text Ownership is not transferred; the caller is responsible for ensuring the lifetime of the buffer extends until it is no longer referenced. heading text Postconditions 1 code this->buffer().data() == other.buffer().data() heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing brief text Constructor param text The object to copy other identifier void 1 identifier DzqMpaJX2O25vPFxEN5EDTyU6uw= params_view other constructor 1 1 1 params_view boost/url/params_view.hpp include/boost/url/params_view.hpp 186 5 1 function mtZAb/TqqVclweoRDpFPAwb+pPA= regular DzqMpaJX2O25vPFxEN5EDTyU6uw= paragraph text This function constructs params from a valid query parameter string, which can contain percent escapes. Unlike the parameters in URLs, the string passed here should not start with "?". Upon construction, the view references the character buffer pointed to by code text s text . The caller is responsible for ensuring that the lifetime of the buffer extends until it is no longer referenced. heading text Example 1 code params_view qp( "first=John&last=Doe" ); heading text Effects 1 code return parse_query( s ).value(); heading text Postconditions 1 code this->buffer().data() == s.data() heading text Complexity 1 paragraph text Linear in code text s text . heading text Exception Safety 1 paragraph text Exceptions thrown on invalid input. heading text BNF 1 code query-params = [ query-param ] *( "&" query-param ) query-param = key [ "=" value ] heading text Specification 1 list paragraph link text 3.4. Query https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 unordered brief text Constructor param text The string to parse. s throws code text s text contains an invalid query parameter string. reference system_error identifier void identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s constructor 1 params_view boost/url/params_view.hpp include/boost/url/params_view.hpp 252 5 1 function QTr9aDRMSQUV86floR9rnK66D1Q= regular DzqMpaJX2O25vPFxEN5EDTyU6uw= paragraph text This function constructs params from a valid query parameter string, which can contain percent escapes. paragraph text This instance will use the specified reference encoding_opts Bb04pNwExynJkzlY9a9GCeeB13k= text when the values are decoded. paragraph text Unlike the parameters in URLs, the string passed here should not start with "?". Upon construction, the view will reference the character buffer pointed to by code text s text . The caller is responsible for ensuring that the lifetime of the buffer extends until it is no longer referenced. heading text Example 1 code encoding_opts opt; opt.space_as_plus = true; params_view qp( "name=John+Doe", opt ); heading text Effects 1 code return params_view(parse_query( s ).value(), opt); heading text Postconditions 1 code this->buffer().data() == s.data() heading text Complexity 1 paragraph text Linear in code text s text . heading text Exception Safety 1 paragraph text Exceptions thrown on invalid input. heading text BNF 1 code query-params = [ query-param ] *( "&" query-param ) query-param = key [ "=" value ] heading text Specification 1 list paragraph link text 3.4. Query https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 unordered brief text Constructor param text The string to parse. s param text The options for decoding. If this parameter is omitted, code text space_as_plus text is used. opt throws code text s text contains an invalid query parameter string. reference system_error identifier void identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s identifier Bb04pNwExynJkzlY9a9GCeeB13k= encoding_opts opt constructor 1 params_view boost/url/params_view.hpp include/boost/url/params_view.hpp 131 5 1 function Hgdj76635HFJyoq5j2uinpxH+/c= regular DzqMpaJX2O25vPFxEN5EDTyU6uw= paragraph text After construction both views will reference the same character buffer but this instance will use the specified reference encoding_opts Bb04pNwExynJkzlY9a9GCeeB13k= text when the values are decoded. paragraph text Ownership is not transferred; the caller is responsible for ensuring the lifetime of the buffer extends until it is no longer referenced. heading text Postconditions 1 code this->buffer().data() == other.buffer().data() heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing brief text Constructor param text The object to copy other param text The options for decoding opt identifier void 1 identifier DzqMpaJX2O25vPFxEN5EDTyU6uw= params_view other identifier Bb04pNwExynJkzlY9a9GCeeB13k= encoding_opts opt constructor 1 operator= boost/url/params_view.hpp include/boost/url/params_view.hpp 280 5 1 function jC0rL5Q8ggiLsnKp6Xy0GRt4XbI= regular DzqMpaJX2O25vPFxEN5EDTyU6uw= paragraph text After assignment, both views reference the same underlying character buffer. paragraph text Ownership is not transferred; the caller is responsible for ensuring the lifetime of the buffer extends until it is no longer referenced. heading text Postconditions 1 code this->buffer().data() == other.buffer().data() heading text Complexity 1 paragraph text Constant heading text Exception Safety 1 paragraph text Throws nothing brief text Assignment returns text A reference to this object param text The object to assign other identifier DzqMpaJX2O25vPFxEN5EDTyU6uw= params_view 1 identifier DzqMpaJX2O25vPFxEN5EDTyU6uw= params_view other normal 1 1 1 begin boost/url/params_base.hpp include/boost/url/params_base.hpp 227 5 1 function rgFjw9W6rMjgEYkGOVMDiLJIIdE= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= heading text Complexity 1 paragraph text Linear in the size of the first param. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return an iterator to the beginning returns text An iterator to the beginning. identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator normal 1 1 buffer boost/url/params_base.hpp include/boost/url/params_base.hpp 178 5 1 function cpczYPJifQzreeaLMlFMrIk8geU= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= paragraph text This function returns the character buffer referenced by the view. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "?first=John&last=Doe" ).params().buffer() == "?first=John&last=Doe" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the referenced character buffer. returns text The buffer. identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 contains boost/url/params_base.hpp include/boost/url/params_base.hpp 275 5 1 function +m1VjI0xtgykFmvRxecqZkXJBNg= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= paragraph text This function examines the parameters in the container to find a match for the specified key. The comparison is performed as if all escaped characters were decoded first. heading text Example 1 code assert( url_view( "?first=John&last=Doe" ).params().contains( "first" ) ); heading text Complexity 1 paragraph text Linear in code text this->buffer().size() text . heading text Exception Safety 1 paragraph text Throws nothing. brief text Return true if a matching key exists returns code text true text if a matching key exists. param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic identifier bool identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core key identifier RATceEbebMWrhFXGkG2RDFi+7WY= ignore_case_param ic {} normal 1 1 count boost/url/params_base.hpp include/boost/url/params_base.hpp 311 5 1 function SUQ73EvVipRYcJ2Sg24T8d60qeQ= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= paragraph text This function examines the parameters in the container to find the number of matches for the specified key. The comparison is performed as if all escaped characters were decoded first. heading text Example 1 code assert( url_view( "?first=John&last=Doe" ).params().count( "first" ) == 1 ); heading text Complexity 1 paragraph text Linear in code text this->buffer().size() text . heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the number of matching keys returns text The number of matching keys. param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core key identifier RATceEbebMWrhFXGkG2RDFi+7WY= ignore_case_param ic {} normal 1 1 empty boost/url/params_base.hpp include/boost/url/params_base.hpp 196 5 1 function VQ4Gk4oWz8OorSDPtJoAWpHsFaI= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= heading text Example 1 code assert( ! url_view( "?key=value" ).params().empty() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return true if there are no params returns code text true text if there are no params. identifier bool normal 1 1 end boost/url/params_base.hpp include/boost/url/params_base.hpp 240 5 1 function NYG2/rgQQuH/CSw2qObuDUB3DYo= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return an iterator to the end returns text An iterator to the end. identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator normal 1 1 find boost/url/params_base.hpp include/boost/url/params_base.hpp 395 5 1 boost/url/params_base.hpp include/boost/url/params_base.hpp 440 5 1 overloads /lfP4NtGxUDEYF5NvxdZQKO226I= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= brief text Find a matching key returns text an iterator to the param param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic param text The position to begin the search from. This can be code text end() text . from normal mSdbytykajruHQy1W8iyrWbbOmM= Q/NxQl0WFzXMzvRmJDH5BghXp5M= identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator find boost/url/params_base.hpp include/boost/url/params_base.hpp 395 5 1 function mSdbytykajruHQy1W8iyrWbbOmM= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= paragraph text This function examines the parameters in the container to find a match for the specified key. The comparison is performed as if all escaped characters were decoded first. paragraph text The search starts from the first param and proceeds forward until either the key is found or the end of the range is reached, in which case code text end() text is returned. heading text Example 1 code assert( (*url_view( "?first=John&last=Doe" ).params().find( "First", ignore_case )).value == "John" ); heading text Effects 1 code return this->find( this->begin(), key, ic ); heading text Complexity 1 paragraph text Linear in code text this->buffer().size() text . brief text Find a matching key returns text an iterator to the param param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core key identifier RATceEbebMWrhFXGkG2RDFi+7WY= ignore_case_param ic {} normal 1 1 find boost/url/params_base.hpp include/boost/url/params_base.hpp 440 5 1 function Q/NxQl0WFzXMzvRmJDH5BghXp5M= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= paragraph text This function examines the parameters in the container to find a match for the specified key. The comparison is performed as if all escaped characters were decoded first. paragraph text The search starts at code text from text and proceeds forward until either the key is found or the end of the range is reached, in which case code text end() text is returned. heading text Example 1 code url_view u( "?First=John&Last=Doe" ); assert( u.params().find( "first" ) != u.params().find( "first", ignore_case ) ); heading text Complexity 1 paragraph text Linear in code text this->buffer().size() text . brief text Find a matching key returns text an iterator to the param param text The position to begin the search from. This can be code text end() text . from param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator from identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core key identifier RATceEbebMWrhFXGkG2RDFi+7WY= ignore_case_param ic {} normal 1 1 find_last boost/url/params_base.hpp include/boost/url/params_base.hpp 481 5 1 boost/url/params_base.hpp include/boost/url/params_base.hpp 527 5 1 overloads S17pkFUExaqRFD9HA5cryLnWVG8= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= brief text Find a matching key returns text an iterator to the param param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic param text One past the position to begin the search from. This can be code text end() text . before normal T7jam5dZRMsS/ZHAEHdP05Fqlug= 2y2ewlvaEuZkWtKX4p7xlBO2wXU= identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator find_last boost/url/params_base.hpp include/boost/url/params_base.hpp 481 5 1 function T7jam5dZRMsS/ZHAEHdP05Fqlug= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= paragraph text This function examines the parameters in the container to find a match for the specified key. The comparison is performed as if all escaped characters were decoded first. paragraph text The search starts from the last param and proceeds backwards until either the key is found or the beginning of the range is reached, in which case code text end() text is returned. heading text Example 1 code assert( (*url_view( "?first=John&last=Doe" ).params().find_last( "last" )).value == "Doe" ); heading text Complexity 1 paragraph text Linear in code text this->buffer().size() text . brief text Find a matching key returns text an iterator to the param param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core key identifier RATceEbebMWrhFXGkG2RDFi+7WY= ignore_case_param ic {} normal 1 1 find_last boost/url/params_base.hpp include/boost/url/params_base.hpp 527 5 1 function 2y2ewlvaEuZkWtKX4p7xlBO2wXU= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= paragraph text This function examines the parameters in the container to find a match for the specified key. The comparison is performed as if all escaped characters were decoded first. paragraph text The search starts prior to code text before text and proceeds backwards until either the key is found or the beginning of the range is reached, in which case code text end() text is returned. heading text Example 1 code url_view u( "?First=John&Last=Doe" ); assert( u.params().find_last( "last" ) != u.params().find_last( "last", ignore_case ) ); heading text Complexity 1 paragraph text Linear in code text this->buffer().size() text . brief text Find a matching key returns text an iterator to the param param text One past the position to begin the search from. This can be code text end() text . before param text The key to match. By default, a case-sensitive comparison is used. key param text An optional parameter. If the value reference ignore_case y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= text is passed here, the comparison is case-insensitive. ic identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator identifier maJcbp53hfhQNovBi8QEK/+HTzw= iterator before identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core key identifier RATceEbebMWrhFXGkG2RDFi+7WY= ignore_case_param ic {} normal 1 1 get_or boost/url/params_base.hpp include/boost/url/params_base.hpp 349 5 1 function GhT3qpAk3WuPisnAoeMMKNguVco= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= paragraph text This convenience function searches for the first parameter matching code text key text and returns its decoded value. If no parameter with the specified key exists, the provided fallback code text value text is returned instead. When the key is found but the parameter has no value, an empty string is returned. heading text Example 1 code url_view u( "/path?first=John&last=Doe" ); assert( u.params().get_or( "first", "n/a" ) == "John" ); assert( u.params().get_or( "missing", "n/a" ) == "n/a" ); heading text Complexity 1 paragraph text Linear in code text this->buffer().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. brief text Return the value for a key or a fallback returns text The decoded value or the fallback. param text The key to match. key param text The fallback string returned when no matching key exists. If this parameter is omitted, an empty string is used. value param text Optional case-insensitive compare indicator. ic identifier UwlFvW1lEI5kSm1M2LJ8livaK7g= string identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core key identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core value {} identifier RATceEbebMWrhFXGkG2RDFi+7WY= ignore_case_param ic {} normal 1 1 size boost/url/params_base.hpp include/boost/url/params_base.hpp 214 5 1 function u/w33vX8w/yA/9Gl176lDHdQs4k= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= heading text Example 1 code assert( url_view( "?key=value").params().size() == 1 ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the number of params returns text The number of params. identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 1 max_size boost/url/params_base.hpp include/boost/url/params_base.hpp 150 5 1 function JAc718f//bzvETv8VNPf4ujJ2G8= regular paRP7A1SOQlKcnfXhxL4FgbVXKs= paragraph text This represents the largest number of characters that are possible in a path, not including any null terminator. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the maximum number of characters possible returns text The maximum number of characters possible. identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 pct_string_view boost/url/pct_string_view.hpp include/boost/url/pct_string_view.hpp 61 1 1 boost/url/pct_string_view.hpp include/boost/url/pct_string_view.hpp 33 1 record t9KlfUmMV/Lq0e5tGD9d/eCq+X0= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text Objects of this type behave like a code text core::string_view text and have the same interface, but offer an additional invariant: they can only be constructed from strings containing valid percent-escapes. paragraph text Attempting construction from a string containing invalid or malformed percent escapes results in an exception. brief text A reference to a valid percent-encoded string class 1 identifier Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= string_view_base identifier 1HiiaUSr2qeoadbVYr8/BZxU47k= grammar M9nrRq55PVZTWigkof7hlGqhSQs= RPNsNnoyHwmywxuPxn4syH3bXek= foZNP6eKrZGgZPs/IKbd+dOnIuM= cmB6LiOLkFK4MPA38l8T4GLupFw= dmpIlMstDzpGYMTB6B+hurB+mqI= v2Dep12IPAm8omMGyr9KHifBXH4= gbVUBvZPpjoSvvOZqK1W2zhI5AQ= 2BMU5wYwVuaXlVqUpJvke+7MMCM= 14arRDIBq/YgI13qmWwvuybUAb4= aECoDgZjoIcUl2uioc0rf6uRMMc= +tfZtqIc5gHEEmeC/8lIgJYq4fI= b0aWgwrT3AK3/HLk/RWi8rRkN5s= GbuFo8xpKkOxheZA4UC8JLNN7Gs= dddK8U41CVXCAcQA8HC6MudTe+4= nQC4Y2i6s+wheRlt1v5rJGHNugs= GPSBm+5EDtUTksx88cke1u+q9fA= EZ1FqJVEv6ucG/n1Wsn17g4MDuU= xhLRk2Z+3lJ0NKV/ZzG0ObdE4Vc= Rx+0KJ+TNUnikAkigK/WTETroXU= ZQTFPUvg322n/q0ZtEZm5OZSVFo= p3EjAR6gAGOc4ePB1QhYlzBbVGI= MQMMmX8IqIdfOm6FYDjZZidJvfc= xeK5f2DKhD4FxCGyXOyhullgYmo= 1CpIQ/DMUJBo1D7302C0yEQZuOs= HTcdnV1aiZerjYE3I6KR5Gq7cf0= HSnuV2919VtfLkMNB4i+t2rX6Bg= JM9rOXKY3LqUNykMVeHmSVOS3NY= OzkudhIJlNyjV0TJmLlM1RnFEVc= lnRLWv5zOOX26+6Kh57i38FcfZk= ngMWx8vbRDOd+QVk+vT2HVNj0j8= 6M2F7eR7W7DJYZJvn1ZsFaCUVzA= GyHF3a0RLJoX69ClpJOiy0xBfKs= R9sQCgYBOMnFuaSY8pJOuErwM/o= PkLaqlX95/D18ZgPiZCiz/mPUmQ= sSd4hgvdFuzpE/2bJtwpG243Apo= GCtLfDBN/T6snyktUaiy6XEF9z0= Hl4C4fbIugV95gCntPCSc1vWBh0= Qyt6qjjrJx0hZ8PQ6zdSAvGHKvU= Q//o6vK16OmfxdQKesNHjMao4iU= QIbw5G83o636lENHQxQpoEKN6kE= 8YWsfJWY2hTYjFk9Llyg3aJV1hk= L0f4ee/wt58Mb/deFLDyLlyfVGY= RdDaHzncr8vavW/PrNUWQxSXPY4= W3vU/KpFnzLZaPl+o/8Hqt7NAJE= XdOsrY6qbLFskpkyLJ49siyex04= Lf2XYnjs3fR1j0dD8fAs04J7YLw= mRqi8IZOOX0xLFHe28WQ8Zwvmkg= sJGvEZ7xbZT0H6u3eUl29JbXZxU= bRcyVQ6ZJghIfxH913mNeaUsZuo= 6BCCiqqFBnxfN5d9Ki/oUcu88Ic= axqsst2fEEr0KskCuLNS6wtH26E= aIJpv/jZ2tM+tFNkNsdGXClHwE0= y5e2cWu7aRkl+6aRLABfP+waghM= j2zlfB2FMKW7UWEt2w+csPbI5o4= mgIS/AfQlcgKNFKOdLRtjihgyFk= const_iterator boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 111 5 1 typedef M9nrRq55PVZTWigkof7hlGqhSQs= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text The const iterator type 1 identifier char const_pointer boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 105 5 1 typedef RPNsNnoyHwmywxuPxn4syH3bXek= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text The const pointer type 1 identifier char const_reference boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 109 5 1 typedef foZNP6eKrZGgZPs/IKbd+dOnIuM= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text The const reference type 1 identifier char const_reverse_iterator boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 115 5 1 typedef cmB6LiOLkFK4MPA38l8T4GLupFw= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text The const reverse iterator type specialization Obj4HqXdPXV9H/4fRgvui4KiGdk= reverse_iterator identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std difference_type boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 122 5 1 typedef dmpIlMstDzpGYMTB6B+hurB+mqI= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text The difference type identifier EH4n8sIj03HafoTNn2U36T1P+Hc= ptrdiff_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std iterator boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 113 5 1 typedef v2Dep12IPAm8omMGyr9KHifBXH4= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text The iterator type identifier M9nrRq55PVZTWigkof7hlGqhSQs= const_iterator pointer boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 103 5 1 typedef gbVUBvZPpjoSvvOZqK1W2zhI5AQ= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text The pointer type identifier char reference boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 107 5 1 typedef 2BMU5wYwVuaXlVqUpJvke+7MMCM= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text The reference type identifier char reverse_iterator boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 118 5 1 typedef 14arRDIBq/YgI13qmWwvuybUAb4= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text The reverse iterator type identifier cmB6LiOLkFK4MPA38l8T4GLupFw= const_reverse_iterator size_type boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 120 5 1 typedef aECoDgZjoIcUl2uioc0rf6uRMMc= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text The size type identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std traits_type boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 99 5 1 typedef +tfZtqIc5gHEEmeC/8lIgJYq4fI= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text The character traits specialization char_traits identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std value_type boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 101 5 1 typedef b0aWgwrT3AK3/HLk/RWi8rRkN5s= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text The value type identifier char pct_string_view boost/url/pct_string_view.hpp include/boost/url/pct_string_view.hpp 107 5 1 boost/url/pct_string_view.hpp include/boost/url/pct_string_view.hpp 234 5 1 overloads GbuFo8xpKkOxheZA4UC8JLNN7Gs= regular t9KlfUmMV/Lq0e5tGD9d/eCq+X0= brief text Constructors param text The string to copy. other param text The string to construct from. s param text The length of the string. len t-param text A type convertible to code text core::string_view String throws text The string contains an invalid percent encoding. reference system_error constructor B6Omwxmd0wianQ380vWy5MdjNts= euJlgcXggZOXAlj/OvtBHJgYqn0= /Sh3kVH8IVM06SmpUPKbuhH95Ow= 1KDDiQ2XilO7xEpMYQgZaEIGskk= xyCBNcYnTeX12QksdJSVLghVR0U= Zn3qeFQJ1firhr2kTuPXqYDst7U= identifier void pct_string_view boost/url/pct_string_view.hpp include/boost/url/pct_string_view.hpp 107 5 1 function B6Omwxmd0wianQ380vWy5MdjNts= regular t9KlfUmMV/Lq0e5tGD9d/eCq+X0= paragraph text Default constructed string are empty. heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Constructor identifier void constructor 1 1 1 pct_string_view boost/url/pct_string_view.hpp include/boost/url/pct_string_view.hpp 129 5 1 function euJlgcXggZOXAlj/OvtBHJgYqn0= regular t9KlfUmMV/Lq0e5tGD9d/eCq+X0= paragraph text The copy references the same underlying character buffer. Ownership is not transferred. heading text Postconditions 1 code this->data() == other.data() heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Constructor param text The string to copy. other identifier void 1 identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view other constructor 1 1 1 pct_string_view boost/url/pct_string_view.hpp include/boost/url/pct_string_view.hpp 177 5 1 function /Sh3kVH8IVM06SmpUPKbuhH95Ow= regular t9KlfUmMV/Lq0e5tGD9d/eCq+X0= brief text Constructor (deleted) param text The object to construct from value identifier void identifier sglnAAn3Uh63NjGq0A1qyc9lE+k= nullptr_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std value constructor 1 1 1 pct_string_view boost/url/pct_string_view.hpp include/boost/url/pct_string_view.hpp 234 5 1 function 1KDDiQ2XilO7xEpMYQgZaEIGskk= regular t9KlfUmMV/Lq0e5tGD9d/eCq+X0= paragraph text The newly constructed string references the specified character buffer. Ownership is not transferred. heading text Postconditions 1 code this->data() == s.data() && this->size() == s.size() heading text Complexity 1 paragraph text Linear in code text s.size() text . heading text Exception Safety 1 paragraph text Exceptions thrown on invalid input. brief text Constructor param text The string to construct from. s throws text The string contains an invalid percent encoding. reference system_error identifier void identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s constructor 1 pct_string_view boost/url/pct_string_view.hpp include/boost/url/pct_string_view.hpp 157 5 1 function xyCBNcYnTeX12QksdJSVLghVR0U= regular t9KlfUmMV/Lq0e5tGD9d/eCq+X0= paragraph text The newly constructed string references the specified character buffer. Ownership is not transferred. heading text Postconditions 1 code this->data() == core::string_view(s).data() heading text Complexity 1 paragraph text Linear in code text core::string_view(s).size() text . heading text Exception Safety 1 paragraph text Exceptions thrown on invalid input. brief text Constructor param text The string to construct from. s t-param text A type convertible to code text core::string_view String throws text The string contains an invalid percent encoding. reference system_error identifier void 1 identifier String s constructor 1 pct_string_view boost/url/pct_string_view.hpp include/boost/url/pct_string_view.hpp 203 5 1 function Zn3qeFQJ1firhr2kTuPXqYDst7U= regular t9KlfUmMV/Lq0e5tGD9d/eCq+X0= paragraph text The newly constructed string references the specified character buffer. Ownership is not transferred. heading text Postconditions 1 code this->data() == s && this->size() == len heading text Complexity 1 paragraph text Linear in code text len text . heading text Exception Safety 1 paragraph text Exceptions thrown on invalid input. brief text Constructor param text The string to construct from. s param text The length of the string. len throws text The string contains an invalid percent encoding. reference system_error identifier void 1 identifier char s identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std len constructor 1 operator= boost/url/pct_string_view.hpp include/boost/url/pct_string_view.hpp 257 5 1 function dddK8U41CVXCAcQA8HC6MudTe+4= regular t9KlfUmMV/Lq0e5tGD9d/eCq+X0= paragraph text The copy references the same underlying character buffer. Ownership is not transferred. heading text Postconditions 1 code this->data() == other.data() heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Assignment returns text A reference to this object. param text The string to copy. other identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view 1 identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view other normal 1 1 1 at boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 331 5 1 function nQC4Y2i6s+wheRlt1v5rJGHNugs= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::at brief text Access a character returns text The character at the position param text The position to access pos identifier foZNP6eKrZGgZPs/IKbd+dOnIuM= const_reference identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos normal 1 1 back boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 355 5 1 function GPSBm+5EDtUTksx88cke1u+q9fA= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::back brief text Return the last character returns text The last character identifier foZNP6eKrZGgZPs/IKbd+dOnIuM= const_reference normal 1 1 begin boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 177 5 1 function EZ1FqJVEv6ucG/n1Wsn17g4MDuU= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::begin brief text Return an iterator to the beginning returns text An iterator to the beginning identifier M9nrRq55PVZTWigkof7hlGqhSQs= const_iterator normal 1 1 cbegin boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 199 5 1 function xhLRk2Z+3lJ0NKV/ZzG0ObdE4Vc= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::cbegin brief text Return an iterator to the beginning returns text An iterator to the beginning identifier M9nrRq55PVZTWigkof7hlGqhSQs= const_iterator normal 1 1 cend boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 210 5 1 function Rx+0KJ+TNUnikAkigK/WTETroXU= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::cend brief text Return an iterator to the end returns text An iterator to the end identifier M9nrRq55PVZTWigkof7hlGqhSQs= const_iterator normal 1 1 compare boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 413 5 1 overloads ZQTFPUvg322n/q0ZtEZm5OZSVFo= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text Return the result of comparing to another string returns text The result of the comparison param text The string to compare str param text The string to compare s param text The position to start comparing from pos1 param text The number of characters to compare n1 param text The number of characters to compare n2 param text The position to start comparing from pos2 normal IRvtO34ISMkRvDCtGybUVmg7Mpw= cNRLSdfTDXzapcGN7U2pkhe09u8= p84tStAnLdfQHeETDgnjtJoYiqE= sURljmP39tfuj1ZZWF8Ttf48S6k= wZOXO+R6A3OjQdJiNoaXo0DPlaE= 4gqP5TnZo4twWHg6MUkJBPf8gqo= identifier int compare boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 413 5 1 function IRvtO34ISMkRvDCtGybUVmg7Mpw= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::compare brief text Return the result of comparing to another string returns text The result of the comparison param text The string to compare str identifier int identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core str normal 1 1 compare boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 459 5 1 function cNRLSdfTDXzapcGN7U2pkhe09u8= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::compare brief text Return the result of comparing to another string returns text The result of the comparison param text The string to compare s identifier int 1 identifier char s normal 1 1 compare boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 428 5 1 function p84tStAnLdfQHeETDgnjtJoYiqE= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::compare brief text Return the result of comparing to another string returns text The result of the comparison param text The position to start comparing from pos1 param text The number of characters to compare n1 param text The string to compare str identifier int identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos1 identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type n1 identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core str normal 1 1 compare boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 474 5 1 function sURljmP39tfuj1ZZWF8Ttf48S6k= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::compare brief text Return the result of comparing to another string returns text The result of the comparison param text The position to start comparing from pos1 param text The number of characters to compare n1 param text The string to compare s identifier int identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos1 identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type n1 1 identifier char s normal 1 1 compare boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 490 5 1 function wZOXO+R6A3OjQdJiNoaXo0DPlaE= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::compare brief text Return the result of comparing to another string returns text The result of the comparison param text The position to start comparing from pos1 param text The number of characters to compare n1 param text The string to compare s param text The number of characters to compare n2 identifier int identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos1 identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type n1 1 identifier char s identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type n2 normal 1 1 compare boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 445 5 1 function 4gqP5TnZo4twWHg6MUkJBPf8gqo= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::compare brief text Return the result of comparing to another string returns text The result of the comparison param text The position to start comparing from pos1 param text The number of characters to compare n1 param text The string to compare str param text The position to start comparing from pos2 param text The number of characters to compare n2 identifier int identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos1 identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type n1 identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core str identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos2 identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type n2 normal 1 1 contains boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 942 5 1 overloads p3EjAR6gAGOc4ePB1QhYlzBbVGI= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text Return true if matching characters are found returns code text true text if the string contains the character, otherwise code text false returns code text true text if the string contains the characters, otherwise code text false param text The character to search for c param text The string to search for sv param text The string to search for s normal SANFmu7YhW7sQVghxqUDA0HYZXU= hKoap9FjP5AWE6/DO69KvjFf2GY= MV82Q9BS0ywf/roJrND9qK4OSDk= identifier bool contains boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 954 5 1 function SANFmu7YhW7sQVghxqUDA0HYZXU= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::contains brief text Return true if matching characters are found returns code text true text if the string contains the character, otherwise code text false param text The character to search for c identifier bool identifier char c normal 1 1 contains boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 942 5 1 function hKoap9FjP5AWE6/DO69KvjFf2GY= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::contains brief text Return true if matching characters are found returns code text true text if the string contains the characters, otherwise code text false param text The string to search for sv identifier bool identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core sv normal 1 1 contains boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 966 5 1 function MV82Q9BS0ywf/roJrND9qK4OSDk= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::contains brief text Return true if matching characters are found returns code text true text if the string contains the characters, otherwise code text false param text The string to search for s identifier bool 1 identifier char s normal 1 1 copy boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 384 5 1 function MQMMmX8IqIdfOm6FYDjZZidJvfc= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::copy brief text Copy the characters to another buffer returns text The number of characters copied param text The destination buffer s param text The number of characters to copy n param text The position to start from pos identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type identifier char s identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type n identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos 0 normal 1 1 crbegin boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 245 5 1 function xeK5f2DKhD4FxCGyXOyhullgYmo= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::crbegin brief text Return a reverse iterator to the end returns text A reverse iterator to the end identifier cmB6LiOLkFK4MPA38l8T4GLupFw= const_reverse_iterator normal 1 1 crend boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 257 5 1 function 1CpIQ/DMUJBo1D7302C0yEQZuOs= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::crend brief text Return a reverse iterator to the beginning returns text A reverse iterator to the beginning identifier cmB6LiOLkFK4MPA38l8T4GLupFw= const_reverse_iterator normal 1 1 data boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 367 5 1 function HTcdnV1aiZerjYE3I6KR5Gq7cf0= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::data brief text Return a pointer to the character buffer returns text A pointer to the character buffer identifier RPNsNnoyHwmywxuPxn4syH3bXek= const_pointer normal 1 1 decode boost/url/pct_string_view.hpp include/boost/url/pct_string_view.hpp 345 5 1 function HSnuV2919VtfLkMNB4i+t2rX6Bg= regular t9KlfUmMV/Lq0e5tGD9d/eCq+X0= paragraph text This function converts percent escapes in the string into ordinary characters and returns the result. When called with no arguments, the return type is code text std::string text . Otherwise, the return type and style of output is determined by which string token is passed. heading text Example 1 code assert( pct_string_view( "Program%20Files" ).decode() == "Program Files" ); heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. String tokens may throw exceptions. brief text Return the string with percent-decoding returns text The decoded string. param text The options for encoding. If this parameter is omitted, the default options are used. opt param text An optional string token. If this parameter is omitted, then a new code text std::string text is returned. Otherwise, the function return type is the result type of the token. token see reference encoding_opts Bb04pNwExynJkzlY9a9GCeeB13k= text , reference string_token::return_string +eBzDECNPyuTkJuxLUTMVIkHGO0= text . identifier result_type identifier StringToken identifier Bb04pNwExynJkzlY9a9GCeeB13k= encoding_opts opt {} identifier StringToken token normal 1 1 decoded_size boost/url/pct_string_view.hpp include/boost/url/pct_string_view.hpp 283 5 1 function JM9rOXKY3LqUNykMVeHmSVOS3NY= regular t9KlfUmMV/Lq0e5tGD9d/eCq+X0= paragraph text This function returns the number of characters in the resulting string if percent escapes were converted into ordinary characters. heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the decoded size returns text The number of characters in the decoded string. identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 1 empty boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 304 5 1 function OzkudhIJlNyjV0TJmLlM1RnFEVc= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::size brief text Return true if the string is empty returns code text true text if the string is empty identifier bool normal 1 1 end boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 188 5 1 function lnRLWv5zOOX26+6Kh57i38FcfZk= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::end brief text Return an iterator to the end returns text An iterator to the end identifier M9nrRq55PVZTWigkof7hlGqhSQs= const_iterator normal 1 1 ends_with boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 547 5 1 overloads ngMWx8vbRDOd+QVk+vT2HVNj0j8= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text Return true if a matching suffix exists returns code text true text if the suffix matches param text The character to search for x normal bqqpptdDDphYcnOxoQYZ8bbItrM= qZO0HQe8HcXAyHXcIQg/g3k7/ns= zfWvE3uSkk8/XX+XPIVSaZzh6Ig= identifier bool ends_with boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 560 5 1 function bqqpptdDDphYcnOxoQYZ8bbItrM= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::ends_with brief text Return true if a matching suffix exists returns code text true text if the suffix matches param text The character to search for x identifier bool identifier char x normal 1 1 ends_with boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 547 5 1 function qZO0HQe8HcXAyHXcIQg/g3k7/ns= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::ends_with brief text Return true if a matching suffix exists returns code text true text if the suffix matches param text The string to search for x identifier bool identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core x normal 1 1 ends_with boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 573 5 1 function zfWvE3uSkk8/XX+XPIVSaZzh6Ig= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::ends_with brief text Return true if a matching suffix exists returns code text true text if the suffix matches param text The string to search for x identifier bool 1 identifier char x normal 1 1 find boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 589 5 1 overloads 6M2F7eR7W7DJYZJvn1ZsFaCUVzA= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text Return the position of matching characters returns text The position of the first match param text The character to search for c param text The position to start searching from pos param text The characters to search for str param text The characters to search for s param text The number of characters to search for n normal BOuO0aTf73DXdcvqk1MTaHMpXbo= 2lfO3WOzLvG1bfwozRhCmBlrqrg= xo8geXuOyX+q7RM3qua7kwLktr0= dia+zPAAu3luYQToXoYd7W8/Wic= identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type find boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 603 5 1 function BOuO0aTf73DXdcvqk1MTaHMpXbo= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::find brief text Return the position of matching characters returns text The position of the first match param text The character to search for c param text The position to start searching from pos identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type identifier char c identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos 0 normal 1 1 find boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 589 5 1 function 2lfO3WOzLvG1bfwozRhCmBlrqrg= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::find brief text Return the position of matching characters returns text The position of the first match param text The characters to search for str param text The position to start searching from pos identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core str identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos 0 normal 1 1 find boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 632 5 1 function xo8geXuOyX+q7RM3qua7kwLktr0= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::find brief text Return the position of matching characters returns text The position of the first match param text The characters to search for s param text The position to start searching from pos identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type 1 identifier char s identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos 0 normal 1 1 find boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 618 5 1 function dia+zPAAu3luYQToXoYd7W8/Wic= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::find brief text Return the position of matching characters returns text The position of the first match param text The characters to search for s param text The position to start searching from pos param text The number of characters to search for n identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type 1 identifier char s identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type n normal 1 1 find_first_not_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 825 5 1 overloads GyHF3a0RLJoX69ClpJOiy0xBfKs= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text Return the position of the first non-match returns text The position of the first non-match param text The character to search for c param text The position to start searching from pos param text The characters to search for str param text The characters to search for s param text The number of characters to search for n normal IfcO4L0ztTwJMGHApS0AToDt5Aw= 5d938wswt4edetpV8UL9bD5KDc4= wmKQqbOIrZmJ/7Cp7VJTFNavoow= qeiTNiB98fApJrmQcyF37NoW9j4= identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type find_first_not_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 839 5 1 function IfcO4L0ztTwJMGHApS0AToDt5Aw= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::find_first_not_of brief text Return the position of the first non-match returns text The position of the first non-match param text The character to search for c param text The position to start searching from pos identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type identifier char c identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos 0 normal 1 1 find_first_not_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 825 5 1 function 5d938wswt4edetpV8UL9bD5KDc4= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::find_first_not_of brief text Return the position of the first non-match returns text The position of the first non-match param text The characters to search for str param text The position to start searching from pos identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core str identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos 0 normal 1 1 find_first_not_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 868 5 1 function wmKQqbOIrZmJ/7Cp7VJTFNavoow= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::find_first_not_of brief text Return the position of the first non-match returns text The position of the first non-match param text The characters to search for s param text The position to start searching from pos identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type 1 identifier char s identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos 0 normal 1 1 find_first_not_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 854 5 1 function qeiTNiB98fApJrmQcyF37NoW9j4= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::find_first_not_of brief text Return the position of the first non-match returns text The position of the first non-match param text The characters to search for s param text The position to start searching from pos param text The number of characters to search for n identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type 1 identifier char s identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type n normal 1 1 find_first_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 707 5 1 overloads R9sQCgYBOMnFuaSY8pJOuErwM/o= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text Return the position of the first match returns text The position of the first match param text The character to search for c param text The position to start searching from pos param text The characters to search for str param text The characters to search for s param text The number of characters to search for n normal TcE6uiDkICSzkegC9lzTM87jwlo= q7omXr2uqTr3v1fJVzA94fhapvE= iz2GUCM611IYR/kjQB79q1n872g= r4kUkL0YV/fA06QtJmR/TjXUtao= identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type find_first_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 721 5 1 function TcE6uiDkICSzkegC9lzTM87jwlo= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::find_first_of brief text Return the position of the first match returns text The position of the first match param text The character to search for c param text The position to start searching from pos identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type identifier char c identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos 0 normal 1 1 find_first_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 707 5 1 function q7omXr2uqTr3v1fJVzA94fhapvE= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::find_first_of brief text Return the position of the first match returns text The position of the first match param text The characters to search for str param text The position to start searching from pos identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core str identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos 0 normal 1 1 find_first_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 750 5 1 function iz2GUCM611IYR/kjQB79q1n872g= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::find_first_of brief text Return the position of the first match returns text The position of the first match param text The characters to search for s param text The position to start searching from pos identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type 1 identifier char s identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos 0 normal 1 1 find_first_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 736 5 1 function r4kUkL0YV/fA06QtJmR/TjXUtao= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::find_first_of brief text Return the position of the first match returns text The position of the first match param text The characters to search for s param text The position to start searching from pos param text The number of characters to search for n identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type 1 identifier char s identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type n normal 1 1 find_last_not_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 884 5 1 overloads PkLaqlX95/D18ZgPiZCiz/mPUmQ= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text Return the position of the last non-match returns text The position of the last non-match param text The character to search for c param text The position to start searching from pos param text The characters to search for str param text The characters to search for s param text The number of characters to search for n normal 2AMMYo3v1gttHFufhYHieIj8bdI= Nfr+v2bpMFyORAQhtwLZ5J432w4= ZPpivnq8JwObb7gqwj6DDXtVLJA= Gu5ADf/dTdCmnisbu/DaC5FtlDQ= identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type find_last_not_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 898 5 1 function 2AMMYo3v1gttHFufhYHieIj8bdI= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::find_last_not_of brief text Return the position of the last non-match returns text The position of the last non-match param text The character to search for c param text The position to start searching from pos identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type identifier char c identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos core::string_view::npos normal 1 1 find_last_not_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 884 5 1 function Nfr+v2bpMFyORAQhtwLZ5J432w4= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::find_last_not_of brief text Return the position of the last non-match returns text The position of the last non-match param text The characters to search for str param text The position to start searching from pos identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core str identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos core::string_view::npos normal 1 1 find_last_not_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 927 5 1 function ZPpivnq8JwObb7gqwj6DDXtVLJA= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::find_last_not_of brief text Return the position of the last non-match returns text The position of the last non-match param text The characters to search for s param text The position to start searching from pos identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type 1 identifier char s identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos core::string_view::npos normal 1 1 find_last_not_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 913 5 1 function Gu5ADf/dTdCmnisbu/DaC5FtlDQ= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::find_last_not_of brief text Return the position of the last non-match returns text The position of the last non-match param text The characters to search for s param text The position to start searching from pos param text The number of characters to search for n identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type 1 identifier char s identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type n normal 1 1 find_last_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 766 5 1 overloads sSd4hgvdFuzpE/2bJtwpG243Apo= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text Return the position of the last match returns text The position of the last match param text The character to search for c param text The position to start searching from pos param text The characters to search for str param text The characters to search for s param text The number of characters to search for n normal x9U9ssyIOQKxLkWfX/TBjJwL3gg= AZeST6eCw9rmQ9mUiVCMY8YyfjU= j10zGQ8rw2lMRMG+TCKNGInKHK4= IIJbBmNRXB9cDV2Hodq45rXi+QY= identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type find_last_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 780 5 1 function x9U9ssyIOQKxLkWfX/TBjJwL3gg= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::find_last_of brief text Return the position of the last match returns text The position of the last match param text The character to search for c param text The position to start searching from pos identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type identifier char c identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos core::string_view::npos normal 1 1 find_last_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 766 5 1 function AZeST6eCw9rmQ9mUiVCMY8YyfjU= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::find_last_of brief text Return the position of the last match returns text The position of the last match param text The characters to search for str param text The position to start searching from pos identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core str identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos core::string_view::npos normal 1 1 find_last_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 809 5 1 function j10zGQ8rw2lMRMG+TCKNGInKHK4= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::find_last_of brief text Return the position of the last match returns text The position of the last match param text The characters to search for s param text The position to start searching from pos identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type 1 identifier char s identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos core::string_view::npos normal 1 1 find_last_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 795 5 1 function IIJbBmNRXB9cDV2Hodq45rXi+QY= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::find_last_of brief text Return the position of the last match returns text The position of the last match param text The characters to search for s param text The position to start searching from pos param text The number of characters to search for n identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type 1 identifier char s identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type n normal 1 1 front boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 343 5 1 function GCtLfDBN/T6snyktUaiy6XEF9z0= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::front brief text Return the first character returns text The first character identifier foZNP6eKrZGgZPs/IKbd+dOnIuM= const_reference normal 1 1 length boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 282 5 1 function Hl4C4fbIugV95gCntPCSc1vWBh0= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::length brief text Return the size returns text The size identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type normal 1 1 max_size boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 293 5 1 function Qyt6qjjrJx0hZ8PQ6zdSAvGHKvU= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::max_size brief text Return the maximum allowed size returns text The maximum allowed size identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type normal 1 1 operator* boost/url/decode_view.hpp include/boost/url/decode_view.hpp 1052 1 boost/url/pct_string_view.hpp include/boost/url/pct_string_view.hpp 303 5 1 function Q//o6vK16OmfxdQKesNHjMao4iU= regular t9KlfUmMV/Lq0e5tGD9d/eCq+X0= heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the string as a range of decoded characters returns text A range of decoded characters. see reference decode_view IhE/V16b2wBX2q+s4QtlgzozWlQ= text . identifier IhE/V16b2wBX2q+s4QtlgzozWlQ= decode_view normal 1 1 operator-> boost/url/pct_string_view.hpp include/boost/url/pct_string_view.hpp 370 5 1 function QIbw5G83o636lENHQxQpoEKN6kE= regular t9KlfUmMV/Lq0e5tGD9d/eCq+X0= brief text Arrow support returns text A pointer to this object. 1 identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 operator[] boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 318 5 1 function 8YWsfJWY2hTYjFk9Llyg3aJV1hk= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::operator[] brief text Access a character returns text The character at the position param text The position to access pos identifier foZNP6eKrZGgZPs/IKbd+dOnIuM= const_reference identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos normal 1 1 rbegin boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 221 5 1 function L0f4ee/wt58Mb/deFLDyLlyfVGY= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::rbegin brief text Return a reverse iterator to the end returns text A reverse iterator to the end identifier cmB6LiOLkFK4MPA38l8T4GLupFw= const_reverse_iterator normal 1 1 rend boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 233 5 1 function RdDaHzncr8vavW/PrNUWQxSXPY4= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::rend brief text Return a reverse iterator to the beginning returns text A reverse iterator to the beginning identifier cmB6LiOLkFK4MPA38l8T4GLupFw= const_reverse_iterator normal 1 1 rfind boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 648 5 1 overloads W3vU/KpFnzLZaPl+o/8Hqt7NAJE= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text Return the position of matching characters returns text The position of the first match param text The character to search for c param text The position to start searching from pos param text The characters to search for str param text The characters to search for s param text The number of characters to search for n normal 67zrufCp4NocNFW+MQmW2AZJHKM= 7eScYOCz/vJ9fpDMMotM0+I8qOE= 18WfSjD0IUf2RSlBRXtH9ZUGgpE= u8pQymbEkfioZr0NHqfpMpKZWho= identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type rfind boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 662 5 1 function 67zrufCp4NocNFW+MQmW2AZJHKM= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::rfind brief text Return the position of matching characters returns text The position of the first match param text The character to search for c param text The position to start searching from pos identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type identifier char c identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos core::string_view::npos normal 1 1 rfind boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 648 5 1 function 7eScYOCz/vJ9fpDMMotM0+I8qOE= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::rfind brief text Return the position of matching characters returns text The position of the first match param text The characters to search for str param text The position to start searching from pos identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core str identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos core::string_view::npos normal 1 1 rfind boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 691 5 1 function 18WfSjD0IUf2RSlBRXtH9ZUGgpE= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::rfind brief text Return the position of matching characters returns text The position of the first match param text The characters to search for s param text The position to start searching from pos identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type 1 identifier char s identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos core::string_view::npos normal 1 1 rfind boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 677 5 1 function u8pQymbEkfioZr0NHqfpMpKZWho= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::rfind brief text Return the position of matching characters returns text The position of the first match param text The characters to search for s param text The position to start searching from pos param text The number of characters to search for n identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type 1 identifier char s identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type n normal 1 1 size boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 271 5 1 function XdOsrY6qbLFskpkyLJ49siyex04= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::size brief text Return the size returns text The size identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type normal 1 1 starts_with boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 506 5 1 overloads Lf2XYnjs3fR1j0dD8fAs04J7YLw= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text Return true if a matching prefix exists returns code text true text if the prefix matches param text The character to search for x normal v3qqifP7Un5JkmpKk4TtAxbqINc= b1zBGpDL1DMowpruv731stD3Vgw= 1Y9DRmbXN1J7HNFxFNed/jYhRcs= identifier bool starts_with boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 519 5 1 function v3qqifP7Un5JkmpKk4TtAxbqINc= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::starts_with brief text Return true if a matching prefix exists returns code text true text if the prefix matches param text The character to search for x identifier bool identifier char x normal 1 1 starts_with boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 506 5 1 function b1zBGpDL1DMowpruv731stD3Vgw= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::starts_with brief text Return true if a matching prefix exists returns code text true text if the prefix matches param text The string to search for x identifier bool identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core x normal 1 1 starts_with boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 532 5 1 function 1Y9DRmbXN1J7HNFxFNed/jYhRcs= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::starts_with brief text Return true if a matching prefix exists returns code text true text if the prefix matches param text The string to search for x identifier bool 1 identifier char x normal 1 1 substr boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 398 5 1 function mRqi8IZOOX0xLFHe28WQ8Zwvmkg= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text See code text core::string_view::substr brief text Return a view to part of the string returns text A view to the substring param text The position to start from pos param text The number of characters n identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type pos 0 identifier aECoDgZjoIcUl2uioc0rf6uRMMc= size_type n core::string_view::npos normal 1 1 swap boost/url/pct_string_view.hpp include/boost/url/pct_string_view.hpp 384 31 1 function sJGvEZ7xbZT0H6u3eUl29JbXZxU= regular t9KlfUmMV/Lq0e5tGD9d/eCq+X0= brief text Swap param text The object to swap with s identifier void identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view s normal 1 operator basic_string<char> boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 160 5 1 function bRcyVQ6ZJghIfxH913mNeaUsZuo= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= paragraph text Conversion to std::string is explicit because assigning to string using an implicit constructor does not preserve capacity. brief text Conversion returns text A string with the same contents identifier UwlFvW1lEI5kSm1M2LJ8livaK7g= string identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std conversion 1 1 operator basic_string_view<char> boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 133 5 1 function 6BCCiqqFBnxfN5d9Ki/oUcu88Ic= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text Conversion returns text A string view with the same contents identifier o9e6TyaeiKXWYT1zlEtJwrwdZys= string_view identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std conversion 1 1 npos boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 125 5 1 variable axqsst2fEEr0KskCuLNS6wtH26E= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text A constant used to represent "no position" identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std core::string_view::npos 1 1 operator= boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 94 5 1 function aIJpv/jZ2tM+tFNkNsdGXClHwE0= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text Assignment returns text A reference to this object param text The object to assign other identifier Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= string_view_base 1 identifier Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= string_view_base other normal 1 1 1 swap boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 73 5 1 function y5e2cWu7aRkl+6aRLABfP+waghM= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text Swap param text The object to swap with s identifier void identifier Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= string_view_base s normal 1 s_ boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 41 5 1 variable j2zlfB2FMKW7UWEt2w+csPbI5o4= regular Y1nkEDuKr1UIyB9Ya2bXvHYVwIY= brief text The referenced character buffer identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core 1 segments_base boost/url/segments_base.hpp include/boost/url/segments_base.hpp 38 1 1 record ge9cOBTN19ywbVTnB5ajdJUC46Q= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text Provides the shared decoded path-segment algorithms (iteration, lookup, comparison) used by reference segments_view ZNJOLZ4RhCB2A2ooiNo7KxZJHrA= text and reference segments_ref zdr3gU7+2/G05oo6ta/IfHlkTF0= text . This base cannot be instantiated directly; instead, use one of the concrete containers below. heading text Containers 1 list paragraph reference segments_ref zdr3gU7+2/G05oo6ta/IfHlkTF0= paragraph reference segments_view ZNJOLZ4RhCB2A2ooiNo7KxZJHrA= paragraph reference segments_encoded_ref TCUUfRiqZjX62kt7tK2fs//VWr0= paragraph reference segments_encoded_view EvaX3SmNTAtai2Kf6Kma3fUkTkQ= unordered brief text Decoded path segment helper base class zdr3gU7+2/G05oo6ta/IfHlkTF0= ZNJOLZ4RhCB2A2ooiNo7KxZJHrA= 0tGsE1R1TOpKN9IAKzyNn7msre4= IwhREgq3doOt5R+7CpjDu5HXeJc= ZGzGSpAZlXL0sCedyhjsT90U4S0= yenFqEfqqK2NrZ+2hs1Il0Gkg/Q= q0c7sMK+HhivONBaUVBcT+YLGYQ= 28sEF1YglFKmk+Kcl4ymHBd02MI= v0DfmyG7n+onJnPwu0SmkmEIIs4= SiUbAVvbiztqJmIoYwdvkoQyi90= RJFHEvDTVOSBEWC5A/qqcBSNc14= v5AF2vYTekOYGThG7Nle0P0fwU4= Bkl327dG/7JY0gyN644pnPkCyj0= oBgrqTEOKSIfUQVCZCwbVHu9pe4= EZ3AwpJPJ+eUXoULAfCVAA57yQU= G6s0M4MqJFqoPBxyx/2YT3jn4W8= yBM8jUZ7lUhztKUrKAMCVlF/JSM= 4eJ21Hl5fc2lKip4HsTT2daKD58= uAUbzlVhUasixfJbpN9gJ0pp30c= 7dQCY1O3aZfzX5qE3KL5ZtTh2D0= jhuGLBQJh2F3/mRS6fQhraC0fVI= identifier ZNJOLZ4RhCB2A2ooiNo7KxZJHrA= segments_view ZNJOLZ4RhCB2A2ooiNo7KxZJHrA= identifier zdr3gU7+2/G05oo6ta/IfHlkTF0= segments_ref zdr3gU7+2/G05oo6ta/IfHlkTF0= identifier UEVNhDEjkZMXfjN1DxbtX0n2rCg= url_view_base UEVNhDEjkZMXfjN1DxbtX0n2rCg= const_iterator boost/url/segments_base.hpp include/boost/url/segments_base.hpp 77 5 1 typedef 0tGsE1R1TOpKN9IAKzyNn7msre4= regular ge9cOBTN19ywbVTnB5ajdJUC46Q= paragraph text Objects of this type allow iteration through the segments in the path. Any percent-escapes in returned strings are decoded first. The values returned are read-only; changes to segments must be made through the container instead, if the container supports modification. paragraph text The strings produced when iterators are dereferenced belong to the iterator and become invalidated when that particular iterator is incremented, decremented, or destroyed. brief text A Bidirectional iterator to a path segment iterator identifier v0DfmyG7n+onJnPwu0SmkmEIIs4= iterator 1 const_reference boost/url/segments_base.hpp include/boost/url/segments_base.hpp 100 5 1 typedef IwhREgq3doOt5R+7CpjDu5HXeJc= regular ge9cOBTN19ywbVTnB5ajdJUC46Q= paragraph text This is the type of value returned when iterators of the view are dereferenced. brief text The reference type reference identifier UwlFvW1lEI5kSm1M2LJ8livaK7g= string identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std 1 difference_type boost/url/segments_base.hpp include/boost/url/segments_base.hpp 108 5 1 typedef ZGzGSpAZlXL0sCedyhjsT90U4S0= regular ge9cOBTN19ywbVTnB5ajdJUC46Q= brief text A signed integer type used to represent differences. identifier EH4n8sIj03HafoTNn2U36T1P+Hc= ptrdiff_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std 1 reference boost/url/segments_base.hpp include/boost/url/segments_base.hpp 97 5 1 typedef yenFqEfqqK2NrZ+2hs1Il0Gkg/Q= regular ge9cOBTN19ywbVTnB5ajdJUC46Q= paragraph text This is the type of value returned when iterators of the view are dereferenced. brief text The reference type identifier UwlFvW1lEI5kSm1M2LJ8livaK7g= string identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std 1 size_type boost/url/segments_base.hpp include/boost/url/segments_base.hpp 104 5 1 typedef q0c7sMK+HhivONBaUVBcT+YLGYQ= regular ge9cOBTN19ywbVTnB5ajdJUC46Q= brief text An unsigned integer type used to represent size. identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std 1 value_type boost/url/segments_base.hpp include/boost/url/segments_base.hpp 90 5 1 typedef 28sEF1YglFKmk+Kcl4ymHBd02MI= regular ge9cOBTN19ywbVTnB5ajdJUC46Q= paragraph text Values of this type represent a segment where unique ownership is retained by making a copy. heading text Example 1 code segments_base::value_type ps( url_view( "/path/to/file.txt" ).segments().back() ); brief text The value type identifier UwlFvW1lEI5kSm1M2LJ8livaK7g= string identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std 1 iterator boost/url/impl/segments_base.hpp include/boost/url/impl/segments_base.hpp 26 1 boost/url/segments_base.hpp include/boost/url/segments_base.hpp 74 5 1 record v0DfmyG7n+onJnPwu0SmkmEIIs4= see-below ge9cOBTN19ywbVTnB5ajdJUC46Q= paragraph text Objects of this type allow iteration through the segments in the path. Any percent-escapes in returned strings are decoded first. The values returned are read-only; changes to segments must be made through the container instead, if the container supports modification. paragraph text The strings produced when iterators are dereferenced belong to the iterator and become invalidated when that particular iterator is incremented, decremented, or destroyed. brief text A Bidirectional iterator to a path segment class identifier zdr3gU7+2/G05oo6ta/IfHlkTF0= segments_ref zdr3gU7+2/G05oo6ta/IfHlkTF0= identifier ge9cOBTN19ywbVTnB5ajdJUC46Q= segments_base ge9cOBTN19ywbVTnB5ajdJUC46Q= back boost/url/segments_base.hpp include/boost/url/segments_base.hpp 279 5 1 function SiUbAVvbiztqJmIoYwdvkoQyi90= regular ge9cOBTN19ywbVTnB5ajdJUC46Q= heading text Preconditions 1 code this->empty() == false heading text Example 1 code assert( url_view( "/path/to/file.txt" ).segments().back() == "file.txt" ); heading text Preconditions 1 code this->empty() == false heading text Effects 1 code return *--end(); heading text Complexity 1 paragraph text Linear in code text this->back().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. brief text Return the last segment returns text The last segment. identifier UwlFvW1lEI5kSm1M2LJ8livaK7g= string identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 1 begin boost/url/segments_base.hpp include/boost/url/segments_base.hpp 293 5 1 function RJFHEvDTVOSBEWC5A/qqcBSNc14= regular ge9cOBTN19ywbVTnB5ajdJUC46Q= heading text Complexity 1 paragraph text Linear in code text this->front().size() text or constant if code text this->empty() text . heading text Exception Safety 1 paragraph text Throws nothing. brief text Return an iterator to the beginning returns text An iterator to the first segment. identifier v0DfmyG7n+onJnPwu0SmkmEIIs4= iterator normal 1 1 buffer boost/url/segments_base.hpp include/boost/url/segments_base.hpp 155 5 1 function v5AF2vYTekOYGThG7Nle0P0fwU4= regular ge9cOBTN19ywbVTnB5ajdJUC46Q= paragraph text This function returns the character buffer referenced by the view. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "/path/to/file.txt" ).segments().buffer() == "/path/to/file.txt" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the referenced character buffer. returns text A string containing the path. identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 empty boost/url/segments_base.hpp include/boost/url/segments_base.hpp 194 5 1 function Bkl327dG/7JY0gyN644pnPkCyj0= regular ge9cOBTN19ywbVTnB5ajdJUC46Q= heading text Example 1 code assert( ! url_view( "/index.htm" ).segments().empty() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return true if there are no segments returns code text true text if there are no segments, otherwise code text false text . identifier bool normal 1 1 end boost/url/segments_base.hpp include/boost/url/segments_base.hpp 306 5 1 function oBgrqTEOKSIfUQVCZCwbVHu9pe4= regular ge9cOBTN19ywbVTnB5ajdJUC46Q= heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return an iterator to the end returns text An iterator to one past the last segment. identifier v0DfmyG7n+onJnPwu0SmkmEIIs4= iterator normal 1 1 front boost/url/segments_base.hpp include/boost/url/segments_base.hpp 246 5 1 function EZ3AwpJPJ+eUXoULAfCVAA57yQU= regular ge9cOBTN19ywbVTnB5ajdJUC46Q= paragraph text This function returns a string with the first segment of the path without any leading or trailing '/' separators. Any percent-escapes in the string are decoded first. heading text Preconditions 1 code this->empty() == false heading text Effects 1 code return *begin(); heading text Example 1 code assert( url_view( "/path/to/file.txt" ).segments().front() == "path" ); heading text Complexity 1 paragraph text Linear in code text this->front().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. brief text Return the first segment returns text The first segment. identifier UwlFvW1lEI5kSm1M2LJ8livaK7g= string identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 1 is_absolute boost/url/segments_base.hpp include/boost/url/segments_base.hpp 176 5 1 function G6s0M4MqJFqoPBxyx/2YT3jn4W8= regular ge9cOBTN19ywbVTnB5ajdJUC46Q= paragraph text Absolute paths always start with a forward slash ('/'). heading text Example 1 code assert( url_view( "/path/to/file.txt" ).segments().is_absolute() == true ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Returns true if this references an absolute path. returns code text true text if the path is absolute, otherwise code text false text . identifier bool normal 1 1 size boost/url/segments_base.hpp include/boost/url/segments_base.hpp 212 5 1 function yBM8jUZ7lUhztKUrKAMCVlF/JSM= regular ge9cOBTN19ywbVTnB5ajdJUC46Q= heading text Example 1 code assert( url_view( "/path/to/file.txt" ).segments().size() == 3 ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the number of segments returns text The number of segments. identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 1 max_size boost/url/segments_base.hpp include/boost/url/segments_base.hpp 127 5 1 function 4eJ21Hl5fc2lKip4HsTT2daKD58= regular ge9cOBTN19ywbVTnB5ajdJUC46Q= paragraph text This represents the largest number of characters that are possible in a path, not including any null terminator. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the maximum number of characters possible returns text The maximum number of characters possible. identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 segments_encoded_base boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 37 1 1 record qs4TNMM406MPgeboXz6oVUmcauE= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text Implements the shared encoded-segment algorithms reused by reference segments_encoded_view EvaX3SmNTAtai2Kf6Kma3fUkTkQ= text and reference segments_encoded_ref TCUUfRiqZjX62kt7tK2fs//VWr0= text . It is not intended to be instantiated directly; use one of those concrete containers instead. heading text Containers 1 list paragraph reference segments_ref zdr3gU7+2/G05oo6ta/IfHlkTF0= paragraph reference segments_view ZNJOLZ4RhCB2A2ooiNo7KxZJHrA= paragraph reference segments_encoded_ref TCUUfRiqZjX62kt7tK2fs//VWr0= paragraph reference segments_encoded_view EvaX3SmNTAtai2Kf6Kma3fUkTkQ= unordered brief text Percent-encoded path segment helper base class TCUUfRiqZjX62kt7tK2fs//VWr0= EvaX3SmNTAtai2Kf6Kma3fUkTkQ= BvhJXmRgOZW7NW+ayuMQkPsFzbs= 7gYb+Bz+3qbqiVq+Wm8Ky9M11+o= m0o4b1/DorAvjn3F219/pMLvlyo= 5In4EDUuaLDGWzqU/EoIRrGbjkw= Qm4R83v/FlItdjfF09x/yy67FzE= AWMsSIW+RTb1aMhvCsG7n58jVHM= g/L8mjAHkEezRBezNicBq+kX83A= huIfaMM6sCgNghdm8mALz0WRL3k= 2sagwnDfZ81Ag59U6dlqMfcbRdM= 77/TrbaxaS3ddWaQsqsrxZgfrtg= GHSGkHUPEHCGOkttbtLrNdeJsYw= FX43RoBCFXu84qOmF9qbuAcvL3A= bCALqPJXUIOplPZHZ//yQObNCt4= qPtb3Gf4eUGNjob+VCTNZu3sUr4= BJwakVSJbowHvD7bCKsCv7Qv2EM= chJ3si+vtHLHOc1xY/5U+6aQTc4= sP8lirwIgyo9GtOeDL2VdOAOGNk= pXnr1bRqpXuAliVw7dAwi+SZsdA= 7PTvtJjWQL3EoFZc8y/DJlVBSDI= identifier EvaX3SmNTAtai2Kf6Kma3fUkTkQ= segments_encoded_view EvaX3SmNTAtai2Kf6Kma3fUkTkQ= identifier TCUUfRiqZjX62kt7tK2fs//VWr0= segments_encoded_ref TCUUfRiqZjX62kt7tK2fs//VWr0= identifier UEVNhDEjkZMXfjN1DxbtX0n2rCg= url_view_base UEVNhDEjkZMXfjN1DxbtX0n2rCg= const_iterator boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 79 5 1 typedef BvhJXmRgOZW7NW+ayuMQkPsFzbs= regular qs4TNMM406MPgeboXz6oVUmcauE= paragraph text Objects of this type allow iteration through the segments in the path. Strings returned by iterators may contain percent escapes. The values returned are read-only; changes to segments must be made through the container instead, if the container supports modification. paragraph text The strings produced when iterators are dereferenced refer to the underlying character buffer. Ownership is not transferred; the caller is responsible for ensuring that the lifetime of the buffer extends until it is no longer referenced by any container or iterator. brief text A Bidirectional iterator to a path segment iterator identifier g/L8mjAHkEezRBezNicBq+kX83A= iterator 1 const_reference boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 102 5 1 typedef 7gYb+Bz+3qbqiVq+Wm8Ky9M11+o= regular qs4TNMM406MPgeboXz6oVUmcauE= paragraph text This is the type of value returned when iterators of the view are dereferenced. brief text The reference type reference identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view 1 difference_type boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 110 5 1 typedef m0o4b1/DorAvjn3F219/pMLvlyo= regular qs4TNMM406MPgeboXz6oVUmcauE= brief text A signed integer type used to represent differences. identifier EH4n8sIj03HafoTNn2U36T1P+Hc= ptrdiff_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std 1 reference boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 99 5 1 typedef 5In4EDUuaLDGWzqU/EoIRrGbjkw= regular qs4TNMM406MPgeboXz6oVUmcauE= paragraph text This is the type of value returned when iterators of the view are dereferenced. brief text The reference type identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view 1 size_type boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 106 5 1 typedef Qm4R83v/FlItdjfF09x/yy67FzE= regular qs4TNMM406MPgeboXz6oVUmcauE= brief text An unsigned integer type used to represent size. identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std 1 value_type boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 92 5 1 typedef AWMsSIW+RTb1aMhvCsG7n58jVHM= regular qs4TNMM406MPgeboXz6oVUmcauE= paragraph text Values of this type represent a segment where unique ownership is retained by making a copy. heading text Example 1 code segments_encoded_base::value_type ps( url_view( "/path/to/file.txt" ).encoded_segments().back() ); brief text The value type identifier UwlFvW1lEI5kSm1M2LJ8livaK7g= string identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std 1 iterator boost/url/impl/segments_encoded_base.hpp include/boost/url/impl/segments_encoded_base.hpp 24 1 boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 76 5 1 record g/L8mjAHkEezRBezNicBq+kX83A= see-below qs4TNMM406MPgeboXz6oVUmcauE= paragraph text Objects of this type allow iteration through the segments in the path. Strings returned by iterators may contain percent escapes. The values returned are read-only; changes to segments must be made through the container instead, if the container supports modification. paragraph text The strings produced when iterators are dereferenced refer to the underlying character buffer. Ownership is not transferred; the caller is responsible for ensuring that the lifetime of the buffer extends until it is no longer referenced by any container or iterator. brief text A Bidirectional iterator to a path segment class identifier TCUUfRiqZjX62kt7tK2fs//VWr0= segments_encoded_ref TCUUfRiqZjX62kt7tK2fs//VWr0= identifier qs4TNMM406MPgeboXz6oVUmcauE= segments_encoded_base qs4TNMM406MPgeboXz6oVUmcauE= identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base aHkFCWJbYb0t+7FT+A5gCI0krpU= back boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 287 5 1 function huIfaMM6sCgNghdm8mALz0WRL3k= regular qs4TNMM406MPgeboXz6oVUmcauE= paragraph text This function returns a string with the last segment of the path without any leading or trailing '/' separators. The returned string may contain percent escapes. heading text Preconditions 1 code this->empty() == false heading text Example 1 code assert( url_view( "/path/to/file.txt" ).encoded_segments().back() == "file.txt" ); heading text Preconditions 1 code this->empty() == false heading text Effects 1 code return *--end(); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the last segment returns text The last segment. identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 begin boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 301 5 1 function 2sagwnDfZ81Ag59U6dlqMfcbRdM= regular qs4TNMM406MPgeboXz6oVUmcauE= heading text Complexity 1 paragraph text Linear in code text this->front().size() text or constant if code text this->empty() text . heading text Exception Safety 1 paragraph text Throws nothing. brief text Return an iterator to the beginning returns text An iterator to the first segment. identifier g/L8mjAHkEezRBezNicBq+kX83A= iterator normal 1 1 buffer boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 157 5 1 function 77/TrbaxaS3ddWaQsqsrxZgfrtg= regular qs4TNMM406MPgeboXz6oVUmcauE= paragraph text This function returns the character buffer referenced by the view. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "/path/to/file.txt" ).encoded_segments().buffer() == "/path/to/file.txt" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the referenced character buffer. returns text A string view of the buffer. identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 empty boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 196 5 1 function GHSGkHUPEHCGOkttbtLrNdeJsYw= regular qs4TNMM406MPgeboXz6oVUmcauE= heading text Example 1 code assert( ! url_view( "/index.htm" ).encoded_segments().empty() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return true if there are no segments returns code text true text if there are no segments, otherwise code text false text . identifier bool normal 1 1 end boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 314 5 1 function FX43RoBCFXu84qOmF9qbuAcvL3A= regular qs4TNMM406MPgeboXz6oVUmcauE= heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return an iterator to the end returns text An iterator to one past the last segment. identifier g/L8mjAHkEezRBezNicBq+kX83A= iterator normal 1 1 front boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 248 5 1 function bCALqPJXUIOplPZHZ//yQObNCt4= regular qs4TNMM406MPgeboXz6oVUmcauE= paragraph text This function returns a string with the first segment of the path without any leading or trailing '/' separators. The returned string may contain percent escapes. heading text Preconditions 1 code this->empty() == false heading text Effects 1 code return *begin(); heading text Example 1 code assert( url_view( "/path/to/file.txt" ).encoded_segments().front() == "path" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the first segment returns text The first segment. identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 is_absolute boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 178 5 1 function qPtb3Gf4eUGNjob+VCTNZu3sUr4= regular qs4TNMM406MPgeboXz6oVUmcauE= paragraph text Absolute paths always start with a forward slash ('/'). heading text Example 1 code assert( url_view( "/path/to/file.txt" ).encoded_segments().is_absolute() == true ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Returns true if this references an absolute path. returns code text true text if the path is absolute, otherwise code text false text . identifier bool normal 1 1 size boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 214 5 1 function BJwakVSJbowHvD7bCKsCv7Qv2EM= regular qs4TNMM406MPgeboXz6oVUmcauE= heading text Example 1 code assert( url_view( "/path/to/file.txt" ).encoded_segments().size() == 3 ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the number of segments returns text The number of segments. identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 1 max_size boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 129 5 1 function chJ3si+vtHLHOc1xY/5U+6aQTc4= regular qs4TNMM406MPgeboXz6oVUmcauE= paragraph text This represents the largest number of characters that are possible in a path, not including any null terminator. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the maximum number of characters possible returns text The maximum number of characters possible. identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 segments_encoded_ref boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 79 1 1 record TCUUfRiqZjX62kt7tK2fs//VWr0= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text Exposes the percent-encoded segments of a reference url_base aHkFCWJbYb0t+7FT+A5gCI0krpU= text as a bidirectional range that can modify the underlying URL. The proxy uses the URL’s storage directly, so the url must outlive any references. heading text Example 1 code url u( "/path/to/file.txt" ); segments_encoded_ref ps = u.encoded_segments(); paragraph text The strings returned when iterators are dereferenced have type reference pct_string_view t9KlfUmMV/Lq0e5tGD9d/eCq+X0= text and may contain percent-escapes. paragraph text Reserved characters in inputs are automatically escaped. Escapes in inputs are preserved. paragraph text Exceptions are thrown on invalid inputs. heading text Iterator Invalidation 1 paragraph text Changes to the underlying character buffer can invalidate iterators which reference it. Modifications made through the container invalidate some or all iterators: list paragraph reference push_back k/+5yJNfDNUOfAvdH+DvTb3aems= text : Only code text end() text . paragraph reference assign BPHuhV1Rn5PL0H/sNy0kFFKa2Ug= text , reference clear KKYw+VvKy1sm99inuPn90KFHN7k= text , reference operator= pL7iCVVEY9YlWQEt9npyzapFS3o= text : All elements. paragraph reference erase EeLa4k9G9NoKr9W5UX1fKP7+NsU= text : Erased elements and all elements after (including code text end() text ). paragraph reference insert B3E0XLlBxIVYiVp1UUrcur2/LLM= text : All elements at or after the insertion point (including code text end() text ). paragraph reference replace 0+6rNxvThC2CYHS9AXltunVbY40= text : Modified elements and all elements after (including code text end() text ). unordered brief text Mutable encoded path segment proxy see reference segments_encoded_view EvaX3SmNTAtai2Kf6Kma3fUkTkQ= text , reference segments_view ZNJOLZ4RhCB2A2ooiNo7KxZJHrA= text , reference segments_ref zdr3gU7+2/G05oo6ta/IfHlkTF0= text . class identifier qs4TNMM406MPgeboXz6oVUmcauE= segments_encoded_base BvhJXmRgOZW7NW+ayuMQkPsFzbs= 7gYb+Bz+3qbqiVq+Wm8Ky9M11+o= m0o4b1/DorAvjn3F219/pMLvlyo= 5In4EDUuaLDGWzqU/EoIRrGbjkw= Qm4R83v/FlItdjfF09x/yy67FzE= AWMsSIW+RTb1aMhvCsG7n58jVHM= mn4nKnQtkPNgTuJ5uNvI6qj2BPc= pJuY2rSnHwe5WWhpQ5dCpAgiUVg= pL7iCVVEY9YlWQEt9npyzapFS3o= BPHuhV1Rn5PL0H/sNy0kFFKa2Ug= huIfaMM6sCgNghdm8mALz0WRL3k= 2sagwnDfZ81Ag59U6dlqMfcbRdM= 77/TrbaxaS3ddWaQsqsrxZgfrtg= KKYw+VvKy1sm99inuPn90KFHN7k= GHSGkHUPEHCGOkttbtLrNdeJsYw= FX43RoBCFXu84qOmF9qbuAcvL3A= EeLa4k9G9NoKr9W5UX1fKP7+NsU= bCALqPJXUIOplPZHZ//yQObNCt4= B3E0XLlBxIVYiVp1UUrcur2/LLM= qPtb3Gf4eUGNjob+VCTNZu3sUr4= JlzMZ8Js8HPWqK22W+WU2MR2Yn8= k/+5yJNfDNUOfAvdH+DvTb3aems= 0+6rNxvThC2CYHS9AXltunVbY40= BJwakVSJbowHvD7bCKsCv7Qv2EM= mXe1gqEV6OcEe9HebGQikLEWj9U= wvBe0xFZCPtYti4CtRJetID8Cfo= chJ3si+vtHLHOc1xY/5U+6aQTc4= 6jDtT/TXCJqoXt8NXeS7Z5J0rFU= KCo/TQ2VN+UYm2PGErORJV9dM0A= bGIMlYHp5bwZfnla9hy7dyq8u9g= identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base aHkFCWJbYb0t+7FT+A5gCI0krpU= const_iterator boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 79 5 1 typedef BvhJXmRgOZW7NW+ayuMQkPsFzbs= regular qs4TNMM406MPgeboXz6oVUmcauE= paragraph text Objects of this type allow iteration through the segments in the path. Strings returned by iterators may contain percent escapes. The values returned are read-only; changes to segments must be made through the container instead, if the container supports modification. paragraph text The strings produced when iterators are dereferenced refer to the underlying character buffer. Ownership is not transferred; the caller is responsible for ensuring that the lifetime of the buffer extends until it is no longer referenced by any container or iterator. brief text A Bidirectional iterator to a path segment iterator identifier g/L8mjAHkEezRBezNicBq+kX83A= iterator 1 const_reference boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 102 5 1 typedef 7gYb+Bz+3qbqiVq+Wm8Ky9M11+o= regular qs4TNMM406MPgeboXz6oVUmcauE= paragraph text This is the type of value returned when iterators of the view are dereferenced. brief text The reference type reference identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view 1 difference_type boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 110 5 1 typedef m0o4b1/DorAvjn3F219/pMLvlyo= regular qs4TNMM406MPgeboXz6oVUmcauE= brief text A signed integer type used to represent differences. identifier EH4n8sIj03HafoTNn2U36T1P+Hc= ptrdiff_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std 1 reference boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 99 5 1 typedef 5In4EDUuaLDGWzqU/EoIRrGbjkw= regular qs4TNMM406MPgeboXz6oVUmcauE= paragraph text This is the type of value returned when iterators of the view are dereferenced. brief text The reference type identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view 1 size_type boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 106 5 1 typedef Qm4R83v/FlItdjfF09x/yy67FzE= regular qs4TNMM406MPgeboXz6oVUmcauE= brief text An unsigned integer type used to represent size. identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std 1 value_type boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 92 5 1 typedef AWMsSIW+RTb1aMhvCsG7n58jVHM= regular qs4TNMM406MPgeboXz6oVUmcauE= paragraph text Values of this type represent a segment where unique ownership is retained by making a copy. heading text Example 1 code segments_encoded_base::value_type ps( url_view( "/path/to/file.txt" ).encoded_segments().back() ); brief text The value type identifier UwlFvW1lEI5kSm1M2LJ8livaK7g= string identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std 1 iterator boost/url/impl/segments_encoded_base.hpp include/boost/url/impl/segments_encoded_base.hpp 24 1 boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 76 5 1 record mn4nKnQtkPNgTuJ5uNvI6qj2BPc= see-below 1 TCUUfRiqZjX62kt7tK2fs//VWr0= paragraph text Objects of this type allow iteration through the segments in the path. Strings returned by iterators may contain percent escapes. The values returned are read-only; changes to segments must be made through the container instead, if the container supports modification. paragraph text The strings produced when iterators are dereferenced refer to the underlying character buffer. Ownership is not transferred; the caller is responsible for ensuring that the lifetime of the buffer extends until it is no longer referenced by any container or iterator. brief text A Bidirectional iterator to a path segment class identifier TCUUfRiqZjX62kt7tK2fs//VWr0= segments_encoded_ref TCUUfRiqZjX62kt7tK2fs//VWr0= identifier qs4TNMM406MPgeboXz6oVUmcauE= segments_encoded_base qs4TNMM406MPgeboXz6oVUmcauE= identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base aHkFCWJbYb0t+7FT+A5gCI0krpU= segments_encoded_ref boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 118 5 1 function pJuY2rSnHwe5WWhpQ5dCpAgiUVg= regular TCUUfRiqZjX62kt7tK2fs//VWr0= paragraph text After construction, both views reference the same url. Ownership is not transferred; the caller is responsible for ensuring the lifetime of the url extends until it is no longer referenced. heading text Postconditions 1 code &this->url() == &other.url(); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Constructor param text The other view. other identifier void 1 identifier TCUUfRiqZjX62kt7tK2fs//VWr0= segments_encoded_ref other constructor 1 1 1 operator= boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 150 5 1 boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 154 5 1 boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 201 5 1 overloads pL7iCVVEY9YlWQEt9npyzapFS3o= regular TCUUfRiqZjX62kt7tK2fs//VWr0= brief text Assignment returns text A reference to this object. returns text A reference to this. param text The segments to assign. other param text The list of segments to assign. init throws text The list contains an invalid percent-encoding. reference system_error normal LL0mmbqUIG/Mm8mpyI7ZCu/2FBE= iNapL7mxSNYw4GT4gV06GT/kKjY= LlrZXMnarSUNL3P19PCkOHJPNrQ= identifier TCUUfRiqZjX62kt7tK2fs//VWr0= segments_encoded_ref operator= boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 150 5 1 function LL0mmbqUIG/Mm8mpyI7ZCu/2FBE= regular TCUUfRiqZjX62kt7tK2fs//VWr0= paragraph text The existing contents are replaced by a copy of the other segments. paragraph text All iterators are invalidated. admonition paragraph text None of the character buffers referenced by code text other text may overlap the buffer of the underlying url, or else the behavior is undefined. note heading text Effects 1 code this->assign( other.begin(), other.end() ); heading text Complexity 1 paragraph text Linear in code text other.buffer().size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. brief text Assignment returns text A reference to this object. param text The segments to assign. other identifier TCUUfRiqZjX62kt7tK2fs//VWr0= segments_encoded_ref 1 identifier TCUUfRiqZjX62kt7tK2fs//VWr0= segments_encoded_ref other normal 1 operator= boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 201 5 1 function iNapL7mxSNYw4GT4gV06GT/kKjY= regular TCUUfRiqZjX62kt7tK2fs//VWr0= paragraph text The existing contents are replaced by a copy of the contents of the initializer list. Reserved characters in the list are automatically escaped. Escapes in the list are preserved. paragraph text All iterators are invalidated. heading text Example 1 code url u; u.encoded_segments() = {"path", "to", "file.txt"}; heading text Preconditions 1 paragraph text None of the character buffers referenced by the list may overlap the character buffer of the underlying url, or else the behavior is undefined. heading text Effects 1 code this->assign( init.begin(), init.end() ); heading text Complexity 1 paragraph text Linear in code text init.size() + this->url().encoded_query().size() + this->url().encoded_fragment().size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. brief text Assignment returns text A reference to this. param text The list of segments to assign. init throws text The list contains an invalid percent-encoding. reference system_error identifier TCUUfRiqZjX62kt7tK2fs//VWr0= segments_encoded_ref specialization 3tT5Y8vozttMWXrA/fNw4NcDYTE= initializer_list identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std init normal 1 operator= boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 154 5 1 function LlrZXMnarSUNL3P19PCkOHJPNrQ= regular TCUUfRiqZjX62kt7tK2fs//VWr0= paragraph text The existing contents are replaced by a copy of the other segments. paragraph text All iterators are invalidated. admonition paragraph text None of the character buffers referenced by code text other text may overlap the buffer of the underlying url, or else the behavior is undefined. note heading text Effects 1 code this->assign( other.begin(), other.end() ); heading text Complexity 1 paragraph text Linear in code text other.buffer().size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. brief text Assignment operator=(segments_encoded_ref const&) returns text A reference to this object. param text The segments to assign. other identifier TCUUfRiqZjX62kt7tK2fs//VWr0= segments_encoded_ref 1 identifier EvaX3SmNTAtai2Kf6Kma3fUkTkQ= segments_encoded_view other normal 1 assign boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 312 5 1 boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 352 5 1 overloads BPHuhV1Rn5PL0H/sNy0kFFKa2Ug= regular TCUUfRiqZjX62kt7tK2fs//VWr0= brief text Assign segments param text The list of segments to assign. init param text The first element in the range. first param text One past the last element in the range. last throws text The list contains an invalid percent-encoding. reference system_error normal 4QcdeaZk+adcrX414Bsr53nPIL4= sC4xzDTVLYJRMWprwhg/L3nnhfA= identifier void assign boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 312 5 1 function 4QcdeaZk+adcrX414Bsr53nPIL4= regular TCUUfRiqZjX62kt7tK2fs//VWr0= paragraph text The existing contents are replaced by a copy of the contents of the initializer list. Reserved characters in the list are automatically escaped. Escapes in the list are preserved. paragraph text All iterators are invalidated. admonition paragraph text None of the character buffers referenced by the list may overlap the character buffer of the underlying url, or else the behavior is undefined. note heading text Example 1 code url u; u.segments().assign( {"path", "to", "file.txt"} ); heading text Complexity 1 paragraph text Linear in code text init.size() + this->url().encoded_query().size() + this->url().encoded_fragment().size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. brief text Assign segments param text The list of segments to assign. init throws text The list contains an invalid percent-encoding. reference system_error identifier void specialization 3tT5Y8vozttMWXrA/fNw4NcDYTE= initializer_list identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std init normal 1 assign boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 352 5 1 function sC4xzDTVLYJRMWprwhg/L3nnhfA= regular TCUUfRiqZjX62kt7tK2fs//VWr0= paragraph text The existing contents are replaced by a copy of the contents of the range. Reserved characters in the range are automatically escaped. Escapes in the range are preserved. paragraph text All iterators are invalidated. admonition paragraph text None of the character buffers referenced by the range may overlap the character buffer of the underlying url, or else the behavior is undefined. note heading text Mandates 1 code std::is_convertible< std::iterator_traits< FwdIt >::reference_type, pct_string_view >::value == true heading text Complexity 1 paragraph text Linear in code text std::distance( first, last ) + this->url().encoded_query().size() + this->url().encoded_fragment().size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. brief text Assign segments param text The first element in the range. first param text One past the last element in the range. last throws text The range contains an invalid percent-encoding. reference system_error identifier void identifier FwdIt first identifier FwdIt last normal 1 back boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 287 5 1 function huIfaMM6sCgNghdm8mALz0WRL3k= regular qs4TNMM406MPgeboXz6oVUmcauE= paragraph text This function returns a string with the last segment of the path without any leading or trailing '/' separators. The returned string may contain percent escapes. heading text Preconditions 1 code this->empty() == false heading text Example 1 code assert( url_view( "/path/to/file.txt" ).encoded_segments().back() == "file.txt" ); heading text Preconditions 1 code this->empty() == false heading text Effects 1 code return *--end(); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the last segment returns text The last segment. identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 begin boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 301 5 1 function 2sagwnDfZ81Ag59U6dlqMfcbRdM= regular qs4TNMM406MPgeboXz6oVUmcauE= heading text Complexity 1 paragraph text Linear in code text this->front().size() text or constant if code text this->empty() text . heading text Exception Safety 1 paragraph text Throws nothing. brief text Return an iterator to the beginning returns text An iterator to the first segment. identifier g/L8mjAHkEezRBezNicBq+kX83A= iterator normal 1 1 buffer boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 157 5 1 function 77/TrbaxaS3ddWaQsqsrxZgfrtg= regular qs4TNMM406MPgeboXz6oVUmcauE= paragraph text This function returns the character buffer referenced by the view. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "/path/to/file.txt" ).encoded_segments().buffer() == "/path/to/file.txt" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the referenced character buffer. returns text A string view of the buffer. identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 clear boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 271 5 1 function KKYw+VvKy1sm99inuPn90KFHN7k= regular TCUUfRiqZjX62kt7tK2fs//VWr0= paragraph text All iterators are invalidated. heading text Effects 1 code this->url().set_encoded_path( "" ); heading text Postconditions 1 code this->empty() == true heading text Complexity 1 paragraph text Linear in code text this->url().encoded_query().size() + this->url().encoded_fragment().size() text . heading text Exception Safety 1 paragraph text Throws nothing. brief text Clear the contents of the container identifier void normal 1 empty boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 196 5 1 function GHSGkHUPEHCGOkttbtLrNdeJsYw= regular qs4TNMM406MPgeboXz6oVUmcauE= heading text Example 1 code assert( ! url_view( "/index.htm" ).encoded_segments().empty() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return true if there are no segments returns code text true text if there are no segments, otherwise code text false text . identifier bool normal 1 1 end boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 314 5 1 function FX43RoBCFXu84qOmF9qbuAcvL3A= regular qs4TNMM406MPgeboXz6oVUmcauE= heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return an iterator to the end returns text An iterator to one past the last segment. identifier g/L8mjAHkEezRBezNicBq+kX83A= iterator normal 1 1 erase boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 521 5 1 boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 544 5 1 overloads EeLa4k9G9NoKr9W5UX1fKP7+NsU= regular TCUUfRiqZjX62kt7tK2fs//VWr0= brief text Erase segments returns text An iterator to one past the removed segment. returns text An iterator to one past the removed range. param text An iterator to the element. pos param text The first element in the range to erase. first param text One past the last element in the range to erase. last normal BsLXaBnDItSMBNgV8pc30X0/TnE= CsDwf/uqlVa7hlApvAf4FGt2j8M= identifier g/L8mjAHkEezRBezNicBq+kX83A= iterator erase boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 521 5 1 function BsLXaBnDItSMBNgV8pc30X0/TnE= regular TCUUfRiqZjX62kt7tK2fs//VWr0= paragraph text This function removes a segment. paragraph text All iterators that are equal to code text pos text or come after are invalidated. heading text Complexity 1 paragraph text Linear in code text this->url().encoded_resource().size() text . heading text Exception Safety 1 paragraph text Throws nothing. brief text Erase segments returns text An iterator to one past the removed segment. param text An iterator to the element. pos identifier g/L8mjAHkEezRBezNicBq+kX83A= iterator identifier g/L8mjAHkEezRBezNicBq+kX83A= iterator pos normal 1 erase boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 544 5 1 function CsDwf/uqlVa7hlApvAf4FGt2j8M= regular TCUUfRiqZjX62kt7tK2fs//VWr0= paragraph text This function removes a range of segments from the container. paragraph text All iterators that are equal to code text first text or come after are invalidated. heading text Complexity 1 paragraph text Linear in code text this->url().encoded_resource().size() text . heading text Exception Safety 1 paragraph text Throws nothing. brief text Erase segments returns text An iterator to one past the removed range. param text The first element in the range to erase. first param text One past the last element in the range to erase. last identifier g/L8mjAHkEezRBezNicBq+kX83A= iterator identifier g/L8mjAHkEezRBezNicBq+kX83A= iterator first identifier g/L8mjAHkEezRBezNicBq+kX83A= iterator last normal 1 front boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 248 5 1 function bCALqPJXUIOplPZHZ//yQObNCt4= regular qs4TNMM406MPgeboXz6oVUmcauE= paragraph text This function returns a string with the first segment of the path without any leading or trailing '/' separators. The returned string may contain percent escapes. heading text Preconditions 1 code this->empty() == false heading text Effects 1 code return *begin(); heading text Example 1 code assert( url_view( "/path/to/file.txt" ).encoded_segments().front() == "path" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the first segment returns text The first segment. identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 insert boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 390 5 1 boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 442 5 1 boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 493 5 1 overloads B3E0XLlBxIVYiVp1UUrcur2/LLM= regular TCUUfRiqZjX62kt7tK2fs//VWr0= brief text Insert segments returns text An iterator to the inserted segment. returns text An iterator to the first element inserted, or code text before text if code text init.size() == 0 text . returns text An iterator to the first segment inserted, or code text before text if code text init.empty() text . param text An iterator before which the segment is inserted. This may be equal to code text end() text . before param text The segment to insert. s param text The list of segments to insert. init param text The first element in the range to insert. first param text One past the last element in the range to insert. last throws text The segment contains an invalid percent-encoding. reference system_error normal TliI3AglmvyLdEMFkrJrjUAv9nM= 2sEwLHnI9RRGyyiqnb7Vjx9qrhM= du85+z+tYyUpagKIefWc+fpeYks= identifier g/L8mjAHkEezRBezNicBq+kX83A= iterator insert boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 390 5 1 function TliI3AglmvyLdEMFkrJrjUAv9nM= regular TCUUfRiqZjX62kt7tK2fs//VWr0= paragraph text This function inserts a segment before the specified position. Reserved characters in the segment are automatically escaped. Escapes in the segment are preserved. paragraph text All iterators that are equal to code text before text or come after are invalidated. heading text Complexity 1 paragraph text Linear in code text s.size() + this->url().encoded_resource().size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. brief text Insert segments returns text An iterator to the inserted segment. param text An iterator before which the segment is inserted. This may be equal to code text end() text . before param text The segment to insert. s throws text The segment contains an invalid percent-encoding. reference system_error identifier g/L8mjAHkEezRBezNicBq+kX83A= iterator identifier g/L8mjAHkEezRBezNicBq+kX83A= iterator before identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view s normal 1 insert boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 442 5 1 function 2sEwLHnI9RRGyyiqnb7Vjx9qrhM= regular TCUUfRiqZjX62kt7tK2fs//VWr0= paragraph text This function inserts the segments in an initializer list before the specified position. Reserved characters in the list are automatically escaped. Escapes in the list are preserved. paragraph text All iterators that are equal to code text before text or come after are invalidated. admonition paragraph text None of the character buffers referenced by the list may overlap the character buffer of the underlying url, or else the behavior is undefined. note heading text Example 1 code url u( "/file.txt" ); u.encoded_segments().insert( u.encoded_segments().begin(), { "path", "to" } ); heading text Complexity 1 paragraph text Linear in code text init.size() + this->url().encoded_resource().size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. brief text Insert segments returns text An iterator to the first element inserted, or code text before text if code text init.size() == 0 text . param text An iterator before which the list is inserted. This may be equal to code text end() text . before param text The list of segments to insert. init throws text The list contains an invalid percent-encoding. reference system_error identifier g/L8mjAHkEezRBezNicBq+kX83A= iterator identifier g/L8mjAHkEezRBezNicBq+kX83A= iterator before specialization 3tT5Y8vozttMWXrA/fNw4NcDYTE= initializer_list identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std init normal 1 insert boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 493 5 1 function du85+z+tYyUpagKIefWc+fpeYks= regular TCUUfRiqZjX62kt7tK2fs//VWr0= paragraph text This function inserts the segments in a range before the specified position. Reserved characters in the range are automatically escaped. Escapes in the range are preserved. paragraph text All iterators that are equal to code text before text or come after are invalidated. admonition paragraph text None of the character buffers referenced by the range may overlap the character buffer of the underlying url, or else the behavior is undefined. note heading text Mandates 1 code std::is_convertible< std::iterator_traits< FwdIt >::reference_type, pct_string_view >::value == true heading text Complexity 1 paragraph text Linear in code text std::distance( first, last ) + this->url().encoded_resource().size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. brief text Insert segments returns text An iterator to the first segment inserted, or code text before text if code text init.empty() text . param text An iterator before which the range is inserted. This may be equal to code text end() text . before param text The first element in the range to insert. first param text One past the last element in the range to insert. last throws text The range contains an invalid percent-encoding. reference system_error identifier g/L8mjAHkEezRBezNicBq+kX83A= iterator identifier g/L8mjAHkEezRBezNicBq+kX83A= iterator before identifier FwdIt first identifier FwdIt last normal 1 is_absolute boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 178 5 1 function qPtb3Gf4eUGNjob+VCTNZu3sUr4= regular qs4TNMM406MPgeboXz6oVUmcauE= paragraph text Absolute paths always start with a forward slash ('/'). heading text Example 1 code assert( url_view( "/path/to/file.txt" ).encoded_segments().is_absolute() == true ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Returns true if this references an absolute path. returns code text true text if the path is absolute, otherwise code text false text . identifier bool normal 1 1 pop_back boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 758 5 1 function JlzMZ8Js8HPWqK22W+WU2MR2Yn8= regular TCUUfRiqZjX62kt7tK2fs//VWr0= paragraph text This function removes the last segment from the container. paragraph text Iterators to the last segment as well as all end iterators are invalidated. heading text Preconditions 1 code !this->empty() heading text Exception Safety 1 paragraph text Throws nothing. brief text Remove the last segment identifier void normal 1 push_back boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 737 5 1 function k/+5yJNfDNUOfAvdH+DvTb3aems= regular TCUUfRiqZjX62kt7tK2fs//VWr0= paragraph text This function appends a segment to the end of the path. Reserved characters in the string are automatically escaped. Escapes in the string are preserved. paragraph text All end iterators are invalidated. heading text Postconditions 1 code this->back() == s heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. brief text Append a segment param text The segment to append. s throws text The string contains an invalid percent-encoding. reference system_error identifier void identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view s normal 1 replace boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 576 5 1 boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 611 5 1 boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 656 5 1 boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 701 5 1 overloads 0+6rNxvThC2CYHS9AXltunVbY40= regular TCUUfRiqZjX62kt7tK2fs//VWr0= brief text Replace segments returns text An iterator to the replaced segment. returns text An iterator to the new segment. returns text An iterator to the first segment inserted, or one past code text to text if code text init.size() == 0 text . param text An iterator to the segment. pos param text The string to assign. s param text The first element in the range of segments to replace. from param text One past the last element in the range of segments to replace. to param text The list of segments to assign. init param text The first element in the new range of segments. first param text One past the last element in the new range of segments. last throws text The string contains an invalid percent-encoding. reference system_error normal cSH8UpR6JdrNaN1ksvNrLn/HVm0= YOSdGvhFD2fK0UePm8DgvTPBl90= i8soX0cNijL1JxXw5PLeDEYw9Z4= +MWzM3N1NhK7lfAn6i7klo69b7M= identifier g/L8mjAHkEezRBezNicBq+kX83A= iterator replace boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 576 5 1 function cSH8UpR6JdrNaN1ksvNrLn/HVm0= regular TCUUfRiqZjX62kt7tK2fs//VWr0= paragraph text This function replaces the segment at the specified position. Reserved characters in the string are automatically escaped. Escapes in the string are preserved. paragraph text All iterators that are equal to code text pos text or come after are invalidated. heading text Complexity 1 paragraph text Linear in code text s.size() + this->url().encoded_resouce().size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. brief text Replace segments returns text An iterator to the replaced segment. param text An iterator to the segment. pos param text The string to assign. s identifier g/L8mjAHkEezRBezNicBq+kX83A= iterator identifier g/L8mjAHkEezRBezNicBq+kX83A= iterator pos identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view s normal 1 replace boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 611 5 1 function YOSdGvhFD2fK0UePm8DgvTPBl90= regular TCUUfRiqZjX62kt7tK2fs//VWr0= paragraph text This function replaces a range of segments with one segment. Reserved characters in the string are automatically escaped. Escapes in the string are preserved. paragraph text All iterators that are equal to code text from text or come after are invalidated. heading text Complexity 1 paragraph text Linear in code text s.size() + this->url().encoded_resouce().size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. brief text Replace segments returns text An iterator to the new segment. param text The first element in the range of segments to replace. from param text One past the last element in the range of segments to replace. to param text The string to assign. s throws text The string contains an invalid percent-encoding. reference system_error identifier g/L8mjAHkEezRBezNicBq+kX83A= iterator identifier g/L8mjAHkEezRBezNicBq+kX83A= iterator from identifier g/L8mjAHkEezRBezNicBq+kX83A= iterator to identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view s normal 1 replace boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 656 5 1 function i8soX0cNijL1JxXw5PLeDEYw9Z4= regular TCUUfRiqZjX62kt7tK2fs//VWr0= paragraph text This function replaces a range of segments with a list of segments in an initializer list. Reserved characters in the list are automatically escaped. Escapes in the list are preserved. paragraph text All iterators that are equal to code text from text or come after are invalidated. heading text Preconditions 1 paragraph text None of the character buffers referenced by the list may overlap the character buffer of the underlying url, or else the behavior is undefined. heading text Complexity 1 paragraph text Linear in code text init.size() + this->url().encoded_resouce().size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. brief text Replace segments returns text An iterator to the first segment inserted, or one past code text to text if code text init.size() == 0 text . param text The first element in the range of segments to replace. from param text One past the last element in the range of segments to replace. to param text The list of segments to assign. init throws text The list contains an invalid percent-encoding. reference system_error identifier g/L8mjAHkEezRBezNicBq+kX83A= iterator identifier g/L8mjAHkEezRBezNicBq+kX83A= iterator from identifier g/L8mjAHkEezRBezNicBq+kX83A= iterator to specialization 3tT5Y8vozttMWXrA/fNw4NcDYTE= initializer_list identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std init normal 1 replace boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 701 5 1 function +MWzM3N1NhK7lfAn6i7klo69b7M= regular TCUUfRiqZjX62kt7tK2fs//VWr0= paragraph text This function replaces a range of segments with annother range of segments. Reserved characters in the new range are automatically escaped. Escapes in the new range are preserved. paragraph text All iterators that are equal to code text from text or come after are invalidated. heading text Preconditions 1 paragraph text None of the character buffers referenced by the new range may overlap the character buffer of the underlying url, or else the behavior is undefined. heading text Complexity 1 paragraph text Linear in code text std::distance( first, last ) + this->url().encoded_resouce().size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. brief text Replace segments returns text An iterator to the first segment inserted, or one past code text to text if code text init.size() == 0 text . param text The first element in the range of segments to replace. from param text One past the last element in the range of segments to replace. to param text The first element in the new range of segments. first param text One past the last element in the new range of segments. last throws text The range contains an invalid percent-encoding. reference system_error identifier g/L8mjAHkEezRBezNicBq+kX83A= iterator identifier g/L8mjAHkEezRBezNicBq+kX83A= iterator from identifier g/L8mjAHkEezRBezNicBq+kX83A= iterator to identifier FwdIt first identifier FwdIt last normal 1 size boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 214 5 1 function BJwakVSJbowHvD7bCKsCv7Qv2EM= regular qs4TNMM406MPgeboXz6oVUmcauE= heading text Example 1 code assert( url_view( "/path/to/file.txt" ).encoded_segments().size() == 3 ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the number of segments returns text The number of segments. identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 1 url boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 238 5 1 function mXe1gqEV6OcEe9HebGQikLEWj9U= regular TCUUfRiqZjX62kt7tK2fs//VWr0= paragraph text This function returns the url referenced by the view. heading text Example 1 code url u( "/path/to/file.txt" ); assert( &u.encoded_segments().url() == &u ); heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the referenced url returns text A reference to the url. identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base normal 1 1 operator segments_encoded_view boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 212 5 1 function wvBe0xFZCPtYti4CtRJetID8Cfo= regular TCUUfRiqZjX62kt7tK2fs//VWr0= brief text Conversion returns text A view of the segments. see reference segments_encoded_view EvaX3SmNTAtai2Kf6Kma3fUkTkQ= text . identifier EvaX3SmNTAtai2Kf6Kma3fUkTkQ= segments_encoded_view conversion 1 1 max_size boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 129 5 1 function chJ3si+vtHLHOc1xY/5U+6aQTc4= regular qs4TNMM406MPgeboXz6oVUmcauE= paragraph text This represents the largest number of characters that are possible in a path, not including any null terminator. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the maximum number of characters possible returns text The maximum number of characters possible. identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 segments_encoded_view boost/url/segments_encoded_view.hpp include/boost/url/segments_encoded_view.hpp 55 1 1 boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 24 1 record EvaX3SmNTAtai2Kf6Kma3fUkTkQ= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text Exposes the raw percent-encoded segments of a URL path as a read-only bidirectional range. The view references the original buffer, so callers must keep that storage alive while iterating. heading text Example 1 code url_view u( "/path/to/file.txt" ); segments_encoded_view ps = u.encoded_segments(); assert( ps.buffer().data() == u.buffer().data() ); paragraph text Elements are returned as encoded strings, preserving escape sequences for callers that need the exact byte representation. heading text Iterator Invalidation 1 paragraph text Changes to the underlying character buffer can invalidate iterators which reference it. brief text Non-owning encoded path segment view see reference segments_view ZNJOLZ4RhCB2A2ooiNo7KxZJHrA= text , reference segments_encoded_ref TCUUfRiqZjX62kt7tK2fs//VWr0= text , reference segments_ref zdr3gU7+2/G05oo6ta/IfHlkTF0= text . class identifier qs4TNMM406MPgeboXz6oVUmcauE= segments_encoded_base BvhJXmRgOZW7NW+ayuMQkPsFzbs= 7gYb+Bz+3qbqiVq+Wm8Ky9M11+o= m0o4b1/DorAvjn3F219/pMLvlyo= 5In4EDUuaLDGWzqU/EoIRrGbjkw= Qm4R83v/FlItdjfF09x/yy67FzE= AWMsSIW+RTb1aMhvCsG7n58jVHM= Ii8/3ppfaHAEx0H3aozCzc4goJM= selbiXMXP5zkjBMvpX306XR3d14= 8pXN2excDq2EJ7VbxNkaGqd9go0= huIfaMM6sCgNghdm8mALz0WRL3k= 2sagwnDfZ81Ag59U6dlqMfcbRdM= 77/TrbaxaS3ddWaQsqsrxZgfrtg= GHSGkHUPEHCGOkttbtLrNdeJsYw= FX43RoBCFXu84qOmF9qbuAcvL3A= bCALqPJXUIOplPZHZ//yQObNCt4= qPtb3Gf4eUGNjob+VCTNZu3sUr4= BJwakVSJbowHvD7bCKsCv7Qv2EM= FpOlQ+VLMkPceEvlT/Y5ixbLG7s= chJ3si+vtHLHOc1xY/5U+6aQTc4= 7gkVWyEXdJ1zZsQB+POHv9dL+bw= UGT2YeR0J7z0ZcyG8/VStlmtGhU= identifier TCUUfRiqZjX62kt7tK2fs//VWr0= segments_encoded_ref TCUUfRiqZjX62kt7tK2fs//VWr0= identifier UEVNhDEjkZMXfjN1DxbtX0n2rCg= url_view_base UEVNhDEjkZMXfjN1DxbtX0n2rCg= const_iterator boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 79 5 1 typedef BvhJXmRgOZW7NW+ayuMQkPsFzbs= regular qs4TNMM406MPgeboXz6oVUmcauE= paragraph text Objects of this type allow iteration through the segments in the path. Strings returned by iterators may contain percent escapes. The values returned are read-only; changes to segments must be made through the container instead, if the container supports modification. paragraph text The strings produced when iterators are dereferenced refer to the underlying character buffer. Ownership is not transferred; the caller is responsible for ensuring that the lifetime of the buffer extends until it is no longer referenced by any container or iterator. brief text A Bidirectional iterator to a path segment iterator identifier g/L8mjAHkEezRBezNicBq+kX83A= iterator 1 const_reference boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 102 5 1 typedef 7gYb+Bz+3qbqiVq+Wm8Ky9M11+o= regular qs4TNMM406MPgeboXz6oVUmcauE= paragraph text This is the type of value returned when iterators of the view are dereferenced. brief text The reference type reference identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view 1 difference_type boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 110 5 1 typedef m0o4b1/DorAvjn3F219/pMLvlyo= regular qs4TNMM406MPgeboXz6oVUmcauE= brief text A signed integer type used to represent differences. identifier EH4n8sIj03HafoTNn2U36T1P+Hc= ptrdiff_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std 1 reference boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 99 5 1 typedef 5In4EDUuaLDGWzqU/EoIRrGbjkw= regular qs4TNMM406MPgeboXz6oVUmcauE= paragraph text This is the type of value returned when iterators of the view are dereferenced. brief text The reference type identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view 1 size_type boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 106 5 1 typedef Qm4R83v/FlItdjfF09x/yy67FzE= regular qs4TNMM406MPgeboXz6oVUmcauE= brief text An unsigned integer type used to represent size. identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std 1 value_type boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 92 5 1 typedef AWMsSIW+RTb1aMhvCsG7n58jVHM= regular qs4TNMM406MPgeboXz6oVUmcauE= paragraph text Values of this type represent a segment where unique ownership is retained by making a copy. heading text Example 1 code segments_encoded_base::value_type ps( url_view( "/path/to/file.txt" ).encoded_segments().back() ); brief text The value type identifier UwlFvW1lEI5kSm1M2LJ8livaK7g= string identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std 1 iterator boost/url/impl/segments_encoded_base.hpp include/boost/url/impl/segments_encoded_base.hpp 24 1 boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 76 5 1 record Ii8/3ppfaHAEx0H3aozCzc4goJM= see-below 1 EvaX3SmNTAtai2Kf6Kma3fUkTkQ= paragraph text Objects of this type allow iteration through the segments in the path. Strings returned by iterators may contain percent escapes. The values returned are read-only; changes to segments must be made through the container instead, if the container supports modification. paragraph text The strings produced when iterators are dereferenced refer to the underlying character buffer. Ownership is not transferred; the caller is responsible for ensuring that the lifetime of the buffer extends until it is no longer referenced by any container or iterator. brief text A Bidirectional iterator to a path segment class identifier TCUUfRiqZjX62kt7tK2fs//VWr0= segments_encoded_ref TCUUfRiqZjX62kt7tK2fs//VWr0= identifier qs4TNMM406MPgeboXz6oVUmcauE= segments_encoded_base qs4TNMM406MPgeboXz6oVUmcauE= identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base aHkFCWJbYb0t+7FT+A5gCI0krpU= segments_encoded_view boost/url/segments_encoded_view.hpp include/boost/url/segments_encoded_view.hpp 109 5 1 boost/url/segments_encoded_view.hpp include/boost/url/segments_encoded_view.hpp 86 5 1 boost/url/segments_encoded_view.hpp include/boost/url/segments_encoded_view.hpp 160 5 1 boost/url/segments_encoded_view.hpp include/boost/url/segments_encoded_view.hpp 229 5 1 overloads selbiXMXP5zkjBMvpX306XR3d14= regular EvaX3SmNTAtai2Kf6Kma3fUkTkQ= brief text Constructor param text The string to parse. s param text The beginning iterator. first param text The ending iterator. last throws code text s text contains an invalid path. reference system_error constructor wB5FLZARVdWOdbpJ8gz6adGJ1pM= tuJdRclMTym11QreHrg310DMHnI= Lh0OOi8ywTpGrLOmwHo1xxGEcUQ= 4Dgwl6h3UrhoR+2g4sK4NKVf7Hc= identifier void segments_encoded_view boost/url/segments_encoded_view.hpp include/boost/url/segments_encoded_view.hpp 86 5 1 function wB5FLZARVdWOdbpJ8gz6adGJ1pM= regular EvaX3SmNTAtai2Kf6Kma3fUkTkQ= paragraph text Default-constructed segments have zero elements. heading text Example 1 code segments_encoded_view ps; heading text Effects 1 code return segments_encoded_view( "" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Constructor identifier void constructor 1 segments_encoded_view boost/url/segments_encoded_view.hpp include/boost/url/segments_encoded_view.hpp 109 5 1 function tuJdRclMTym11QreHrg310DMHnI= regular EvaX3SmNTAtai2Kf6Kma3fUkTkQ= paragraph text After construction, both views reference the same character buffer. paragraph text Ownership is not transferred; the caller is responsible for ensuring the lifetime of the buffer extends until it is no longer referenced. heading text Postconditions 1 code this->buffer().data() == other.buffer().data() heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing brief text Constructor param text The object to copy construct from other identifier void 1 identifier EvaX3SmNTAtai2Kf6Kma3fUkTkQ= segments_encoded_view other constructor 1 1 1 segments_encoded_view boost/url/segments_encoded_view.hpp include/boost/url/segments_encoded_view.hpp 160 5 1 function Lh0OOi8ywTpGrLOmwHo1xxGEcUQ= regular EvaX3SmNTAtai2Kf6Kma3fUkTkQ= paragraph text This function constructs segments from a valid path string, which can contain percent escapes. Upon construction, the view references the character buffer pointed to by code text s text . caller is responsible for ensuring that the lifetime of the buffer extends until the view is destroyed. heading text Example 1 code segments_encoded_view ps( "/path/to/file.txt" ); heading text Effects 1 code return parse_path( s ).value(); heading text Postconditions 1 code this->buffer().data() == s.data() heading text Complexity 1 paragraph text Linear in code text s text . heading text Exception Safety 1 paragraph text Exceptions thrown on invalid input. heading text BNF 1 code path = [ "/" ] [ segment *( "/" segment ) ] segment = *pchar heading text Specification 1 list paragraph link text 3.3. Path https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text Constructor param text The string to parse. s throws code text s text contains an invalid path. reference system_error identifier void identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s constructor 1 segments_encoded_view boost/url/segments_encoded_view.hpp include/boost/url/segments_encoded_view.hpp 229 5 1 function 4Dgwl6h3UrhoR+2g4sK4NKVf7Hc= regular EvaX3SmNTAtai2Kf6Kma3fUkTkQ= paragraph text This function creates a new reference segments_encoded_view selbiXMXP5zkjBMvpX306XR3d14= text from a pair of iterators referring to elements of another encoded segments view. The resulting view references the same underlying character buffer as the original. paragraph text The constructed view preserves the original absolute flag when code text first text selects the first segment and otherwise produces an absolute subview: if the source path is relative and `first == ps.begin()` the new view is relative, and in every other case the subview is absolute with the separator immediately preceding code text *first text retained at the front. This ensures the underlying text can be reconstructed by concatenating the buffers of adjacent subviews. paragraph text The caller is responsible for ensuring that the lifetime of the original buffer extends until the constructed view is no longer referenced. heading text Example 1 code segments_encoded_view ps( "/path/to/file.txt" ); segments_encoded_view sub( std::next(ps.begin()), ps.end()); segments_encoded_view first_half( ps.begin(), std::next(ps.begin())); // sub represents "/to/file.txt" std::string combined( first_half.buffer().data(), first_half.buffer().size()); combined.append( sub.buffer().data(), sub.buffer().size()); BOOST_ASSERT(combined == ps.buffer()); heading text Preconditions 1 paragraph text The iterators must be valid and belong to the same reference segments_encoded_view selbiXMXP5zkjBMvpX306XR3d14= text . heading text Postconditions 1 paragraph code text sub.buffer() text references characters in the original code text ps.buffer() text . heading text Complexity 1 paragraph text Constant heading text Exception Safety 1 paragraph text Throws nothing. brief text Constructor param text The beginning iterator. first param text The ending iterator. last identifier void identifier g/L8mjAHkEezRBezNicBq+kX83A= iterator first identifier g/L8mjAHkEezRBezNicBq+kX83A= iterator last constructor 1 operator= boost/url/segments_encoded_view.hpp include/boost/url/segments_encoded_view.hpp 258 5 1 function 8pXN2excDq2EJ7VbxNkaGqd9go0= regular EvaX3SmNTAtai2Kf6Kma3fUkTkQ= paragraph text After assignment, both views reference the same underlying character buffer. paragraph text Ownership is not transferred; the caller is responsible for ensuring the lifetime of the buffer extends until it is no longer referenced. heading text Postconditions 1 code this->buffer().data() == other.buffer().data() heading text Complexity 1 paragraph text Constant heading text Exception Safety 1 paragraph text Throws nothing brief text Assignment returns text Reference to this object param text The segments to copy. other identifier EvaX3SmNTAtai2Kf6Kma3fUkTkQ= segments_encoded_view 1 identifier EvaX3SmNTAtai2Kf6Kma3fUkTkQ= segments_encoded_view other normal 1 1 1 back boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 287 5 1 function huIfaMM6sCgNghdm8mALz0WRL3k= regular qs4TNMM406MPgeboXz6oVUmcauE= paragraph text This function returns a string with the last segment of the path without any leading or trailing '/' separators. The returned string may contain percent escapes. heading text Preconditions 1 code this->empty() == false heading text Example 1 code assert( url_view( "/path/to/file.txt" ).encoded_segments().back() == "file.txt" ); heading text Preconditions 1 code this->empty() == false heading text Effects 1 code return *--end(); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the last segment returns text The last segment. identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 begin boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 301 5 1 function 2sagwnDfZ81Ag59U6dlqMfcbRdM= regular qs4TNMM406MPgeboXz6oVUmcauE= heading text Complexity 1 paragraph text Linear in code text this->front().size() text or constant if code text this->empty() text . heading text Exception Safety 1 paragraph text Throws nothing. brief text Return an iterator to the beginning returns text An iterator to the first segment. identifier g/L8mjAHkEezRBezNicBq+kX83A= iterator normal 1 1 buffer boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 157 5 1 function 77/TrbaxaS3ddWaQsqsrxZgfrtg= regular qs4TNMM406MPgeboXz6oVUmcauE= paragraph text This function returns the character buffer referenced by the view. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "/path/to/file.txt" ).encoded_segments().buffer() == "/path/to/file.txt" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the referenced character buffer. returns text A string view of the buffer. identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 empty boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 196 5 1 function GHSGkHUPEHCGOkttbtLrNdeJsYw= regular qs4TNMM406MPgeboXz6oVUmcauE= heading text Example 1 code assert( ! url_view( "/index.htm" ).encoded_segments().empty() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return true if there are no segments returns code text true text if there are no segments, otherwise code text false text . identifier bool normal 1 1 end boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 314 5 1 function FX43RoBCFXu84qOmF9qbuAcvL3A= regular qs4TNMM406MPgeboXz6oVUmcauE= heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return an iterator to the end returns text An iterator to one past the last segment. identifier g/L8mjAHkEezRBezNicBq+kX83A= iterator normal 1 1 front boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 248 5 1 function bCALqPJXUIOplPZHZ//yQObNCt4= regular qs4TNMM406MPgeboXz6oVUmcauE= paragraph text This function returns a string with the first segment of the path without any leading or trailing '/' separators. The returned string may contain percent escapes. heading text Preconditions 1 code this->empty() == false heading text Effects 1 code return *begin(); heading text Example 1 code assert( url_view( "/path/to/file.txt" ).encoded_segments().front() == "path" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the first segment returns text The first segment. identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 is_absolute boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 178 5 1 function qPtb3Gf4eUGNjob+VCTNZu3sUr4= regular qs4TNMM406MPgeboXz6oVUmcauE= paragraph text Absolute paths always start with a forward slash ('/'). heading text Example 1 code assert( url_view( "/path/to/file.txt" ).encoded_segments().is_absolute() == true ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Returns true if this references an absolute path. returns code text true text if the path is absolute, otherwise code text false text . identifier bool normal 1 1 size boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 214 5 1 function BJwakVSJbowHvD7bCKsCv7Qv2EM= regular qs4TNMM406MPgeboXz6oVUmcauE= heading text Example 1 code assert( url_view( "/path/to/file.txt" ).encoded_segments().size() == 3 ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the number of segments returns text The number of segments. identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 1 operator segments_view boost/url/segments_encoded_view.hpp include/boost/url/segments_encoded_view.hpp 293 5 1 function FpOlQ+VLMkPceEvlT/Y5ixbLG7s= regular EvaX3SmNTAtai2Kf6Kma3fUkTkQ= paragraph text This conversion returns a new view which references the same underlying character buffer, and whose iterators and members return ordinary strings with decoding applied to any percent escapes. paragraph text Ownership is not transferred; the caller is responsible for ensuring the lifetime of the buffer extends until it is no longer referenced. heading text Example 1 code segments_view ps = parse_path( "/path/to/file.txt" ).value(); heading text Postconditions 1 code segments_view( *this ).buffer().data() == this->buffer().data() heading text Complexity 1 paragraph text Constant heading text Exception Safety 1 paragraph text Throws nothing brief text Conversion returns text A view of the segments. identifier ZNJOLZ4RhCB2A2ooiNo7KxZJHrA= segments_view conversion 1 1 max_size boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 129 5 1 function chJ3si+vtHLHOc1xY/5U+6aQTc4= regular qs4TNMM406MPgeboXz6oVUmcauE= paragraph text This represents the largest number of characters that are possible in a path, not including any null terminator. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the maximum number of characters possible returns text The maximum number of characters possible. identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 segments_ref boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 77 1 1 record zdr3gU7+2/G05oo6ta/IfHlkTF0= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text Presents the decoded path segments of a reference url_base aHkFCWJbYb0t+7FT+A5gCI0krpU= text as a bidirectional range whose modifiers update the underlying URL. The proxy references the URL’s storage directly, so the owning URL must remain alive while the proxy is used. heading text Example 1 code url u( "/path/to/file.txt" ); segments_ref ps = u.segments(); paragraph text Percent escapes in strings returned when dereferencing iterators are automatically decoded. Reserved characters in strings supplied to modifier functions are automatically percent-escaped. heading text Iterator Invalidation 1 paragraph text Changes to the underlying character buffer can invalidate iterators which reference it. Modifications made through the container invalidate some or all iterators: list paragraph reference push_back p+DBZZu3QuesD/ekEuyMjTorERE= text : Only code text end() text . paragraph reference assign yk59a6CWvKnyW5JtHWlEpfDUqFA= text , reference clear T88pkBtjum3iYJBQByTdXoPyzjw= text , reference operator= piNXpzgeUoD/RA/BSEJ3dTOGjjo= text : All elements. paragraph reference erase 5afJHXlAoRiqzRJc8w2mcuxkTbY= text : Erased elements and all elements after (including code text end() text ). paragraph reference insert o3f0ppPyLAjEzoszvlgHabNYjQM= text : All elements at or after the insertion point (including code text end() text ). paragraph reference replace 1gPxWts+COnggCmEY+jFMaMueUs= text : Modified elements and all elements after (including code text end() text ). unordered brief text Mutable decoded path segment proxy see reference segments_encoded_ref TCUUfRiqZjX62kt7tK2fs//VWr0= text , reference segments_encoded_view EvaX3SmNTAtai2Kf6Kma3fUkTkQ= text , reference segments_view ZNJOLZ4RhCB2A2ooiNo7KxZJHrA= text . class identifier ge9cOBTN19ywbVTnB5ajdJUC46Q= segments_base 0tGsE1R1TOpKN9IAKzyNn7msre4= IwhREgq3doOt5R+7CpjDu5HXeJc= ZGzGSpAZlXL0sCedyhjsT90U4S0= yenFqEfqqK2NrZ+2hs1Il0Gkg/Q= q0c7sMK+HhivONBaUVBcT+YLGYQ= 28sEF1YglFKmk+Kcl4ymHBd02MI= LW3uh7FWN6WafxvEuqhgJKpQi08= nxBSMlBfKGySbzDTm/u8cZlRsUI= piNXpzgeUoD/RA/BSEJ3dTOGjjo= yk59a6CWvKnyW5JtHWlEpfDUqFA= SiUbAVvbiztqJmIoYwdvkoQyi90= RJFHEvDTVOSBEWC5A/qqcBSNc14= v5AF2vYTekOYGThG7Nle0P0fwU4= T88pkBtjum3iYJBQByTdXoPyzjw= Bkl327dG/7JY0gyN644pnPkCyj0= oBgrqTEOKSIfUQVCZCwbVHu9pe4= 5afJHXlAoRiqzRJc8w2mcuxkTbY= EZ3AwpJPJ+eUXoULAfCVAA57yQU= o3f0ppPyLAjEzoszvlgHabNYjQM= G6s0M4MqJFqoPBxyx/2YT3jn4W8= +a4Rj4DZHhwXrfe1x6L8Q14NlZM= p+DBZZu3QuesD/ekEuyMjTorERE= 1gPxWts+COnggCmEY+jFMaMueUs= yBM8jUZ7lUhztKUrKAMCVlF/JSM= t+7RWQooKrtJXGKQJu70HNfs5V0= Yjmz7FLx2FKEMNm77t8koOdVeiw= 4eJ21Hl5fc2lKip4HsTT2daKD58= xrdeTc2Y1per7HCvZXxw8NKd02U= Q1kzZ1buHAvDbNn5g2FXyP3gFI4= M4WepjP10Rufxwx2SSM3sgDobTY= identifier TCUUfRiqZjX62kt7tK2fs//VWr0= segments_encoded_ref TCUUfRiqZjX62kt7tK2fs//VWr0= identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base aHkFCWJbYb0t+7FT+A5gCI0krpU= const_iterator boost/url/segments_base.hpp include/boost/url/segments_base.hpp 77 5 1 typedef 0tGsE1R1TOpKN9IAKzyNn7msre4= regular ge9cOBTN19ywbVTnB5ajdJUC46Q= paragraph text Objects of this type allow iteration through the segments in the path. Any percent-escapes in returned strings are decoded first. The values returned are read-only; changes to segments must be made through the container instead, if the container supports modification. paragraph text The strings produced when iterators are dereferenced belong to the iterator and become invalidated when that particular iterator is incremented, decremented, or destroyed. brief text A Bidirectional iterator to a path segment iterator identifier v0DfmyG7n+onJnPwu0SmkmEIIs4= iterator 1 const_reference boost/url/segments_base.hpp include/boost/url/segments_base.hpp 100 5 1 typedef IwhREgq3doOt5R+7CpjDu5HXeJc= regular ge9cOBTN19ywbVTnB5ajdJUC46Q= paragraph text This is the type of value returned when iterators of the view are dereferenced. brief text The reference type reference identifier UwlFvW1lEI5kSm1M2LJ8livaK7g= string identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std 1 difference_type boost/url/segments_base.hpp include/boost/url/segments_base.hpp 108 5 1 typedef ZGzGSpAZlXL0sCedyhjsT90U4S0= regular ge9cOBTN19ywbVTnB5ajdJUC46Q= brief text A signed integer type used to represent differences. identifier EH4n8sIj03HafoTNn2U36T1P+Hc= ptrdiff_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std 1 reference boost/url/segments_base.hpp include/boost/url/segments_base.hpp 97 5 1 typedef yenFqEfqqK2NrZ+2hs1Il0Gkg/Q= regular ge9cOBTN19ywbVTnB5ajdJUC46Q= paragraph text This is the type of value returned when iterators of the view are dereferenced. brief text The reference type identifier UwlFvW1lEI5kSm1M2LJ8livaK7g= string identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std 1 size_type boost/url/segments_base.hpp include/boost/url/segments_base.hpp 104 5 1 typedef q0c7sMK+HhivONBaUVBcT+YLGYQ= regular ge9cOBTN19ywbVTnB5ajdJUC46Q= brief text An unsigned integer type used to represent size. identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std 1 value_type boost/url/segments_base.hpp include/boost/url/segments_base.hpp 90 5 1 typedef 28sEF1YglFKmk+Kcl4ymHBd02MI= regular ge9cOBTN19ywbVTnB5ajdJUC46Q= paragraph text Values of this type represent a segment where unique ownership is retained by making a copy. heading text Example 1 code segments_base::value_type ps( url_view( "/path/to/file.txt" ).segments().back() ); brief text The value type identifier UwlFvW1lEI5kSm1M2LJ8livaK7g= string identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std 1 iterator boost/url/impl/segments_base.hpp include/boost/url/impl/segments_base.hpp 26 1 boost/url/segments_base.hpp include/boost/url/segments_base.hpp 74 5 1 record LW3uh7FWN6WafxvEuqhgJKpQi08= see-below 1 zdr3gU7+2/G05oo6ta/IfHlkTF0= paragraph text Objects of this type allow iteration through the segments in the path. Any percent-escapes in returned strings are decoded first. The values returned are read-only; changes to segments must be made through the container instead, if the container supports modification. paragraph text The strings produced when iterators are dereferenced belong to the iterator and become invalidated when that particular iterator is incremented, decremented, or destroyed. brief text A Bidirectional iterator to a path segment class identifier zdr3gU7+2/G05oo6ta/IfHlkTF0= segments_ref zdr3gU7+2/G05oo6ta/IfHlkTF0= identifier ge9cOBTN19ywbVTnB5ajdJUC46Q= segments_base ge9cOBTN19ywbVTnB5ajdJUC46Q= segments_ref boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 116 5 1 function nxBSMlBfKGySbzDTm/u8cZlRsUI= regular zdr3gU7+2/G05oo6ta/IfHlkTF0= paragraph text After construction, both views reference the same url. Ownership is not transferred; the caller is responsible for ensuring the lifetime of the url extends until it is no longer referenced. heading text Postconditions 1 code &this->url() == &other.url(); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Constructor param text The other view. other identifier void 1 identifier zdr3gU7+2/G05oo6ta/IfHlkTF0= segments_ref other constructor 1 1 1 operator= boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 148 5 1 boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 152 5 1 boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 194 5 1 overloads piNXpzgeUoD/RA/BSEJ3dTOGjjo= regular zdr3gU7+2/G05oo6ta/IfHlkTF0= brief text Assignment returns text A reference to this object. param text The segments to assign. other param text The list of segments to assign. init normal 1PGonC8ca/Nb6CSk6xQynqWAXwQ= +pM8OfSmj9bcZr8C7H2/n3i2q7c= iqCU4nc7T888hTdpOUX2IIuAra4= identifier zdr3gU7+2/G05oo6ta/IfHlkTF0= segments_ref operator= boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 148 5 1 function 1PGonC8ca/Nb6CSk6xQynqWAXwQ= regular zdr3gU7+2/G05oo6ta/IfHlkTF0= paragraph text The existing contents are replaced by a copy of the other segments. paragraph text All iterators are invalidated. admonition paragraph text None of the character buffers referenced by code text other text may overlap the buffer of the underlying url, or else the behavior is undefined. note heading text Effects 1 code this->assign( other.begin(), other.end() ); heading text Complexity 1 paragraph text Linear in code text other.buffer().size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. brief text Assignment returns text A reference to this object. param text The segments to assign. other identifier zdr3gU7+2/G05oo6ta/IfHlkTF0= segments_ref 1 identifier zdr3gU7+2/G05oo6ta/IfHlkTF0= segments_ref other normal 1 operator= boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 194 5 1 function +pM8OfSmj9bcZr8C7H2/n3i2q7c= regular zdr3gU7+2/G05oo6ta/IfHlkTF0= paragraph text The existing contents are replaced by a copy of the contents of the initializer list. Reserved characters in the list are automatically escaped. paragraph text All iterators are invalidated. heading text Example 1 code url u; u.segments() = { "path", "to", "file.txt" }; heading text Preconditions 1 paragraph text None of the character buffers referenced by the list may overlap the character buffer of the underlying url, or else the behavior is undefined. heading text Effects 1 code this->assign( init.begin(), init.end() ); heading text Complexity 1 paragraph text Linear in code text init.size() + this->url().encoded_query().size() + this->url().encoded_fragment().size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. brief text Assignment returns text A reference to this object. param text The list of segments to assign. init identifier zdr3gU7+2/G05oo6ta/IfHlkTF0= segments_ref specialization 3tT5Y8vozttMWXrA/fNw4NcDYTE= initializer_list identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std init normal 1 operator= boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 152 5 1 function iqCU4nc7T888hTdpOUX2IIuAra4= regular zdr3gU7+2/G05oo6ta/IfHlkTF0= paragraph text The existing contents are replaced by a copy of the other segments. paragraph text All iterators are invalidated. admonition paragraph text None of the character buffers referenced by code text other text may overlap the buffer of the underlying url, or else the behavior is undefined. note heading text Effects 1 code this->assign( other.begin(), other.end() ); heading text Complexity 1 paragraph text Linear in code text other.buffer().size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. brief text Assignment segments_ref::operator=(segments_ref const&) returns text A reference to this object. param text The segments to assign. other identifier zdr3gU7+2/G05oo6ta/IfHlkTF0= segments_ref 1 identifier ZNJOLZ4RhCB2A2ooiNo7KxZJHrA= segments_view other normal 1 assign boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 300 5 1 boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 335 5 1 overloads yk59a6CWvKnyW5JtHWlEpfDUqFA= regular zdr3gU7+2/G05oo6ta/IfHlkTF0= brief text Assign segments param text The list of segments to assign. init param text The beginning of the range of segments to assign. first param text The end of the range of segments to assign. last normal jmv/jLLJzcA3XERfiZBze0WECd8= 1mO8vRMU8isq7VD+oX7GFNTSSKs= identifier void assign boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 300 5 1 function jmv/jLLJzcA3XERfiZBze0WECd8= regular zdr3gU7+2/G05oo6ta/IfHlkTF0= paragraph text The existing contents are replaced by a copy of the contents of the initializer list. Reserved characters in the list are automatically escaped. paragraph text All iterators are invalidated. admonition paragraph text None of the character buffers referenced by code text init text may overlap the character buffer of the underlying url, or else the behavior is undefined. note heading text Example 1 code url u; u.segments().assign( { "path", "to", "file.txt" } ); heading text Complexity 1 paragraph text Linear in code text init.size() + this->url().encoded_query().size() + this->url().encoded_fragment().size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. brief text Assign segments param text The list of segments to assign. init identifier void specialization 3tT5Y8vozttMWXrA/fNw4NcDYTE= initializer_list identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std init normal 1 assign boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 335 5 1 function 1mO8vRMU8isq7VD+oX7GFNTSSKs= regular zdr3gU7+2/G05oo6ta/IfHlkTF0= paragraph text The existing contents are replaced by a copy of the contents of the range. Reserved characters in the range are automatically escaped. paragraph text All iterators are invalidated. admonition paragraph text None of the character buffers referenced by the range may overlap the character buffer of the underlying url, or else the behavior is undefined. note heading text Mandates 1 code std::is_convertible< std::iterator_traits< FwdIt >::reference_type, core::string_view >::value == true heading text Complexity 1 paragraph text Linear in code text std::distance( first, last ) + this->url().encoded_query().size() + this->url().encoded_fragment().size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. brief text Assign segments param text The beginning of the range of segments to assign. first param text The end of the range of segments to assign. last identifier void identifier FwdIt first identifier FwdIt last normal 1 back boost/url/segments_base.hpp include/boost/url/segments_base.hpp 279 5 1 function SiUbAVvbiztqJmIoYwdvkoQyi90= regular ge9cOBTN19ywbVTnB5ajdJUC46Q= heading text Preconditions 1 code this->empty() == false heading text Example 1 code assert( url_view( "/path/to/file.txt" ).segments().back() == "file.txt" ); heading text Preconditions 1 code this->empty() == false heading text Effects 1 code return *--end(); heading text Complexity 1 paragraph text Linear in code text this->back().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. brief text Return the last segment returns text The last segment. identifier UwlFvW1lEI5kSm1M2LJ8livaK7g= string identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 1 begin boost/url/segments_base.hpp include/boost/url/segments_base.hpp 293 5 1 function RJFHEvDTVOSBEWC5A/qqcBSNc14= regular ge9cOBTN19ywbVTnB5ajdJUC46Q= heading text Complexity 1 paragraph text Linear in code text this->front().size() text or constant if code text this->empty() text . heading text Exception Safety 1 paragraph text Throws nothing. brief text Return an iterator to the beginning returns text An iterator to the first segment. identifier v0DfmyG7n+onJnPwu0SmkmEIIs4= iterator normal 1 1 buffer boost/url/segments_base.hpp include/boost/url/segments_base.hpp 155 5 1 function v5AF2vYTekOYGThG7Nle0P0fwU4= regular ge9cOBTN19ywbVTnB5ajdJUC46Q= paragraph text This function returns the character buffer referenced by the view. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "/path/to/file.txt" ).segments().buffer() == "/path/to/file.txt" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the referenced character buffer. returns text A string containing the path. identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 clear boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 264 5 1 function T88pkBtjum3iYJBQByTdXoPyzjw= regular zdr3gU7+2/G05oo6ta/IfHlkTF0= paragraph text All iterators are invalidated. heading text Effects 1 code this->url().set_encoded_path( "" ); heading text Postconditions 1 code this->empty() == true heading text Complexity 1 paragraph text Linear in code text this->url().encoded_query().size() + this->url().encoded_fragment().size() text . heading text Exception Safety 1 paragraph text Throws nothing. brief text Clear the contents of the container identifier void normal 1 empty boost/url/segments_base.hpp include/boost/url/segments_base.hpp 194 5 1 function Bkl327dG/7JY0gyN644pnPkCyj0= regular ge9cOBTN19ywbVTnB5ajdJUC46Q= heading text Example 1 code assert( ! url_view( "/index.htm" ).segments().empty() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return true if there are no segments returns code text true text if there are no segments, otherwise code text false text . identifier bool normal 1 1 end boost/url/segments_base.hpp include/boost/url/segments_base.hpp 306 5 1 function oBgrqTEOKSIfUQVCZCwbVHu9pe4= regular ge9cOBTN19ywbVTnB5ajdJUC46Q= heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return an iterator to the end returns text An iterator to one past the last segment. identifier v0DfmyG7n+onJnPwu0SmkmEIIs4= iterator normal 1 1 erase boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 488 5 1 boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 512 5 1 overloads 5afJHXlAoRiqzRJc8w2mcuxkTbY= regular zdr3gU7+2/G05oo6ta/IfHlkTF0= brief text Erase segments returns text An iterator to one past the removed segment. returns text An iterator to one past the removed range. param text An iterator to the segment. pos param text The beginning of the range to remove. first param text The end of the range to remove. last normal ry28jZcnbOn9xqooHcGdMYri4RI= r1gTyRFDkNhliFkLegBVVeTsqXM= identifier v0DfmyG7n+onJnPwu0SmkmEIIs4= iterator erase boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 488 5 1 function ry28jZcnbOn9xqooHcGdMYri4RI= regular zdr3gU7+2/G05oo6ta/IfHlkTF0= paragraph text This function removes a segment. paragraph text All iterators that are equal to code text pos text or come after are invalidated. heading text Complexity 1 paragraph text Linear in code text this->url().encoded_resource().size() text . heading text Exception Safety 1 paragraph text Throws nothing. brief text Erase segments returns text An iterator to one past the removed segment. param text An iterator to the segment. pos identifier v0DfmyG7n+onJnPwu0SmkmEIIs4= iterator identifier v0DfmyG7n+onJnPwu0SmkmEIIs4= iterator pos normal 1 erase boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 512 5 1 function r1gTyRFDkNhliFkLegBVVeTsqXM= regular zdr3gU7+2/G05oo6ta/IfHlkTF0= paragraph text This function removes a range of segments. paragraph text All iterators that are equal to code text first text or come after are invalidated. heading text Complexity 1 paragraph text Linear in code text this->url().encoded_resource().size() text . heading text Exception Safety 1 paragraph text Throws nothing. brief text Erase segments returns text An iterator to one past the removed range. param text The beginning of the range to remove. first param text The end of the range to remove. last identifier v0DfmyG7n+onJnPwu0SmkmEIIs4= iterator identifier v0DfmyG7n+onJnPwu0SmkmEIIs4= iterator first identifier v0DfmyG7n+onJnPwu0SmkmEIIs4= iterator last normal 1 front boost/url/segments_base.hpp include/boost/url/segments_base.hpp 246 5 1 function EZ3AwpJPJ+eUXoULAfCVAA57yQU= regular ge9cOBTN19ywbVTnB5ajdJUC46Q= paragraph text This function returns a string with the first segment of the path without any leading or trailing '/' separators. Any percent-escapes in the string are decoded first. heading text Preconditions 1 code this->empty() == false heading text Effects 1 code return *begin(); heading text Example 1 code assert( url_view( "/path/to/file.txt" ).segments().front() == "path" ); heading text Complexity 1 paragraph text Linear in code text this->front().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. brief text Return the first segment returns text The first segment. identifier UwlFvW1lEI5kSm1M2LJ8livaK7g= string identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 1 insert boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 368 5 1 boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 415 5 1 boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 460 5 1 overloads o3f0ppPyLAjEzoszvlgHabNYjQM= regular zdr3gU7+2/G05oo6ta/IfHlkTF0= brief text Insert segments returns text An iterator to the inserted segment. returns text An iterator to the first element inserted, or code text before text if code text init.size() == 0 text . returns text An iterator to the first segment inserted, or code text before text if code text init.empty() text . param text An iterator before which the segment is inserted. This may be equal to code text end() text . before param text The segment to insert. s param text The list of segments to insert. init param text The beginning of the range of segments to insert. first param text The end of the range of segments to insert. last normal UFcbKr0/9mzfgNed32nyewDv04g= nGAGqRMRbhZiwWI72JEu5nr4tJs= dou6hXskL/iyVwdF5Jbixl7OQFY= identifier v0DfmyG7n+onJnPwu0SmkmEIIs4= iterator insert boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 368 5 1 function UFcbKr0/9mzfgNed32nyewDv04g= regular zdr3gU7+2/G05oo6ta/IfHlkTF0= paragraph text This function inserts a segment before the specified position. Reserved characters in the segment are automatically escaped. paragraph text All iterators that are equal to code text before text or come after are invalidated. heading text Complexity 1 paragraph text Linear in code text s.size() + this->url().encoded_resource().size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. brief text Insert segments returns text An iterator to the inserted segment. param text An iterator before which the segment is inserted. This may be equal to code text end() text . before param text The segment to insert. s identifier v0DfmyG7n+onJnPwu0SmkmEIIs4= iterator identifier v0DfmyG7n+onJnPwu0SmkmEIIs4= iterator before identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 insert boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 415 5 1 function nGAGqRMRbhZiwWI72JEu5nr4tJs= regular zdr3gU7+2/G05oo6ta/IfHlkTF0= paragraph text This function inserts the segments in an initializer list before the specified position. Reserved characters in the list are percent-escaped in the result. paragraph text All iterators that are equal to code text before text or come after are invalidated. admonition paragraph text None of the character buffers referenced by the list may overlap the character buffer of the underlying url, or else the behavior is undefined. note heading text Example 1 code url u( "/file.txt" ); u.segments().insert( u.segments().begin(), { "path", "to" } ); heading text Complexity 1 paragraph text Linear in code text init.size() + this->url().encoded_resource().size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. brief text Insert segments returns text An iterator to the first element inserted, or code text before text if code text init.size() == 0 text . param text An iterator before which the list is inserted. This may be equal to code text end() text . before param text The list of segments to insert. init identifier v0DfmyG7n+onJnPwu0SmkmEIIs4= iterator identifier v0DfmyG7n+onJnPwu0SmkmEIIs4= iterator before specialization 3tT5Y8vozttMWXrA/fNw4NcDYTE= initializer_list identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std init normal 1 insert boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 460 5 1 function dou6hXskL/iyVwdF5Jbixl7OQFY= regular zdr3gU7+2/G05oo6ta/IfHlkTF0= paragraph text This function inserts the segments in a range before the specified position. Reserved characters in the list are automatically escaped. paragraph text All iterators that are equal to code text before text or come after are invalidated. admonition paragraph text None of the character buffers referenced by the range may overlap the character buffer of the underlying url, or else the behavior is undefined. note heading text Mandates 1 code std::is_convertible< std::iterator_traits< FwdIt >::reference_type, core::string_view >::value == true heading text Complexity 1 paragraph text Linear in code text std::distance( first, last ) + this->url().encoded_resource().size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. brief text Insert segments returns text An iterator to the first segment inserted, or code text before text if code text init.empty() text . param text An iterator before which the range is inserted. This may be equal to code text end() text . before param text The beginning of the range of segments to insert. first param text The end of the range of segments to insert. last identifier v0DfmyG7n+onJnPwu0SmkmEIIs4= iterator identifier v0DfmyG7n+onJnPwu0SmkmEIIs4= iterator before identifier FwdIt first identifier FwdIt last normal 1 is_absolute boost/url/segments_base.hpp include/boost/url/segments_base.hpp 176 5 1 function G6s0M4MqJFqoPBxyx/2YT3jn4W8= regular ge9cOBTN19ywbVTnB5ajdJUC46Q= paragraph text Absolute paths always start with a forward slash ('/'). heading text Example 1 code assert( url_view( "/path/to/file.txt" ).segments().is_absolute() == true ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Returns true if this references an absolute path. returns code text true text if the path is absolute, otherwise code text false text . identifier bool normal 1 1 pop_back boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 703 5 1 function +a4Rj4DZHhwXrfe1x6L8Q14NlZM= regular zdr3gU7+2/G05oo6ta/IfHlkTF0= paragraph text This function removes the last segment from the container. paragraph text Iterators to the last segment as well as all end iterators are invalidated. heading text Preconditions 1 code not this->empty() heading text Exception Safety 1 paragraph text Throws nothing. brief text Remove the last segment identifier void normal 1 push_back boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 682 5 1 function p+DBZZu3QuesD/ekEuyMjTorERE= regular zdr3gU7+2/G05oo6ta/IfHlkTF0= paragraph text This function appends a segment to the end of the path. Reserved characters in the string are automatically escaped. paragraph text All end iterators are invalidated. heading text Postconditions 1 code this->back() == s heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. brief text Append a segment param text The segment to append. s identifier void identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 replace boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 543 5 1 boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 573 5 1 boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 613 5 1 boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 653 5 1 overloads 1gPxWts+COnggCmEY+jFMaMueUs= regular zdr3gU7+2/G05oo6ta/IfHlkTF0= brief text Replace segments returns text An iterator to the replaced segment. returns text An iterator to the new segment. returns text An iterator to the first segment inserted, or one past code text to text if code text init.size() == 0 text . param text An iterator to the segment. pos param text The string to assign. s param text The beginning of the range of segments to replace. from param text The end of the range of segments to replace. to param text The list of segments to assign. init param text The beginning of the range of segments to assign. first param text The end of the range of segments to assign. last normal Xc7GRtURrDuIx9hU5zwjeuPO+8Q= S2FK13kWWDfcPxOgjxbi3h2Sltw= IJ6Vu12OFGjGPmnV9h7THG7k83c= e0Co52pl+qsDVNfc3Vu3Cy3GyZM= identifier v0DfmyG7n+onJnPwu0SmkmEIIs4= iterator replace boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 543 5 1 function Xc7GRtURrDuIx9hU5zwjeuPO+8Q= regular zdr3gU7+2/G05oo6ta/IfHlkTF0= paragraph text This function replaces the segment at the specified position. Reserved characters in the string are automatically escaped. paragraph text All iterators that are equal to code text pos text or come after are invalidated. heading text Complexity 1 paragraph text Linear in code text s.size() + this->url().encoded_resouce().size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. brief text Replace segments returns text An iterator to the replaced segment. param text An iterator to the segment. pos param text The string to assign. s identifier v0DfmyG7n+onJnPwu0SmkmEIIs4= iterator identifier v0DfmyG7n+onJnPwu0SmkmEIIs4= iterator pos identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 replace boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 573 5 1 function S2FK13kWWDfcPxOgjxbi3h2Sltw= regular zdr3gU7+2/G05oo6ta/IfHlkTF0= paragraph text This function replaces a range of segments with one segment. Reserved characters in the string are automatically escaped. paragraph text All iterators that are equal to code text from text or come after are invalidated. heading text Complexity 1 paragraph text Linear in code text s.size() + this->url().encoded_resouce().size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. brief text Replace segments returns text An iterator to the new segment. param text The beginning of the range of segments to replace. from param text The end of the range of segments to replace. to param text The string to assign. s identifier v0DfmyG7n+onJnPwu0SmkmEIIs4= iterator identifier v0DfmyG7n+onJnPwu0SmkmEIIs4= iterator from identifier v0DfmyG7n+onJnPwu0SmkmEIIs4= iterator to identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 replace boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 613 5 1 function IJ6Vu12OFGjGPmnV9h7THG7k83c= regular zdr3gU7+2/G05oo6ta/IfHlkTF0= paragraph text This function replaces a range of segments with a list of segments in an initializer list. Reserved characters in the list are automatically escaped. paragraph text All iterators that are equal to code text from text or come after are invalidated. heading text Preconditions 1 paragraph text None of the character buffers referenced by the list may overlap the character buffer of the underlying url, or else the behavior is undefined. heading text Complexity 1 paragraph text Linear in code text init.size() + this->url().encoded_resouce().size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. brief text Replace segments returns text An iterator to the first segment inserted, or one past code text to text if code text init.size() == 0 text . param text The beginning of the range of segments to replace. from param text The end of the range of segments to replace. to param text The list of segments to assign. init identifier v0DfmyG7n+onJnPwu0SmkmEIIs4= iterator identifier v0DfmyG7n+onJnPwu0SmkmEIIs4= iterator from identifier v0DfmyG7n+onJnPwu0SmkmEIIs4= iterator to specialization 3tT5Y8vozttMWXrA/fNw4NcDYTE= initializer_list identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std init normal 1 replace boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 653 5 1 function e0Co52pl+qsDVNfc3Vu3Cy3GyZM= regular zdr3gU7+2/G05oo6ta/IfHlkTF0= paragraph text This function replaces a range of segments with annother range of segments. Reserved characters in the new range are automatically escaped. paragraph text All iterators that are equal to code text from text or come after are invalidated. heading text Preconditions 1 paragraph text None of the character buffers referenced by the new range may overlap the character buffer of the underlying url, or else the behavior is undefined. heading text Complexity 1 paragraph text Linear in code text std::distance( first, last ) + this->url().encoded_resouce().size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. brief text Replace segments returns text An iterator to the first segment inserted, or one past code text to text if code text init.size() == 0 text . param text The beginning of the range of segments to replace. from param text The end of the range of segments to replace. to param text The beginning of the range of segments to assign. first param text The end of the range of segments to assign. last identifier v0DfmyG7n+onJnPwu0SmkmEIIs4= iterator identifier v0DfmyG7n+onJnPwu0SmkmEIIs4= iterator from identifier v0DfmyG7n+onJnPwu0SmkmEIIs4= iterator to identifier FwdIt first identifier FwdIt last normal 1 size boost/url/segments_base.hpp include/boost/url/segments_base.hpp 212 5 1 function yBM8jUZ7lUhztKUrKAMCVlF/JSM= regular ge9cOBTN19ywbVTnB5ajdJUC46Q= heading text Example 1 code assert( url_view( "/path/to/file.txt" ).segments().size() == 3 ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the number of segments returns text The number of segments. identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 1 url boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 231 5 1 function t+7RWQooKrtJXGKQJu70HNfs5V0= regular zdr3gU7+2/G05oo6ta/IfHlkTF0= paragraph text This function returns the url referenced by the view. heading text Example 1 code url u( "/path/to/file.txt" ); assert( &u.segments().url() == &u ); heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the referenced url returns text A reference to the url. identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base normal 1 1 operator segments_view boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 205 5 1 function Yjmz7FLx2FKEMNm77t8koOdVeiw= regular zdr3gU7+2/G05oo6ta/IfHlkTF0= brief text Conversion returns text A view of the segments. see reference segments_view ZNJOLZ4RhCB2A2ooiNo7KxZJHrA= text . identifier ZNJOLZ4RhCB2A2ooiNo7KxZJHrA= segments_view conversion 1 1 max_size boost/url/segments_base.hpp include/boost/url/segments_base.hpp 127 5 1 function 4eJ21Hl5fc2lKip4HsTT2daKD58= regular ge9cOBTN19ywbVTnB5ajdJUC46Q= paragraph text This represents the largest number of characters that are possible in a path, not including any null terminator. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the maximum number of characters possible returns text The maximum number of characters possible. identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 segments_view boost/url/segments_view.hpp include/boost/url/segments_view.hpp 50 1 1 boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 24 1 record ZNJOLZ4RhCB2A2ooiNo7KxZJHrA= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text Presents the path of a URL as a read-only bidirectional range of percent-decoded segments. The range references the original buffer, so callers must keep that storage alive for as long as the view is accessed. heading text Example 1 code url_view u( "/path/to/file.txt" ); segments_view ps = u.segments(); assert( ps.buffer().data() == u.buffer().data() ); paragraph text Any percent-escapes are decoded on demand when iterators are dereferenced. heading text Iterator Invalidation 1 paragraph text Changes to the underlying character buffer can invalidate iterators which reference it. brief text Non-owning decoded path segment view see reference segments_encoded_view EvaX3SmNTAtai2Kf6Kma3fUkTkQ= text , reference segments_encoded_ref TCUUfRiqZjX62kt7tK2fs//VWr0= text , reference segments_ref zdr3gU7+2/G05oo6ta/IfHlkTF0= text . class identifier ge9cOBTN19ywbVTnB5ajdJUC46Q= segments_base 0tGsE1R1TOpKN9IAKzyNn7msre4= IwhREgq3doOt5R+7CpjDu5HXeJc= ZGzGSpAZlXL0sCedyhjsT90U4S0= yenFqEfqqK2NrZ+2hs1Il0Gkg/Q= q0c7sMK+HhivONBaUVBcT+YLGYQ= 28sEF1YglFKmk+Kcl4ymHBd02MI= Qbre70Zj14MwjhtttKNLW91WVxM= ydzw5w8huQuG9pteNJoeKOKbYR8= FWGpy6a5UHxn4hL/tsnvXl0/+fs= SiUbAVvbiztqJmIoYwdvkoQyi90= RJFHEvDTVOSBEWC5A/qqcBSNc14= v5AF2vYTekOYGThG7Nle0P0fwU4= Bkl327dG/7JY0gyN644pnPkCyj0= oBgrqTEOKSIfUQVCZCwbVHu9pe4= EZ3AwpJPJ+eUXoULAfCVAA57yQU= G6s0M4MqJFqoPBxyx/2YT3jn4W8= yBM8jUZ7lUhztKUrKAMCVlF/JSM= 4eJ21Hl5fc2lKip4HsTT2daKD58= f+NvaOSPnJsrxskms8N3bJCg+0g= identifier zdr3gU7+2/G05oo6ta/IfHlkTF0= segments_ref zdr3gU7+2/G05oo6ta/IfHlkTF0= identifier EvaX3SmNTAtai2Kf6Kma3fUkTkQ= segments_encoded_view EvaX3SmNTAtai2Kf6Kma3fUkTkQ= identifier UEVNhDEjkZMXfjN1DxbtX0n2rCg= url_view_base UEVNhDEjkZMXfjN1DxbtX0n2rCg= const_iterator boost/url/segments_base.hpp include/boost/url/segments_base.hpp 77 5 1 typedef 0tGsE1R1TOpKN9IAKzyNn7msre4= regular ge9cOBTN19ywbVTnB5ajdJUC46Q= paragraph text Objects of this type allow iteration through the segments in the path. Any percent-escapes in returned strings are decoded first. The values returned are read-only; changes to segments must be made through the container instead, if the container supports modification. paragraph text The strings produced when iterators are dereferenced belong to the iterator and become invalidated when that particular iterator is incremented, decremented, or destroyed. brief text A Bidirectional iterator to a path segment iterator identifier v0DfmyG7n+onJnPwu0SmkmEIIs4= iterator 1 const_reference boost/url/segments_base.hpp include/boost/url/segments_base.hpp 100 5 1 typedef IwhREgq3doOt5R+7CpjDu5HXeJc= regular ge9cOBTN19ywbVTnB5ajdJUC46Q= paragraph text This is the type of value returned when iterators of the view are dereferenced. brief text The reference type reference identifier UwlFvW1lEI5kSm1M2LJ8livaK7g= string identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std 1 difference_type boost/url/segments_base.hpp include/boost/url/segments_base.hpp 108 5 1 typedef ZGzGSpAZlXL0sCedyhjsT90U4S0= regular ge9cOBTN19ywbVTnB5ajdJUC46Q= brief text A signed integer type used to represent differences. identifier EH4n8sIj03HafoTNn2U36T1P+Hc= ptrdiff_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std 1 reference boost/url/segments_base.hpp include/boost/url/segments_base.hpp 97 5 1 typedef yenFqEfqqK2NrZ+2hs1Il0Gkg/Q= regular ge9cOBTN19ywbVTnB5ajdJUC46Q= paragraph text This is the type of value returned when iterators of the view are dereferenced. brief text The reference type identifier UwlFvW1lEI5kSm1M2LJ8livaK7g= string identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std 1 size_type boost/url/segments_base.hpp include/boost/url/segments_base.hpp 104 5 1 typedef q0c7sMK+HhivONBaUVBcT+YLGYQ= regular ge9cOBTN19ywbVTnB5ajdJUC46Q= brief text An unsigned integer type used to represent size. identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std 1 value_type boost/url/segments_base.hpp include/boost/url/segments_base.hpp 90 5 1 typedef 28sEF1YglFKmk+Kcl4ymHBd02MI= regular ge9cOBTN19ywbVTnB5ajdJUC46Q= paragraph text Values of this type represent a segment where unique ownership is retained by making a copy. heading text Example 1 code segments_base::value_type ps( url_view( "/path/to/file.txt" ).segments().back() ); brief text The value type identifier UwlFvW1lEI5kSm1M2LJ8livaK7g= string identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std 1 iterator boost/url/impl/segments_base.hpp include/boost/url/impl/segments_base.hpp 26 1 boost/url/segments_base.hpp include/boost/url/segments_base.hpp 74 5 1 record Qbre70Zj14MwjhtttKNLW91WVxM= see-below 1 ZNJOLZ4RhCB2A2ooiNo7KxZJHrA= paragraph text Objects of this type allow iteration through the segments in the path. Any percent-escapes in returned strings are decoded first. The values returned are read-only; changes to segments must be made through the container instead, if the container supports modification. paragraph text The strings produced when iterators are dereferenced belong to the iterator and become invalidated when that particular iterator is incremented, decremented, or destroyed. brief text A Bidirectional iterator to a path segment class identifier zdr3gU7+2/G05oo6ta/IfHlkTF0= segments_ref zdr3gU7+2/G05oo6ta/IfHlkTF0= identifier ge9cOBTN19ywbVTnB5ajdJUC46Q= segments_base ge9cOBTN19ywbVTnB5ajdJUC46Q= segments_view boost/url/segments_view.hpp include/boost/url/segments_view.hpp 108 5 1 boost/url/segments_view.hpp include/boost/url/segments_view.hpp 82 5 1 boost/url/segments_view.hpp include/boost/url/segments_view.hpp 159 5 1 boost/url/segments_view.hpp include/boost/url/segments_view.hpp 224 5 1 overloads ydzw5w8huQuG9pteNJoeKOKbYR8= regular ZNJOLZ4RhCB2A2ooiNo7KxZJHrA= brief text Constructor param text The other view. other param text The string to parse. s param text The beginning iterator. first param text The ending iterator. last throws code text s text contains an invalid path. reference system_error constructor xup3nwwyorPFymGBU7c4wNwY6Io= 0cHQ+7V5eDQgnGquC1jWEshsR58= 6Iuf1/aBc8j1vZPIdZUI+IuUksE= rsFmGNGj/sKltk1KFytGNrY5TZs= identifier void segments_view boost/url/segments_view.hpp include/boost/url/segments_view.hpp 82 5 1 function xup3nwwyorPFymGBU7c4wNwY6Io= regular ZNJOLZ4RhCB2A2ooiNo7KxZJHrA= paragraph text Default-constructed segments have zero elements. heading text Example 1 code segments_view ps; heading text Effects 1 code return segments_view( "" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Constructor identifier void constructor 1 segments_view boost/url/segments_view.hpp include/boost/url/segments_view.hpp 108 5 1 function 0cHQ+7V5eDQgnGquC1jWEshsR58= regular ZNJOLZ4RhCB2A2ooiNo7KxZJHrA= paragraph text After construction, viewss reference the same underlying character buffer. paragraph text Ownership is not transferred; the caller is responsible for ensuring the lifetime of the buffer extends until it is no longer referenced. heading text Postconditions 1 code this->buffer().data() == other.buffer().data() heading text Complexity 1 paragraph text Constant heading text Exception Safety 1 paragraph text Throws nothing brief text Constructor param text The other view. other identifier void 1 identifier ZNJOLZ4RhCB2A2ooiNo7KxZJHrA= segments_view other constructor 1 1 1 segments_view boost/url/segments_view.hpp include/boost/url/segments_view.hpp 159 5 1 function 6Iuf1/aBc8j1vZPIdZUI+IuUksE= regular ZNJOLZ4RhCB2A2ooiNo7KxZJHrA= paragraph text This function constructs segments from a valid path string, which can contain percent escapes. Upon construction, the view references the character buffer pointed to by code text s text . caller is responsible for ensuring that the lifetime of the buffer extends until the view is destroyed. heading text Example 1 code segments_view ps( "/path/to/file.txt" ); heading text Effects 1 code return parse_path( s ).value(); heading text Postconditions 1 code this->buffer().data() == s.data() heading text Complexity 1 paragraph text Linear in code text s text . heading text Exception Safety 1 paragraph text Exceptions thrown on invalid input. heading text BNF 1 code path = [ "/" ] [ segment *( "/" segment ) ] segment = *pchar heading text Specification 1 list paragraph link text 3.3. Path https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text Constructor param text The string to parse. s throws code text s text contains an invalid path. reference system_error identifier void identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s constructor 1 segments_view boost/url/segments_view.hpp include/boost/url/segments_view.hpp 224 5 1 function rsFmGNGj/sKltk1KFytGNrY5TZs= regular ZNJOLZ4RhCB2A2ooiNo7KxZJHrA= paragraph text This function creates a new reference segments_view ydzw5w8huQuG9pteNJoeKOKbYR8= text from a pair of iterators referring to elements of another segments view. The resulting view references the same underlying character buffer as the original. paragraph text The constructed view preserves the original absolute flag when code text first text selects the first segment and otherwise produces an absolute subview: if the source path is relative and `first == ps.begin()` the new view is relative, and in every other case the subview is absolute with the separator immediately preceding code text *first text retained at the front. This ensures the underlying text can be reconstructed by concatenating the buffers of adjacent subviews. paragraph text The caller is responsible for ensuring that the lifetime of the original buffer extends until the constructed view is no longer referenced. heading text Example 1 code segments_view ps( "/path/to/file.txt" ); segments_view sub( std::next(ps.begin()), ps.end()); segments_view first_half( ps.begin(), std::next(ps.begin())); // sub represents "/to/file.txt" std::string combined(first_half.buffer()); combined.append(sub.buffer()); BOOST_ASSERT(combined == ps.buffer()); heading text Preconditions 1 paragraph text The iterators must be valid and belong to the same reference segments_view ydzw5w8huQuG9pteNJoeKOKbYR8= text . heading text Postconditions 1 paragraph code text sub.buffer() text references characters in the original code text ps.buffer() text . heading text Complexity 1 paragraph text Constant heading text Exception Safety 1 paragraph text Throws nothing. brief text Constructor param text The beginning iterator. first param text The ending iterator. last identifier void identifier v0DfmyG7n+onJnPwu0SmkmEIIs4= iterator first identifier v0DfmyG7n+onJnPwu0SmkmEIIs4= iterator last constructor 1 operator= boost/url/segments_view.hpp include/boost/url/segments_view.hpp 253 5 1 function FWGpy6a5UHxn4hL/tsnvXl0/+fs= regular ZNJOLZ4RhCB2A2ooiNo7KxZJHrA= paragraph text After assignment, both views reference the same underlying character buffer. paragraph text Ownership is not transferred; the caller is responsible for ensuring the lifetime of the buffer extends until it is no longer referenced. heading text Postconditions 1 code this->buffer().data() == other.buffer().data() heading text Complexity 1 paragraph text Constant heading text Exception Safety 1 paragraph text Throws nothing brief text Assignment returns text A reference to this object. param text The other view. other identifier ZNJOLZ4RhCB2A2ooiNo7KxZJHrA= segments_view 1 identifier ZNJOLZ4RhCB2A2ooiNo7KxZJHrA= segments_view other normal 1 1 1 back boost/url/segments_base.hpp include/boost/url/segments_base.hpp 279 5 1 function SiUbAVvbiztqJmIoYwdvkoQyi90= regular ge9cOBTN19ywbVTnB5ajdJUC46Q= heading text Preconditions 1 code this->empty() == false heading text Example 1 code assert( url_view( "/path/to/file.txt" ).segments().back() == "file.txt" ); heading text Preconditions 1 code this->empty() == false heading text Effects 1 code return *--end(); heading text Complexity 1 paragraph text Linear in code text this->back().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. brief text Return the last segment returns text The last segment. identifier UwlFvW1lEI5kSm1M2LJ8livaK7g= string identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 1 begin boost/url/segments_base.hpp include/boost/url/segments_base.hpp 293 5 1 function RJFHEvDTVOSBEWC5A/qqcBSNc14= regular ge9cOBTN19ywbVTnB5ajdJUC46Q= heading text Complexity 1 paragraph text Linear in code text this->front().size() text or constant if code text this->empty() text . heading text Exception Safety 1 paragraph text Throws nothing. brief text Return an iterator to the beginning returns text An iterator to the first segment. identifier v0DfmyG7n+onJnPwu0SmkmEIIs4= iterator normal 1 1 buffer boost/url/segments_base.hpp include/boost/url/segments_base.hpp 155 5 1 function v5AF2vYTekOYGThG7Nle0P0fwU4= regular ge9cOBTN19ywbVTnB5ajdJUC46Q= paragraph text This function returns the character buffer referenced by the view. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "/path/to/file.txt" ).segments().buffer() == "/path/to/file.txt" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the referenced character buffer. returns text A string containing the path. identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 empty boost/url/segments_base.hpp include/boost/url/segments_base.hpp 194 5 1 function Bkl327dG/7JY0gyN644pnPkCyj0= regular ge9cOBTN19ywbVTnB5ajdJUC46Q= heading text Example 1 code assert( ! url_view( "/index.htm" ).segments().empty() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return true if there are no segments returns code text true text if there are no segments, otherwise code text false text . identifier bool normal 1 1 end boost/url/segments_base.hpp include/boost/url/segments_base.hpp 306 5 1 function oBgrqTEOKSIfUQVCZCwbVHu9pe4= regular ge9cOBTN19ywbVTnB5ajdJUC46Q= heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return an iterator to the end returns text An iterator to one past the last segment. identifier v0DfmyG7n+onJnPwu0SmkmEIIs4= iterator normal 1 1 front boost/url/segments_base.hpp include/boost/url/segments_base.hpp 246 5 1 function EZ3AwpJPJ+eUXoULAfCVAA57yQU= regular ge9cOBTN19ywbVTnB5ajdJUC46Q= paragraph text This function returns a string with the first segment of the path without any leading or trailing '/' separators. Any percent-escapes in the string are decoded first. heading text Preconditions 1 code this->empty() == false heading text Effects 1 code return *begin(); heading text Example 1 code assert( url_view( "/path/to/file.txt" ).segments().front() == "path" ); heading text Complexity 1 paragraph text Linear in code text this->front().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. brief text Return the first segment returns text The first segment. identifier UwlFvW1lEI5kSm1M2LJ8livaK7g= string identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 1 is_absolute boost/url/segments_base.hpp include/boost/url/segments_base.hpp 176 5 1 function G6s0M4MqJFqoPBxyx/2YT3jn4W8= regular ge9cOBTN19ywbVTnB5ajdJUC46Q= paragraph text Absolute paths always start with a forward slash ('/'). heading text Example 1 code assert( url_view( "/path/to/file.txt" ).segments().is_absolute() == true ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Returns true if this references an absolute path. returns code text true text if the path is absolute, otherwise code text false text . identifier bool normal 1 1 size boost/url/segments_base.hpp include/boost/url/segments_base.hpp 212 5 1 function yBM8jUZ7lUhztKUrKAMCVlF/JSM= regular ge9cOBTN19ywbVTnB5ajdJUC46Q= heading text Example 1 code assert( url_view( "/path/to/file.txt" ).segments().size() == 3 ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the number of segments returns text The number of segments. identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 1 max_size boost/url/segments_base.hpp include/boost/url/segments_base.hpp 127 5 1 function 4eJ21Hl5fc2lKip4HsTT2daKD58= regular ge9cOBTN19ywbVTnB5ajdJUC46Q= paragraph text This represents the largest number of characters that are possible in a path, not including any null terminator. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the maximum number of characters possible returns text The maximum number of characters possible. identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 static_url boost/url/static_url.hpp include/boost/url/static_url.hpp 105 1 1 boost/url/static_url.hpp include/boost/url/static_url.hpp 23 1 record 4HBDcnMjZthTXFnhpS7z+UhDNjA= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text This container owns a url, represented by an inline, null-terminated character buffer with fixed capacity. The contents may be inspected and modified, and the implementation maintains a useful invariant: changes to the url always leave it in a valid state. heading text Example 1 code static_url< 1024 > u( "https://www.example.com" ); heading text Invariants 1 code this->capacity() == Capacity + 1 brief text A modifiable container for a URL. t-param text The maximum capacity in characters, not including the null terminator. Capacity see reference url B4dRaSXMG3fDmuNKMW3KOeRu6kA= text , reference url_view wh3UbUToX9YDmRmnpcoM9EUEZo8= text . reference format_to K7ofEKM2bNb4ZS9OFo0DX+7Ep9I= reference format_to ueXaMbO5jFzZWelOn6upDJcN55Y= reference operator!= QA2q/R+XvrJl2j8UnJwv+lnhdDA= reference operator< Si07vh35lnvnJy8tpXUIpiFEjGM= reference operator<= rRCHC/6GEaVZrjzAeFDlvaCydi0= reference operator== E2+0o+/H5dWqJ1IkTzJ6aHTaMHE= reference operator> ngGy21anUjaZiQQJidHT5lvOC2w= reference operator>= AdXFp/RvPKHF4rljfa5/5yBmyfs= reference resolve /6zWjIFN5df0PBj9zFsfNUjNY6s= class identifier dmsqdje8dXFRFgNB9wxOs9Y5nb8= static_url_base WYhDZyKg9+HytIwRowGryE7RigU= UJqneUQSMdwOiE39fVUkGksoIMI= cM0oo0VbodeQ1IXWnhG6goAP79c= v5/R9LI0iKJDiBrNUt7k8qrVBdM= oDNnPxjP34HYhoUyyduWMZfqZs4= OUdGewqojyZZ2vohOsR/ce3sgdM= FPqXKVymUm0eRCsXV1yuMFlv4ug= PMYRGpyOUt7hbDyd33GRHTcxEj8= p+2L2asXUGpE7eey1ouRvFXKD1g= I2WjK21z+iS45kbL4TnzA8O5oE0= 5yR7btLz2K+NLHFnzfXMyGsq2fo= Ww04vLA2k7BwctuyNeP3KwoNr4M= M7+OzewsxChMvecRSytXqTCqKrY= EcGxt+esOtVfjloInubXUYLy5GY= yXsUZRbi+wInLqaUUVy9b7nIIBo= 9ptIMbwWSNtVv+KAUpHCO3bmTWg= 4URKnuP+gvIUVjIkywv/pXeFjv4= wG6ey1727HIj10Wh+OD/s8kuOjo= tDMWbnBabN2mGSH3Apn445gDMEQ= W9oZv0BM5z4XAggQPbNAKIM7/ro= GNlqbV0MSxGIA/gSjlOb2rfSHhU= suU4/MiRITTTYf61BFw2aI6WxdI= yLMNPjiW4s31xcLN4xOiqVySYLA= qeLAK8oZj7+xpHv7Pyh0yYASuqU= IcodRek43l5Zc13Z67L74PlhG0U= oYwrnXcglhO4tlvhkxLGfFCYbAk= yzkq+uCmbTlXrfDuyd1fT0Zu6xw= 5M2smbXDaSa2d/li//A+GmlDgDU= aA1Q9NAW4/TnG3SXhe4k1mNB5nk= gadV3YsYDjlGX+64Rtiz4S+QD4A= ZiWsQaQCAif94KdP6GXH9+F5GmM= 9JACnsebk8tFsoryabfDxE8VpnA= 5V5uOhRsy00O+TSEAkIb7uFoN2U= SLiWca6gUGmTh+r/BbU40NrICW8= iwSH2fvVkb89TkZj7KWLGSyc4sA= i/v5Vfq44OnlLbuKgQ2KvgWgZqo= ICcovOIyqnxhSMU6MuEekYg2z+E= F0RYzLwUP8ied6l3zmKvomgFHag= KL8F3KYxyzpC1e6fqoJy3B8IHhw= CvoRh2IpWg4QixngVwDjSKoeQVY= 55Yh68uToEiKy+IDTpyctuK/T3g= AhPhrC4hmBsZgd/ztqbkAuOkbBM= Nv9Emy6spILLI/mqyIz2uRNBJhU= eh5BeHbLjL3BuEY7ao3tbEAZnTw= L2Z21HVmwJtKqNOMTyQFY4JQ+1o= qk2f0tqyaZwxuSA2dS+0Zj9T+5w= 9CJcPfVnJvVk0zBf34CB8xfETIg= 1gxbOWXXkNcHf0a7aqVLoeQbw4w= bi805EoX8OTri5KIPxrlqmiZtE8= QIsV9n6MWFnqA0MZenHn3zX9jt8= wdcIrRY9aj9gn6bF1i59TpOAQb4= +ZB55yb2DeVYG+/eYqlMcGcedVE= Q5NVO+d/+BmZ5v3/ogNb2XpUTKs= cRPG1npIXmfYC0K+C+idxOqIc04= OlWcRIIUl1cq5Ab9fLXGPyhYCfI= lctXu8FITJWg0+Y+yZVt5iv7QDM= 4epyMikskiBx2Gu+S87oAhrM/ZY= MPuGLe4mCyOKSSQn7S4dh3SMX90= vlLHNM13ymUzmjWB6UhixNSj74k= zpYwaJSR17hZMraeX0G0cTNJI68= MQlcavJoBHnGjmgTMowtBTZ9n5A= 0MEk6Ddnsq5FQhANarFWyfhL4/M= IYZqU1YD/Yk8eV1APcJAB1m/E/M= RDtnbPaPAWgiqF4O91xaQbfnghQ= mFEIJCpzEh4h8vUKHZxjlOuZoao= R5AajT/eZPgijKrm8AxolAdhsRQ= 3Pi5l1khAbVAQHD3fWi5GoHEr5E= 43fxogaC5oVqfauhwXyN4s4ibEM= uM37WpBqetqzfHjns3M8/+CcoEU= coMz0KQ2BIuACsWbIRZ/6lTOmuk= vlMSELWXcWTwdf2/dZGlv0TYnHA= m72MkIEEYt8H1GVoxvQZHBwWY1A= WTVVGr7kT7qnFaI6e/getY73eAI= jlXXuOvH7OFDJ92kr+Ha02sixZY= vyW7/09OitF6fXON1o2ftFzwX0Y= S9fyQqerhxu7yBt8GhsEJ9RKJl8= mUCYlTgG9KMapdW4rMNGGyUC2eY= ZtNFxErPLOzV+1Hgm4Z5rSqtm00= 4AIKM/5iinX3DS4QhIO4XJUfuzw= ScaSqMYZdNZbpN1CvNkkcKQ/mBY= c4/wDJ3igTWJNUnNsXC3LS2Fazc= Tl61JQhOPE2BzstsH+PNh3+HPAI= +4IRFmcYy74cW/dNQ+7qmhQ1mdU= c6/kyTU/r4vjSPQM1DnwtnTv3/o= TGaSnQ4PS0WINemStJIm4VLR0rI= J2yY5s29/Vm0kL+xtvGZMflIdkI= Guwgs2WWqZMqTOkuQucJUI0fpO8= 6YBmlxPZA2kZSlYjMb1sLD6KrGQ= UaE/Nbim4fGJNSgi8xJbANtFuso= l3egvbg5aBpsjCXp8RnOSZ8DzX4= sIGA8IQp3kSw3ip4pm7lmc1s9C4= VqDEXtjQm5PewYuAWxjhVpm2+MY= BHDHQef0k/8vd3QskLyTrsv7+DE= ay+XTyyJRSCsLBhW5JNwRtngbwo= vvvc+qpbS5HUTGzLHaY+KnnRbGQ= 4zoimIYzrVVdns97BxYUtHZkP8w= Lc5XBzZs/ayxU18Djd6Q0BHFWv4= rtAxCFit/TGmjKYS6TFVsrBNQEI= C6kqHeeHWCV8aBfJIaZHzF3nxi4= he1jodL9CeOuw4MBdmIdXvYfXMk= bEmCJdx+TpNi361IL4hPfZSdUWI= b5EwiMBFGrk0/BIGaiumuCVSoFM= /oa6wZJEG852J9Yi1LQlnq1n1tM= S9yd7MVhXxF+598Xy2/+jwnCZzc= rN6p9/aLARL9S9gn02k+M+j21q8= 0JOtXYOmKvCl2dNIZYV6J7flgJE= mg8FRYZ94og9lKYjTEYdjucqHw4= aSDB3babl7TsiU0T+gdHMM/NC5c= specialization PJd7qch01fTpaC83fxeMwg+clc0= hash identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std PJd7qch01fTpaC83fxeMwg+clc0= static_url boost/url/static_url.hpp include/boost/url/static_url.hpp 164 5 1 overloads WYhDZyKg9+HytIwRowGryE7RigU= regular 4HBDcnMjZthTXFnhpS7z+UhDNjA= brief text Constructor param text The url to copy. u param text The string to parse. s throws text The input does not contain a valid url. reference system_error constructor mEkgYHAc/HYClOyXcF9nTEfpbP4= n2/to9j8CotfITBMUa6mO/VikSc= ggZkLD7wiXC1v7fr28mqgIniaL0= vNUaO1bY7ac8xTQ7BeZb6STvikU= identifier void static_url boost/url/static_url.hpp include/boost/url/static_url.hpp 164 5 1 function mEkgYHAc/HYClOyXcF9nTEfpbP4= regular 4HBDcnMjZthTXFnhpS7z+UhDNjA= paragraph text Default constructed urls contain a zero-length string. This matches the grammar for a relative-ref with an empty path and no query or fragment. heading text Example 1 code static_url< 1024 > u; heading text Postconditions 1 code this->empty() == true heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code relative-ref = relative-part [ "?" query ] [ "#" fragment ] heading text Specification 1 brief text Constructor identifier void constructor 1 static_url boost/url/static_url.hpp include/boost/url/static_url.hpp 242 5 1 function n2/to9j8CotfITBMUa6mO/VikSc= regular 4HBDcnMjZthTXFnhpS7z+UhDNjA= paragraph text The newly constructed object contains a copy of code text u text . heading text Postconditions 1 code this->buffer() == u.buffer() && this->buffer.data() != u.buffer().data() heading text Complexity 1 paragraph text Linear in code text u.size() text . heading text Exception Safety 1 paragraph text Throws nothing. brief text Constructor param text The url to copy. u identifier void 1 identifier 4HBDcnMjZthTXFnhpS7z+UhDNjA= static_url u constructor 1 static_url boost/url/static_url.hpp include/boost/url/static_url.hpp 216 5 1 function ggZkLD7wiXC1v7fr28mqgIniaL0= regular 4HBDcnMjZthTXFnhpS7z+UhDNjA= paragraph text This function constructs a url from the string code text s text , which must contain a valid emph text URI text or emph text relative-ref text or else an exception is thrown. The new url retains ownership by making a copy of the passed string. heading text Example 1 code static_url< 1024 > u( "https://www.example.com" ); heading text Effects 1 code return static_url( parse_uri_reference( s ).value() ); heading text Postconditions 1 code this->buffer().data() != s.data() heading text Complexity 1 paragraph text Linear in code text s.size() text . heading text Exception Safety 1 paragraph text Exceptions thrown on invalid input. heading text BNF 1 code URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] relative-ref = relative-part [ "?" query ] [ "#" fragment ] heading text Specification 1 list paragraph link text 4.1. URI Reference https://datatracker.ietf.org/doc/html/rfc3986#section-4.1 unordered brief text Constructor param text The string to parse. s throws text The input does not contain a valid url. reference system_error identifier void identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s constructor 1 static_url boost/url/static_url.hpp include/boost/url/static_url.hpp 270 5 1 function vNUaO1bY7ac8xTQ7BeZb6STvikU= regular 4HBDcnMjZthTXFnhpS7z+UhDNjA= paragraph text The newly constructed object contains a copy of code text u text . heading text Postconditions 1 code this->buffer() == u.buffer() && this->buffer.data() != u.buffer().data() heading text Complexity 1 paragraph text Linear in code text u.size() text . heading text Exception Safety 1 paragraph text Exception thrown if capacity exceeded. brief text Constructor param text The url to copy. u throws text Capacity would be exceeded. reference system_error identifier void 1 identifier UEVNhDEjkZMXfjN1DxbtX0n2rCg= url_view_base u constructor 1 ~static_url boost/url/static_url.hpp include/boost/url/static_url.hpp 129 5 1 function UJqneUQSMdwOiE39fVUkGksoIMI= regular 4HBDcnMjZthTXFnhpS7z+UhDNjA= paragraph text Any params, segments, iterators, or views which reference this object are invalidated. The underlying character buffer is destroyed, invalidating all references to it. brief text Destructor identifier void destructor 1 1 1 1 operator= boost/url/static_url.hpp include/boost/url/static_url.hpp 298 5 1 overloads cM0oo0VbodeQ1IXWnhG6goAP79c= regular 4HBDcnMjZthTXFnhpS7z+UhDNjA= brief text Assignment returns text A reference to this object. param text The url to copy. u throws text Capacity would be exceeded. reference system_error normal ZbZVVtfA1JKtM1dcN2cV7GcXCZY= xHg0bhQF0gPax0+KtdpIwbK2efA= identifier 4HBDcnMjZthTXFnhpS7z+UhDNjA= static_url operator= boost/url/static_url.hpp include/boost/url/static_url.hpp 298 5 1 function ZbZVVtfA1JKtM1dcN2cV7GcXCZY= regular 4HBDcnMjZthTXFnhpS7z+UhDNjA= paragraph text The contents of code text u text are copied and the previous contents of code text this text are discarded. Capacity remains unchanged. heading text Postconditions 1 code this->buffer() == u.buffer() && this->buffer().data() != u.buffer().data() heading text Complexity 1 paragraph text Linear in code text u.size() text . heading text Exception Safety 1 paragraph text Throws nothing. brief text Assignment returns text A reference to this object. param text The url to copy. u identifier 4HBDcnMjZthTXFnhpS7z+UhDNjA= static_url 1 identifier 4HBDcnMjZthTXFnhpS7z+UhDNjA= static_url u normal 1 operator= boost/url/static_url.hpp include/boost/url/static_url.hpp 331 5 1 function xHg0bhQF0gPax0+KtdpIwbK2efA= regular 4HBDcnMjZthTXFnhpS7z+UhDNjA= paragraph text The contents of code text u text are copied and the previous contents of code text this text are discarded. heading text Postconditions 1 code this->buffer() == u.buffer() && this->buffer().data() != u.buffer().data() heading text Complexity 1 paragraph text Linear in code text u.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Exception thrown if capacity exceeded. brief text Assignment returns text A reference to this object. param text The url to copy. u throws text Capacity would be exceeded. reference system_error identifier 4HBDcnMjZthTXFnhpS7z+UhDNjA= static_url 1 identifier UEVNhDEjkZMXfjN1DxbtX0n2rCg= url_view_base u normal 1 authority boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 564 5 1 function v5/R9LI0iKJDiBrNUt7k8qrVBdM= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the authority as an reference authority_view d/hMlyyC3Ave6L9McUD7B4TwENA= text . heading text Example 1 code authority_view a = url_view( "https://www.example.com:8080/index.htm" ).authority(); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code authority = [ userinfo "@" ] host [ ":" port ] heading text Specification 1 list paragraph link text 3.2. Authority (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2 unordered brief text Return the authority returns text An authority_view representing the authority. see reference encoded_authority Ww04vLA2k7BwctuyNeP3KwoNr4M= text , reference has_authority gadV3YsYDjlGX+64Rtiz4S+QD4A= text . identifier d/hMlyyC3Ave6L9McUD7B4TwENA= authority_view normal 1 1 buffer boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 282 5 1 function oDNnPxjP34HYhoUyyduWMZfqZs4= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the entire url, which may contain percent escapes. heading text Example 1 code assert( url_view( "http://www.example.com" ).buffer() == "http://www.example.com" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the url string returns text The url as a string. identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core normal 1 1 c_str boost/url/url_base.hpp include/boost/url/url_base.hpp 127 5 1 function OUdGewqojyZZ2vohOsR/ce3sgdM= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function returns a pointer to a null terminated string representing the url, which may contain percent escapes. heading text Example 1 code assert( std::strlen( url( "http://www.example.com" ).c_str() ) == 22 ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the url as a null-terminated string returns text A pointer to a null-terminated string containing the URL. 1 identifier char normal 1 1 capacity boost/url/url_base.hpp include/boost/url/url_base.hpp 146 5 1 function FPqXKVymUm0eRCsXV1yuMFlv4ug= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This does not include the null terminator, which is always present. heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the number of characters that can be stored without reallocating returns code text *this identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 1 clear boost/url/url_base.hpp include/boost/url/url_base.hpp 165 5 1 function PMYRGpyOUt7hbDyd33GRHTcxEj8= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= heading text Postconditions 1 code this->empty() == true heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text No-throw guarantee. brief text Clear the contents while preserving the capacity identifier void normal 1 compare boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2446 5 1 function p+2L2asXUGpE7eey1ouRvFXKD1g= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function compares two URLs according to Syntax-Based comparison algorithm. heading text Complexity 1 paragraph text Linear in code text min( u0.size(), u1.size() ) heading text Exception Safety 1 paragraph text Throws nothing. heading text Specification 1 list paragraph link text 6.2.2 Syntax-Based Normalization (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-6.2.2 unordered brief text Return the result of comparing this with another url returns text -1 if code text *this < other text , 0 if code text this == other text , and 1 if code text this > other text . param text The url to compare other identifier int 1 identifier UEVNhDEjkZMXfjN1DxbtX0n2rCg= url_view_base other normal 1 1 data boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 258 5 1 function I2WjK21z+iS45kbL4TnzA8O5oE0= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns a pointer to the first character of the url, which is not guaranteed to be null-terminated. heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return a pointer to the url's character buffer returns text A pointer to the first character. 1 identifier char normal 1 1 empty boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 238 5 1 function 5yR7btLz2K+NLHFnzfXMyGsq2fo= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text The empty string matches the emph text relative-ref text grammar. heading text Example 1 code assert( url_view( "" ).empty() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code relative-ref = relative-part [ "?" query ] [ "#" fragment ] relative-part = "//" authority path-abempty / path-absolute / path-noscheme / path-empty heading text Specification 1 list paragraph link text 4.2. Relative Reference (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-4.2 unordered brief text Return true if the url is empty returns code text true text if the url is empty. identifier bool normal 1 1 encoded_authority boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 601 5 1 function Ww04vLA2k7BwctuyNeP3KwoNr4M= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If present, this function returns a string representing the authority (which may be empty). Otherwise it returns an empty string. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "file://Network%20Drive/My%2DFiles" ).encoded_authority() == "Network%20Drive" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code authority = [ userinfo "@" ] host [ ":" port ] heading text Specification 1 list paragraph link text 3.2. Authority (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2 unordered brief text Return the authority. returns text The authority as a string. see reference authority v5/R9LI0iKJDiBrNUt7k8qrVBdM= text , reference has_authority gadV3YsYDjlGX+64Rtiz4S+QD4A= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_fragment boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2280 5 1 function M7+OzewsxChMvecRSytXqTCqKrY= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the fragment as a string with percent-escapes. Ownership is not transferred; the string returned references the underlying character buffer, which must remain valid or else undefined behavior occurs. heading text Example 1 code assert( url_view( "http://www.example.com/index.htm#a%2D1" ).encoded_fragment() == "a%2D1" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code fragment = *( pchar / "/" / "?" ) pchar = unreserved / pct-encoded / sub-delims / ":" / "@" heading text Specification 1 list paragraph link text 3.5. Fragment (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.5 unordered brief text Return the fragment returns text The fragment portion of the url. see reference fragment aA1Q9NAW4/TnG3SXhe4k1mNB5nk= text , reference has_fragment ZiWsQaQCAif94KdP6GXH9+F5GmM= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_host boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1120 5 1 function EcGxt+esOtVfjloInubXUYLy5GY= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the host portion of the authority as a string, or the empty string if there is no authority. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "https://www%2droot.example.com/" ).encoded_host() == "www%2droot.example.com" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPvFuture ) "]" reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host returns text The host address as a string. identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_host_address boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1237 5 1 function yXsUZRbi+wInLqaUUVy9b7nIIBo= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text The value returned by this function depends on the type of host returned from the function reference host_type Nv9Emy6spILLI/mqyIz2uRNBJhU= text . list paragraph text If the type is reference host_type::ipv4 49F64dAiji9HVbP6MxLQiqot7AY= text , then the IPv4 address string is returned. paragraph text If the type is reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= text , then the IPv6 address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::ipvfuture TcYJaTwDFsx+0S2CkvHHARcCqWc= text , then the IPvFuture address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= text , then the host name string is returned. Any percent-escapes in the string are decoded first. paragraph text If the type is reference host_type::none QyoMTu07h232/Sxqovu2mGoPgTo= text , then an empty string is returned. The returned string may contain percent escapes. unordered heading text Example 1 code assert( url_view( "https://www%2droot.example.com/" ).encoded_host_address() == "www%2droot.example.com" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPvFuture ) "]" reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host returns text The host address as a string. identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_host_and_port boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2325 5 1 function 9ptIMbwWSNtVv+KAUpHCO3bmTWg= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If an authority is present, this function returns the host and optional port as a string, which may be empty. Otherwise it returns an empty string. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "http://www.example.com:8080/index.htm" ).encoded_host_and_port() == "www.example.com:8080" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code authority = [ userinfo "@" ] host [ ":" port ] heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 paragraph link text 3.2.3. Port (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.3 unordered brief text Return the host and port returns text The host and port portion of the url. see reference has_port 5V5uOhRsy00O+TSEAkIb7uFoN2U= text , reference port OlWcRIIUl1cq5Ab9fLXGPyhYCfI= text , reference port_number lctXu8FITJWg0+Y+yZVt5iv7QDM= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_host_name boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1441 5 1 function 4URKnuP+gvIUVjIkywv/pXeFjv4= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If the host type is reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= text , this function returns the name as a string. Otherwise, if the host type is not an name, it returns an empty string. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "https://www%2droot.example.com/" ).encoded_host_name() == "www%2droot.example.com" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPvFuture ) "]" reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host name returns text The host name as a percent-encoded string. identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_origin boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2355 5 1 function wG6ey1727HIj10Wh+OD/s8kuOjo= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If an authority is present, this function returns the scheme and authority portion of the url. Otherwise, an empty string is returned. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "http://www.example.com:8080/index.htm?text=none#h1" ).encoded_origin() == "http://www.example.com:8080" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the origin returns text The origin portion of the url. see reference encoded_resource yLMNPjiW4s31xcLN4xOiqVySYLA= text , reference encoded_target IcodRek43l5Zc13Z67L74PlhG0U= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_params boost/url/url_base.hpp include/boost/url/url_base.hpp 2248 5 1 boost/url/url_base.hpp include/boost/url/url_base.hpp 2300 5 1 overloads tDMWbnBabN2mGSH3Apn445gDMEQ= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= brief text Return the query as a container of parameters returns code text *this returns text A bidirectional view of key/value pairs. see reference params wdcIrRY9aj9gn6bF1i59TpOAQb4= text , reference remove_query ZZWEzCK7DguUxc3TvUfizoGKplE= text , reference set_encoded_query QcQ13DUh8M8TR/zj/LDG3N/+i3c= text , reference set_query 99/QTSBQGLrNj3zGdw5VzYlqfnI= text . see reference encoded_query suU4/MiRITTTYf61BFw2aI6WxdI= text , reference has_query SLiWca6gUGmTh+r/BbU40NrICW8= text , reference params wdcIrRY9aj9gn6bF1i59TpOAQb4= text , reference query 4epyMikskiBx2Gu+S87oAhrM/ZY= text . normal aMmTh8VyfWGYracYniHLsug6OhI= JE/K4m/Ht4rR+eX6GaLeumryMhM= encoded_params boost/url/url_base.hpp include/boost/url/url_base.hpp 2300 5 1 function aMmTh8VyfWGYracYniHLsug6OhI= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function returns a bidirectional view of key/value pairs over the query. The returned view references the same underlying character buffer; ownership is not transferred. Strings returned when iterating the range may contain percent escapes. The container is modifiable; changes to the container are reflected in the underlying URL. heading text Example 1 code params_encoded_ref pv = url( "/sql?id=42&name=jane%2Ddoe&page+size=20" ).encoded_params(); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Return the query as a container of parameters returns code text *this see reference params wdcIrRY9aj9gn6bF1i59TpOAQb4= text , reference remove_query ZZWEzCK7DguUxc3TvUfizoGKplE= text , reference set_encoded_query QcQ13DUh8M8TR/zj/LDG3N/+i3c= text , reference set_query 99/QTSBQGLrNj3zGdw5VzYlqfnI= text . identifier oR5B5D0/JYTOQYvyFXRv+at91JE= params_encoded_ref normal 1 encoded_params boost/url/url_base.hpp include/boost/url/url_base.hpp 2248 5 1 function JE/K4m/Ht4rR+eX6GaLeumryMhM= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function returns a bidirectional view of key/value pairs over the query. The returned view references the same underlying character buffer; ownership is not transferred. Strings returned when iterating the range may contain percent escapes. heading text Example 1 code params_encoded_view pv = url_view( "/sql?id=42&name=jane%2Ddoe&page+size=20" ).encoded_params(); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Return the query as a container of parameters url_view_base::encoded_params returns text A bidirectional view of key/value pairs. see reference encoded_query suU4/MiRITTTYf61BFw2aI6WxdI= text , reference has_query SLiWca6gUGmTh+r/BbU40NrICW8= text , reference params wdcIrRY9aj9gn6bF1i59TpOAQb4= text , reference query 4epyMikskiBx2Gu+S87oAhrM/ZY= text . identifier 0nSfM4mK92fIx58KtzdWGiHuq2w= params_encoded_view normal 1 1 encoded_password boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 996 5 1 function W9oZv0BM5z4XAggQPbNAKIM7/ro= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the password portion of the userinfo as a percent-encoded string. heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).encoded_password() == "pass" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code userinfo = user [ ":" [ password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return the password returns text The password as a string. see reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text , reference has_userinfo i/v5Vfq44OnlLbuKgQ2KvgWgZqo= text , reference encoded_user oYwrnXcglhO4tlvhkxLGfFCYbAk= text , reference encoded_userinfo yzkq+uCmbTlXrfDuyd1fT0Zu6xw= text , reference password +ZB55yb2DeVYG+/eYqlMcGcedVE= text , reference user /oa6wZJEG852J9Yi1LQlnq1n1tM= text , reference userinfo S9yd7MVhXxF+598Xy2/+jwnCZzc= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_path boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1799 5 1 function GNlqbV0MSxGIA/gSjlOb2rfSHhU= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the path as a string. The path may be empty. Any percent-escapes in the string are decoded first. heading text Example 1 code assert( url_view( "file:///Program%20Files/Games/config.ini" ).encoded_path() == "/Program%20Files/Games/config.ini" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code path = path-abempty ; begins with "/" or is empty / path-absolute ; begins with "/" but not "//" / path-noscheme ; begins with a non-colon segment / path-rootless ; begins with a segment / path-empty ; zero characters path-abempty = *( "/" segment ) path-absolute = "/" [ segment-nz *( "/" segment ) ] path-noscheme = segment-nz-nc *( "/" segment ) path-rootless = segment-nz *( "/" segment ) path-empty = 0<pchar> heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text Return the path returns text The path as a string. see reference is_path_absolute eh5BeHbLjL3BuEY7ao3tbEAZnTw= text , reference encoded_segments xDk467Vs74WMTJdzZiv8izTuGQo= text . reference path Q5NVO+d/+BmZ5v3/ogNb2XpUTKs= text , reference segments txoybJuonJpAdGVWgiAsiI45+ok= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_query boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2040 5 1 function suU4/MiRITTTYf61BFw2aI6WxdI= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If this contains a query, it is returned as a string (which may be empty). Otherwise, an empty string is returned. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "/sql?id=42&name=jane%2Ddoe&page+size=20" ).encoded_query() == "id=42&name=jane%2Ddoe&page+size=20" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Return the query returns text The query as a string. see reference encoded_params YdRpQ6mNNA/rw8PqzTxP08VgNnY= text , reference has_query SLiWca6gUGmTh+r/BbU40NrICW8= text , reference params ZdlRIJ+RVbaF05I+w1pfQzUA0/0= text , reference query 4epyMikskiBx2Gu+S87oAhrM/ZY= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_resource boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2387 5 1 function yLMNPjiW4s31xcLN4xOiqVySYLA= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the resource, which is the portion of the url that includes only the path, query, and fragment. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "http://www.example.com/index.html?query#frag" ).encoded_resource() == "/index.html?query#frag" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 unordered brief text Return the resource returns text The resource portion of the url. see reference encoded_origin wG6ey1727HIj10Wh+OD/s8kuOjo= text , reference encoded_target IcodRek43l5Zc13Z67L74PlhG0U= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_segments boost/url/url_base.hpp include/boost/url/url_base.hpp 2018 5 1 boost/url/url_base.hpp include/boost/url/url_base.hpp 2014 5 1 overloads qeLAK8oZj7+xpHv7Pyh0yYASuqU= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= brief text Return the path as a container of segments returns code text *this returns text A bidirectional view of encoded segments. see reference encoded_segments 6FgVEvfQ0X7vaJ9TLmk6h3MBVPU= text , reference set_encoded_path GQGd+Ne+D3eTy4fe+x1cpa5zefU= text , reference set_path 0VMn4mT6ruiabbTCXyOFe+JATBg= text , reference set_path_absolute BHDHQef0k/8vd3QskLyTrsv7+DE= text . see reference is_path_absolute eh5BeHbLjL3BuEY7ao3tbEAZnTw= text , reference encoded_path GNlqbV0MSxGIA/gSjlOb2rfSHhU= text , reference path Q5NVO+d/+BmZ5v3/ogNb2XpUTKs= text , reference segments coMz0KQ2BIuACsWbIRZ/6lTOmuk= text , reference segments_encoded_view EvaX3SmNTAtai2Kf6Kma3fUkTkQ= text . normal 6FgVEvfQ0X7vaJ9TLmk6h3MBVPU= 5da2HmyZRkzKje3uZJyQ0Zr/GBI= encoded_segments boost/url/url_base.hpp include/boost/url/url_base.hpp 2014 5 1 function 6FgVEvfQ0X7vaJ9TLmk6h3MBVPU= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function returns a bidirectional view of segments over the path. The returned view references the same underlying character buffer; ownership is not transferred. Strings returned when iterating the range may contain percent escapes. The container is modifiable; changes to the container are reflected in the underlying URL. heading text Example 1 code url u( "http://example.com/path/to/file.txt" ); segments_encoded_ref sv = u.encoded_segments(); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code path = path-abempty ; begins with "/" or is empty / path-absolute ; begins with "/" but not "//" / path-noscheme ; begins with a non-colon segment / path-rootless ; begins with a segment / path-empty ; zero characters path-abempty = *( "/" segment ) path-absolute = "/" [ segment-nz *( "/" segment ) ] path-noscheme = segment-nz-nc *( "/" segment ) path-rootless = segment-nz *( "/" segment ) path-empty = 0<pchar> heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text Return the path as a container of segments returns code text *this see reference encoded_segments qeLAK8oZj7+xpHv7Pyh0yYASuqU= text , reference set_encoded_path GQGd+Ne+D3eTy4fe+x1cpa5zefU= text , reference set_path 0VMn4mT6ruiabbTCXyOFe+JATBg= text , reference set_path_absolute BHDHQef0k/8vd3QskLyTrsv7+DE= text . identifier TCUUfRiqZjX62kt7tK2fs//VWr0= segments_encoded_ref normal 1 encoded_segments boost/url/url_base.hpp include/boost/url/url_base.hpp 2018 5 1 function 5da2HmyZRkzKje3uZJyQ0Zr/GBI= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function returns a bidirectional view of strings over the path. The returned view references the same underlying character buffer; ownership is not transferred. Strings returned when iterating the range may contain percent escapes. heading text Example 1 code segments_encoded_view sv = url_view( "/path/to/file.txt" ).encoded_segments(); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code path = path-abempty ; begins with "/" or is empty / path-absolute ; begins with "/" but not "//" / path-noscheme ; begins with a non-colon segment / path-rootless ; begins with a segment / path-empty ; zero characters path-abempty = *( "/" segment ) path-absolute = "/" [ segment-nz *( "/" segment ) ] path-noscheme = segment-nz-nc *( "/" segment ) path-rootless = segment-nz *( "/" segment ) path-empty = 0<pchar> heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text Return the path as a container of segments url_view_base::encoded_segments returns text A bidirectional view of encoded segments. see reference is_path_absolute eh5BeHbLjL3BuEY7ao3tbEAZnTw= text , reference encoded_path GNlqbV0MSxGIA/gSjlOb2rfSHhU= text , reference path Q5NVO+d/+BmZ5v3/ogNb2XpUTKs= text , reference segments coMz0KQ2BIuACsWbIRZ/6lTOmuk= text , reference segments_encoded_view EvaX3SmNTAtai2Kf6Kma3fUkTkQ= text . identifier EvaX3SmNTAtai2Kf6Kma3fUkTkQ= segments_encoded_view normal 1 1 encoded_target boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2419 5 1 function IcodRek43l5Zc13Z67L74PlhG0U= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the target, which is the portion of the url that includes only the path and query. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "http://www.example.com/index.html?query#frag" ).encoded_target() == "/index.html?query" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 unordered brief text Return the target returns text The target portion of the url. see reference encoded_origin wG6ey1727HIj10Wh+OD/s8kuOjo= text , reference encoded_resource yLMNPjiW4s31xcLN4xOiqVySYLA= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_user boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 901 5 1 function oYwrnXcglhO4tlvhkxLGfFCYbAk= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If present, this function returns a string representing the user (which may be empty). Otherwise it returns an empty string. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).encoded_user() == "jane%2Ddoe" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code userinfo = user [ ":" [ password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return the user returns text The user as a string. see reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text , reference has_userinfo i/v5Vfq44OnlLbuKgQ2KvgWgZqo= text , reference encoded_password W9oZv0BM5z4XAggQPbNAKIM7/ro= text , reference encoded_userinfo yzkq+uCmbTlXrfDuyd1fT0Zu6xw= text , reference password +ZB55yb2DeVYG+/eYqlMcGcedVE= text , reference user /oa6wZJEG852J9Yi1LQlnq1n1tM= text , reference userinfo S9yd7MVhXxF+598Xy2/+jwnCZzc= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_userinfo boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 800 5 1 function yzkq+uCmbTlXrfDuyd1fT0Zu6xw= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If present, this function returns a string representing the userinfo (which may be empty). Otherwise it returns an empty string. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).encoded_userinfo() == "jane%2Ddoe:pass" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing heading text BNF 1 code userinfo = user [ ":" [ password ] ] authority = [ userinfo "@" ] host [ ":" port ] heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return the userinfo returns text The userinfo as a string. see reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text , reference has_userinfo i/v5Vfq44OnlLbuKgQ2KvgWgZqo= text , reference encoded_password W9oZv0BM5z4XAggQPbNAKIM7/ro= text , reference encoded_user oYwrnXcglhO4tlvhkxLGfFCYbAk= text , reference password +ZB55yb2DeVYG+/eYqlMcGcedVE= text , reference user /oa6wZJEG852J9Yi1LQlnq1n1tM= text , reference userinfo S9yd7MVhXxF+598Xy2/+jwnCZzc= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_zone_id boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1526 5 1 function 5M2smbXDaSa2d/li//A+GmlDgDU= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If the host type is reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= text , this function returns the Zone ID as a string. Otherwise an empty string is returned. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "http://[fe80::1%25eth0]/" ).encoded_zone_id() == "eth0" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPv6addrz / IPvFuture ) "]" ZoneID = 1*( unreserved / pct-encoded ) IPv6addrz = IPv6address "%25" ZoneID heading text Specification 1 list paragraph link text Representing IPv6 Zone Identifiers in Address Literals and Uniform Resource Identifiers https://datatracker.ietf.org/doc/html/rfc6874 unordered brief text Return the IPv6 Zone ID returns text The Zone ID as a percent-encoded string. identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 fragment boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2233 5 1 function aA1Q9NAW4/TnG3SXhe4k1mNB5nk= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function calculates the fragment of the url, with percent escapes decoded and without the leading pound sign ('#') whose presence indicates that the url contains a fragment. paragraph text This function accepts an optional emph text StringToken text parameter which controls the return type and behavior of the function: list paragraph text When called with no arguments, the return type of the function is code text std::string text . Otherwise paragraph text When called with a string token, the behavior and return type of the function depends on the type of string token being passed. unordered heading text Example 1 code assert( url_view( "http://www.example.com/index.htm#a%2D1" ).fragment() == "a-1" ); heading text Complexity 1 paragraph text Linear in code text this->fragment().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. String tokens may throw exceptions. heading text BNF 1 code fragment = *( pchar / "/" / "?" ) fragment-part = [ "#" fragment ] heading text Specification 1 list paragraph link text 3.5. Fragment (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.5 unordered brief text Return the fragment returns text The fragment portion of the url. param text An optional string token to use. If this parameter is omitted, the function returns a new code text std::string text . token see reference encoded_fragment M7+OzewsxChMvecRSytXqTCqKrY= text , reference has_fragment ZiWsQaQCAif94KdP6GXH9+F5GmM= text . identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 has_authority boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 528 5 1 function gadV3YsYDjlGX+64Rtiz4S+QD4A= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns true if the url contains an authority. The presence of an authority is denoted by a double slash ("//") at the beginning or after the scheme. heading text Example 1 code assert( url_view( "http://www.example.com/index.htm" ).has_authority() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code authority = [ userinfo "@" ] host [ ":" port ] URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] absolute-URI = scheme ":" hier-part [ "?" query ] URI-reference = URI / relative-ref relative-ref = relative-part [ "?" query ] [ "#" fragment ] hier-part = "//" authority path-abempty ; (more...) relative-part = "//" authority path-abempty ; (more...) heading text Specification 1 list paragraph link text 3.2. Authority (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2 unordered brief text Return true if an authority is present returns code text true text if the url contains an authority. see reference authority v5/R9LI0iKJDiBrNUt7k8qrVBdM= text , reference encoded_authority Ww04vLA2k7BwctuyNeP3KwoNr4M= text . identifier bool normal 1 1 has_fragment boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2173 5 1 function ZiWsQaQCAif94KdP6GXH9+F5GmM= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns true if the url contains a fragment. An empty fragment is distinct from no fragment. heading text Example 1 code assert( url_view( "http://www.example.com/index.htm#anchor" ).has_fragment() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] relative-ref = relative-part [ "?" query ] [ "#" fragment ] heading text Specification 1 list paragraph link text 3.5. Fragment (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.5 unordered brief text Return true if a fragment is present returns code text true text if the url contains a fragment. see reference encoded_fragment M7+OzewsxChMvecRSytXqTCqKrY= text , reference fragment aA1Q9NAW4/TnG3SXhe4k1mNB5nk= text . identifier bool normal 1 1 has_password boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 689 5 1 function 9JACnsebk8tFsoryabfDxE8VpnA= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns true if the userinfo is present and contains a password. heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).has_password() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code userinfo = user [ ":" [ password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return true if a password is present returns code text true text if the userinfo contains a password. see reference has_userinfo i/v5Vfq44OnlLbuKgQ2KvgWgZqo= text , reference encoded_password W9oZv0BM5z4XAggQPbNAKIM7/ro= text , reference encoded_user oYwrnXcglhO4tlvhkxLGfFCYbAk= text , reference encoded_userinfo yzkq+uCmbTlXrfDuyd1fT0Zu6xw= text , reference password +ZB55yb2DeVYG+/eYqlMcGcedVE= text , reference user /oa6wZJEG852J9Yi1LQlnq1n1tM= text , reference userinfo S9yd7MVhXxF+598Xy2/+jwnCZzc= text . identifier bool normal 1 1 has_port boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1568 5 1 function 5V5uOhRsy00O+TSEAkIb7uFoN2U= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns true if an authority is present and contains a port. heading text Example 1 code assert( url_view( "wss://www.example.com:443" ).has_port() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code authority = [ userinfo "@" ] host [ ":" port ] port = *DIGIT heading text Specification 1 list paragraph link text 3.2.3. Port (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.3 unordered brief text Return true if a port is present returns code text true text if a port is present, code text false text otherwise. see reference encoded_host_and_port 9ptIMbwWSNtVv+KAUpHCO3bmTWg= text , reference port OlWcRIIUl1cq5Ab9fLXGPyhYCfI= text , reference port_number lctXu8FITJWg0+Y+yZVt5iv7QDM= text . identifier bool normal 1 1 has_query boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1937 5 1 function SLiWca6gUGmTh+r/BbU40NrICW8= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns true if this contains a query. An empty query is distinct from having no query. heading text Example 1 code assert( url_view( "/sql?id=42&col=name&page-size=20" ).has_query() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Return true if a query is present returns code text true text if a query is present. see reference encoded_params YdRpQ6mNNA/rw8PqzTxP08VgNnY= text , reference encoded_query suU4/MiRITTTYf61BFw2aI6WxdI= text , reference params ZdlRIJ+RVbaF05I+w1pfQzUA0/0= text , reference query 4epyMikskiBx2Gu+S87oAhrM/ZY= text . identifier bool normal 1 1 has_scheme boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 384 5 1 function iwSH2fvVkb89TkZj7KWLGSyc4sA= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns true if this contains a scheme. heading text Example 1 code assert( url_view( "http://www.example.com" ).has_scheme() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] absolute-URI = scheme ":" hier-part [ "?" query ] scheme = ALPHA *( ALPHA / DIGIT / "+" / "-" / "." ) heading text Specification 1 list paragraph link text 3.1. Scheme (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.1 unordered brief text Return true a scheme is present returns code text true text if the url contains a scheme. see reference scheme 43fxogaC5oVqfauhwXyN4s4ibEM= text , reference scheme_id uM37WpBqetqzfHjns3M8/+CcoEU= text . identifier bool normal 1 1 has_userinfo boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 647 5 1 function i/v5Vfq44OnlLbuKgQ2KvgWgZqo= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns true if this contains a userinfo. heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).has_userinfo() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code userinfo = user [ ":" [ password ] ] authority = [ userinfo "@" ] host [ ":" port ] heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return true if a userinfo is present returns code text true text if the userinfo is present. see reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text , reference encoded_password W9oZv0BM5z4XAggQPbNAKIM7/ro= text , reference encoded_user oYwrnXcglhO4tlvhkxLGfFCYbAk= text , reference encoded_userinfo yzkq+uCmbTlXrfDuyd1fT0Zu6xw= text , reference password +ZB55yb2DeVYG+/eYqlMcGcedVE= text , reference user /oa6wZJEG852J9Yi1LQlnq1n1tM= text , reference userinfo S9yd7MVhXxF+598Xy2/+jwnCZzc= text . identifier bool normal 1 1 host boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1076 5 1 function ICcovOIyqnxhSMU6MuEekYg2z+E= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the host portion of the authority as a string, or the empty string if there is no authority. Any percent-escapes in the string are decoded first. heading text Example 1 code assert( url_view( "https://www%2droot.example.com/" ).host() == "www-root.example.com" ); heading text Complexity 1 paragraph text Linear in code text this->host().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPvFuture ) "]" reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host returns text The host address as a string. param text A string token customization token identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 host_address boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1174 5 1 function F0RYzLwUP8ied6l3zmKvomgFHag= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text The value returned by this function depends on the type of host returned from the function reference host_type Nv9Emy6spILLI/mqyIz2uRNBJhU= text . list paragraph text If the type is reference host_type::ipv4 49F64dAiji9HVbP6MxLQiqot7AY= text , then the IPv4 address string is returned. paragraph text If the type is reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= text , then the IPv6 address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::ipvfuture TcYJaTwDFsx+0S2CkvHHARcCqWc= text , then the IPvFuture address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= text , then the host name string is returned. Any percent-escapes in the string are decoded first. paragraph text If the type is reference host_type::none QyoMTu07h232/Sxqovu2mGoPgTo= text , then an empty string is returned. unordered heading text Example 1 code assert( url_view( "https://[1::6:c0a8:1]/" ).host_address() == "1::6:c0a8:1" ); heading text Complexity 1 paragraph text Linear in code text this->host_address().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPvFuture ) "]" reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host returns text The host address as a string. param text A string token customization token identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 host_ipv4_address boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1277 5 1 function KL8F3KYxyzpC1e6fqoJy3B8IHhw= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If the host type is reference host_type::ipv4 49F64dAiji9HVbP6MxLQiqot7AY= text , this function returns the address as a value of type reference ipv4_address /Wpp3ZZDp3kUHzbULeDoaOEhnVs= text . Otherwise, if the host type is not an IPv4 address, it returns a default-constructed value which is equal to the unspecified address "0.0.0.0". heading text Example 1 code assert( url_view( "http://127.0.0.1/index.htm?user=win95" ).host_ipv4_address() == ipv4_address( "127.0.0.1" ) ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code IPv4address = dec-octet "." dec-octet "." dec-octet "." dec-octet dec-octet = DIGIT ; 0-9 / %x31-39 DIGIT ; 10-99 / "1" 2DIGIT ; 100-199 / "2" %x30-34 DIGIT ; 200-249 / "25" %x30-35 ; 250-255 heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host IPv4 address returns text The IPv4 address as a value of type reference ipv4_address /Wpp3ZZDp3kUHzbULeDoaOEhnVs= text . identifier /Wpp3ZZDp3kUHzbULeDoaOEhnVs= ipv4_address normal 1 1 host_ipv6_address boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1325 5 1 function CvoRh2IpWg4QixngVwDjSKoeQVY= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If the host type is reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= text , this function returns the address as a value of type reference ipv6_address dhMSRVBIIIItY0URHSc8rwHcdTQ= text . Otherwise, if the host type is not an IPv6 address, it returns a default-constructed value which is equal to the unspecified address "0:0:0:0:0:0:0:0". heading text Example 1 code assert( url_view( "ftp://[::1]/" ).host_ipv6_address() == ipv6_address( "::1" ) ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code IPv6address = 6( h16 ":" ) ls32 / "::" 5( h16 ":" ) ls32 / [ h16 ] "::" 4( h16 ":" ) ls32 / [ *1( h16 ":" ) h16 ] "::" 3( h16 ":" ) ls32 / [ *2( h16 ":" ) h16 ] "::" 2( h16 ":" ) ls32 / [ *3( h16 ":" ) h16 ] "::" h16 ":" ls32 / [ *4( h16 ":" ) h16 ] "::" ls32 / [ *5( h16 ":" ) h16 ] "::" h16 / [ *6( h16 ":" ) h16 ] "::" ls32 = ( h16 ":" h16 ) / IPv4address ; least-significant 32 bits of address h16 = 1*4HEXDIG ; 16 bits of address represented in hexadecimal heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host IPv6 address returns text The IPv6 address as a value of type reference ipv6_address dhMSRVBIIIItY0URHSc8rwHcdTQ= text . identifier dhMSRVBIIIItY0URHSc8rwHcdTQ= ipv6_address normal 1 1 host_ipvfuture boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1358 5 1 function 55Yh68uToEiKy+IDTpyctuK/T3g= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If the host type is reference host_type::ipvfuture TcYJaTwDFsx+0S2CkvHHARcCqWc= text , this function returns the address as a string. Otherwise, if the host type is not an IPvFuture address, it returns an empty string. heading text Example 1 code assert( url_view( "http://[v1fe.d:9]/index.htm" ).host_ipvfuture() == "v1fe.d:9" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code IPvFuture = "v" 1*HEXDIG "." 1*( unreserved / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host IPvFuture address returns text The IPvFuture address as a string. identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core normal 1 1 host_name boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1395 5 1 function AhPhrC4hmBsZgd/ztqbkAuOkbBM= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If the host type is reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= text , this function returns the name as a string. Otherwise an empty string is returned. Any percent-escapes in the string are decoded first. heading text Example 1 code assert( url_view( "https://www%2droot.example.com/" ).host_name() == "www-root.example.com" ); heading text Complexity 1 paragraph text Linear in code text this->host_name().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPvFuture ) "]" reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host name returns text The host name as a string. param text A string token customization. token identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 host_type boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1036 5 1 function Nv9Emy6spILLI/mqyIz2uRNBJhU= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns one of the following constants representing the type of host present. list paragraph reference host_type::ipv4 49F64dAiji9HVbP6MxLQiqot7AY= paragraph reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= paragraph reference host_type::ipvfuture TcYJaTwDFsx+0S2CkvHHARcCqWc= paragraph reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= paragraph reference host_type::none QyoMTu07h232/Sxqovu2mGoPgTo= unordered paragraph text When reference has_authority gadV3YsYDjlGX+64Rtiz4S+QD4A= text is false, the host type is reference host_type::none QyoMTu07h232/Sxqovu2mGoPgTo= text . heading text Example 1 code assert( url_view( "https://192.168.0.1/local.htm" ).host_type() == host_type::ipv4 ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host type returns text The type of host present. identifier YLHFVyAYZGSFQe18DPGjn6XsAMs= host_type identifier dnk5XPfR2OaMpCYaH3cWSxcTdyc= urls normal 1 1 is_path_absolute boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1691 5 1 function eh5BeHbLjL3BuEY7ao3tbEAZnTw= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns true if the path begins with a forward slash ('/'). heading text Example 1 code assert( url_view( "/path/to/file.txt" ).is_path_absolute() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code path = path-abempty ; begins with "/" or is empty / path-absolute ; begins with "/" but not "//" / path-noscheme ; begins with a non-colon segment / path-rootless ; begins with a segment / path-empty ; zero characters path-abempty = *( "/" segment ) path-absolute = "/" [ segment-nz *( "/" segment ) ] path-noscheme = segment-nz-nc *( "/" segment ) path-rootless = segment-nz *( "/" segment ) path-empty = 0<pchar> heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text Return true if the path is absolute returns code text true text if the path is absolute, code text false text otherwise. see reference encoded_path GNlqbV0MSxGIA/gSjlOb2rfSHhU= text , reference encoded_segments xDk467Vs74WMTJdzZiv8izTuGQo= text . reference path Q5NVO+d/+BmZ5v3/ogNb2XpUTKs= text , reference segments txoybJuonJpAdGVWgiAsiI45+ok= text . identifier bool normal 1 1 normalize boost/url/static_url.hpp include/boost/url/static_url.hpp 430 5 1 function L2Z21HVmwJtKqNOMTyQFY4JQ+1o= regular 4HBDcnMjZthTXFnhpS7z+UhDNjA= paragraph text Applies Syntax-based normalization to all components of the URL. paragraph text The scheme is normalized to lowercase. code assert( url( "HTTP://www.example.com" ).normalize().buffer() == "http://www.example.com" ); paragraph text The host is normalized to lowercase. Percent-encoding triplets are normalized to uppercase letters. Percent-encoded octets that correspond to unreserved characters are decoded. code assert( url( "http://www.Example.com" ).normalize().buffer() == "http://www.example.com" ); assert( url( "http://www.%65xample.com" ).normalize().buffer() == "http://www.example.com" ); paragraph text Percent-encoding triplets in the path are normalized to uppercase letters. Percent-encoded octets that correspond to unreserved characters are decoded. Redundant path-segments "." and ".." are removed. code assert( url( "http://www.example.com/a/b/../c" ).normalize().buffer() == "http://www.example.com/a/c" ); assert( url( "http://www.example.com/a/./b" ).normalize().buffer() == "http://www.example.com/a/b" ); assert( url( "http://www.example.com/%63ss" ).normalize().buffer() == "http://www.example.com/css" ); paragraph text Percent-encoding triplets in the query are normalized to uppercase letters. Percent-encoded octets that correspond to unreserved characters are decoded. code assert( url( "http://www.example.com?a=%62" ).normalize().buffer() == "http://www.example.com?a=b" ); paragraph text Percent-encoding triplets in the fragment are normalized to uppercase letters. Percent-encoded octets that correspond to unreserved characters are decoded. code assert( url( "http://www.example.com#%61bc" ).normalize().buffer() == "http://www.example.com#abc" ); paragraph text Applying normalization to a URL with all components percent-encoded: code assert( url( "HTTP://www.Example.com/%70ath?%71uery#%66rag" ).normalize().buffer() == "http://www.example.com/path?query#frag" ); heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text Specification 1 list paragraph link text 6.2.2 Syntax-Based Normalization (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-6.2.2 unordered brief text Normalize the URL components url_base::normalize returns code text *this see reference normalize_scheme iyO2AawtEbzXMJkvSocn7BpBBrI= text , reference normalize_authority j2lB1y9ywFNpGt8xXYkZZuJbs30= text , reference normalize_path pjVn3eVVaWNAixzkPBECE+lKByQ= text , reference normalize_query 4CZ8ebKgivCQbRJoYD78PmOko2U= text , reference normalize_fragment R2y0tPa5JiRRSTNXgUjKdMoCOcA= identifier 4HBDcnMjZthTXFnhpS7z+UhDNjA= static_url normal 1 normalize_authority boost/url/static_url.hpp include/boost/url/static_url.hpp 434 5 1 function qk2f0tqyaZwxuSA2dS+0Zj9T+5w= regular 4HBDcnMjZthTXFnhpS7z+UhDNjA= paragraph text Applies Syntax-based normalization to the URL authority. paragraph text The host is normalized to lowercase. Percent-encoding triplets are normalized to uppercase letters. Percent-encoded octets that correspond to unreserved characters are decoded. code assert( url( "http://www.Example.com" ).normalize_authority().buffer() == "http://www.example.com" ); assert( url( "http://www.%65xample.com" ).normalize_authority().buffer() == "http://www.example.com" ); heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text Specification 1 list paragraph link text 6.2.2 Syntax-Based Normalization (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-6.2.2 unordered brief text Normalize the URL authority url_base::normalize_authority returns code text *this identifier 4HBDcnMjZthTXFnhpS7z+UhDNjA= static_url normal 1 normalize_fragment boost/url/static_url.hpp include/boost/url/static_url.hpp 440 5 1 function 9CJcPfVnJvVk0zBf34CB8xfETIg= regular 4HBDcnMjZthTXFnhpS7z+UhDNjA= paragraph text Applies Syntax-based normalization to the URL fragment. paragraph text Percent-encoding triplets are normalized to uppercase letters. Percent-encoded octets that correspond to unreserved characters are decoded. code assert( url( "http://www.example.com#%61bc" ).normalize_fragment().buffer() == "http://www.example.com#abc" ); heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text Specification 1 list paragraph link text 6.2.2 Syntax-Based Normalization (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-6.2.2 unordered brief text Normalize the URL fragment url_base::normalize_fragment returns code text *this identifier 4HBDcnMjZthTXFnhpS7z+UhDNjA= static_url normal 1 normalize_path boost/url/static_url.hpp include/boost/url/static_url.hpp 436 5 1 function 1gxbOWXXkNcHf0a7aqVLoeQbw4w= regular 4HBDcnMjZthTXFnhpS7z+UhDNjA= paragraph text Applies Syntax-based normalization to the URL path. paragraph text Percent-encoding triplets are normalized to uppercase letters. Percent-encoded octets that correspond to unreserved characters are decoded. Redundant path-segments "." and ".." are removed. code assert( url( "http://www.example.com/a/b/../c" ).normalize_path().buffer() == "http://www.example.com/a/c" ); assert( url( "http://www.example.com/a/./b" ).normalize_path().buffer() == "http://www.example.com/a/b" ); assert( url( "http://www.example.com/%63ss" ).normalize_path().buffer() == "http://www.example.com/css" ); heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text Specification 1 list paragraph link text 6.2.2 Syntax-Based Normalization (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-6.2.2 unordered brief text Normalize the URL path url_base::normalize_path returns code text *this identifier 4HBDcnMjZthTXFnhpS7z+UhDNjA= static_url normal 1 normalize_query boost/url/static_url.hpp include/boost/url/static_url.hpp 438 5 1 function bi805EoX8OTri5KIPxrlqmiZtE8= regular 4HBDcnMjZthTXFnhpS7z+UhDNjA= paragraph text Applies Syntax-based normalization to the URL query. paragraph text Percent-encoding triplets are normalized to uppercase letters. Percent-encoded octets that correspond to unreserved characters are decoded. code assert( url( "http://www.example.com?a=%62" ).normalize_query().buffer() == "http://www.example.com?a=b" ); heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text Specification 1 list paragraph link text 6.2.2 Syntax-Based Normalization (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-6.2.2 unordered brief text Normalize the URL query url_base::normalize_query returns code text *this identifier 4HBDcnMjZthTXFnhpS7z+UhDNjA= static_url normal 1 normalize_scheme boost/url/static_url.hpp include/boost/url/static_url.hpp 432 5 1 function QIsV9n6MWFnqA0MZenHn3zX9jt8= regular 4HBDcnMjZthTXFnhpS7z+UhDNjA= paragraph text Applies Syntax-based normalization to the URL scheme. paragraph text The scheme is normalized to lowercase. code assert( url( "HTTP://www.example.com" ).normalize_scheme().buffer() == "http://www.example.com" ); heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text Specification 1 list paragraph link text 6.2.2 Syntax-Based Normalization (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-6.2.2 unordered brief text Normalize the URL scheme url_base::normalize_scheme returns code text *this identifier 4HBDcnMjZthTXFnhpS7z+UhDNjA= static_url normal 1 params boost/url/url_base.hpp include/boost/url/url_base.hpp 2186 5 1 boost/url/url_base.hpp include/boost/url/url_base.hpp 2182 5 1 boost/url/url_base.hpp include/boost/url/url_base.hpp 2244 5 1 boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2087 5 overloads wdcIrRY9aj9gn6bF1i59TpOAQb4= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= brief text Return the query as a container of parameters returns code text *this returns text A bidirectional view of key/value pairs. returns text A range of references to the parameters. param text The options for decoding. If this parameter is omitted, the code text space_as_plus text is used. opt see reference encoded_params tDMWbnBabN2mGSH3Apn445gDMEQ= text , reference remove_query ZZWEzCK7DguUxc3TvUfizoGKplE= text , reference set_encoded_query QcQ13DUh8M8TR/zj/LDG3N/+i3c= text , reference set_query 99/QTSBQGLrNj3zGdw5VzYlqfnI= text . see reference encoded_params tDMWbnBabN2mGSH3Apn445gDMEQ= text , reference encoded_query suU4/MiRITTTYf61BFw2aI6WxdI= text , reference has_query SLiWca6gUGmTh+r/BbU40NrICW8= text , reference query 4epyMikskiBx2Gu+S87oAhrM/ZY= text . normal MYfnAHxNPsNhl4M31kQzwrirB9M= s9dRuYwynzv+XH3wi5E1LonuuYk= yOAcBK51dE1EJqsBF6ZGTSEnocA= V3u1IzKjTvUUsoIglN4qUAzgD4k= params boost/url/url_base.hpp include/boost/url/url_base.hpp 2182 5 1 function MYfnAHxNPsNhl4M31kQzwrirB9M= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function returns a bidirectional view of key/value pairs over the query. The returned view references the same underlying character buffer; ownership is not transferred. Any percent-escapes in strings returned when iterating the view are decoded first. The container is modifiable; changes to the container are reflected in the underlying URL. heading text Example 1 code params_ref pv = url( "/sql?id=42&name=jane%2Ddoe&page+size=20" ).params(); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Return the query as a container of parameters returns code text *this see reference encoded_params tDMWbnBabN2mGSH3Apn445gDMEQ= text , reference remove_query ZZWEzCK7DguUxc3TvUfizoGKplE= text , reference set_encoded_query QcQ13DUh8M8TR/zj/LDG3N/+i3c= text , reference set_query 99/QTSBQGLrNj3zGdw5VzYlqfnI= text . identifier 8S83BKvWBCDdTktlY8X93Mlo9E0= params_ref normal 1 params boost/url/url_base.hpp include/boost/url/url_base.hpp 2186 5 1 function s9dRuYwynzv+XH3wi5E1LonuuYk= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= brief text Return the query as a container of parameters url_view_base::params returns text A bidirectional view of key/value pairs. see reference encoded_params tDMWbnBabN2mGSH3Apn445gDMEQ= text , reference encoded_query suU4/MiRITTTYf61BFw2aI6WxdI= text , reference has_query SLiWca6gUGmTh+r/BbU40NrICW8= text , reference query 4epyMikskiBx2Gu+S87oAhrM/ZY= text . identifier DzqMpaJX2O25vPFxEN5EDTyU6uw= params_view normal 1 1 params boost/url/url_base.hpp include/boost/url/url_base.hpp 2244 5 1 function yOAcBK51dE1EJqsBF6ZGTSEnocA= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function returns a bidirectional view of key/value pairs over the query. The returned view references the same underlying character buffer; ownership is not transferred. Any percent-escapes in strings returned when iterating the view are decoded first. The container is modifiable; changes to the container are reflected in the underlying URL. heading text Example 1 code encoding_opts opt; opt.space_as_plus = true; params_ref pv = url( "/sql?id=42&name=jane+doe&page+size=20" ).params(opt); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Return the query as a container of parameters returns text A range of references to the parameters. param text The options for decoding. If this parameter is omitted, the code text space_as_plus text is used. opt see reference encoded_params tDMWbnBabN2mGSH3Apn445gDMEQ= text , reference remove_query ZZWEzCK7DguUxc3TvUfizoGKplE= text , reference set_encoded_query QcQ13DUh8M8TR/zj/LDG3N/+i3c= text , reference set_query 99/QTSBQGLrNj3zGdw5VzYlqfnI= text . identifier 8S83BKvWBCDdTktlY8X93Mlo9E0= params_ref identifier Bb04pNwExynJkzlY9a9GCeeB13k= encoding_opts opt normal 1 params boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2087 5 function V3u1IzKjTvUUsoIglN4qUAzgD4k= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= identifier DzqMpaJX2O25vPFxEN5EDTyU6uw= params_view identifier Bb04pNwExynJkzlY9a9GCeeB13k= encoding_opts opt normal 1 1 password boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 947 5 1 function +ZB55yb2DeVYG+/eYqlMcGcedVE= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If present, this function returns a string representing the password (which may be an empty string). Otherwise it returns an empty string. Any percent-escapes in the string are decoded first. heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).password() == "pass" ); heading text Complexity 1 paragraph text Linear in code text this->password().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code userinfo = user [ ":" [ password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return the password returns text The password as a string. param text The string token to use. token see reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text , reference has_userinfo i/v5Vfq44OnlLbuKgQ2KvgWgZqo= text , reference encoded_password W9oZv0BM5z4XAggQPbNAKIM7/ro= text , reference encoded_user oYwrnXcglhO4tlvhkxLGfFCYbAk= text , reference encoded_userinfo yzkq+uCmbTlXrfDuyd1fT0Zu6xw= text , reference user /oa6wZJEG852J9Yi1LQlnq1n1tM= text , reference userinfo S9yd7MVhXxF+598Xy2/+jwnCZzc= text . identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 path boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1744 5 1 function Q5NVO+d/+BmZ5v3/ogNb2XpUTKs= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the path as a string. The path may be empty. Any percent-escapes in the string are decoded first. heading text Example 1 code assert( url_view( "file:///Program%20Files/Games/config.ini" ).path() == "/Program Files/Games/config.ini" ); heading text Complexity 1 paragraph text Linear in code text this->path().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code path = path-abempty ; begins with "/" or is empty / path-absolute ; begins with "/" but not "//" / path-noscheme ; begins with a non-colon segment / path-rootless ; begins with a segment / path-empty ; zero characters path-abempty = *( "/" segment ) path-absolute = "/" [ segment-nz *( "/" segment ) ] path-noscheme = segment-nz-nc *( "/" segment ) path-rootless = segment-nz *( "/" segment ) path-empty = 0<pchar> heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text Return the path returns text The path as a string. param text A string token to use for the result. token see reference is_path_absolute eh5BeHbLjL3BuEY7ao3tbEAZnTw= text , reference encoded_path GNlqbV0MSxGIA/gSjlOb2rfSHhU= text , reference encoded_segments xDk467Vs74WMTJdzZiv8izTuGQo= text . reference segments txoybJuonJpAdGVWgiAsiI45+ok= text . identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 persist boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 341 5 1 function cRPG1npIXmfYC0K+C+idxOqIc04= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns a read-only copy of the url, with shared lifetime. The returned value owns (persists) the underlying string. The algorithm used to create the value minimizes the number of individual memory allocations, making it more efficient than when using direct standard library functions. heading text Example 1 code std::shared_ptr< url_view const > sp; { std::string s( "http://example.com" ); url_view u( s ); // u references characters in s assert( u.data() == s.data() ); // same buffer sp = u.persist(); assert( sp->data() != s.data() ); // different buffer assert( sp->buffer() == s); // same contents // s is destroyed and thus u // becomes invalid, but sp remains valid. } heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. brief text Return a shared, persistent copy of the url returns text A shared pointer to a read-only url_view. specialization yAZI7i9M7QvpFoRBZvP2RcJBIWs= shared_ptr identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 1 port boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1604 5 1 function OlWcRIIUl1cq5Ab9fLXGPyhYCfI= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If present, this function returns a string representing the port (which may be empty). Otherwise it returns an empty string. heading text Example 1 code assert( url_view( "http://localhost.com:8080" ).port() == "8080" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code port = *DIGIT heading text Specification 1 list paragraph link text 3.2.3. Port (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.3 unordered brief text Return the port returns text The port as a string. see reference encoded_host_and_port 9ptIMbwWSNtVv+KAUpHCO3bmTWg= text , reference has_port 5V5uOhRsy00O+TSEAkIb7uFoN2U= text , reference port_number lctXu8FITJWg0+Y+yZVt5iv7QDM= text . identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core normal 1 1 port_number boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1640 5 1 function lctXu8FITJWg0+Y+yZVt5iv7QDM= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If a port is present and the numerical value is representable, it is returned as an unsigned integer. Otherwise, the number zero is returned. heading text Example 1 code assert( url_view( "http://localhost.com:8080" ).port_number() == 8080 ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code port = *DIGIT heading text Specification 1 list paragraph link text 3.2.3. Port (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.3 unordered brief text Return the port returns text The port number as an unsigned integer. see reference encoded_host_and_port 9ptIMbwWSNtVv+KAUpHCO3bmTWg= text , reference has_port 5V5uOhRsy00O+TSEAkIb7uFoN2U= text , reference port OlWcRIIUl1cq5Ab9fLXGPyhYCfI= text . identifier Qvo2fOST20EZC7bSOAFZr+u3ITg= uint16_t normal 1 1 query boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1987 5 1 function 4epyMikskiBx2Gu+S87oAhrM/ZY= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If this contains a query, it is returned as a string (which may be empty). Otherwise, an empty string is returned. Any percent-escapes in the string are decoded first. paragraph text Literal plus signs remain unchanged by default to match RFC 3986. To treat '+' as a space, supply decoding options with code text space_as_plus = true text when calling this function. heading text Example 1 code assert( url_view( "/sql?id=42&name=jane%2Ddoe&page+size=20" ).query() == "id=42&name=jane-doe&page size=20" ); heading text Complexity 1 paragraph text Linear in code text this->query().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Return the query returns text The query as a string. param text A token to use for the returned string. token see reference encoded_params YdRpQ6mNNA/rw8PqzTxP08VgNnY= text , reference encoded_query suU4/MiRITTTYf61BFw2aI6WxdI= text , reference has_query SLiWca6gUGmTh+r/BbU40NrICW8= text , reference params ZdlRIJ+RVbaF05I+w1pfQzUA0/0= text . identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 remove_authority boost/url/static_url.hpp include/boost/url/static_url.hpp 355 5 1 function MPuGLe4mCyOKSSQn7S4dh3SMX90= regular 4HBDcnMjZthTXFnhpS7z+UhDNjA= paragraph text This function removes the authority, which includes the userinfo, host, and a port if present. heading text Example 1 code assert( url( "http://example.com/echo.cgi" ).remove_authority().buffer() == "http:/echo.cgi" ); heading text Postconditions 1 code this->has_authority() == false && this->has_userinfo() == false && this->has_port() == false heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code authority = [ userinfo "@" ] host [ ":" port ] userinfo = *( unreserved / pct-encoded / sub-delims / ":" ) host = IP-literal / IPv4address / reg-name port = *DIGIT heading text Specification 1 list paragraph link text 3.2. Authority (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2 unordered brief text Remove the authority url_base::remove_authority returns code text *this see reference set_encoded_authority VTO/x6AChJRFyjVKxhaqmIAvYFI= text . identifier 4HBDcnMjZthTXFnhpS7z+UhDNjA= static_url normal 1 remove_fragment boost/url/static_url.hpp include/boost/url/static_url.hpp 420 5 1 function vlLHNM13ymUzmjWB6UhixNSj74k= regular 4HBDcnMjZthTXFnhpS7z+UhDNjA= paragraph text This function removes the fragment. An empty fragment is distinct from having no fragment. heading text Example 1 code assert( url( "?first=john&last=doe#anchor" ).remove_fragment().buffer() == "?first=john&last=doe" ); heading text Postconditions 1 code this->has_fragment() == false && this->encoded_fragment() == "" heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code fragment = *( pchar / "/" / "?" ) heading text Specification 1 list paragraph link text 3.5. Fragment https://datatracker.ietf.org/doc/html/rfc3986#section-3.5 unordered brief text Remove the fragment url_base::remove_fragment returns code text *this see reference remove_fragment vlLHNM13ymUzmjWB6UhixNSj74k= text , reference set_encoded_fragment m72MkIEEYt8H1GVoxvQZHBwWY1A= text , reference set_fragment +4IRFmcYy74cW/dNQ+7qmhQ1mdU= text . identifier 4HBDcnMjZthTXFnhpS7z+UhDNjA= static_url normal 1 remove_origin boost/url/static_url.hpp include/boost/url/static_url.hpp 427 5 1 function zpYwaJSR17hZMraeX0G0cTNJI68= regular 4HBDcnMjZthTXFnhpS7z+UhDNjA= paragraph text This function removes the origin, which consists of the scheme and authority. heading text Example 1 code assert( url( "http://www.example.com/index.htm" ).remove_origin().buffer() == "/index.htm" ); heading text Postconditions 1 code this->scheme_id() == scheme::none && this->has_authority() == false heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Throws nothing. brief text Remove the origin component url_base::remove_origin returns code text *this identifier 4HBDcnMjZthTXFnhpS7z+UhDNjA= static_url normal 1 remove_password boost/url/static_url.hpp include/boost/url/static_url.hpp 372 5 1 function MQlcavJoBHnGjmgTMowtBTZ9n5A= regular 4HBDcnMjZthTXFnhpS7z+UhDNjA= paragraph text This function removes the password from the userinfo if a password exists. If there is no userinfo or no authority, the call has no effect. admonition paragraph text The interpretation of the userinfo as individual user and password components is scheme-dependent. Transmitting passwords in URLs is deprecated. note heading text Example 1 code assert( url( "http://user:pass@example.com" ).remove_password().authority().buffer() == "user@example.com" ); heading text Postconditions 1 code this->has_password() == false && this->encoded_password().empty() == true heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code userinfo = [ [ user ] [ ':' password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Remove the password url_base::remove_password returns code text *this see reference set_encoded_password qF7dDBIf4KkHxSuysLw1EJNSh2Y= text , reference set_encoded_user YNLJGohUXCdL6mo1PM3ms9pRQyE= text , reference set_password blkDquwzHtk7o5mJf/hdeY15zWg= text , reference set_user GWy3y66sOX4ov+Eh3hxNRVsAEwY= text . identifier 4HBDcnMjZthTXFnhpS7z+UhDNjA= static_url normal 1 remove_port boost/url/static_url.hpp include/boost/url/static_url.hpp 401 5 1 function 0MEk6Ddnsq5FQhANarFWyfhL4/M= regular 4HBDcnMjZthTXFnhpS7z+UhDNjA= paragraph text If a port exists, it is removed. The rest of the authority is unchanged. heading text Example 1 code assert( url( "http://www.example.com:80" ).remove_port().authority().buffer() == "www.example.com" ); heading text Postconditions 1 code this->has_port() == false && this->port_number() == 0 && this->port() == "" heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code authority = [ userinfo "@" ] host [ ":" port ] port = *DIGIT heading text Specification 1 list paragraph link text 3.2.3. Port (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.3 unordered brief text Remove the port url_base::remove_port returns code text *this see reference set_port p1q1Ba+a+naWvTDfBuMPt0DJw2A= text . identifier 4HBDcnMjZthTXFnhpS7z+UhDNjA= static_url normal 1 remove_query boost/url/static_url.hpp include/boost/url/static_url.hpp 417 5 1 function IYZqU1YD/Yk8eV1APcJAB1m/E/M= regular 4HBDcnMjZthTXFnhpS7z+UhDNjA= paragraph text If a query is present, it is removed. An empty query is distinct from having no query. heading text Example 1 code assert( url( "http://www.example.com?id=42" ).remove_query().buffer() == "http://www.example.com" ); heading text Postconditions 1 code this->has_query() == false && this->params().empty() heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Remove the query url_base::remove_query returns code text *this see reference encoded_params tDMWbnBabN2mGSH3Apn445gDMEQ= text , reference params wdcIrRY9aj9gn6bF1i59TpOAQb4= text , reference set_encoded_query QcQ13DUh8M8TR/zj/LDG3N/+i3c= text , reference set_query 99/QTSBQGLrNj3zGdw5VzYlqfnI= text . identifier 4HBDcnMjZthTXFnhpS7z+UhDNjA= static_url normal 1 remove_scheme boost/url/static_url.hpp include/boost/url/static_url.hpp 350 5 1 function RDtnbPaPAWgiqF4O91xaQbfnghQ= regular 4HBDcnMjZthTXFnhpS7z+UhDNjA= paragraph text This function removes the scheme if it is present. heading text Example 1 code assert( url("http://www.example.com/index.htm" ).remove_scheme().buffer() == "//www.example.com/index.htm" ); heading text Postconditions 1 code this->has_scheme() == false && this->scheme_id() == scheme::none heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] heading text Specification 1 list paragraph link text 3.1. Scheme (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.1 unordered brief text Remove the scheme url_base::remove_scheme returns code text *this see reference set_scheme Lc5XBzZs/ayxU18Djd6Q0BHFWv4= text . identifier 4HBDcnMjZthTXFnhpS7z+UhDNjA= static_url normal 1 remove_userinfo boost/url/static_url.hpp include/boost/url/static_url.hpp 362 5 1 function mFEIJCpzEh4h8vUKHZxjlOuZoao= regular 4HBDcnMjZthTXFnhpS7z+UhDNjA= paragraph text This function removes the userinfo if present, without removing any authority. heading text Example 1 code assert( url( "http://user@example.com" ).remove_userinfo().has_userinfo() == false ); heading text Postconditions 1 code this->has_userinfo() == false && this->encoded_userinfo().empty == true heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code userinfo = [ [ user ] [ ':' password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Remove the userinfo url_base::remove_userinfo returns code text *this see reference set_encoded_userinfo c4/wDJ3igTWJNUnNsXC3LS2Fazc= text , reference set_userinfo he1jodL9CeOuw4MBdmIdXvYfXMk= text . identifier 4HBDcnMjZthTXFnhpS7z+UhDNjA= static_url normal 1 reserve boost/url/url_base.hpp include/boost/url/url_base.hpp 187 5 1 function R5AajT/eZPgijKrm8AxolAdhsRQ= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function adjusts the capacity of the container in characters, without affecting the current contents. Has no effect if code text n <= this->capacity() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. brief text Adjust the capacity without changing the size param text The capacity in characters, excluding any null terminator. n throws text Allocation failure reference bad_alloc identifier void identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std n normal 1 resolve boost/url/url_base.hpp include/boost/url/url_base.hpp 2973 5 1 function 3Pi5l1khAbVAQHD3fWi5GoHEr5E= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function attempts to resolve a URL reference code text ref text against this base URL in a manner similar to that of a web browser resolving an anchor tag. paragraph text This URL must satisfy the emph text URI text grammar. In other words, it must contain a scheme. paragraph text Relative references are only usable when in the context of a base absolute URI. This process of resolving a relative emph text reference text within the context of a emph text base text URI is defined in detail in rfc3986 (see below). paragraph text The resolution process works as if the relative reference is appended to the base URI and the result is normalized. paragraph text Given the input base URL, this function resolves the relative reference as if performing the following steps: list paragraph text Ensure the base URI has at least a scheme paragraph text Normalizing the reference path paragraph text Merge base and reference paths paragraph text Normalize the merged path unordered paragraph text This function places the result of the resolution into this URL in place. paragraph text If an error occurs, the contents of this URL are unspecified and a code text boost::system::result text with an code text system::error_code text is returned. admonition paragraph text Abnormal hrefs where the number of ".." segments exceeds the number of segments in the base path are handled by including the unmatched ".." segments in the result, as described in link text Errata 4547 https://www.rfc-editor.org/errata/eid4547 text . note heading text Example 1 code url base1( "/one/two/three" ); base1.resolve("four"); assert( base1.buffer() == "/one/two/four" ); url base2( "http://example.com/" ) base2.resolve("/one"); assert( base2.buffer() == "http://example.com/one" ); url base3( "http://example.com/one" ); base3.resolve("/two"); assert( base3.buffer() == "http://example.com/two" ); url base4( "http://a/b/c/d;p?q" ); base4.resolve("g#s"); assert( base4.buffer() == "http://a/b/c/g#s" ); heading text BNF 1 code absolute-URI = scheme ":" hier-part [ "?" query ] heading text Exception Safety 1 paragraph text Basic guarantee. Calls to allocate may throw. heading text Specification 1 brief text Resolve a URL reference against this base URL returns text An empty code text boost::system::result text upon success, otherwise an error code if code text !base.has_scheme() text . param text The URL reference to resolve. ref see reference url B4dRaSXMG3fDmuNKMW3KOeRu6kA= text , reference url_view wh3UbUToX9YDmRmnpcoM9EUEZo8= text . specialization O+YzwnquzbCEPErxi2iuhXKphsk= result identifier LWQB+dn+7lsRKPzx/twz66ZcOWI= system 1 identifier UEVNhDEjkZMXfjN1DxbtX0n2rCg= url_view_base ref normal 1 scheme boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 421 5 1 function 43fxogaC5oVqfauhwXyN4s4ibEM= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the scheme if it exists, without a trailing colon (':'). Otherwise it returns an empty string. Note that schemes are case-insensitive, and the canonical form is lowercased. heading text Example 1 code assert( url_view( "http://www.example.com" ).scheme() == "http" ); heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code scheme = ALPHA *( ALPHA / DIGIT / "+" / "-" / "." ) URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] absolute-URI = scheme ":" hier-part [ "?" query ] heading text Specification 1 list paragraph link text 3.1. Scheme (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.1 unordered brief text Return the scheme returns text The scheme as a string. see reference has_scheme iwSH2fvVkb89TkZj7KWLGSyc4sA= text , reference scheme_id uM37WpBqetqzfHjns3M8/+CcoEU= text . identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core normal 1 1 scheme_id boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 471 5 1 function uM37WpBqetqzfHjns3M8/+CcoEU= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns a value which depends on the scheme in the url: list paragraph text If the scheme is a well-known scheme, corresponding value from the enumeration reference urls::scheme P7uOjuAMILimKGOcbjDUSpMAL/U= text is returned. paragraph text If a scheme is present but is not a well-known scheme, the value returned is reference urls::scheme::unknown LJxTyQ55ot1WYLH7f46nZvdGU78= text . paragraph text Otherwise, if the scheme is absent the value returned is reference urls::scheme::none VupiauVBXlZQ8Uix+vk8kSl+fM8= text . unordered heading text Example 1 code assert( url_view( "wss://www.example.com/crypto.cgi" ).scheme_id() == scheme::wss ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] absolute-URI = scheme ":" hier-part [ "?" query ] scheme = ALPHA *( ALPHA / DIGIT / "+" / "-" / "." ) heading text Specification 1 list paragraph link text 3.1. Scheme (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.1 unordered brief text Return the scheme returns text The scheme as an enumeration value. see reference has_scheme iwSH2fvVkb89TkZj7KWLGSyc4sA= text , reference scheme 43fxogaC5oVqfauhwXyN4s4ibEM= text . identifier P7uOjuAMILimKGOcbjDUSpMAL/U= scheme identifier dnk5XPfR2OaMpCYaH3cWSxcTdyc= urls normal 1 1 segments boost/url/url_base.hpp include/boost/url/url_base.hpp 1955 5 1 boost/url/url_base.hpp include/boost/url/url_base.hpp 1951 5 1 overloads coMz0KQ2BIuACsWbIRZ/6lTOmuk= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= brief text Return the path as a container of segments returns code text *this returns text A bidirectional view of segments. see reference encoded_segments qeLAK8oZj7+xpHv7Pyh0yYASuqU= text , reference set_encoded_path GQGd+Ne+D3eTy4fe+x1cpa5zefU= text , reference set_path 0VMn4mT6ruiabbTCXyOFe+JATBg= text , reference set_path_absolute BHDHQef0k/8vd3QskLyTrsv7+DE= text . see reference is_path_absolute eh5BeHbLjL3BuEY7ao3tbEAZnTw= text , reference encoded_path GNlqbV0MSxGIA/gSjlOb2rfSHhU= text , reference encoded_segments qeLAK8oZj7+xpHv7Pyh0yYASuqU= text . reference path Q5NVO+d/+BmZ5v3/ogNb2XpUTKs= text , reference segments_view ZNJOLZ4RhCB2A2ooiNo7KxZJHrA= text . normal 7IUB1R6CP5b6VCTpQBgLFv27mfU= QP1V0/Bd4lTeXI0vaNEiUqgvkPQ= segments boost/url/url_base.hpp include/boost/url/url_base.hpp 1951 5 1 function 7IUB1R6CP5b6VCTpQBgLFv27mfU= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function returns a bidirectional view of segments over the path. The returned view references the same underlying character buffer; ownership is not transferred. Any percent-escapes in strings returned when iterating the view are decoded first. The container is modifiable; changes to the container are reflected in the underlying URL. heading text Example 1 code url u( "http://example.com/path/to/file.txt" ); segments sv = u.segments(); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code path = path-abempty ; begins with "/" or is empty / path-absolute ; begins with "/" but not "//" / path-noscheme ; begins with a non-colon segment / path-rootless ; begins with a segment / path-empty ; zero characters path-abempty = *( "/" segment ) path-absolute = "/" [ segment-nz *( "/" segment ) ] path-noscheme = segment-nz-nc *( "/" segment ) path-rootless = segment-nz *( "/" segment ) path-empty = 0<pchar> heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text Return the path as a container of segments returns code text *this see reference encoded_segments qeLAK8oZj7+xpHv7Pyh0yYASuqU= text , reference set_encoded_path GQGd+Ne+D3eTy4fe+x1cpa5zefU= text , reference set_path 0VMn4mT6ruiabbTCXyOFe+JATBg= text , reference set_path_absolute BHDHQef0k/8vd3QskLyTrsv7+DE= text . identifier zdr3gU7+2/G05oo6ta/IfHlkTF0= segments_ref identifier dnk5XPfR2OaMpCYaH3cWSxcTdyc= urls normal 1 segments boost/url/url_base.hpp include/boost/url/url_base.hpp 1955 5 1 function QP1V0/Bd4lTeXI0vaNEiUqgvkPQ= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function returns a bidirectional view of strings over the path. The returned view references the same underlying character buffer; ownership is not transferred. Any percent-escapes in strings returned when iterating the view are decoded first. heading text Example 1 code segments_view sv = url_view( "/path/to/file.txt" ).segments(); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code path = [ "/" ] segment *( "/" segment ) heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text Return the path as a container of segments url_view_base::segments returns text A bidirectional view of segments. see reference is_path_absolute eh5BeHbLjL3BuEY7ao3tbEAZnTw= text , reference encoded_path GNlqbV0MSxGIA/gSjlOb2rfSHhU= text , reference encoded_segments qeLAK8oZj7+xpHv7Pyh0yYASuqU= text . reference path Q5NVO+d/+BmZ5v3/ogNb2XpUTKs= text , reference segments_view ZNJOLZ4RhCB2A2ooiNo7KxZJHrA= text . identifier ZNJOLZ4RhCB2A2ooiNo7KxZJHrA= segments_view normal 1 1 set_encoded_authority boost/url/static_url.hpp include/boost/url/static_url.hpp 353 5 1 function vlMSELWXcWTwdf2/dZGlv0TYnHA= regular 4HBDcnMjZthTXFnhpS7z+UhDNjA= paragraph text This function sets the authority to the specified string. The string may contain percent-escapes. heading text Example 1 code assert( url().set_encoded_authority( "My%20Computer" ).has_authority() ); heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text BNF 1 code authority = [ userinfo "@" ] host [ ":" port ] userinfo = *( unreserved / pct-encoded / sub-delims / ":" ) host = IP-literal / IPv4address / reg-name port = *DIGIT heading text Specification 1 list paragraph link text 3.2. Authority (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2 unordered brief text Set the authority url_base::set_encoded_authority returns code text *this param text The authority string to set. s see reference remove_authority MPuGLe4mCyOKSSQn7S4dh3SMX90= text . identifier 4HBDcnMjZthTXFnhpS7z+UhDNjA= static_url identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view s normal 1 set_encoded_fragment boost/url/static_url.hpp include/boost/url/static_url.hpp 424 5 1 function m72MkIEEYt8H1GVoxvQZHBwWY1A= regular 4HBDcnMjZthTXFnhpS7z+UhDNjA= paragraph text This function sets the fragment to the specified string, which may contain percent-escapes and which may be empty. An empty fragment is distinct from having no fragment. Escapes in the string are preserved, and reserved characters in the string are percent-escaped in the result. heading text Example 1 code assert( url("?first=john&last=doe" ).set_encoded_fragment( "john%2Ddoe" ).fragment() == "john-doe" ); heading text Postconditions 1 code this->has_fragment() == true && this->fragment() == decode_view( s ) heading text Complexity 1 paragraph text Linear in code text this->size() + s.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text BNF 1 code fragment = *( pchar / "/" / "?" ) heading text Specification 1 list paragraph link text 3.5. Fragment https://datatracker.ietf.org/doc/html/rfc3986#section-3.5 unordered brief text Set the fragment. url_base::set_encoded_fragment returns code text *this param text The string to set. s see reference remove_fragment vlLHNM13ymUzmjWB6UhixNSj74k= text , reference set_fragment +4IRFmcYy74cW/dNQ+7qmhQ1mdU= text . identifier 4HBDcnMjZthTXFnhpS7z+UhDNjA= static_url identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view s normal 1 set_encoded_host boost/url/static_url.hpp include/boost/url/static_url.hpp 377 5 1 function WTVVGr7kT7qnFaI6e/getY73eAI= regular 4HBDcnMjZthTXFnhpS7z+UhDNjA= paragraph text Depending on the contents of the passed string, this function sets the host: list paragraph text If the string is a valid IPv4 address, then the host is set to the address. The host type is reference host_type::ipv4 49F64dAiji9HVbP6MxLQiqot7AY= text . paragraph text If the string is a valid IPv6 address enclosed in square brackets, then the host is set to that address. The host type is reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= text . paragraph text If the string is a valid IPvFuture address enclosed in square brackets, then the host is set to that address. The host type is reference host_type::ipvfuture TcYJaTwDFsx+0S2CkvHHARcCqWc= text . paragraph text Otherwise, the host name is set to the string. This string can contain percent escapes, or can be empty. Escapes in the string are preserved, and reserved characters in the string are percent-escaped in the result. The host type is reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= text . unordered paragraph text In all cases, when this function returns, the URL contains an authority. heading text Example 1 code assert( url( "http://www.example.com" ).set_host( "127.0.0.1" ).buffer() == "http://127.0.0.1" ); heading text Postconditions 1 code this->has_authority() == true heading text Complexity 1 paragraph text Linear in code text this->size() + s.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPvFuture ) "]" reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text IPv4 (Wikipedia) https://en.wikipedia.org/wiki/IPv4 paragraph link text IP Version 6 Addressing Architecture (rfc4291) https://datatracker.ietf.org/doc/html/rfc4291 paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Set the host url_base::set_encoded_host returns code text *this param text The string to set. s see reference set_encoded_host_address jlXXuOvH7OFDJ92kr+Ha02sixZY= text , reference set_encoded_host_name vyW7/09OitF6fXON1o2ftFzwX0Y= text , reference set_host c6/kyTU/r4vjSPQM1DnwtnTv3/o= text , reference set_host_address TGaSnQ4PS0WINemStJIm4VLR0rI= text , reference set_host_ipv4 J2yY5s29/Vm0kL+xtvGZMflIdkI= text , reference set_host_ipv6 Guwgs2WWqZMqTOkuQucJUI0fpO8= text , reference set_host_ipvfuture 6YBmlxPZA2kZSlYjMb1sLD6KrGQ= text , reference set_host_name UaE/Nbim4fGJNSgi8xJbANtFuso= text . identifier 4HBDcnMjZthTXFnhpS7z+UhDNjA= static_url identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view s normal 1 set_encoded_host_address boost/url/static_url.hpp include/boost/url/static_url.hpp 381 5 1 function jlXXuOvH7OFDJ92kr+Ha02sixZY= regular 4HBDcnMjZthTXFnhpS7z+UhDNjA= paragraph text Depending on the contents of the passed string, this function sets the host: list paragraph text If the string is a valid IPv4 address, then the host is set to the address. The host type is reference host_type::ipv4 49F64dAiji9HVbP6MxLQiqot7AY= text . paragraph text If the string is a valid IPv6 address, then the host is set to that address. The host type is reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= text . paragraph text If the string is a valid IPvFuture, then the host is set to that address. The host type is reference host_type::ipvfuture TcYJaTwDFsx+0S2CkvHHARcCqWc= text . paragraph text Otherwise, the host name is set to the string. This string can contain percent escapes, or can be empty. Escapes in the string are preserved, and reserved characters in the string are percent-escaped in the result. The host type is reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= text . unordered paragraph text In all cases, when this function returns, the URL contains an authority. heading text Example 1 code assert( url( "http://www.example.com" ).set_host( "127.0.0.1" ).buffer() == "http://127.0.0.1" ); heading text Postconditions 1 code this->has_authority() == true heading text Complexity 1 paragraph text Linear in code text this->size() + s.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text BNF 1 code IPv4address = dec-octet "." dec-octet "." dec-octet "." dec-octet dec-octet = DIGIT ; 0-9 / %x31-39 DIGIT ; 10-99 / "1" 2DIGIT ; 100-199 / "2" %x30-34 DIGIT ; 200-249 / "25" %x30-35 ; 250-255 IPv6address = 6( h16 ":" ) ls32 / "::" 5( h16 ":" ) ls32 / [ h16 ] "::" 4( h16 ":" ) ls32 / [ *1( h16 ":" ) h16 ] "::" 3( h16 ":" ) ls32 / [ *2( h16 ":" ) h16 ] "::" 2( h16 ":" ) ls32 / [ *3( h16 ":" ) h16 ] "::" h16 ":" ls32 / [ *4( h16 ":" ) h16 ] "::" ls32 / [ *5( h16 ":" ) h16 ] "::" h16 / [ *6( h16 ":" ) h16 ] "::" ls32 = ( h16 ":" h16 ) / IPv4address ; least-significant 32 bits of address h16 = 1*4HEXDIG ; 16 bits of address represented in hexadecimal IPvFuture = "v" 1*HEXDIG "." 1*( unreserved / sub-delims / ":" ) reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text IPv4 (Wikipedia) https://en.wikipedia.org/wiki/IPv4 paragraph link text IP Version 6 Addressing Architecture (rfc4291) https://datatracker.ietf.org/doc/html/rfc4291 paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Set the host to an address url_base::set_encoded_host_address returns code text *this param text The string to set. s see reference set_encoded_host WTVVGr7kT7qnFaI6e/getY73eAI= text , reference set_encoded_host_name vyW7/09OitF6fXON1o2ftFzwX0Y= text , reference set_host c6/kyTU/r4vjSPQM1DnwtnTv3/o= text , reference set_host_address TGaSnQ4PS0WINemStJIm4VLR0rI= text , reference set_host_ipv4 J2yY5s29/Vm0kL+xtvGZMflIdkI= text , reference set_host_ipv6 Guwgs2WWqZMqTOkuQucJUI0fpO8= text , reference set_host_ipvfuture 6YBmlxPZA2kZSlYjMb1sLD6KrGQ= text , reference set_host_name UaE/Nbim4fGJNSgi8xJbANtFuso= text . identifier 4HBDcnMjZthTXFnhpS7z+UhDNjA= static_url identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view s normal 1 set_encoded_host_name boost/url/static_url.hpp include/boost/url/static_url.hpp 395 5 1 function vyW7/09OitF6fXON1o2ftFzwX0Y= regular 4HBDcnMjZthTXFnhpS7z+UhDNjA= paragraph text The host is set to the specified string, which may contain percent-escapes and can be empty. Escapes in the string are preserved, and reserved characters in the string are percent-escaped in the result. The host type is reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= text . heading text Example 1 code assert( url( "http://www.example.com/index.htm").set_encoded_host_name( "localhost" ).host_address() == "localhost" ); heading text Postconditions 1 code this->has_authority() == true && this->host_ipv6_address() == addr && this->host_type() == host_type::name heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text BNF 1 code reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Set the host to a name url_base::set_encoded_host_name returns code text *this param text The string to set. s see reference set_encoded_host WTVVGr7kT7qnFaI6e/getY73eAI= text , reference set_encoded_host_address jlXXuOvH7OFDJ92kr+Ha02sixZY= text , reference set_host c6/kyTU/r4vjSPQM1DnwtnTv3/o= text , reference set_host_address TGaSnQ4PS0WINemStJIm4VLR0rI= text , reference set_host_ipv4 J2yY5s29/Vm0kL+xtvGZMflIdkI= text , reference set_host_ipv6 Guwgs2WWqZMqTOkuQucJUI0fpO8= text , reference set_host_ipvfuture 6YBmlxPZA2kZSlYjMb1sLD6KrGQ= text , reference set_host_name UaE/Nbim4fGJNSgi8xJbANtFuso= text . identifier 4HBDcnMjZthTXFnhpS7z+UhDNjA= static_url identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view s normal 1 set_encoded_params boost/url/url_base.hpp include/boost/url/url_base.hpp 2419 5 1 function S9fyQqerhxu7yBt8GhsEJ9RKJl8= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This sets the query params to the elements in the list, which may contain percent-escapes and can be empty. paragraph text An empty list of params is distinct from having no query. paragraph text Escapes in the string are preserved, and reserved characters in the string are percent-escaped in the result. heading text Example 1 code assert( url( "http://example.com" ).set_encoded_params( {"id", "42"} ).encoded_query() == "id=42" ); heading text Postconditions 1 code this->has_query() == true heading text Complexity 1 paragraph text Linear. heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Set the query params returns code text *this param text The params to set. ps throws text some element in code text ps text contains an invalid percent-encoding. reference system_error see reference set_params 6eTAKxxUVgfC1QD7w2yAukEvLs4= text , reference params wdcIrRY9aj9gn6bF1i59TpOAQb4= text , reference remove_query ZZWEzCK7DguUxc3TvUfizoGKplE= text , reference set_encoded_query QcQ13DUh8M8TR/zj/LDG3N/+i3c= text , reference set_query 99/QTSBQGLrNj3zGdw5VzYlqfnI= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base specialization 3tT5Y8vozttMWXrA/fNw4NcDYTE= initializer_list identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std ps normal 1 set_encoded_password boost/url/static_url.hpp include/boost/url/static_url.hpp 370 5 1 function mUCYlTgG9KMapdW4rMNGGyUC2eY= regular 4HBDcnMjZthTXFnhpS7z+UhDNjA= paragraph text This function sets the password in the userinfo to the string, which may contain percent-escapes. Escapes in the string are preserved, and reserved characters in the string are percent-escaped in the result. admonition paragraph text The interpretation of the userinfo as individual user and password components is scheme-dependent. Transmitting passwords in URLs is deprecated. note heading text Example 1 code assert( url("http://user@example.com").set_encoded_password( "pass" ).encoded_userinfo() == "user:pass" ); heading text Postconditions 1 code this->has_password() == true heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code userinfo = [ [ user ] [ ':' password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Set the password. url_base::set_encoded_password returns code text *this param text The string to set. This string may contain any characters, including nulls. s see reference remove_password MQlcavJoBHnGjmgTMowtBTZ9n5A= text , reference set_encoded_password mUCYlTgG9KMapdW4rMNGGyUC2eY= text , reference set_encoded_user ScaSqMYZdNZbpN1CvNkkcKQ/mBY= text , reference set_user C6kqHeeHWCV8aBfJIaZHzF3nxi4= text . identifier 4HBDcnMjZthTXFnhpS7z+UhDNjA= static_url identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view s normal 1 set_encoded_path boost/url/static_url.hpp include/boost/url/static_url.hpp 408 5 1 function ZtNFxErPLOzV+1Hgm4Z5rSqtm00= regular 4HBDcnMjZthTXFnhpS7z+UhDNjA= paragraph text This function sets the path to the string, which may contain percent-escapes and can be empty. Escapes in the string are preserved, and reserved characters in the string are percent-escaped in the result. admonition paragraph text The library may adjust the final result to ensure that no other parts of the url is semantically affected. note heading text Example 1 code url u( "http://www.example.com" ); u.set_encoded_path( "path/to/file.txt" ); assert( u.encoded_path() == "/path/to/file.txt" ); heading text Complexity 1 paragraph text Linear in code text this->size() + s.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text BNF 1 code path = path-abempty ; begins with "/" or is empty / path-absolute ; begins with "/" but not "//" / path-noscheme ; begins with a non-colon segment / path-rootless ; begins with a segment / path-empty ; zero characters path-abempty = *( "/" segment ) path-absolute = "/" [ segment-nz *( "/" segment ) ] path-noscheme = segment-nz-nc *( "/" segment ) path-rootless = segment-nz *( "/" segment ) path-empty = 0<pchar> heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text Set the path. url_base::set_encoded_path returns code text *this param text The string to set. s see reference encoded_segments qeLAK8oZj7+xpHv7Pyh0yYASuqU= text , reference segments coMz0KQ2BIuACsWbIRZ/6lTOmuk= text , reference set_path 0VMn4mT6ruiabbTCXyOFe+JATBg= text , reference set_path_absolute BHDHQef0k/8vd3QskLyTrsv7+DE= text . identifier 4HBDcnMjZthTXFnhpS7z+UhDNjA= static_url identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view s normal 1 set_encoded_query boost/url/static_url.hpp include/boost/url/static_url.hpp 413 5 1 function 4AIKM/5iinX3DS4QhIO4XJUfuzw= regular 4HBDcnMjZthTXFnhpS7z+UhDNjA= paragraph text This sets the query to the string, which may contain percent-escapes and can be empty. An empty query is distinct from having no query. Escapes in the string are preserved, and reserved characters in the string are percent-escaped in the result. heading text Example 1 code assert( url( "http://example.com" ).set_encoded_query( "id=42" ).encoded_query() == "id=42" ); heading text Postconditions 1 code this->has_query() == true && this->query() == decode_view( s ); heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Set the query url_base::set_encoded_query returns code text *this param text The string to set. s see reference encoded_params tDMWbnBabN2mGSH3Apn445gDMEQ= text , reference params wdcIrRY9aj9gn6bF1i59TpOAQb4= text , reference remove_query ZZWEzCK7DguUxc3TvUfizoGKplE= text , reference set_query 99/QTSBQGLrNj3zGdw5VzYlqfnI= text . identifier 4HBDcnMjZthTXFnhpS7z+UhDNjA= static_url identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view s normal 1 set_encoded_user boost/url/static_url.hpp include/boost/url/static_url.hpp 366 5 1 function ScaSqMYZdNZbpN1CvNkkcKQ/mBY= regular 4HBDcnMjZthTXFnhpS7z+UhDNjA= paragraph text This function sets the user part of the userinfo the the string, which may contain percent-escapes. Escapes in the string are preserved, and reserved characters in the string are percent-escaped in the result. heading text Example 1 code assert( url().set_encoded_user("john%20doe").userinfo() == "john doe" ); heading text Postconditions 1 code this->has_authority() == true && this->has_userinfo() == true heading text Complexity 1 paragraph text Linear in code text this->size() + s.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code userinfo = [ [ user ] [ ':' password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Set the user url_base::set_encoded_user returns code text *this param text The string to set. s see reference remove_password MQlcavJoBHnGjmgTMowtBTZ9n5A= text , reference set_encoded_password mUCYlTgG9KMapdW4rMNGGyUC2eY= text , reference set_password sIGA8IQp3kSw3ip4pm7lmc1s9C4= text , reference set_user C6kqHeeHWCV8aBfJIaZHzF3nxi4= text . identifier 4HBDcnMjZthTXFnhpS7z+UhDNjA= static_url identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view s normal 1 set_encoded_userinfo boost/url/static_url.hpp include/boost/url/static_url.hpp 360 5 1 function c4/wDJ3igTWJNUnNsXC3LS2Fazc= regular 4HBDcnMjZthTXFnhpS7z+UhDNjA= paragraph text The userinfo is set to the given string, which may contain percent-escapes. Escapes in the string are preserved, and reserved characters in the string are percent-escaped in the result. The effects on the user and password depend on the presence of a colon (':') in the string: list paragraph text If an unescaped colon exists, the characters up to the colon become the user and the rest of the characters after the colon become the password. In this case reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text returns true. Otherwise, paragraph text If there is no colon, the user is set to the string. The function reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text returns false. unordered admonition paragraph text The interpretation of the userinfo as individual user and password components is scheme-dependent. Transmitting passwords in URLs is deprecated. note heading text Example 1 code assert( url( "http://example.com" ).set_encoded_userinfo( "john%20doe" ).user() == "john doe" ); heading text Complexity 1 paragraph text Linear in code text this->size() + s.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text BNF 1 code userinfo = [ [ user ] [ ':' password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Set the userinfo. url_base::set_encoded_userinfo returns code text *this param text The string to set. s see reference remove_userinfo PjTTglJlJuEwKHuRXGByi7wW8W8= text , reference set_userinfo s+5EFNaQxZ6HMzMRElE8AAODpm8= text . identifier 4HBDcnMjZthTXFnhpS7z+UhDNjA= static_url identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view s normal 1 set_encoded_zone_id boost/url/static_url.hpp include/boost/url/static_url.hpp 389 5 1 boost/url/url_base.hpp include/boost/url/url_base.hpp 1411 5 1 overloads Tl61JQhOPE2BzstsH+PNh3+HPAI= regular 4HBDcnMjZthTXFnhpS7z+UhDNjA= brief text Set the zone ID for an IPv6 address (percent-encoded). returns code text *this param text The zone ID to set. s throws code text s text contains an invalid percent-encoding. reference system_error normal /HsDRNr5aHRIzBwkJqZnZrdNZ/k= uMCWMPTaG0c6Qr//HaWgWGV0e0E= set_encoded_zone_id boost/url/url_base.hpp include/boost/url/url_base.hpp 1411 5 1 function /HsDRNr5aHRIzBwkJqZnZrdNZ/k= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function sets the zone ID for the host if the host is an IPv6 address. Escapes in the string are preserved, and reserved characters in the string are percent-escaped in the result. heading text Example 1 code assert( u.set_host_ipv6( ipv6_address( "fe80::1" ) ).set_encoded_zone_id( "eth0" ).buffer() == "https://[fe80::1%25eth0]" ); heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text Specification 1 list paragraph link text RFC 6874 https://datatracker.ietf.org/doc/html/rfc6874 unordered brief text Set the zone ID for an IPv6 address (percent-encoded). returns code text *this param text The zone ID to set. s throws code text s text contains an invalid percent-encoding. reference system_error identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view s normal 1 set_encoded_zone_id boost/url/static_url.hpp include/boost/url/static_url.hpp 389 5 1 function uMCWMPTaG0c6Qr//HaWgWGV0e0E= regular 4HBDcnMjZthTXFnhpS7z+UhDNjA= paragraph text This function sets the zone ID for the host if the host is an IPv6 address. Escapes in the string are preserved, and reserved characters in the string are percent-escaped in the result. heading text Example 1 code assert( u.set_host_ipv6( ipv6_address( "fe80::1" ) ).set_encoded_zone_id( "eth0" ).buffer() == "https://[fe80::1%25eth0]" ); heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text Specification 1 list paragraph link text RFC 6874 https://datatracker.ietf.org/doc/html/rfc6874 unordered brief text Set the zone ID for an IPv6 address (percent-encoded). url_base::set_encoded_zone_id returns code text *this param text The zone ID to set. s identifier 4HBDcnMjZthTXFnhpS7z+UhDNjA= static_url 1 identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view s normal 1 set_fragment boost/url/static_url.hpp include/boost/url/static_url.hpp 422 5 1 function +4IRFmcYy74cW/dNQ+7qmhQ1mdU= regular 4HBDcnMjZthTXFnhpS7z+UhDNjA= paragraph text This function sets the fragment to the specified string, which may be empty. An empty fragment is distinct from having no fragment. Reserved characters in the string are percent-escaped in the result. heading text Example 1 code assert( url("?first=john&last=doe" ).set_encoded_fragment( "john doe" ).encoded_fragment() == "john%20doe" ); heading text Postconditions 1 code this->has_fragment() == true && this->fragment() == s heading text Complexity 1 paragraph text Linear in code text this->size() + s.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code fragment = *( pchar / "/" / "?" ) heading text Specification 1 list paragraph link text 3.5. Fragment https://datatracker.ietf.org/doc/html/rfc3986#section-3.5 unordered brief text Set the fragment. url_base::set_fragment returns code text *this param text The string to set. s see reference remove_fragment aGhIz5PP9XtdztICzhAvM4n92Sg= text , reference set_encoded_fragment ebU9NPxh5c4VwDAaQA1CXRWbSKk= text . identifier 4HBDcnMjZthTXFnhpS7z+UhDNjA= static_url identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 set_host boost/url/static_url.hpp include/boost/url/static_url.hpp 375 5 1 function c6/kyTU/r4vjSPQM1DnwtnTv3/o= regular 4HBDcnMjZthTXFnhpS7z+UhDNjA= paragraph text Depending on the contents of the passed string, this function sets the host: list paragraph text If the string is a valid IPv4 address, then the host is set to the address. The host type is reference host_type::ipv4 49F64dAiji9HVbP6MxLQiqot7AY= text . paragraph text If the string is a valid IPv6 address enclosed in square brackets, then the host is set to that address. The host type is reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= text . paragraph text If the string is a valid IPvFuture address enclosed in square brackets, then the host is set to that address. The host type is reference host_type::ipvfuture TcYJaTwDFsx+0S2CkvHHARcCqWc= text . paragraph text Otherwise, the host name is set to the string, which may be empty. Reserved characters in the string are percent-escaped in the result. The host type is reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= text . unordered paragraph text In all cases, when this function returns, the URL contains an authority. heading text Example 1 code assert( url( "http://www.example.com" ).set_host( "127.0.0.1" ).buffer() == "http://127.0.0.1" ); heading text Postconditions 1 code this->has_authority() == true heading text Complexity 1 paragraph text Linear in code text this->size() + s.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPvFuture ) "]" reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text IPv4 (Wikipedia) https://en.wikipedia.org/wiki/IPv4 paragraph link text IP Version 6 Addressing Architecture (rfc4291) https://datatracker.ietf.org/doc/html/rfc4291 paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Set the host url_base::set_host returns code text *this param text The string to set. s see reference set_encoded_host WTVVGr7kT7qnFaI6e/getY73eAI= text , reference set_encoded_host_address jlXXuOvH7OFDJ92kr+Ha02sixZY= text , reference set_encoded_host_name vyW7/09OitF6fXON1o2ftFzwX0Y= text , reference set_host_address TGaSnQ4PS0WINemStJIm4VLR0rI= text , reference set_host_ipv4 J2yY5s29/Vm0kL+xtvGZMflIdkI= text , reference set_host_ipv6 Guwgs2WWqZMqTOkuQucJUI0fpO8= text , reference set_host_ipvfuture 6YBmlxPZA2kZSlYjMb1sLD6KrGQ= text , reference set_host_name UaE/Nbim4fGJNSgi8xJbANtFuso= text . identifier 4HBDcnMjZthTXFnhpS7z+UhDNjA= static_url identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 set_host_address boost/url/static_url.hpp include/boost/url/static_url.hpp 379 5 1 function TGaSnQ4PS0WINemStJIm4VLR0rI= regular 4HBDcnMjZthTXFnhpS7z+UhDNjA= paragraph text Depending on the contents of the passed string, this function sets the host: list paragraph text If the string is a valid IPv4 address, then the host is set to the address. The host type is reference host_type::ipv4 49F64dAiji9HVbP6MxLQiqot7AY= text . paragraph text If the string is a valid IPv6 address, then the host is set to that address. The host type is reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= text . paragraph text If the string is a valid IPvFuture, then the host is set to that address. The host type is reference host_type::ipvfuture TcYJaTwDFsx+0S2CkvHHARcCqWc= text . paragraph text Otherwise, the host name is set to the string, which may be empty. Reserved characters in the string are percent-escaped in the result. The host type is reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= text . unordered paragraph text In all cases, when this function returns, the URL contains an authority. heading text Example 1 code assert( url( "http://www.example.com" ).set_host_address( "127.0.0.1" ).buffer() == "http://127.0.0.1" ); heading text Postconditions 1 code this->has_authority() == true heading text Complexity 1 paragraph text Linear in code text s.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code IPv4address = dec-octet "." dec-octet "." dec-octet "." dec-octet dec-octet = DIGIT ; 0-9 / %x31-39 DIGIT ; 10-99 / "1" 2DIGIT ; 100-199 / "2" %x30-34 DIGIT ; 200-249 / "25" %x30-35 ; 250-255 IPv6address = 6( h16 ":" ) ls32 / "::" 5( h16 ":" ) ls32 / [ h16 ] "::" 4( h16 ":" ) ls32 / [ *1( h16 ":" ) h16 ] "::" 3( h16 ":" ) ls32 / [ *2( h16 ":" ) h16 ] "::" 2( h16 ":" ) ls32 / [ *3( h16 ":" ) h16 ] "::" h16 ":" ls32 / [ *4( h16 ":" ) h16 ] "::" ls32 / [ *5( h16 ":" ) h16 ] "::" h16 / [ *6( h16 ":" ) h16 ] "::" ls32 = ( h16 ":" h16 ) / IPv4address ; least-significant 32 bits of address h16 = 1*4HEXDIG ; 16 bits of address represented in hexadecimal IPvFuture = "v" 1*HEXDIG "." 1*( unreserved / sub-delims / ":" ) reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text IPv4 (Wikipedia) https://en.wikipedia.org/wiki/IPv4 paragraph link text IP Version 6 Addressing Architecture (rfc4291) https://datatracker.ietf.org/doc/html/rfc4291 paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Set the host to an address url_base::set_host_address returns code text *this param text The string to set. s see reference set_encoded_host WTVVGr7kT7qnFaI6e/getY73eAI= text , reference set_encoded_host_address jlXXuOvH7OFDJ92kr+Ha02sixZY= text , reference set_encoded_host_name vyW7/09OitF6fXON1o2ftFzwX0Y= text , reference set_host c6/kyTU/r4vjSPQM1DnwtnTv3/o= text , reference set_host_address TGaSnQ4PS0WINemStJIm4VLR0rI= text , reference set_host_ipv4 J2yY5s29/Vm0kL+xtvGZMflIdkI= text , reference set_host_ipv6 Guwgs2WWqZMqTOkuQucJUI0fpO8= text , reference set_host_ipvfuture 6YBmlxPZA2kZSlYjMb1sLD6KrGQ= text , reference set_host_name UaE/Nbim4fGJNSgi8xJbANtFuso= text . identifier 4HBDcnMjZthTXFnhpS7z+UhDNjA= static_url identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 set_host_ipv4 boost/url/static_url.hpp include/boost/url/static_url.hpp 383 5 1 function J2yY5s29/Vm0kL+xtvGZMflIdkI= regular 4HBDcnMjZthTXFnhpS7z+UhDNjA= paragraph text The host is set to the specified IPv4 address. The host type is reference host_type::ipv4 49F64dAiji9HVbP6MxLQiqot7AY= text . heading text Example 1 code assert( url("http://www.example.com").set_host_ipv4( ipv4_address( "127.0.0.1" ) ).buffer() == "http://127.0.0.1" ); heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Postconditions 1 code this->has_authority() == true && this->host_ipv4_address() == addr && this->host_type() == host_type::ipv4 heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code IPv4address = dec-octet "." dec-octet "." dec-octet "." dec-octet dec-octet = DIGIT ; 0-9 / %x31-39 DIGIT ; 10-99 / "1" 2DIGIT ; 100-199 / "2" %x30-34 DIGIT ; 200-249 / "25" %x30-35 ; 250-255 heading text Specification 1 list paragraph link text IPv4 (Wikipedia) https://en.wikipedia.org/wiki/IPv4 paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Set the host to an address url_base::set_host_ipv4 returns code text *this param text The address to set. addr see reference set_encoded_host WTVVGr7kT7qnFaI6e/getY73eAI= text , reference set_encoded_host_address jlXXuOvH7OFDJ92kr+Ha02sixZY= text , reference set_encoded_host_name vyW7/09OitF6fXON1o2ftFzwX0Y= text , reference set_host c6/kyTU/r4vjSPQM1DnwtnTv3/o= text , reference set_host_address TGaSnQ4PS0WINemStJIm4VLR0rI= text , reference set_host_ipv6 Guwgs2WWqZMqTOkuQucJUI0fpO8= text , reference set_host_ipvfuture 6YBmlxPZA2kZSlYjMb1sLD6KrGQ= text , reference set_host_name UaE/Nbim4fGJNSgi8xJbANtFuso= text . identifier 4HBDcnMjZthTXFnhpS7z+UhDNjA= static_url 1 identifier /Wpp3ZZDp3kUHzbULeDoaOEhnVs= ipv4_address addr normal 1 set_host_ipv6 boost/url/static_url.hpp include/boost/url/static_url.hpp 385 5 1 function Guwgs2WWqZMqTOkuQucJUI0fpO8= regular 4HBDcnMjZthTXFnhpS7z+UhDNjA= paragraph text The host is set to the specified IPv6 address. The host type is reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= text . heading text Example 1 code assert( url().set_host_ipv6( ipv6_address( "1::6:c0a8:1" ) ).authority().buffer() == "[1::6:c0a8:1]" ); heading text Postconditions 1 code this->has_authority() == true && this->host_ipv6_address() == addr && this->host_type() == host_type::ipv6 heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code IPv6address = 6( h16 ":" ) ls32 / "::" 5( h16 ":" ) ls32 / [ h16 ] "::" 4( h16 ":" ) ls32 / [ *1( h16 ":" ) h16 ] "::" 3( h16 ":" ) ls32 / [ *2( h16 ":" ) h16 ] "::" 2( h16 ":" ) ls32 / [ *3( h16 ":" ) h16 ] "::" h16 ":" ls32 / [ *4( h16 ":" ) h16 ] "::" ls32 / [ *5( h16 ":" ) h16 ] "::" h16 / [ *6( h16 ":" ) h16 ] "::" ls32 = ( h16 ":" h16 ) / IPv4address ; least-significant 32 bits of address h16 = 1*4HEXDIG ; 16 bits of address represented in hexadecimal heading text Specification 1 list paragraph link text IP Version 6 Addressing Architecture (rfc4291) https://datatracker.ietf.org/doc/html/rfc4291 paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Set the host to an address url_base::set_host_ipv6 returns code text *this param text The address to set. addr see reference set_encoded_host OgEcjvMpUkw5cqqrotx6BNVfYuA= text , reference set_encoded_host_address 51fvhkKEd4+UZEBsnLd4vUL/Svw= text , reference set_encoded_host_name Lz8KFSebh4YuJuAAf0STYQ/VPqk= text , reference set_host lhYybwvylnG/ieiGmyVfyExN3dw= text , reference set_host_address ut25mVfVRShtv19Mg+nvS5jVATc= text , reference set_host_ipv4 Cn5GM3RJyUENDJ/d6LnYVW+gkA4= text , reference set_host_ipvfuture BQxPHhB2Uv0OyVbWf3e7/seXVX8= text , reference set_host_name Pt4icJRgJxULgQjbXV6yzBigNl8= text . identifier 4HBDcnMjZthTXFnhpS7z+UhDNjA= static_url 1 identifier dhMSRVBIIIItY0URHSc8rwHcdTQ= ipv6_address addr normal 1 set_host_ipvfuture boost/url/static_url.hpp include/boost/url/static_url.hpp 391 5 1 function 6YBmlxPZA2kZSlYjMb1sLD6KrGQ= regular 4HBDcnMjZthTXFnhpS7z+UhDNjA= paragraph text The host is set to the specified IPvFuture string. The host type is reference host_type::ipvfuture TcYJaTwDFsx+0S2CkvHHARcCqWc= text . heading text Example 1 code assert( url().set_host_ipvfuture( "v42.bis" ).buffer() == "//[v42.bis]" ); heading text Complexity 1 paragraph text Linear in code text this->size() + s.size() text . heading text Postconditions 1 code this->has_authority() == true && this->host_ipvfuture) == s && this->host_type() == host_type::ipvfuture heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text BNF 1 code IPvFuture = "v" 1*HEXDIG "." 1*( unreserved / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Set the host to an address url_base::set_host_ipvfuture returns code text *this param text The string to set. s see reference set_encoded_host WTVVGr7kT7qnFaI6e/getY73eAI= text , reference set_encoded_host_address jlXXuOvH7OFDJ92kr+Ha02sixZY= text , reference set_encoded_host_name vyW7/09OitF6fXON1o2ftFzwX0Y= text , reference set_host c6/kyTU/r4vjSPQM1DnwtnTv3/o= text , reference set_host_address TGaSnQ4PS0WINemStJIm4VLR0rI= text , reference set_host_ipv4 J2yY5s29/Vm0kL+xtvGZMflIdkI= text , reference set_host_ipv6 Guwgs2WWqZMqTOkuQucJUI0fpO8= text , reference set_host_name UaE/Nbim4fGJNSgi8xJbANtFuso= text . identifier 4HBDcnMjZthTXFnhpS7z+UhDNjA= static_url identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 set_host_name boost/url/static_url.hpp include/boost/url/static_url.hpp 393 5 1 function UaE/Nbim4fGJNSgi8xJbANtFuso= regular 4HBDcnMjZthTXFnhpS7z+UhDNjA= paragraph text The host is set to the specified string, which may be empty. Reserved characters in the string are percent-escaped in the result. The host type is reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= text . heading text Example 1 code assert( url( "http://www.example.com/index.htm").set_host_name( "localhost" ).host_address() == "localhost" ); heading text Postconditions 1 code this->has_authority() == true && this->host_ipv6_address() == addr && this->host_type() == host_type::name heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Set the host to a name url_base::set_host_name returns code text *this param text The string to set. s see reference set_encoded_host WTVVGr7kT7qnFaI6e/getY73eAI= text , reference set_encoded_host_address jlXXuOvH7OFDJ92kr+Ha02sixZY= text , reference set_encoded_host_name vyW7/09OitF6fXON1o2ftFzwX0Y= text , reference set_host c6/kyTU/r4vjSPQM1DnwtnTv3/o= text , reference set_host_address TGaSnQ4PS0WINemStJIm4VLR0rI= text , reference set_host_ipv4 J2yY5s29/Vm0kL+xtvGZMflIdkI= text , reference set_host_ipv6 Guwgs2WWqZMqTOkuQucJUI0fpO8= text , reference set_host_ipvfuture 6YBmlxPZA2kZSlYjMb1sLD6KrGQ= text . identifier 4HBDcnMjZthTXFnhpS7z+UhDNjA= static_url identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 set_params boost/url/static_url.hpp include/boost/url/static_url.hpp 415 5 1 function l3egvbg5aBpsjCXp8RnOSZ8DzX4= regular 4HBDcnMjZthTXFnhpS7z+UhDNjA= paragraph text This sets the query params to the list of param_view, which can be empty. paragraph text An empty list of params is distinct from having no params. paragraph text Reserved characters in the string are percent-escaped in the result. heading text Example 1 code assert( url( "http://example.com" ).set_params( {"id", "42"} ).query() == "id=42" ); heading text Postconditions 1 code this->has_query() == true heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text Complexity 1 paragraph text Linear. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text ://en.wikipedia.org/wiki/Query_string" >Query string (Wikipedia) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 >3.4. Query (rfc3986)</a> @li <a href= unordered brief text Set the query params url_base::set_params returns code text *this param text The params to set. ps param text The options for encoding. opts see reference encoded_params tDMWbnBabN2mGSH3Apn445gDMEQ= text , reference remove_query IYZqU1YD/Yk8eV1APcJAB1m/E/M= text , reference set_encoded_query 4AIKM/5iinX3DS4QhIO4XJUfuzw= text , reference set_query 4zoimIYzrVVdns97BxYUtHZkP8w= text . identifier 4HBDcnMjZthTXFnhpS7z+UhDNjA= static_url specialization 3tT5Y8vozttMWXrA/fNw4NcDYTE= initializer_list identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std ps identifier Bb04pNwExynJkzlY9a9GCeeB13k= encoding_opts opts {} normal 1 set_password boost/url/static_url.hpp include/boost/url/static_url.hpp 368 5 1 function sIGA8IQp3kSw3ip4pm7lmc1s9C4= regular 4HBDcnMjZthTXFnhpS7z+UhDNjA= paragraph text This function sets the password in the userinfo to the string. Reserved characters in the string are percent-escaped in the result. admonition paragraph text The interpretation of the userinfo as individual user and password components is scheme-dependent. Transmitting passwords in URLs is deprecated. note heading text Example 1 code assert( url("http://user@example.com").set_password( "pass" ).encoded_userinfo() == "user:pass" ); heading text Postconditions 1 code this->has_password() == true && this->password() == s heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code userinfo = [ [ user ] [ ':' password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Set the password. url_base::set_password returns code text *this param text The string to set. This string may contain any characters, including nulls. s see reference remove_password M5RIQPf9vzlN+m4Qn0PDNFKy8ak= text , reference set_encoded_password qF7dDBIf4KkHxSuysLw1EJNSh2Y= text , reference set_encoded_user YNLJGohUXCdL6mo1PM3ms9pRQyE= text , reference set_user GWy3y66sOX4ov+Eh3hxNRVsAEwY= text . identifier 4HBDcnMjZthTXFnhpS7z+UhDNjA= static_url identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 set_path boost/url/static_url.hpp include/boost/url/static_url.hpp 406 5 1 function VqDEXtjQm5PewYuAWxjhVpm2+MY= regular 4HBDcnMjZthTXFnhpS7z+UhDNjA= paragraph text This function sets the path to the string, which may be empty. Reserved characters in the string are percent-escaped in the result. admonition paragraph text The library may adjust the final result to ensure that no other parts of the URL are semantically affected. note admonition paragraph text This function does not encode '/' chars, which are unreserved for paths but reserved for path segments. If a path segment should include encoded '/'s to differentiate it from path separators, the functions reference set_encoded_path GQGd+Ne+D3eTy4fe+x1cpa5zefU= text or reference segments coMz0KQ2BIuACsWbIRZ/6lTOmuk= text should be used instead. note heading text Example 1 code url u( "http://www.example.com" ); u.set_path( "path/to/file.txt" ); assert( u.path() == "/path/to/file.txt" ); heading text Complexity 1 paragraph text Linear in code text this->size() + s.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code path = path-abempty ; begins with "/" or is empty / path-absolute ; begins with "/" but not "//" / path-noscheme ; begins with a non-colon segment / path-rootless ; begins with a segment / path-empty ; zero characters path-abempty = *( "/" segment ) path-absolute = "/" [ segment-nz *( "/" segment ) ] path-noscheme = segment-nz-nc *( "/" segment ) path-rootless = segment-nz *( "/" segment ) path-empty = 0<pchar> heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text Set the path. url_base::set_path returns code text *this param text The string to set. s see reference encoded_segments qeLAK8oZj7+xpHv7Pyh0yYASuqU= text , reference segments coMz0KQ2BIuACsWbIRZ/6lTOmuk= text , reference set_encoded_path ZtNFxErPLOzV+1Hgm4Z5rSqtm00= text , reference set_path_absolute BHDHQef0k/8vd3QskLyTrsv7+DE= text . identifier 4HBDcnMjZthTXFnhpS7z+UhDNjA= static_url identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 set_path_absolute boost/url/url_base.hpp include/boost/url/url_base.hpp 1760 5 1 function BHDHQef0k/8vd3QskLyTrsv7+DE= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function adjusts the path to make it absolute or not, depending on the parameter. admonition paragraph text If an authority is present, the path is always absolute. In this case, the function has no effect. note heading text Example 1 code url u( "path/to/file.txt" ); assert( u.set_path_absolute( true ) ); assert( u.buffer() == "/path/to/file.txt" ); heading text Postconditions 1 code this->is_path_absolute() == true && this->encoded_path().front() == '/' heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text BNF 1 code path = path-abempty ; begins with "/" or is empty / path-absolute ; begins with "/" but not "//" / path-noscheme ; begins with a non-colon segment / path-rootless ; begins with a segment / path-empty ; zero characters path-abempty = *( "/" segment ) path-absolute = "/" [ segment-nz *( "/" segment ) ] path-noscheme = segment-nz-nc *( "/" segment ) path-rootless = segment-nz *( "/" segment ) path-empty = 0<pchar> heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text Set if the path is absolute returns text true on success. param text If code text true text , the path is made absolute. absolute see reference encoded_segments qeLAK8oZj7+xpHv7Pyh0yYASuqU= text , reference segments coMz0KQ2BIuACsWbIRZ/6lTOmuk= text , reference set_encoded_path GQGd+Ne+D3eTy4fe+x1cpa5zefU= text , reference set_path 0VMn4mT6ruiabbTCXyOFe+JATBg= text . identifier bool identifier bool absolute normal 1 set_port boost/url/static_url.hpp include/boost/url/static_url.hpp 399 5 1 function ay+XTyyJRSCsLBhW5JNwRtngbwo= regular 4HBDcnMjZthTXFnhpS7z+UhDNjA= paragraph text This port is set to the string, which must contain only digits or be empty. An empty port string is distinct from having no port. heading text Example 1 code assert( url( "http://www.example.com" ).set_port( "8080" ).authority().buffer() == "www.example.com:8080" ); heading text Postconditions 1 code this->has_port() == true && this->port_number() == n && this->port() == std::to_string(n) heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text BNF 1 code port = *DIGIT heading text Specification 1 list paragraph link text 3.2.3. Port (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.3 unordered brief text Set the port url_base::set_port returns code text *this param text The port string to set. s see reference remove_port ADa0xIsiS8APEAdL3+s0LoNowA8= text , reference set_port p1q1Ba+a+naWvTDfBuMPt0DJw2A= text . identifier 4HBDcnMjZthTXFnhpS7z+UhDNjA= static_url identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 set_port_number boost/url/static_url.hpp include/boost/url/static_url.hpp 397 5 1 function vvvc+qpbS5HUTGzLHaY+KnnRbGQ= regular 4HBDcnMjZthTXFnhpS7z+UhDNjA= paragraph text The port is set to the specified integer. heading text Example 1 code assert( url( "http://www.example.com" ).set_port_number( 8080 ).authority().buffer() == "www.example.com:8080" ); heading text Postconditions 1 code this->has_authority() == true && this->has_port() == true && this->port_number() == n heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code authority = [ userinfo "@" ] host [ ":" port ] port = *DIGIT heading text Specification 1 list paragraph link text 3.2.3. Port (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.3 unordered brief text Set the port url_base::set_port_number returns code text *this param text The port number to set. n see reference remove_port 0MEk6Ddnsq5FQhANarFWyfhL4/M= text , reference set_port ay+XTyyJRSCsLBhW5JNwRtngbwo= text . identifier 4HBDcnMjZthTXFnhpS7z+UhDNjA= static_url identifier Qvo2fOST20EZC7bSOAFZr+u3ITg= uint16_t n normal 1 set_query boost/url/static_url.hpp include/boost/url/static_url.hpp 411 5 1 function 4zoimIYzrVVdns97BxYUtHZkP8w= regular 4HBDcnMjZthTXFnhpS7z+UhDNjA= paragraph text This sets the query to the string, which can be empty. An empty query is distinct from having no query. Reserved characters in the string are percent-escaped in the result. heading text Example 1 code assert( url( "http://example.com" ).set_query( "id=42" ).query() == "id=42" ); heading text Postconditions 1 code this->has_query() == true && this->query() == s heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Set the query url_base::set_query returns code text *this param text The string to set. s see reference encoded_params tDMWbnBabN2mGSH3Apn445gDMEQ= text , reference params wdcIrRY9aj9gn6bF1i59TpOAQb4= text , reference remove_query ZZWEzCK7DguUxc3TvUfizoGKplE= text , reference set_encoded_query QcQ13DUh8M8TR/zj/LDG3N/+i3c= text . identifier 4HBDcnMjZthTXFnhpS7z+UhDNjA= static_url identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 set_scheme boost/url/static_url.hpp include/boost/url/static_url.hpp 346 5 1 function Lc5XBzZs/ayxU18Djd6Q0BHFWv4= regular 4HBDcnMjZthTXFnhpS7z+UhDNjA= paragraph text The scheme is set to the specified string, which must contain a valid scheme without any trailing colon (':'). Note that schemes are case-insensitive, and the canonical form is lowercased. heading text Example 1 code assert( url( "http://www.example.com" ).set_scheme( "https" ).scheme_id() == scheme::https ); heading text Complexity 1 paragraph text Linear in code text this->size() + s.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text BNF 1 code scheme = ALPHA *( ALPHA / DIGIT / "+" / "-" / "." ) heading text Specification 1 list paragraph link text 3.1. Scheme (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.1 unordered brief text Set the scheme url_base::set_scheme returns code text *this param text The scheme to set. s see reference remove_scheme 1N2Tt1DokczwHdRgAZiZzhPQr4E= text . identifier 4HBDcnMjZthTXFnhpS7z+UhDNjA= static_url identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 set_scheme_id boost/url/static_url.hpp include/boost/url/static_url.hpp 348 5 1 function rtAxCFit/TGmjKYS6TFVsrBNQEI= regular 4HBDcnMjZthTXFnhpS7z+UhDNjA= paragraph text This function sets the scheme to the specified known reference urls::scheme P7uOjuAMILimKGOcbjDUSpMAL/U= text id, which may not be reference scheme::unknown LJxTyQ55ot1WYLH7f46nZvdGU78= text or else an exception is thrown. If the id is reference scheme::none VupiauVBXlZQ8Uix+vk8kSl+fM8= text , this function behaves as if reference remove_scheme 1N2Tt1DokczwHdRgAZiZzhPQr4E= text were called. heading text Example 1 code assert( url( "http://example.com/echo.cgi" ).set_scheme_id( scheme::wss ).buffer() == "wss://example.com/echo.cgi" ); heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text Specification 1 list paragraph link text 3.1. Scheme (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.1 unordered brief text Set the scheme url_base::set_scheme_id returns code text *this param text The scheme to set. id identifier 4HBDcnMjZthTXFnhpS7z+UhDNjA= static_url identifier P7uOjuAMILimKGOcbjDUSpMAL/U= scheme identifier dnk5XPfR2OaMpCYaH3cWSxcTdyc= urls id normal 1 set_user boost/url/static_url.hpp include/boost/url/static_url.hpp 364 5 1 function C6kqHeeHWCV8aBfJIaZHzF3nxi4= regular 4HBDcnMjZthTXFnhpS7z+UhDNjA= paragraph text This function sets the user part of the userinfo to the string. Any special or reserved characters in the string are automatically percent-encoded. heading text Example 1 code assert( url().set_user("john doe").encoded_userinfo() == "john%20doe" ); heading text Postconditions 1 code this->has_authority() == true && this->has_userinfo() == true heading text Complexity 1 paragraph text Linear in code text this->size() + s.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code userinfo = [ [ user ] [ ':' password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Set the user url_base::set_user returns code text *this param text The string to set. s see reference remove_password MQlcavJoBHnGjmgTMowtBTZ9n5A= text , reference set_encoded_password mUCYlTgG9KMapdW4rMNGGyUC2eY= text , reference set_encoded_user ScaSqMYZdNZbpN1CvNkkcKQ/mBY= text , reference set_password sIGA8IQp3kSw3ip4pm7lmc1s9C4= text . identifier 4HBDcnMjZthTXFnhpS7z+UhDNjA= static_url identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 set_userinfo boost/url/static_url.hpp include/boost/url/static_url.hpp 358 5 1 function he1jodL9CeOuw4MBdmIdXvYfXMk= regular 4HBDcnMjZthTXFnhpS7z+UhDNjA= paragraph text The userinfo is set to the given string, which may contain percent-escapes. Any special or reserved characters in the string are automatically percent-encoded. The effects on the user and password depend on the presence of a colon (':') in the string: list paragraph text If an unescaped colon exists, the characters up to the colon become the user and the rest of the characters after the colon become the password. In this case reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text returns true. Otherwise, paragraph text If there is no colon, the user is set to the string. The function reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text returns false. unordered admonition paragraph text The interpretation of the userinfo as individual user and password components is scheme-dependent. Transmitting passwords in URLs is deprecated. note heading text Example 1 code assert( url( "http://example.com" ).set_userinfo( "user:pass" ).encoded_user() == "user" ); heading text Complexity 1 paragraph text Linear in code text this->size() + s.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code userinfo = [ [ user ] [ ':' password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Set the userinfo url_base::set_userinfo returns code text *this param text The string to set. s see reference remove_userinfo mFEIJCpzEh4h8vUKHZxjlOuZoao= text , reference set_encoded_userinfo c4/wDJ3igTWJNUnNsXC3LS2Fazc= text . identifier 4HBDcnMjZthTXFnhpS7z+UhDNjA= static_url identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 set_zone_id boost/url/static_url.hpp include/boost/url/static_url.hpp 387 5 1 function bEmCJdx+TpNi361IL4hPfZSdUWI= regular 4HBDcnMjZthTXFnhpS7z+UhDNjA= paragraph text This function sets the zone ID for the host if the host is an IPv6 address. Reserved characters in the string are percent-escaped in the result. heading text Example 1 code assert( u.set_host_ipv6( ipv6_address( "fe80::1" ) ).set_zone_id( "eth0" ).buffer() == "https://[fe80::1%25eth0]" ); heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text Specification 1 list paragraph link text RFC 6874 https://datatracker.ietf.org/doc/html/rfc6874 unordered brief text Set the zone ID for an IPv6 address. url_base::set_zone_id returns code text *this param text The zone ID to set. s identifier 4HBDcnMjZthTXFnhpS7z+UhDNjA= static_url identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 size boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 201 5 1 function b5EwiMBFGrk0/BIGaiumuCVSoFM= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the number of characters in the url's encoded string, not including any null terminator, if present. heading text Example 1 code assert( url_view( "file:///Program%20Files" ).size() == 23 ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the number of characters in the url returns text The number of characters in the url. identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 1 user boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 848 5 1 function /oa6wZJEG852J9Yi1LQlnq1n1tM= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If present, this function returns a string representing the user (which may be empty). Otherwise it returns an empty string. Any percent-escapes in the string are decoded first. heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).user() == "jane-doe" ); heading text Complexity 1 paragraph text Linear in code text this->user().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code userinfo = user [ ":" [ password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return the user returns text The user as a string. param text The string token to use. token see reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text , reference has_userinfo i/v5Vfq44OnlLbuKgQ2KvgWgZqo= text , reference encoded_password W9oZv0BM5z4XAggQPbNAKIM7/ro= text , reference encoded_user oYwrnXcglhO4tlvhkxLGfFCYbAk= text , reference encoded_userinfo yzkq+uCmbTlXrfDuyd1fT0Zu6xw= text , reference password +ZB55yb2DeVYG+/eYqlMcGcedVE= text , reference userinfo S9yd7MVhXxF+598Xy2/+jwnCZzc= text . identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 userinfo boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 748 5 1 function S9yd7MVhXxF+598Xy2/+jwnCZzc= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If present, this function returns a string representing the userinfo (which may be empty). Otherwise it returns an empty string. Any percent-escapes in the string are decoded first. admonition paragraph text This function uses the string token return type customization. Depending on the token passed, the return type and behavior of the function can be different. See reference string_token::return_string +eBzDECNPyuTkJuxLUTMVIkHGO0= text for more information. note heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).userinfo() == "jane-doe:pass" ); heading text Complexity 1 paragraph text Linear in code text this->userinfo().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code userinfo = user [ ":" [ password ] ] authority = [ userinfo "@" ] host [ ":" port ] heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return the userinfo returns text When called with no arguments, a value of type code text std::string text is returned. Otherwise, the return type and meaning depends on the string token passed to the function. returns text The userinfo as a string. param text The string token to use. token see reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text , reference has_userinfo i/v5Vfq44OnlLbuKgQ2KvgWgZqo= text , reference encoded_password W9oZv0BM5z4XAggQPbNAKIM7/ro= text , reference encoded_user oYwrnXcglhO4tlvhkxLGfFCYbAk= text , reference encoded_userinfo yzkq+uCmbTlXrfDuyd1fT0Zu6xw= text , reference password +ZB55yb2DeVYG+/eYqlMcGcedVE= text , reference user /oa6wZJEG852J9Yi1LQlnq1n1tM= text . identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 zone_id boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1480 5 1 function rN6p9/aLARL9S9gn02k+M+j21q8= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If the host type is reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= text , this function returns the Zone ID as a string. Otherwise an empty string is returned. Any percent-escapes in the string are decoded first. heading text Example 1 code assert( url_view( "http://[fe80::1%25eth0]/" ).zone_id() == "eth0" ); heading text Complexity 1 paragraph text Linear in code text this->encoded_zone_id().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPv6addrz / IPvFuture ) "]" ZoneID = 1*( unreserved / pct-encoded ) IPv6addrz = IPv6address "%25" ZoneID heading text Specification 1 list paragraph link text Representing IPv6 Zone Identifiers in Address Literals and Uniform Resource Identifiers https://datatracker.ietf.org/doc/html/rfc6874 unordered brief text Return the IPv6 Zone ID returns text The Zone ID as a string. param text A string token customization. token identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 operator basic_string_view<char> boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 299 5 1 function 0JOtXYOmKvCl2dNIZYV6J7flgJE= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the URL as a core::string_view returns text A string view of the URL. identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core conversion 1 1 max_size boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 173 5 1 function mg8FRYZ94og9lKYjTEYdjucqHw4= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This represents the largest number of characters that are theoretically possible to represent in a url, not including any null terminator. In practice the actual possible size may be lower than this number. heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the maximum number of characters possible returns text The maximum number of characters. identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 digest boost/url/impl/url_view_base.hpp include/boost/url/impl/url_view_base.hpp 81 1 boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 146 5 1 function aSDB3babl7TsiU0T+gdHMM/NC5c= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function calculates a hash of the url as if it were always normalized. heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Throws nothing. brief text Calculate a hash of the url returns text A hash value suitable for use in hash-based containers. param text An initial value to add to the hash salt identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std salt 0 normal 1 1 static_url_base boost/url/static_url.hpp include/boost/url/static_url.hpp 52 1 1 record dmsqdje8dXFRFgNB9wxOs9Y5nb8= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text This base class is used by the library to provide common functionality for static URLs. Users should not use this class directly. Instead, construct an instance of one of the containers or call a parsing function. heading text Containers 1 list paragraph reference url B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph reference url_view wh3UbUToX9YDmRmnpcoM9EUEZo8= paragraph reference static_url 4HBDcnMjZthTXFnhpS7z+UhDNjA= unordered heading text Parsing Functions 1 list paragraph reference parse_absolute_uri U3CVElRbcTcbg1JzOqhBCd5RSzM= paragraph reference parse_origin_form J4f05lEg7oi89R2SkpRaYiBhCIQ= paragraph reference parse_relative_ref QFzcl8vSLEeKOEO6w3mv1zGqX3k= paragraph reference parse_uri f+9kR517VGSM5ZPoS7g/RFb0g/0= paragraph reference parse_uri_reference 7d2b1xVBWJPgL/+PWFdoBaZJvMA= unordered brief text Common implementation for all static URLs reference format_to K7ofEKM2bNb4ZS9OFo0DX+7Ep9I= reference format_to ueXaMbO5jFzZWelOn6upDJcN55Y= reference operator!= QA2q/R+XvrJl2j8UnJwv+lnhdDA= reference operator< Si07vh35lnvnJy8tpXUIpiFEjGM= reference operator<= rRCHC/6GEaVZrjzAeFDlvaCydi0= reference operator== E2+0o+/H5dWqJ1IkTzJ6aHTaMHE= reference operator> ngGy21anUjaZiQQJidHT5lvOC2w= reference operator>= AdXFp/RvPKHF4rljfa5/5yBmyfs= reference resolve /6zWjIFN5df0PBj9zFsfNUjNY6s= class identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base 4HBDcnMjZthTXFnhpS7z+UhDNjA= v5/R9LI0iKJDiBrNUt7k8qrVBdM= oDNnPxjP34HYhoUyyduWMZfqZs4= OUdGewqojyZZ2vohOsR/ce3sgdM= FPqXKVymUm0eRCsXV1yuMFlv4ug= PMYRGpyOUt7hbDyd33GRHTcxEj8= p+2L2asXUGpE7eey1ouRvFXKD1g= I2WjK21z+iS45kbL4TnzA8O5oE0= 5yR7btLz2K+NLHFnzfXMyGsq2fo= Ww04vLA2k7BwctuyNeP3KwoNr4M= M7+OzewsxChMvecRSytXqTCqKrY= EcGxt+esOtVfjloInubXUYLy5GY= yXsUZRbi+wInLqaUUVy9b7nIIBo= 9ptIMbwWSNtVv+KAUpHCO3bmTWg= 4URKnuP+gvIUVjIkywv/pXeFjv4= wG6ey1727HIj10Wh+OD/s8kuOjo= tDMWbnBabN2mGSH3Apn445gDMEQ= W9oZv0BM5z4XAggQPbNAKIM7/ro= GNlqbV0MSxGIA/gSjlOb2rfSHhU= suU4/MiRITTTYf61BFw2aI6WxdI= yLMNPjiW4s31xcLN4xOiqVySYLA= qeLAK8oZj7+xpHv7Pyh0yYASuqU= IcodRek43l5Zc13Z67L74PlhG0U= oYwrnXcglhO4tlvhkxLGfFCYbAk= yzkq+uCmbTlXrfDuyd1fT0Zu6xw= 5M2smbXDaSa2d/li//A+GmlDgDU= aA1Q9NAW4/TnG3SXhe4k1mNB5nk= gadV3YsYDjlGX+64Rtiz4S+QD4A= ZiWsQaQCAif94KdP6GXH9+F5GmM= 9JACnsebk8tFsoryabfDxE8VpnA= 5V5uOhRsy00O+TSEAkIb7uFoN2U= SLiWca6gUGmTh+r/BbU40NrICW8= iwSH2fvVkb89TkZj7KWLGSyc4sA= i/v5Vfq44OnlLbuKgQ2KvgWgZqo= ICcovOIyqnxhSMU6MuEekYg2z+E= F0RYzLwUP8ied6l3zmKvomgFHag= KL8F3KYxyzpC1e6fqoJy3B8IHhw= CvoRh2IpWg4QixngVwDjSKoeQVY= 55Yh68uToEiKy+IDTpyctuK/T3g= AhPhrC4hmBsZgd/ztqbkAuOkbBM= Nv9Emy6spILLI/mqyIz2uRNBJhU= eh5BeHbLjL3BuEY7ao3tbEAZnTw= ldUmQToJNGQ58j33Mti85clcGbM= j2lB1y9ywFNpGt8xXYkZZuJbs30= R2y0tPa5JiRRSTNXgUjKdMoCOcA= pjVn3eVVaWNAixzkPBECE+lKByQ= 4CZ8ebKgivCQbRJoYD78PmOko2U= iyO2AawtEbzXMJkvSocn7BpBBrI= wdcIrRY9aj9gn6bF1i59TpOAQb4= +ZB55yb2DeVYG+/eYqlMcGcedVE= Q5NVO+d/+BmZ5v3/ogNb2XpUTKs= cRPG1npIXmfYC0K+C+idxOqIc04= OlWcRIIUl1cq5Ab9fLXGPyhYCfI= lctXu8FITJWg0+Y+yZVt5iv7QDM= 4epyMikskiBx2Gu+S87oAhrM/ZY= cjTKMEM0IWRzDexmJAiWOj6P+ZI= aGhIz5PP9XtdztICzhAvM4n92Sg= OqDHBYUjGSW4mGYuSUu09xFSlEc= M5RIQPf9vzlN+m4Qn0PDNFKy8ak= ADa0xIsiS8APEAdL3+s0LoNowA8= ZZWEzCK7DguUxc3TvUfizoGKplE= 1N2Tt1DokczwHdRgAZiZzhPQr4E= PjTTglJlJuEwKHuRXGByi7wW8W8= R5AajT/eZPgijKrm8AxolAdhsRQ= 3Pi5l1khAbVAQHD3fWi5GoHEr5E= 43fxogaC5oVqfauhwXyN4s4ibEM= uM37WpBqetqzfHjns3M8/+CcoEU= coMz0KQ2BIuACsWbIRZ/6lTOmuk= VTO/x6AChJRFyjVKxhaqmIAvYFI= ebU9NPxh5c4VwDAaQA1CXRWbSKk= OgEcjvMpUkw5cqqrotx6BNVfYuA= 51fvhkKEd4+UZEBsnLd4vUL/Svw= Lz8KFSebh4YuJuAAf0STYQ/VPqk= S9fyQqerhxu7yBt8GhsEJ9RKJl8= qF7dDBIf4KkHxSuysLw1EJNSh2Y= GQGd+Ne+D3eTy4fe+x1cpa5zefU= QcQ13DUh8M8TR/zj/LDG3N/+i3c= YNLJGohUXCdL6mo1PM3ms9pRQyE= MLv0mdC6EhrEgdnFiOF+W8sw0/c= /HsDRNr5aHRIzBwkJqZnZrdNZ/k= VHh7zoCWGsviuG3lWYA54cKWneU= lhYybwvylnG/ieiGmyVfyExN3dw= ut25mVfVRShtv19Mg+nvS5jVATc= Cn5GM3RJyUENDJ/d6LnYVW+gkA4= BryTExdDEUoZs6riyC1Qi0/NtPE= BQxPHhB2Uv0OyVbWf3e7/seXVX8= Pt4icJRgJxULgQjbXV6yzBigNl8= 6eTAKxxUVgfC1QD7w2yAukEvLs4= blkDquwzHtk7o5mJf/hdeY15zWg= 0VMn4mT6ruiabbTCXyOFe+JATBg= BHDHQef0k/8vd3QskLyTrsv7+DE= p1q1Ba+a+naWvTDfBuMPt0DJw2A= 4bptcCq14NmzqKQvnx54lE+28F0= 99/QTSBQGLrNj3zGdw5VzYlqfnI= rKQfFZ6dfzeuSqZL+PgPNpIFQ5g= iuTF0vS1Knzl0Hxr4iVhx35Fzdk= GWy3y66sOX4ov+Eh3hxNRVsAEwY= s+5EFNaQxZ6HMzMRElE8AAODpm8= eM5mUh7EZ/5wyXKQEoMXhHD+KJk= b5EwiMBFGrk0/BIGaiumuCVSoFM= /oa6wZJEG852J9Yi1LQlnq1n1tM= S9yd7MVhXxF+598Xy2/+jwnCZzc= rN6p9/aLARL9S9gn02k+M+j21q8= 0JOtXYOmKvCl2dNIZYV6J7flgJE= mg8FRYZ94og9lKYjTEYdjucqHw4= aSDB3babl7TsiU0T+gdHMM/NC5c= s6HKzX/rADHiXcPsOj7bt3LOVvs= ee3ZKIZhpzPJMH0diw4MvZ+ERdQ= dgHgxOVEi/0OyuItCHP5sKnV2js= WAFszRiZ/D/ZYZCsOebkJfP/LG0= 7Cc9v8YINptmQzW8jYAyZOH5E2Y= iGCcoeGQ74DedqGvfo7nSUBPAW0= 4HBDcnMjZthTXFnhpS7z+UhDNjA= authority boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 564 5 1 function v5/R9LI0iKJDiBrNUt7k8qrVBdM= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the authority as an reference authority_view d/hMlyyC3Ave6L9McUD7B4TwENA= text . heading text Example 1 code authority_view a = url_view( "https://www.example.com:8080/index.htm" ).authority(); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code authority = [ userinfo "@" ] host [ ":" port ] heading text Specification 1 list paragraph link text 3.2. Authority (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2 unordered brief text Return the authority returns text An authority_view representing the authority. see reference encoded_authority Ww04vLA2k7BwctuyNeP3KwoNr4M= text , reference has_authority gadV3YsYDjlGX+64Rtiz4S+QD4A= text . identifier d/hMlyyC3Ave6L9McUD7B4TwENA= authority_view normal 1 1 buffer boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 282 5 1 function oDNnPxjP34HYhoUyyduWMZfqZs4= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the entire url, which may contain percent escapes. heading text Example 1 code assert( url_view( "http://www.example.com" ).buffer() == "http://www.example.com" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the url string returns text The url as a string. identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core normal 1 1 c_str boost/url/url_base.hpp include/boost/url/url_base.hpp 127 5 1 function OUdGewqojyZZ2vohOsR/ce3sgdM= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function returns a pointer to a null terminated string representing the url, which may contain percent escapes. heading text Example 1 code assert( std::strlen( url( "http://www.example.com" ).c_str() ) == 22 ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the url as a null-terminated string returns text A pointer to a null-terminated string containing the URL. 1 identifier char normal 1 1 capacity boost/url/url_base.hpp include/boost/url/url_base.hpp 146 5 1 function FPqXKVymUm0eRCsXV1yuMFlv4ug= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This does not include the null terminator, which is always present. heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the number of characters that can be stored without reallocating returns code text *this identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 1 clear boost/url/url_base.hpp include/boost/url/url_base.hpp 165 5 1 function PMYRGpyOUt7hbDyd33GRHTcxEj8= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= heading text Postconditions 1 code this->empty() == true heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text No-throw guarantee. brief text Clear the contents while preserving the capacity identifier void normal 1 compare boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2446 5 1 function p+2L2asXUGpE7eey1ouRvFXKD1g= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function compares two URLs according to Syntax-Based comparison algorithm. heading text Complexity 1 paragraph text Linear in code text min( u0.size(), u1.size() ) heading text Exception Safety 1 paragraph text Throws nothing. heading text Specification 1 list paragraph link text 6.2.2 Syntax-Based Normalization (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-6.2.2 unordered brief text Return the result of comparing this with another url returns text -1 if code text *this < other text , 0 if code text this == other text , and 1 if code text this > other text . param text The url to compare other identifier int 1 identifier UEVNhDEjkZMXfjN1DxbtX0n2rCg= url_view_base other normal 1 1 data boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 258 5 1 function I2WjK21z+iS45kbL4TnzA8O5oE0= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns a pointer to the first character of the url, which is not guaranteed to be null-terminated. heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return a pointer to the url's character buffer returns text A pointer to the first character. 1 identifier char normal 1 1 empty boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 238 5 1 function 5yR7btLz2K+NLHFnzfXMyGsq2fo= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text The empty string matches the emph text relative-ref text grammar. heading text Example 1 code assert( url_view( "" ).empty() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code relative-ref = relative-part [ "?" query ] [ "#" fragment ] relative-part = "//" authority path-abempty / path-absolute / path-noscheme / path-empty heading text Specification 1 list paragraph link text 4.2. Relative Reference (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-4.2 unordered brief text Return true if the url is empty returns code text true text if the url is empty. identifier bool normal 1 1 encoded_authority boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 601 5 1 function Ww04vLA2k7BwctuyNeP3KwoNr4M= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If present, this function returns a string representing the authority (which may be empty). Otherwise it returns an empty string. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "file://Network%20Drive/My%2DFiles" ).encoded_authority() == "Network%20Drive" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code authority = [ userinfo "@" ] host [ ":" port ] heading text Specification 1 list paragraph link text 3.2. Authority (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2 unordered brief text Return the authority. returns text The authority as a string. see reference authority v5/R9LI0iKJDiBrNUt7k8qrVBdM= text , reference has_authority gadV3YsYDjlGX+64Rtiz4S+QD4A= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_fragment boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2280 5 1 function M7+OzewsxChMvecRSytXqTCqKrY= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the fragment as a string with percent-escapes. Ownership is not transferred; the string returned references the underlying character buffer, which must remain valid or else undefined behavior occurs. heading text Example 1 code assert( url_view( "http://www.example.com/index.htm#a%2D1" ).encoded_fragment() == "a%2D1" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code fragment = *( pchar / "/" / "?" ) pchar = unreserved / pct-encoded / sub-delims / ":" / "@" heading text Specification 1 list paragraph link text 3.5. Fragment (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.5 unordered brief text Return the fragment returns text The fragment portion of the url. see reference fragment aA1Q9NAW4/TnG3SXhe4k1mNB5nk= text , reference has_fragment ZiWsQaQCAif94KdP6GXH9+F5GmM= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_host boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1120 5 1 function EcGxt+esOtVfjloInubXUYLy5GY= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the host portion of the authority as a string, or the empty string if there is no authority. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "https://www%2droot.example.com/" ).encoded_host() == "www%2droot.example.com" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPvFuture ) "]" reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host returns text The host address as a string. identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_host_address boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1237 5 1 function yXsUZRbi+wInLqaUUVy9b7nIIBo= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text The value returned by this function depends on the type of host returned from the function reference host_type Nv9Emy6spILLI/mqyIz2uRNBJhU= text . list paragraph text If the type is reference host_type::ipv4 49F64dAiji9HVbP6MxLQiqot7AY= text , then the IPv4 address string is returned. paragraph text If the type is reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= text , then the IPv6 address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::ipvfuture TcYJaTwDFsx+0S2CkvHHARcCqWc= text , then the IPvFuture address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= text , then the host name string is returned. Any percent-escapes in the string are decoded first. paragraph text If the type is reference host_type::none QyoMTu07h232/Sxqovu2mGoPgTo= text , then an empty string is returned. The returned string may contain percent escapes. unordered heading text Example 1 code assert( url_view( "https://www%2droot.example.com/" ).encoded_host_address() == "www%2droot.example.com" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPvFuture ) "]" reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host returns text The host address as a string. identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_host_and_port boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2325 5 1 function 9ptIMbwWSNtVv+KAUpHCO3bmTWg= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If an authority is present, this function returns the host and optional port as a string, which may be empty. Otherwise it returns an empty string. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "http://www.example.com:8080/index.htm" ).encoded_host_and_port() == "www.example.com:8080" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code authority = [ userinfo "@" ] host [ ":" port ] heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 paragraph link text 3.2.3. Port (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.3 unordered brief text Return the host and port returns text The host and port portion of the url. see reference has_port 5V5uOhRsy00O+TSEAkIb7uFoN2U= text , reference port OlWcRIIUl1cq5Ab9fLXGPyhYCfI= text , reference port_number lctXu8FITJWg0+Y+yZVt5iv7QDM= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_host_name boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1441 5 1 function 4URKnuP+gvIUVjIkywv/pXeFjv4= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If the host type is reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= text , this function returns the name as a string. Otherwise, if the host type is not an name, it returns an empty string. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "https://www%2droot.example.com/" ).encoded_host_name() == "www%2droot.example.com" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPvFuture ) "]" reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host name returns text The host name as a percent-encoded string. identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_origin boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2355 5 1 function wG6ey1727HIj10Wh+OD/s8kuOjo= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If an authority is present, this function returns the scheme and authority portion of the url. Otherwise, an empty string is returned. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "http://www.example.com:8080/index.htm?text=none#h1" ).encoded_origin() == "http://www.example.com:8080" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the origin returns text The origin portion of the url. see reference encoded_resource yLMNPjiW4s31xcLN4xOiqVySYLA= text , reference encoded_target IcodRek43l5Zc13Z67L74PlhG0U= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_params boost/url/url_base.hpp include/boost/url/url_base.hpp 2248 5 1 boost/url/url_base.hpp include/boost/url/url_base.hpp 2300 5 1 overloads tDMWbnBabN2mGSH3Apn445gDMEQ= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= brief text Return the query as a container of parameters returns code text *this returns text A bidirectional view of key/value pairs. see reference params wdcIrRY9aj9gn6bF1i59TpOAQb4= text , reference remove_query ZZWEzCK7DguUxc3TvUfizoGKplE= text , reference set_encoded_query QcQ13DUh8M8TR/zj/LDG3N/+i3c= text , reference set_query 99/QTSBQGLrNj3zGdw5VzYlqfnI= text . see reference encoded_query suU4/MiRITTTYf61BFw2aI6WxdI= text , reference has_query SLiWca6gUGmTh+r/BbU40NrICW8= text , reference params wdcIrRY9aj9gn6bF1i59TpOAQb4= text , reference query 4epyMikskiBx2Gu+S87oAhrM/ZY= text . normal aMmTh8VyfWGYracYniHLsug6OhI= JE/K4m/Ht4rR+eX6GaLeumryMhM= encoded_params boost/url/url_base.hpp include/boost/url/url_base.hpp 2300 5 1 function aMmTh8VyfWGYracYniHLsug6OhI= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function returns a bidirectional view of key/value pairs over the query. The returned view references the same underlying character buffer; ownership is not transferred. Strings returned when iterating the range may contain percent escapes. The container is modifiable; changes to the container are reflected in the underlying URL. heading text Example 1 code params_encoded_ref pv = url( "/sql?id=42&name=jane%2Ddoe&page+size=20" ).encoded_params(); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Return the query as a container of parameters returns code text *this see reference params wdcIrRY9aj9gn6bF1i59TpOAQb4= text , reference remove_query ZZWEzCK7DguUxc3TvUfizoGKplE= text , reference set_encoded_query QcQ13DUh8M8TR/zj/LDG3N/+i3c= text , reference set_query 99/QTSBQGLrNj3zGdw5VzYlqfnI= text . identifier oR5B5D0/JYTOQYvyFXRv+at91JE= params_encoded_ref normal 1 encoded_params boost/url/url_base.hpp include/boost/url/url_base.hpp 2248 5 1 function JE/K4m/Ht4rR+eX6GaLeumryMhM= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function returns a bidirectional view of key/value pairs over the query. The returned view references the same underlying character buffer; ownership is not transferred. Strings returned when iterating the range may contain percent escapes. heading text Example 1 code params_encoded_view pv = url_view( "/sql?id=42&name=jane%2Ddoe&page+size=20" ).encoded_params(); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Return the query as a container of parameters url_view_base::encoded_params returns text A bidirectional view of key/value pairs. see reference encoded_query suU4/MiRITTTYf61BFw2aI6WxdI= text , reference has_query SLiWca6gUGmTh+r/BbU40NrICW8= text , reference params wdcIrRY9aj9gn6bF1i59TpOAQb4= text , reference query 4epyMikskiBx2Gu+S87oAhrM/ZY= text . identifier 0nSfM4mK92fIx58KtzdWGiHuq2w= params_encoded_view normal 1 1 encoded_password boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 996 5 1 function W9oZv0BM5z4XAggQPbNAKIM7/ro= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the password portion of the userinfo as a percent-encoded string. heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).encoded_password() == "pass" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code userinfo = user [ ":" [ password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return the password returns text The password as a string. see reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text , reference has_userinfo i/v5Vfq44OnlLbuKgQ2KvgWgZqo= text , reference encoded_user oYwrnXcglhO4tlvhkxLGfFCYbAk= text , reference encoded_userinfo yzkq+uCmbTlXrfDuyd1fT0Zu6xw= text , reference password +ZB55yb2DeVYG+/eYqlMcGcedVE= text , reference user /oa6wZJEG852J9Yi1LQlnq1n1tM= text , reference userinfo S9yd7MVhXxF+598Xy2/+jwnCZzc= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_path boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1799 5 1 function GNlqbV0MSxGIA/gSjlOb2rfSHhU= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the path as a string. The path may be empty. Any percent-escapes in the string are decoded first. heading text Example 1 code assert( url_view( "file:///Program%20Files/Games/config.ini" ).encoded_path() == "/Program%20Files/Games/config.ini" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code path = path-abempty ; begins with "/" or is empty / path-absolute ; begins with "/" but not "//" / path-noscheme ; begins with a non-colon segment / path-rootless ; begins with a segment / path-empty ; zero characters path-abempty = *( "/" segment ) path-absolute = "/" [ segment-nz *( "/" segment ) ] path-noscheme = segment-nz-nc *( "/" segment ) path-rootless = segment-nz *( "/" segment ) path-empty = 0<pchar> heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text Return the path returns text The path as a string. see reference is_path_absolute eh5BeHbLjL3BuEY7ao3tbEAZnTw= text , reference encoded_segments xDk467Vs74WMTJdzZiv8izTuGQo= text . reference path Q5NVO+d/+BmZ5v3/ogNb2XpUTKs= text , reference segments txoybJuonJpAdGVWgiAsiI45+ok= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_query boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2040 5 1 function suU4/MiRITTTYf61BFw2aI6WxdI= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If this contains a query, it is returned as a string (which may be empty). Otherwise, an empty string is returned. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "/sql?id=42&name=jane%2Ddoe&page+size=20" ).encoded_query() == "id=42&name=jane%2Ddoe&page+size=20" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Return the query returns text The query as a string. see reference encoded_params YdRpQ6mNNA/rw8PqzTxP08VgNnY= text , reference has_query SLiWca6gUGmTh+r/BbU40NrICW8= text , reference params ZdlRIJ+RVbaF05I+w1pfQzUA0/0= text , reference query 4epyMikskiBx2Gu+S87oAhrM/ZY= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_resource boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2387 5 1 function yLMNPjiW4s31xcLN4xOiqVySYLA= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the resource, which is the portion of the url that includes only the path, query, and fragment. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "http://www.example.com/index.html?query#frag" ).encoded_resource() == "/index.html?query#frag" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 unordered brief text Return the resource returns text The resource portion of the url. see reference encoded_origin wG6ey1727HIj10Wh+OD/s8kuOjo= text , reference encoded_target IcodRek43l5Zc13Z67L74PlhG0U= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_segments boost/url/url_base.hpp include/boost/url/url_base.hpp 2018 5 1 boost/url/url_base.hpp include/boost/url/url_base.hpp 2014 5 1 overloads qeLAK8oZj7+xpHv7Pyh0yYASuqU= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= brief text Return the path as a container of segments returns code text *this returns text A bidirectional view of encoded segments. see reference encoded_segments 6FgVEvfQ0X7vaJ9TLmk6h3MBVPU= text , reference set_encoded_path GQGd+Ne+D3eTy4fe+x1cpa5zefU= text , reference set_path 0VMn4mT6ruiabbTCXyOFe+JATBg= text , reference set_path_absolute BHDHQef0k/8vd3QskLyTrsv7+DE= text . see reference is_path_absolute eh5BeHbLjL3BuEY7ao3tbEAZnTw= text , reference encoded_path GNlqbV0MSxGIA/gSjlOb2rfSHhU= text , reference path Q5NVO+d/+BmZ5v3/ogNb2XpUTKs= text , reference segments coMz0KQ2BIuACsWbIRZ/6lTOmuk= text , reference segments_encoded_view EvaX3SmNTAtai2Kf6Kma3fUkTkQ= text . normal 6FgVEvfQ0X7vaJ9TLmk6h3MBVPU= 5da2HmyZRkzKje3uZJyQ0Zr/GBI= encoded_segments boost/url/url_base.hpp include/boost/url/url_base.hpp 2014 5 1 function 6FgVEvfQ0X7vaJ9TLmk6h3MBVPU= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function returns a bidirectional view of segments over the path. The returned view references the same underlying character buffer; ownership is not transferred. Strings returned when iterating the range may contain percent escapes. The container is modifiable; changes to the container are reflected in the underlying URL. heading text Example 1 code url u( "http://example.com/path/to/file.txt" ); segments_encoded_ref sv = u.encoded_segments(); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code path = path-abempty ; begins with "/" or is empty / path-absolute ; begins with "/" but not "//" / path-noscheme ; begins with a non-colon segment / path-rootless ; begins with a segment / path-empty ; zero characters path-abempty = *( "/" segment ) path-absolute = "/" [ segment-nz *( "/" segment ) ] path-noscheme = segment-nz-nc *( "/" segment ) path-rootless = segment-nz *( "/" segment ) path-empty = 0<pchar> heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text Return the path as a container of segments returns code text *this see reference encoded_segments qeLAK8oZj7+xpHv7Pyh0yYASuqU= text , reference set_encoded_path GQGd+Ne+D3eTy4fe+x1cpa5zefU= text , reference set_path 0VMn4mT6ruiabbTCXyOFe+JATBg= text , reference set_path_absolute BHDHQef0k/8vd3QskLyTrsv7+DE= text . identifier TCUUfRiqZjX62kt7tK2fs//VWr0= segments_encoded_ref normal 1 encoded_segments boost/url/url_base.hpp include/boost/url/url_base.hpp 2018 5 1 function 5da2HmyZRkzKje3uZJyQ0Zr/GBI= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function returns a bidirectional view of strings over the path. The returned view references the same underlying character buffer; ownership is not transferred. Strings returned when iterating the range may contain percent escapes. heading text Example 1 code segments_encoded_view sv = url_view( "/path/to/file.txt" ).encoded_segments(); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code path = path-abempty ; begins with "/" or is empty / path-absolute ; begins with "/" but not "//" / path-noscheme ; begins with a non-colon segment / path-rootless ; begins with a segment / path-empty ; zero characters path-abempty = *( "/" segment ) path-absolute = "/" [ segment-nz *( "/" segment ) ] path-noscheme = segment-nz-nc *( "/" segment ) path-rootless = segment-nz *( "/" segment ) path-empty = 0<pchar> heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text Return the path as a container of segments url_view_base::encoded_segments returns text A bidirectional view of encoded segments. see reference is_path_absolute eh5BeHbLjL3BuEY7ao3tbEAZnTw= text , reference encoded_path GNlqbV0MSxGIA/gSjlOb2rfSHhU= text , reference path Q5NVO+d/+BmZ5v3/ogNb2XpUTKs= text , reference segments coMz0KQ2BIuACsWbIRZ/6lTOmuk= text , reference segments_encoded_view EvaX3SmNTAtai2Kf6Kma3fUkTkQ= text . identifier EvaX3SmNTAtai2Kf6Kma3fUkTkQ= segments_encoded_view normal 1 1 encoded_target boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2419 5 1 function IcodRek43l5Zc13Z67L74PlhG0U= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the target, which is the portion of the url that includes only the path and query. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "http://www.example.com/index.html?query#frag" ).encoded_target() == "/index.html?query" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 unordered brief text Return the target returns text The target portion of the url. see reference encoded_origin wG6ey1727HIj10Wh+OD/s8kuOjo= text , reference encoded_resource yLMNPjiW4s31xcLN4xOiqVySYLA= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_user boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 901 5 1 function oYwrnXcglhO4tlvhkxLGfFCYbAk= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If present, this function returns a string representing the user (which may be empty). Otherwise it returns an empty string. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).encoded_user() == "jane%2Ddoe" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code userinfo = user [ ":" [ password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return the user returns text The user as a string. see reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text , reference has_userinfo i/v5Vfq44OnlLbuKgQ2KvgWgZqo= text , reference encoded_password W9oZv0BM5z4XAggQPbNAKIM7/ro= text , reference encoded_userinfo yzkq+uCmbTlXrfDuyd1fT0Zu6xw= text , reference password +ZB55yb2DeVYG+/eYqlMcGcedVE= text , reference user /oa6wZJEG852J9Yi1LQlnq1n1tM= text , reference userinfo S9yd7MVhXxF+598Xy2/+jwnCZzc= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_userinfo boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 800 5 1 function yzkq+uCmbTlXrfDuyd1fT0Zu6xw= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If present, this function returns a string representing the userinfo (which may be empty). Otherwise it returns an empty string. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).encoded_userinfo() == "jane%2Ddoe:pass" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing heading text BNF 1 code userinfo = user [ ":" [ password ] ] authority = [ userinfo "@" ] host [ ":" port ] heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return the userinfo returns text The userinfo as a string. see reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text , reference has_userinfo i/v5Vfq44OnlLbuKgQ2KvgWgZqo= text , reference encoded_password W9oZv0BM5z4XAggQPbNAKIM7/ro= text , reference encoded_user oYwrnXcglhO4tlvhkxLGfFCYbAk= text , reference password +ZB55yb2DeVYG+/eYqlMcGcedVE= text , reference user /oa6wZJEG852J9Yi1LQlnq1n1tM= text , reference userinfo S9yd7MVhXxF+598Xy2/+jwnCZzc= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_zone_id boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1526 5 1 function 5M2smbXDaSa2d/li//A+GmlDgDU= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If the host type is reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= text , this function returns the Zone ID as a string. Otherwise an empty string is returned. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "http://[fe80::1%25eth0]/" ).encoded_zone_id() == "eth0" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPv6addrz / IPvFuture ) "]" ZoneID = 1*( unreserved / pct-encoded ) IPv6addrz = IPv6address "%25" ZoneID heading text Specification 1 list paragraph link text Representing IPv6 Zone Identifiers in Address Literals and Uniform Resource Identifiers https://datatracker.ietf.org/doc/html/rfc6874 unordered brief text Return the IPv6 Zone ID returns text The Zone ID as a percent-encoded string. identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 fragment boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2233 5 1 function aA1Q9NAW4/TnG3SXhe4k1mNB5nk= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function calculates the fragment of the url, with percent escapes decoded and without the leading pound sign ('#') whose presence indicates that the url contains a fragment. paragraph text This function accepts an optional emph text StringToken text parameter which controls the return type and behavior of the function: list paragraph text When called with no arguments, the return type of the function is code text std::string text . Otherwise paragraph text When called with a string token, the behavior and return type of the function depends on the type of string token being passed. unordered heading text Example 1 code assert( url_view( "http://www.example.com/index.htm#a%2D1" ).fragment() == "a-1" ); heading text Complexity 1 paragraph text Linear in code text this->fragment().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. String tokens may throw exceptions. heading text BNF 1 code fragment = *( pchar / "/" / "?" ) fragment-part = [ "#" fragment ] heading text Specification 1 list paragraph link text 3.5. Fragment (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.5 unordered brief text Return the fragment returns text The fragment portion of the url. param text An optional string token to use. If this parameter is omitted, the function returns a new code text std::string text . token see reference encoded_fragment M7+OzewsxChMvecRSytXqTCqKrY= text , reference has_fragment ZiWsQaQCAif94KdP6GXH9+F5GmM= text . identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 has_authority boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 528 5 1 function gadV3YsYDjlGX+64Rtiz4S+QD4A= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns true if the url contains an authority. The presence of an authority is denoted by a double slash ("//") at the beginning or after the scheme. heading text Example 1 code assert( url_view( "http://www.example.com/index.htm" ).has_authority() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code authority = [ userinfo "@" ] host [ ":" port ] URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] absolute-URI = scheme ":" hier-part [ "?" query ] URI-reference = URI / relative-ref relative-ref = relative-part [ "?" query ] [ "#" fragment ] hier-part = "//" authority path-abempty ; (more...) relative-part = "//" authority path-abempty ; (more...) heading text Specification 1 list paragraph link text 3.2. Authority (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2 unordered brief text Return true if an authority is present returns code text true text if the url contains an authority. see reference authority v5/R9LI0iKJDiBrNUt7k8qrVBdM= text , reference encoded_authority Ww04vLA2k7BwctuyNeP3KwoNr4M= text . identifier bool normal 1 1 has_fragment boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2173 5 1 function ZiWsQaQCAif94KdP6GXH9+F5GmM= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns true if the url contains a fragment. An empty fragment is distinct from no fragment. heading text Example 1 code assert( url_view( "http://www.example.com/index.htm#anchor" ).has_fragment() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] relative-ref = relative-part [ "?" query ] [ "#" fragment ] heading text Specification 1 list paragraph link text 3.5. Fragment (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.5 unordered brief text Return true if a fragment is present returns code text true text if the url contains a fragment. see reference encoded_fragment M7+OzewsxChMvecRSytXqTCqKrY= text , reference fragment aA1Q9NAW4/TnG3SXhe4k1mNB5nk= text . identifier bool normal 1 1 has_password boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 689 5 1 function 9JACnsebk8tFsoryabfDxE8VpnA= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns true if the userinfo is present and contains a password. heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).has_password() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code userinfo = user [ ":" [ password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return true if a password is present returns code text true text if the userinfo contains a password. see reference has_userinfo i/v5Vfq44OnlLbuKgQ2KvgWgZqo= text , reference encoded_password W9oZv0BM5z4XAggQPbNAKIM7/ro= text , reference encoded_user oYwrnXcglhO4tlvhkxLGfFCYbAk= text , reference encoded_userinfo yzkq+uCmbTlXrfDuyd1fT0Zu6xw= text , reference password +ZB55yb2DeVYG+/eYqlMcGcedVE= text , reference user /oa6wZJEG852J9Yi1LQlnq1n1tM= text , reference userinfo S9yd7MVhXxF+598Xy2/+jwnCZzc= text . identifier bool normal 1 1 has_port boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1568 5 1 function 5V5uOhRsy00O+TSEAkIb7uFoN2U= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns true if an authority is present and contains a port. heading text Example 1 code assert( url_view( "wss://www.example.com:443" ).has_port() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code authority = [ userinfo "@" ] host [ ":" port ] port = *DIGIT heading text Specification 1 list paragraph link text 3.2.3. Port (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.3 unordered brief text Return true if a port is present returns code text true text if a port is present, code text false text otherwise. see reference encoded_host_and_port 9ptIMbwWSNtVv+KAUpHCO3bmTWg= text , reference port OlWcRIIUl1cq5Ab9fLXGPyhYCfI= text , reference port_number lctXu8FITJWg0+Y+yZVt5iv7QDM= text . identifier bool normal 1 1 has_query boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1937 5 1 function SLiWca6gUGmTh+r/BbU40NrICW8= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns true if this contains a query. An empty query is distinct from having no query. heading text Example 1 code assert( url_view( "/sql?id=42&col=name&page-size=20" ).has_query() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Return true if a query is present returns code text true text if a query is present. see reference encoded_params YdRpQ6mNNA/rw8PqzTxP08VgNnY= text , reference encoded_query suU4/MiRITTTYf61BFw2aI6WxdI= text , reference params ZdlRIJ+RVbaF05I+w1pfQzUA0/0= text , reference query 4epyMikskiBx2Gu+S87oAhrM/ZY= text . identifier bool normal 1 1 has_scheme boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 384 5 1 function iwSH2fvVkb89TkZj7KWLGSyc4sA= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns true if this contains a scheme. heading text Example 1 code assert( url_view( "http://www.example.com" ).has_scheme() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] absolute-URI = scheme ":" hier-part [ "?" query ] scheme = ALPHA *( ALPHA / DIGIT / "+" / "-" / "." ) heading text Specification 1 list paragraph link text 3.1. Scheme (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.1 unordered brief text Return true a scheme is present returns code text true text if the url contains a scheme. see reference scheme 43fxogaC5oVqfauhwXyN4s4ibEM= text , reference scheme_id uM37WpBqetqzfHjns3M8/+CcoEU= text . identifier bool normal 1 1 has_userinfo boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 647 5 1 function i/v5Vfq44OnlLbuKgQ2KvgWgZqo= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns true if this contains a userinfo. heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).has_userinfo() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code userinfo = user [ ":" [ password ] ] authority = [ userinfo "@" ] host [ ":" port ] heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return true if a userinfo is present returns code text true text if the userinfo is present. see reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text , reference encoded_password W9oZv0BM5z4XAggQPbNAKIM7/ro= text , reference encoded_user oYwrnXcglhO4tlvhkxLGfFCYbAk= text , reference encoded_userinfo yzkq+uCmbTlXrfDuyd1fT0Zu6xw= text , reference password +ZB55yb2DeVYG+/eYqlMcGcedVE= text , reference user /oa6wZJEG852J9Yi1LQlnq1n1tM= text , reference userinfo S9yd7MVhXxF+598Xy2/+jwnCZzc= text . identifier bool normal 1 1 host boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1076 5 1 function ICcovOIyqnxhSMU6MuEekYg2z+E= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the host portion of the authority as a string, or the empty string if there is no authority. Any percent-escapes in the string are decoded first. heading text Example 1 code assert( url_view( "https://www%2droot.example.com/" ).host() == "www-root.example.com" ); heading text Complexity 1 paragraph text Linear in code text this->host().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPvFuture ) "]" reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host returns text The host address as a string. param text A string token customization token identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 host_address boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1174 5 1 function F0RYzLwUP8ied6l3zmKvomgFHag= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text The value returned by this function depends on the type of host returned from the function reference host_type Nv9Emy6spILLI/mqyIz2uRNBJhU= text . list paragraph text If the type is reference host_type::ipv4 49F64dAiji9HVbP6MxLQiqot7AY= text , then the IPv4 address string is returned. paragraph text If the type is reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= text , then the IPv6 address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::ipvfuture TcYJaTwDFsx+0S2CkvHHARcCqWc= text , then the IPvFuture address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= text , then the host name string is returned. Any percent-escapes in the string are decoded first. paragraph text If the type is reference host_type::none QyoMTu07h232/Sxqovu2mGoPgTo= text , then an empty string is returned. unordered heading text Example 1 code assert( url_view( "https://[1::6:c0a8:1]/" ).host_address() == "1::6:c0a8:1" ); heading text Complexity 1 paragraph text Linear in code text this->host_address().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPvFuture ) "]" reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host returns text The host address as a string. param text A string token customization token identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 host_ipv4_address boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1277 5 1 function KL8F3KYxyzpC1e6fqoJy3B8IHhw= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If the host type is reference host_type::ipv4 49F64dAiji9HVbP6MxLQiqot7AY= text , this function returns the address as a value of type reference ipv4_address /Wpp3ZZDp3kUHzbULeDoaOEhnVs= text . Otherwise, if the host type is not an IPv4 address, it returns a default-constructed value which is equal to the unspecified address "0.0.0.0". heading text Example 1 code assert( url_view( "http://127.0.0.1/index.htm?user=win95" ).host_ipv4_address() == ipv4_address( "127.0.0.1" ) ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code IPv4address = dec-octet "." dec-octet "." dec-octet "." dec-octet dec-octet = DIGIT ; 0-9 / %x31-39 DIGIT ; 10-99 / "1" 2DIGIT ; 100-199 / "2" %x30-34 DIGIT ; 200-249 / "25" %x30-35 ; 250-255 heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host IPv4 address returns text The IPv4 address as a value of type reference ipv4_address /Wpp3ZZDp3kUHzbULeDoaOEhnVs= text . identifier /Wpp3ZZDp3kUHzbULeDoaOEhnVs= ipv4_address normal 1 1 host_ipv6_address boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1325 5 1 function CvoRh2IpWg4QixngVwDjSKoeQVY= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If the host type is reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= text , this function returns the address as a value of type reference ipv6_address dhMSRVBIIIItY0URHSc8rwHcdTQ= text . Otherwise, if the host type is not an IPv6 address, it returns a default-constructed value which is equal to the unspecified address "0:0:0:0:0:0:0:0". heading text Example 1 code assert( url_view( "ftp://[::1]/" ).host_ipv6_address() == ipv6_address( "::1" ) ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code IPv6address = 6( h16 ":" ) ls32 / "::" 5( h16 ":" ) ls32 / [ h16 ] "::" 4( h16 ":" ) ls32 / [ *1( h16 ":" ) h16 ] "::" 3( h16 ":" ) ls32 / [ *2( h16 ":" ) h16 ] "::" 2( h16 ":" ) ls32 / [ *3( h16 ":" ) h16 ] "::" h16 ":" ls32 / [ *4( h16 ":" ) h16 ] "::" ls32 / [ *5( h16 ":" ) h16 ] "::" h16 / [ *6( h16 ":" ) h16 ] "::" ls32 = ( h16 ":" h16 ) / IPv4address ; least-significant 32 bits of address h16 = 1*4HEXDIG ; 16 bits of address represented in hexadecimal heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host IPv6 address returns text The IPv6 address as a value of type reference ipv6_address dhMSRVBIIIItY0URHSc8rwHcdTQ= text . identifier dhMSRVBIIIItY0URHSc8rwHcdTQ= ipv6_address normal 1 1 host_ipvfuture boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1358 5 1 function 55Yh68uToEiKy+IDTpyctuK/T3g= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If the host type is reference host_type::ipvfuture TcYJaTwDFsx+0S2CkvHHARcCqWc= text , this function returns the address as a string. Otherwise, if the host type is not an IPvFuture address, it returns an empty string. heading text Example 1 code assert( url_view( "http://[v1fe.d:9]/index.htm" ).host_ipvfuture() == "v1fe.d:9" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code IPvFuture = "v" 1*HEXDIG "." 1*( unreserved / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host IPvFuture address returns text The IPvFuture address as a string. identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core normal 1 1 host_name boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1395 5 1 function AhPhrC4hmBsZgd/ztqbkAuOkbBM= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If the host type is reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= text , this function returns the name as a string. Otherwise an empty string is returned. Any percent-escapes in the string are decoded first. heading text Example 1 code assert( url_view( "https://www%2droot.example.com/" ).host_name() == "www-root.example.com" ); heading text Complexity 1 paragraph text Linear in code text this->host_name().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPvFuture ) "]" reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host name returns text The host name as a string. param text A string token customization. token identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 host_type boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1036 5 1 function Nv9Emy6spILLI/mqyIz2uRNBJhU= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns one of the following constants representing the type of host present. list paragraph reference host_type::ipv4 49F64dAiji9HVbP6MxLQiqot7AY= paragraph reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= paragraph reference host_type::ipvfuture TcYJaTwDFsx+0S2CkvHHARcCqWc= paragraph reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= paragraph reference host_type::none QyoMTu07h232/Sxqovu2mGoPgTo= unordered paragraph text When reference has_authority gadV3YsYDjlGX+64Rtiz4S+QD4A= text is false, the host type is reference host_type::none QyoMTu07h232/Sxqovu2mGoPgTo= text . heading text Example 1 code assert( url_view( "https://192.168.0.1/local.htm" ).host_type() == host_type::ipv4 ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host type returns text The type of host present. identifier YLHFVyAYZGSFQe18DPGjn6XsAMs= host_type identifier dnk5XPfR2OaMpCYaH3cWSxcTdyc= urls normal 1 1 is_path_absolute boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1691 5 1 function eh5BeHbLjL3BuEY7ao3tbEAZnTw= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns true if the path begins with a forward slash ('/'). heading text Example 1 code assert( url_view( "/path/to/file.txt" ).is_path_absolute() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code path = path-abempty ; begins with "/" or is empty / path-absolute ; begins with "/" but not "//" / path-noscheme ; begins with a non-colon segment / path-rootless ; begins with a segment / path-empty ; zero characters path-abempty = *( "/" segment ) path-absolute = "/" [ segment-nz *( "/" segment ) ] path-noscheme = segment-nz-nc *( "/" segment ) path-rootless = segment-nz *( "/" segment ) path-empty = 0<pchar> heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text Return true if the path is absolute returns code text true text if the path is absolute, code text false text otherwise. see reference encoded_path GNlqbV0MSxGIA/gSjlOb2rfSHhU= text , reference encoded_segments xDk467Vs74WMTJdzZiv8izTuGQo= text . reference path Q5NVO+d/+BmZ5v3/ogNb2XpUTKs= text , reference segments txoybJuonJpAdGVWgiAsiI45+ok= text . identifier bool normal 1 1 normalize boost/url/url_base.hpp include/boost/url/url_base.hpp 2731 5 1 function ldUmQToJNGQ58j33Mti85clcGbM= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text Applies Syntax-based normalization to all components of the URL. paragraph text The scheme is normalized to lowercase. code assert( url( "HTTP://www.example.com" ).normalize().buffer() == "http://www.example.com" ); paragraph text The host is normalized to lowercase. Percent-encoding triplets are normalized to uppercase letters. Percent-encoded octets that correspond to unreserved characters are decoded. code assert( url( "http://www.Example.com" ).normalize().buffer() == "http://www.example.com" ); assert( url( "http://www.%65xample.com" ).normalize().buffer() == "http://www.example.com" ); paragraph text Percent-encoding triplets in the path are normalized to uppercase letters. Percent-encoded octets that correspond to unreserved characters are decoded. Redundant path-segments "." and ".." are removed. code assert( url( "http://www.example.com/a/b/../c" ).normalize().buffer() == "http://www.example.com/a/c" ); assert( url( "http://www.example.com/a/./b" ).normalize().buffer() == "http://www.example.com/a/b" ); assert( url( "http://www.example.com/%63ss" ).normalize().buffer() == "http://www.example.com/css" ); paragraph text Percent-encoding triplets in the query are normalized to uppercase letters. Percent-encoded octets that correspond to unreserved characters are decoded. code assert( url( "http://www.example.com?a=%62" ).normalize().buffer() == "http://www.example.com?a=b" ); paragraph text Percent-encoding triplets in the fragment are normalized to uppercase letters. Percent-encoded octets that correspond to unreserved characters are decoded. code assert( url( "http://www.example.com#%61bc" ).normalize().buffer() == "http://www.example.com#abc" ); paragraph text Applying normalization to a URL with all components percent-encoded: code assert( url( "HTTP://www.Example.com/%70ath?%71uery#%66rag" ).normalize().buffer() == "http://www.example.com/path?query#frag" ); heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text Specification 1 list paragraph link text 6.2.2 Syntax-Based Normalization (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-6.2.2 unordered brief text Normalize the URL components returns code text *this see reference normalize_scheme iyO2AawtEbzXMJkvSocn7BpBBrI= text , reference normalize_authority j2lB1y9ywFNpGt8xXYkZZuJbs30= text , reference normalize_path pjVn3eVVaWNAixzkPBECE+lKByQ= text , reference normalize_query 4CZ8ebKgivCQbRJoYD78PmOko2U= text , reference normalize_fragment R2y0tPa5JiRRSTNXgUjKdMoCOcA= identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base normal 1 normalize_authority boost/url/url_base.hpp include/boost/url/url_base.hpp 2786 5 1 function j2lB1y9ywFNpGt8xXYkZZuJbs30= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text Applies Syntax-based normalization to the URL authority. paragraph text The host is normalized to lowercase. Percent-encoding triplets are normalized to uppercase letters. Percent-encoded octets that correspond to unreserved characters are decoded. code assert( url( "http://www.Example.com" ).normalize_authority().buffer() == "http://www.example.com" ); assert( url( "http://www.%65xample.com" ).normalize_authority().buffer() == "http://www.example.com" ); heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text Specification 1 list paragraph link text 6.2.2 Syntax-Based Normalization (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-6.2.2 unordered brief text Normalize the URL authority returns code text *this identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base normal 1 normalize_fragment boost/url/url_base.hpp include/boost/url/url_base.hpp 2873 5 1 function R2y0tPa5JiRRSTNXgUjKdMoCOcA= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text Applies Syntax-based normalization to the URL fragment. paragraph text Percent-encoding triplets are normalized to uppercase letters. Percent-encoded octets that correspond to unreserved characters are decoded. code assert( url( "http://www.example.com#%61bc" ).normalize_fragment().buffer() == "http://www.example.com#abc" ); heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text Specification 1 list paragraph link text 6.2.2 Syntax-Based Normalization (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-6.2.2 unordered brief text Normalize the URL fragment returns code text *this identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base normal 1 normalize_path boost/url/url_base.hpp include/boost/url/url_base.hpp 2817 5 1 function pjVn3eVVaWNAixzkPBECE+lKByQ= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text Applies Syntax-based normalization to the URL path. paragraph text Percent-encoding triplets are normalized to uppercase letters. Percent-encoded octets that correspond to unreserved characters are decoded. Redundant path-segments "." and ".." are removed. code assert( url( "http://www.example.com/a/b/../c" ).normalize_path().buffer() == "http://www.example.com/a/c" ); assert( url( "http://www.example.com/a/./b" ).normalize_path().buffer() == "http://www.example.com/a/b" ); assert( url( "http://www.example.com/%63ss" ).normalize_path().buffer() == "http://www.example.com/css" ); heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text Specification 1 list paragraph link text 6.2.2 Syntax-Based Normalization (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-6.2.2 unordered brief text Normalize the URL path returns code text *this identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base normal 1 normalize_query boost/url/url_base.hpp include/boost/url/url_base.hpp 2845 5 1 function 4CZ8ebKgivCQbRJoYD78PmOko2U= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text Applies Syntax-based normalization to the URL query. paragraph text Percent-encoding triplets are normalized to uppercase letters. Percent-encoded octets that correspond to unreserved characters are decoded. code assert( url( "http://www.example.com?a=%62" ).normalize_query().buffer() == "http://www.example.com?a=b" ); heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text Specification 1 list paragraph link text 6.2.2 Syntax-Based Normalization (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-6.2.2 unordered brief text Normalize the URL query returns code text *this identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base normal 1 normalize_scheme boost/url/url_base.hpp include/boost/url/url_base.hpp 2756 5 1 function iyO2AawtEbzXMJkvSocn7BpBBrI= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text Applies Syntax-based normalization to the URL scheme. paragraph text The scheme is normalized to lowercase. code assert( url( "HTTP://www.example.com" ).normalize_scheme().buffer() == "http://www.example.com" ); heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text Specification 1 list paragraph link text 6.2.2 Syntax-Based Normalization (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-6.2.2 unordered brief text Normalize the URL scheme returns code text *this identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base normal 1 params boost/url/url_base.hpp include/boost/url/url_base.hpp 2186 5 1 boost/url/url_base.hpp include/boost/url/url_base.hpp 2182 5 1 boost/url/url_base.hpp include/boost/url/url_base.hpp 2244 5 1 boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2087 5 overloads wdcIrRY9aj9gn6bF1i59TpOAQb4= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= brief text Return the query as a container of parameters returns code text *this returns text A bidirectional view of key/value pairs. returns text A range of references to the parameters. param text The options for decoding. If this parameter is omitted, the code text space_as_plus text is used. opt see reference encoded_params tDMWbnBabN2mGSH3Apn445gDMEQ= text , reference remove_query ZZWEzCK7DguUxc3TvUfizoGKplE= text , reference set_encoded_query QcQ13DUh8M8TR/zj/LDG3N/+i3c= text , reference set_query 99/QTSBQGLrNj3zGdw5VzYlqfnI= text . see reference encoded_params tDMWbnBabN2mGSH3Apn445gDMEQ= text , reference encoded_query suU4/MiRITTTYf61BFw2aI6WxdI= text , reference has_query SLiWca6gUGmTh+r/BbU40NrICW8= text , reference query 4epyMikskiBx2Gu+S87oAhrM/ZY= text . normal MYfnAHxNPsNhl4M31kQzwrirB9M= s9dRuYwynzv+XH3wi5E1LonuuYk= yOAcBK51dE1EJqsBF6ZGTSEnocA= V3u1IzKjTvUUsoIglN4qUAzgD4k= params boost/url/url_base.hpp include/boost/url/url_base.hpp 2182 5 1 function MYfnAHxNPsNhl4M31kQzwrirB9M= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function returns a bidirectional view of key/value pairs over the query. The returned view references the same underlying character buffer; ownership is not transferred. Any percent-escapes in strings returned when iterating the view are decoded first. The container is modifiable; changes to the container are reflected in the underlying URL. heading text Example 1 code params_ref pv = url( "/sql?id=42&name=jane%2Ddoe&page+size=20" ).params(); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Return the query as a container of parameters returns code text *this see reference encoded_params tDMWbnBabN2mGSH3Apn445gDMEQ= text , reference remove_query ZZWEzCK7DguUxc3TvUfizoGKplE= text , reference set_encoded_query QcQ13DUh8M8TR/zj/LDG3N/+i3c= text , reference set_query 99/QTSBQGLrNj3zGdw5VzYlqfnI= text . identifier 8S83BKvWBCDdTktlY8X93Mlo9E0= params_ref normal 1 params boost/url/url_base.hpp include/boost/url/url_base.hpp 2186 5 1 function s9dRuYwynzv+XH3wi5E1LonuuYk= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= brief text Return the query as a container of parameters url_view_base::params returns text A bidirectional view of key/value pairs. see reference encoded_params tDMWbnBabN2mGSH3Apn445gDMEQ= text , reference encoded_query suU4/MiRITTTYf61BFw2aI6WxdI= text , reference has_query SLiWca6gUGmTh+r/BbU40NrICW8= text , reference query 4epyMikskiBx2Gu+S87oAhrM/ZY= text . identifier DzqMpaJX2O25vPFxEN5EDTyU6uw= params_view normal 1 1 params boost/url/url_base.hpp include/boost/url/url_base.hpp 2244 5 1 function yOAcBK51dE1EJqsBF6ZGTSEnocA= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function returns a bidirectional view of key/value pairs over the query. The returned view references the same underlying character buffer; ownership is not transferred. Any percent-escapes in strings returned when iterating the view are decoded first. The container is modifiable; changes to the container are reflected in the underlying URL. heading text Example 1 code encoding_opts opt; opt.space_as_plus = true; params_ref pv = url( "/sql?id=42&name=jane+doe&page+size=20" ).params(opt); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Return the query as a container of parameters returns text A range of references to the parameters. param text The options for decoding. If this parameter is omitted, the code text space_as_plus text is used. opt see reference encoded_params tDMWbnBabN2mGSH3Apn445gDMEQ= text , reference remove_query ZZWEzCK7DguUxc3TvUfizoGKplE= text , reference set_encoded_query QcQ13DUh8M8TR/zj/LDG3N/+i3c= text , reference set_query 99/QTSBQGLrNj3zGdw5VzYlqfnI= text . identifier 8S83BKvWBCDdTktlY8X93Mlo9E0= params_ref identifier Bb04pNwExynJkzlY9a9GCeeB13k= encoding_opts opt normal 1 params boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2087 5 function V3u1IzKjTvUUsoIglN4qUAzgD4k= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= identifier DzqMpaJX2O25vPFxEN5EDTyU6uw= params_view identifier Bb04pNwExynJkzlY9a9GCeeB13k= encoding_opts opt normal 1 1 password boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 947 5 1 function +ZB55yb2DeVYG+/eYqlMcGcedVE= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If present, this function returns a string representing the password (which may be an empty string). Otherwise it returns an empty string. Any percent-escapes in the string are decoded first. heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).password() == "pass" ); heading text Complexity 1 paragraph text Linear in code text this->password().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code userinfo = user [ ":" [ password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return the password returns text The password as a string. param text The string token to use. token see reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text , reference has_userinfo i/v5Vfq44OnlLbuKgQ2KvgWgZqo= text , reference encoded_password W9oZv0BM5z4XAggQPbNAKIM7/ro= text , reference encoded_user oYwrnXcglhO4tlvhkxLGfFCYbAk= text , reference encoded_userinfo yzkq+uCmbTlXrfDuyd1fT0Zu6xw= text , reference user /oa6wZJEG852J9Yi1LQlnq1n1tM= text , reference userinfo S9yd7MVhXxF+598Xy2/+jwnCZzc= text . identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 path boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1744 5 1 function Q5NVO+d/+BmZ5v3/ogNb2XpUTKs= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the path as a string. The path may be empty. Any percent-escapes in the string are decoded first. heading text Example 1 code assert( url_view( "file:///Program%20Files/Games/config.ini" ).path() == "/Program Files/Games/config.ini" ); heading text Complexity 1 paragraph text Linear in code text this->path().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code path = path-abempty ; begins with "/" or is empty / path-absolute ; begins with "/" but not "//" / path-noscheme ; begins with a non-colon segment / path-rootless ; begins with a segment / path-empty ; zero characters path-abempty = *( "/" segment ) path-absolute = "/" [ segment-nz *( "/" segment ) ] path-noscheme = segment-nz-nc *( "/" segment ) path-rootless = segment-nz *( "/" segment ) path-empty = 0<pchar> heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text Return the path returns text The path as a string. param text A string token to use for the result. token see reference is_path_absolute eh5BeHbLjL3BuEY7ao3tbEAZnTw= text , reference encoded_path GNlqbV0MSxGIA/gSjlOb2rfSHhU= text , reference encoded_segments xDk467Vs74WMTJdzZiv8izTuGQo= text . reference segments txoybJuonJpAdGVWgiAsiI45+ok= text . identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 persist boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 341 5 1 function cRPG1npIXmfYC0K+C+idxOqIc04= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns a read-only copy of the url, with shared lifetime. The returned value owns (persists) the underlying string. The algorithm used to create the value minimizes the number of individual memory allocations, making it more efficient than when using direct standard library functions. heading text Example 1 code std::shared_ptr< url_view const > sp; { std::string s( "http://example.com" ); url_view u( s ); // u references characters in s assert( u.data() == s.data() ); // same buffer sp = u.persist(); assert( sp->data() != s.data() ); // different buffer assert( sp->buffer() == s); // same contents // s is destroyed and thus u // becomes invalid, but sp remains valid. } heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. brief text Return a shared, persistent copy of the url returns text A shared pointer to a read-only url_view. specialization yAZI7i9M7QvpFoRBZvP2RcJBIWs= shared_ptr identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 1 port boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1604 5 1 function OlWcRIIUl1cq5Ab9fLXGPyhYCfI= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If present, this function returns a string representing the port (which may be empty). Otherwise it returns an empty string. heading text Example 1 code assert( url_view( "http://localhost.com:8080" ).port() == "8080" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code port = *DIGIT heading text Specification 1 list paragraph link text 3.2.3. Port (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.3 unordered brief text Return the port returns text The port as a string. see reference encoded_host_and_port 9ptIMbwWSNtVv+KAUpHCO3bmTWg= text , reference has_port 5V5uOhRsy00O+TSEAkIb7uFoN2U= text , reference port_number lctXu8FITJWg0+Y+yZVt5iv7QDM= text . identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core normal 1 1 port_number boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1640 5 1 function lctXu8FITJWg0+Y+yZVt5iv7QDM= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If a port is present and the numerical value is representable, it is returned as an unsigned integer. Otherwise, the number zero is returned. heading text Example 1 code assert( url_view( "http://localhost.com:8080" ).port_number() == 8080 ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code port = *DIGIT heading text Specification 1 list paragraph link text 3.2.3. Port (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.3 unordered brief text Return the port returns text The port number as an unsigned integer. see reference encoded_host_and_port 9ptIMbwWSNtVv+KAUpHCO3bmTWg= text , reference has_port 5V5uOhRsy00O+TSEAkIb7uFoN2U= text , reference port OlWcRIIUl1cq5Ab9fLXGPyhYCfI= text . identifier Qvo2fOST20EZC7bSOAFZr+u3ITg= uint16_t normal 1 1 query boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1987 5 1 function 4epyMikskiBx2Gu+S87oAhrM/ZY= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If this contains a query, it is returned as a string (which may be empty). Otherwise, an empty string is returned. Any percent-escapes in the string are decoded first. paragraph text Literal plus signs remain unchanged by default to match RFC 3986. To treat '+' as a space, supply decoding options with code text space_as_plus = true text when calling this function. heading text Example 1 code assert( url_view( "/sql?id=42&name=jane%2Ddoe&page+size=20" ).query() == "id=42&name=jane-doe&page size=20" ); heading text Complexity 1 paragraph text Linear in code text this->query().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Return the query returns text The query as a string. param text A token to use for the returned string. token see reference encoded_params YdRpQ6mNNA/rw8PqzTxP08VgNnY= text , reference encoded_query suU4/MiRITTTYf61BFw2aI6WxdI= text , reference has_query SLiWca6gUGmTh+r/BbU40NrICW8= text , reference params ZdlRIJ+RVbaF05I+w1pfQzUA0/0= text . identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 remove_authority boost/url/url_base.hpp include/boost/url/url_base.hpp 408 5 1 function cjTKMEM0IWRzDexmJAiWOj6P+ZI= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function removes the authority, which includes the userinfo, host, and a port if present. heading text Example 1 code assert( url( "http://example.com/echo.cgi" ).remove_authority().buffer() == "http:/echo.cgi" ); heading text Postconditions 1 code this->has_authority() == false && this->has_userinfo() == false && this->has_port() == false heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code authority = [ userinfo "@" ] host [ ":" port ] userinfo = *( unreserved / pct-encoded / sub-delims / ":" ) host = IP-literal / IPv4address / reg-name port = *DIGIT heading text Specification 1 list paragraph link text 3.2. Authority (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2 unordered brief text Remove the authority returns code text *this see reference set_encoded_authority VTO/x6AChJRFyjVKxhaqmIAvYFI= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base normal 1 remove_fragment boost/url/url_base.hpp include/boost/url/url_base.hpp 2510 5 1 function aGhIz5PP9XtdztICzhAvM4n92Sg= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function removes the fragment. An empty fragment is distinct from having no fragment. heading text Example 1 code assert( url( "?first=john&last=doe#anchor" ).remove_fragment().buffer() == "?first=john&last=doe" ); heading text Postconditions 1 code this->has_fragment() == false && this->encoded_fragment() == "" heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code fragment = *( pchar / "/" / "?" ) heading text Specification 1 list paragraph link text 3.5. Fragment https://datatracker.ietf.org/doc/html/rfc3986#section-3.5 unordered brief text Remove the fragment returns code text *this see reference remove_fragment aGhIz5PP9XtdztICzhAvM4n92Sg= text , reference set_encoded_fragment ebU9NPxh5c4VwDAaQA1CXRWbSKk= text , reference set_fragment VHh7zoCWGsviuG3lWYA54cKWneU= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base normal 1 remove_origin boost/url/url_base.hpp include/boost/url/url_base.hpp 2644 5 1 function OqDHBYUjGSW4mGYuSUu09xFSlEc= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function removes the origin, which consists of the scheme and authority. heading text Example 1 code assert( url( "http://www.example.com/index.htm" ).remove_origin().buffer() == "/index.htm" ); heading text Postconditions 1 code this->scheme_id() == scheme::none && this->has_authority() == false heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Throws nothing. brief text Remove the origin component returns code text *this identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base normal 1 remove_password boost/url/url_base.hpp include/boost/url/url_base.hpp 857 5 1 function M5RIQPf9vzlN+m4Qn0PDNFKy8ak= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function removes the password from the userinfo if a password exists. If there is no userinfo or no authority, the call has no effect. admonition paragraph text The interpretation of the userinfo as individual user and password components is scheme-dependent. Transmitting passwords in URLs is deprecated. note heading text Example 1 code assert( url( "http://user:pass@example.com" ).remove_password().authority().buffer() == "user@example.com" ); heading text Postconditions 1 code this->has_password() == false && this->encoded_password().empty() == true heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code userinfo = [ [ user ] [ ':' password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Remove the password returns code text *this see reference set_encoded_password qF7dDBIf4KkHxSuysLw1EJNSh2Y= text , reference set_encoded_user YNLJGohUXCdL6mo1PM3ms9pRQyE= text , reference set_password blkDquwzHtk7o5mJf/hdeY15zWg= text , reference set_user GWy3y66sOX4ov+Eh3hxNRVsAEwY= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base normal 1 remove_port boost/url/url_base.hpp include/boost/url/url_base.hpp 1696 5 1 function ADa0xIsiS8APEAdL3+s0LoNowA8= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text If a port exists, it is removed. The rest of the authority is unchanged. heading text Example 1 code assert( url( "http://www.example.com:80" ).remove_port().authority().buffer() == "www.example.com" ); heading text Postconditions 1 code this->has_port() == false && this->port_number() == 0 && this->port() == "" heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code authority = [ userinfo "@" ] host [ ":" port ] port = *DIGIT heading text Specification 1 list paragraph link text 3.2.3. Port (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.3 unordered brief text Remove the port returns code text *this see reference set_port p1q1Ba+a+naWvTDfBuMPt0DJw2A= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base normal 1 remove_query boost/url/url_base.hpp include/boost/url/url_base.hpp 2463 5 1 function ZZWEzCK7DguUxc3TvUfizoGKplE= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text If a query is present, it is removed. An empty query is distinct from having no query. heading text Example 1 code assert( url( "http://www.example.com?id=42" ).remove_query().buffer() == "http://www.example.com" ); heading text Postconditions 1 code this->has_query() == false && this->params().empty() heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Remove the query returns code text *this see reference encoded_params tDMWbnBabN2mGSH3Apn445gDMEQ= text , reference params wdcIrRY9aj9gn6bF1i59TpOAQb4= text , reference set_encoded_query QcQ13DUh8M8TR/zj/LDG3N/+i3c= text , reference set_query 99/QTSBQGLrNj3zGdw5VzYlqfnI= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base normal 1 remove_scheme boost/url/url_base.hpp include/boost/url/url_base.hpp 318 5 1 function 1N2Tt1DokczwHdRgAZiZzhPQr4E= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function removes the scheme if it is present. heading text Example 1 code assert( url("http://www.example.com/index.htm" ).remove_scheme().buffer() == "//www.example.com/index.htm" ); heading text Postconditions 1 code this->has_scheme() == false && this->scheme_id() == scheme::none heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] heading text Specification 1 list paragraph link text 3.1. Scheme (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.1 unordered brief text Remove the scheme returns code text *this see reference set_scheme rKQfFZ6dfzeuSqZL+PgPNpIFQ5g= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base normal 1 remove_userinfo boost/url/url_base.hpp include/boost/url/url_base.hpp 585 5 1 function PjTTglJlJuEwKHuRXGByi7wW8W8= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function removes the userinfo if present, without removing any authority. heading text Example 1 code assert( url( "http://user@example.com" ).remove_userinfo().has_userinfo() == false ); heading text Postconditions 1 code this->has_userinfo() == false && this->encoded_userinfo().empty == true heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code userinfo = [ [ user ] [ ':' password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Remove the userinfo returns code text *this see reference set_encoded_userinfo MLv0mdC6EhrEgdnFiOF+W8sw0/c= text , reference set_userinfo s+5EFNaQxZ6HMzMRElE8AAODpm8= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base normal 1 reserve boost/url/url_base.hpp include/boost/url/url_base.hpp 187 5 1 function R5AajT/eZPgijKrm8AxolAdhsRQ= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function adjusts the capacity of the container in characters, without affecting the current contents. Has no effect if code text n <= this->capacity() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. brief text Adjust the capacity without changing the size param text The capacity in characters, excluding any null terminator. n throws text Allocation failure reference bad_alloc identifier void identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std n normal 1 resolve boost/url/url_base.hpp include/boost/url/url_base.hpp 2973 5 1 function 3Pi5l1khAbVAQHD3fWi5GoHEr5E= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function attempts to resolve a URL reference code text ref text against this base URL in a manner similar to that of a web browser resolving an anchor tag. paragraph text This URL must satisfy the emph text URI text grammar. In other words, it must contain a scheme. paragraph text Relative references are only usable when in the context of a base absolute URI. This process of resolving a relative emph text reference text within the context of a emph text base text URI is defined in detail in rfc3986 (see below). paragraph text The resolution process works as if the relative reference is appended to the base URI and the result is normalized. paragraph text Given the input base URL, this function resolves the relative reference as if performing the following steps: list paragraph text Ensure the base URI has at least a scheme paragraph text Normalizing the reference path paragraph text Merge base and reference paths paragraph text Normalize the merged path unordered paragraph text This function places the result of the resolution into this URL in place. paragraph text If an error occurs, the contents of this URL are unspecified and a code text boost::system::result text with an code text system::error_code text is returned. admonition paragraph text Abnormal hrefs where the number of ".." segments exceeds the number of segments in the base path are handled by including the unmatched ".." segments in the result, as described in link text Errata 4547 https://www.rfc-editor.org/errata/eid4547 text . note heading text Example 1 code url base1( "/one/two/three" ); base1.resolve("four"); assert( base1.buffer() == "/one/two/four" ); url base2( "http://example.com/" ) base2.resolve("/one"); assert( base2.buffer() == "http://example.com/one" ); url base3( "http://example.com/one" ); base3.resolve("/two"); assert( base3.buffer() == "http://example.com/two" ); url base4( "http://a/b/c/d;p?q" ); base4.resolve("g#s"); assert( base4.buffer() == "http://a/b/c/g#s" ); heading text BNF 1 code absolute-URI = scheme ":" hier-part [ "?" query ] heading text Exception Safety 1 paragraph text Basic guarantee. Calls to allocate may throw. heading text Specification 1 brief text Resolve a URL reference against this base URL returns text An empty code text boost::system::result text upon success, otherwise an error code if code text !base.has_scheme() text . param text The URL reference to resolve. ref see reference url B4dRaSXMG3fDmuNKMW3KOeRu6kA= text , reference url_view wh3UbUToX9YDmRmnpcoM9EUEZo8= text . specialization O+YzwnquzbCEPErxi2iuhXKphsk= result identifier LWQB+dn+7lsRKPzx/twz66ZcOWI= system 1 identifier UEVNhDEjkZMXfjN1DxbtX0n2rCg= url_view_base ref normal 1 scheme boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 421 5 1 function 43fxogaC5oVqfauhwXyN4s4ibEM= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the scheme if it exists, without a trailing colon (':'). Otherwise it returns an empty string. Note that schemes are case-insensitive, and the canonical form is lowercased. heading text Example 1 code assert( url_view( "http://www.example.com" ).scheme() == "http" ); heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code scheme = ALPHA *( ALPHA / DIGIT / "+" / "-" / "." ) URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] absolute-URI = scheme ":" hier-part [ "?" query ] heading text Specification 1 list paragraph link text 3.1. Scheme (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.1 unordered brief text Return the scheme returns text The scheme as a string. see reference has_scheme iwSH2fvVkb89TkZj7KWLGSyc4sA= text , reference scheme_id uM37WpBqetqzfHjns3M8/+CcoEU= text . identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core normal 1 1 scheme_id boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 471 5 1 function uM37WpBqetqzfHjns3M8/+CcoEU= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns a value which depends on the scheme in the url: list paragraph text If the scheme is a well-known scheme, corresponding value from the enumeration reference urls::scheme P7uOjuAMILimKGOcbjDUSpMAL/U= text is returned. paragraph text If a scheme is present but is not a well-known scheme, the value returned is reference urls::scheme::unknown LJxTyQ55ot1WYLH7f46nZvdGU78= text . paragraph text Otherwise, if the scheme is absent the value returned is reference urls::scheme::none VupiauVBXlZQ8Uix+vk8kSl+fM8= text . unordered heading text Example 1 code assert( url_view( "wss://www.example.com/crypto.cgi" ).scheme_id() == scheme::wss ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] absolute-URI = scheme ":" hier-part [ "?" query ] scheme = ALPHA *( ALPHA / DIGIT / "+" / "-" / "." ) heading text Specification 1 list paragraph link text 3.1. Scheme (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.1 unordered brief text Return the scheme returns text The scheme as an enumeration value. see reference has_scheme iwSH2fvVkb89TkZj7KWLGSyc4sA= text , reference scheme 43fxogaC5oVqfauhwXyN4s4ibEM= text . identifier P7uOjuAMILimKGOcbjDUSpMAL/U= scheme identifier dnk5XPfR2OaMpCYaH3cWSxcTdyc= urls normal 1 1 segments boost/url/url_base.hpp include/boost/url/url_base.hpp 1955 5 1 boost/url/url_base.hpp include/boost/url/url_base.hpp 1951 5 1 overloads coMz0KQ2BIuACsWbIRZ/6lTOmuk= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= brief text Return the path as a container of segments returns code text *this returns text A bidirectional view of segments. see reference encoded_segments qeLAK8oZj7+xpHv7Pyh0yYASuqU= text , reference set_encoded_path GQGd+Ne+D3eTy4fe+x1cpa5zefU= text , reference set_path 0VMn4mT6ruiabbTCXyOFe+JATBg= text , reference set_path_absolute BHDHQef0k/8vd3QskLyTrsv7+DE= text . see reference is_path_absolute eh5BeHbLjL3BuEY7ao3tbEAZnTw= text , reference encoded_path GNlqbV0MSxGIA/gSjlOb2rfSHhU= text , reference encoded_segments qeLAK8oZj7+xpHv7Pyh0yYASuqU= text . reference path Q5NVO+d/+BmZ5v3/ogNb2XpUTKs= text , reference segments_view ZNJOLZ4RhCB2A2ooiNo7KxZJHrA= text . normal 7IUB1R6CP5b6VCTpQBgLFv27mfU= QP1V0/Bd4lTeXI0vaNEiUqgvkPQ= segments boost/url/url_base.hpp include/boost/url/url_base.hpp 1951 5 1 function 7IUB1R6CP5b6VCTpQBgLFv27mfU= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function returns a bidirectional view of segments over the path. The returned view references the same underlying character buffer; ownership is not transferred. Any percent-escapes in strings returned when iterating the view are decoded first. The container is modifiable; changes to the container are reflected in the underlying URL. heading text Example 1 code url u( "http://example.com/path/to/file.txt" ); segments sv = u.segments(); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code path = path-abempty ; begins with "/" or is empty / path-absolute ; begins with "/" but not "//" / path-noscheme ; begins with a non-colon segment / path-rootless ; begins with a segment / path-empty ; zero characters path-abempty = *( "/" segment ) path-absolute = "/" [ segment-nz *( "/" segment ) ] path-noscheme = segment-nz-nc *( "/" segment ) path-rootless = segment-nz *( "/" segment ) path-empty = 0<pchar> heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text Return the path as a container of segments returns code text *this see reference encoded_segments qeLAK8oZj7+xpHv7Pyh0yYASuqU= text , reference set_encoded_path GQGd+Ne+D3eTy4fe+x1cpa5zefU= text , reference set_path 0VMn4mT6ruiabbTCXyOFe+JATBg= text , reference set_path_absolute BHDHQef0k/8vd3QskLyTrsv7+DE= text . identifier zdr3gU7+2/G05oo6ta/IfHlkTF0= segments_ref identifier dnk5XPfR2OaMpCYaH3cWSxcTdyc= urls normal 1 segments boost/url/url_base.hpp include/boost/url/url_base.hpp 1955 5 1 function QP1V0/Bd4lTeXI0vaNEiUqgvkPQ= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function returns a bidirectional view of strings over the path. The returned view references the same underlying character buffer; ownership is not transferred. Any percent-escapes in strings returned when iterating the view are decoded first. heading text Example 1 code segments_view sv = url_view( "/path/to/file.txt" ).segments(); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code path = [ "/" ] segment *( "/" segment ) heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text Return the path as a container of segments url_view_base::segments returns text A bidirectional view of segments. see reference is_path_absolute eh5BeHbLjL3BuEY7ao3tbEAZnTw= text , reference encoded_path GNlqbV0MSxGIA/gSjlOb2rfSHhU= text , reference encoded_segments qeLAK8oZj7+xpHv7Pyh0yYASuqU= text . reference path Q5NVO+d/+BmZ5v3/ogNb2XpUTKs= text , reference segments_view ZNJOLZ4RhCB2A2ooiNo7KxZJHrA= text . identifier ZNJOLZ4RhCB2A2ooiNo7KxZJHrA= segments_view normal 1 1 set_encoded_authority boost/url/url_base.hpp include/boost/url/url_base.hpp 364 5 1 function VTO/x6AChJRFyjVKxhaqmIAvYFI= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function sets the authority to the specified string. The string may contain percent-escapes. heading text Example 1 code assert( url().set_encoded_authority( "My%20Computer" ).has_authority() ); heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text BNF 1 code authority = [ userinfo "@" ] host [ ":" port ] userinfo = *( unreserved / pct-encoded / sub-delims / ":" ) host = IP-literal / IPv4address / reg-name port = *DIGIT heading text Specification 1 list paragraph link text 3.2. Authority (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2 unordered brief text Set the authority returns code text *this param text The authority string to set. s throws text The string contains an invalid percent-encoding. reference system_eror see reference remove_authority cjTKMEM0IWRzDexmJAiWOj6P+ZI= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view s normal 1 set_encoded_fragment boost/url/url_base.hpp include/boost/url/url_base.hpp 2611 5 1 function ebU9NPxh5c4VwDAaQA1CXRWbSKk= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function sets the fragment to the specified string, which may contain percent-escapes and which may be empty. An empty fragment is distinct from having no fragment. Escapes in the string are preserved, and reserved characters in the string are percent-escaped in the result. heading text Example 1 code assert( url("?first=john&last=doe" ).set_encoded_fragment( "john%2Ddoe" ).fragment() == "john-doe" ); heading text Postconditions 1 code this->has_fragment() == true && this->fragment() == decode_view( s ) heading text Complexity 1 paragraph text Linear in code text this->size() + s.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text BNF 1 code fragment = *( pchar / "/" / "?" ) heading text Specification 1 list paragraph link text 3.5. Fragment https://datatracker.ietf.org/doc/html/rfc3986#section-3.5 unordered brief text Set the fragment. returns code text *this returns code text *this param text The string to set. s throws code text s text contains an invalid percent-encoding. reference system_error see reference remove_fragment aGhIz5PP9XtdztICzhAvM4n92Sg= text , reference set_fragment VHh7zoCWGsviuG3lWYA54cKWneU= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view s normal 1 set_encoded_host boost/url/url_base.hpp include/boost/url/url_base.hpp 1027 5 1 function OgEcjvMpUkw5cqqrotx6BNVfYuA= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text Depending on the contents of the passed string, this function sets the host: list paragraph text If the string is a valid IPv4 address, then the host is set to the address. The host type is reference host_type::ipv4 49F64dAiji9HVbP6MxLQiqot7AY= text . paragraph text If the string is a valid IPv6 address enclosed in square brackets, then the host is set to that address. The host type is reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= text . paragraph text If the string is a valid IPvFuture address enclosed in square brackets, then the host is set to that address. The host type is reference host_type::ipvfuture TcYJaTwDFsx+0S2CkvHHARcCqWc= text . paragraph text Otherwise, the host name is set to the string. This string can contain percent escapes, or can be empty. Escapes in the string are preserved, and reserved characters in the string are percent-escaped in the result. The host type is reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= text . unordered paragraph text In all cases, when this function returns, the URL contains an authority. heading text Example 1 code assert( url( "http://www.example.com" ).set_host( "127.0.0.1" ).buffer() == "http://127.0.0.1" ); heading text Postconditions 1 code this->has_authority() == true heading text Complexity 1 paragraph text Linear in code text this->size() + s.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPvFuture ) "]" reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text IPv4 (Wikipedia) https://en.wikipedia.org/wiki/IPv4 paragraph link text IP Version 6 Addressing Architecture (rfc4291) https://datatracker.ietf.org/doc/html/rfc4291 paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Set the host returns code text *this param text The string to set. s throws code text s text contains an invalid percent-encoding. reference system_error see reference set_encoded_host_address 51fvhkKEd4+UZEBsnLd4vUL/Svw= text , reference set_encoded_host_name Lz8KFSebh4YuJuAAf0STYQ/VPqk= text , reference set_host lhYybwvylnG/ieiGmyVfyExN3dw= text , reference set_host_address ut25mVfVRShtv19Mg+nvS5jVATc= text , reference set_host_ipv4 Cn5GM3RJyUENDJ/d6LnYVW+gkA4= text , reference set_host_ipv6 BryTExdDEUoZs6riyC1Qi0/NtPE= text , reference set_host_ipvfuture BQxPHhB2Uv0OyVbWf3e7/seXVX8= text , reference set_host_name Pt4icJRgJxULgQjbXV6yzBigNl8= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view s normal 1 set_encoded_host_address boost/url/url_base.hpp include/boost/url/url_base.hpp 1230 5 1 function 51fvhkKEd4+UZEBsnLd4vUL/Svw= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text Depending on the contents of the passed string, this function sets the host: list paragraph text If the string is a valid IPv4 address, then the host is set to the address. The host type is reference host_type::ipv4 49F64dAiji9HVbP6MxLQiqot7AY= text . paragraph text If the string is a valid IPv6 address, then the host is set to that address. The host type is reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= text . paragraph text If the string is a valid IPvFuture, then the host is set to that address. The host type is reference host_type::ipvfuture TcYJaTwDFsx+0S2CkvHHARcCqWc= text . paragraph text Otherwise, the host name is set to the string. This string can contain percent escapes, or can be empty. Escapes in the string are preserved, and reserved characters in the string are percent-escaped in the result. The host type is reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= text . unordered paragraph text In all cases, when this function returns, the URL contains an authority. heading text Example 1 code assert( url( "http://www.example.com" ).set_host( "127.0.0.1" ).buffer() == "http://127.0.0.1" ); heading text Postconditions 1 code this->has_authority() == true heading text Complexity 1 paragraph text Linear in code text this->size() + s.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text BNF 1 code IPv4address = dec-octet "." dec-octet "." dec-octet "." dec-octet dec-octet = DIGIT ; 0-9 / %x31-39 DIGIT ; 10-99 / "1" 2DIGIT ; 100-199 / "2" %x30-34 DIGIT ; 200-249 / "25" %x30-35 ; 250-255 IPv6address = 6( h16 ":" ) ls32 / "::" 5( h16 ":" ) ls32 / [ h16 ] "::" 4( h16 ":" ) ls32 / [ *1( h16 ":" ) h16 ] "::" 3( h16 ":" ) ls32 / [ *2( h16 ":" ) h16 ] "::" 2( h16 ":" ) ls32 / [ *3( h16 ":" ) h16 ] "::" h16 ":" ls32 / [ *4( h16 ":" ) h16 ] "::" ls32 / [ *5( h16 ":" ) h16 ] "::" h16 / [ *6( h16 ":" ) h16 ] "::" ls32 = ( h16 ":" h16 ) / IPv4address ; least-significant 32 bits of address h16 = 1*4HEXDIG ; 16 bits of address represented in hexadecimal IPvFuture = "v" 1*HEXDIG "." 1*( unreserved / sub-delims / ":" ) reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text IPv4 (Wikipedia) https://en.wikipedia.org/wiki/IPv4 paragraph link text IP Version 6 Addressing Architecture (rfc4291) https://datatracker.ietf.org/doc/html/rfc4291 paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Set the host to an address returns code text *this param text The string to set. s throws code text s text contains an invalid percent-encoding. reference system_error see reference set_encoded_host OgEcjvMpUkw5cqqrotx6BNVfYuA= text , reference set_encoded_host_name Lz8KFSebh4YuJuAAf0STYQ/VPqk= text , reference set_host lhYybwvylnG/ieiGmyVfyExN3dw= text , reference set_host_address ut25mVfVRShtv19Mg+nvS5jVATc= text , reference set_host_ipv4 Cn5GM3RJyUENDJ/d6LnYVW+gkA4= text , reference set_host_ipv6 BryTExdDEUoZs6riyC1Qi0/NtPE= text , reference set_host_ipvfuture BQxPHhB2Uv0OyVbWf3e7/seXVX8= text , reference set_host_name Pt4icJRgJxULgQjbXV6yzBigNl8= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view s normal 1 set_encoded_host_name boost/url/url_base.hpp include/boost/url/url_base.hpp 1566 5 1 function Lz8KFSebh4YuJuAAf0STYQ/VPqk= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text The host is set to the specified string, which may contain percent-escapes and can be empty. Escapes in the string are preserved, and reserved characters in the string are percent-escaped in the result. The host type is reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= text . heading text Example 1 code assert( url( "http://www.example.com/index.htm").set_encoded_host_name( "localhost" ).host_address() == "localhost" ); heading text Postconditions 1 code this->has_authority() == true && this->host_ipv6_address() == addr && this->host_type() == host_type::name heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text BNF 1 code reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Set the host to a name returns code text *this param text The string to set. s throws code text s text contains an invalid percent-encoding. reference system_error see reference set_encoded_host OgEcjvMpUkw5cqqrotx6BNVfYuA= text , reference set_encoded_host_address 51fvhkKEd4+UZEBsnLd4vUL/Svw= text , reference set_host lhYybwvylnG/ieiGmyVfyExN3dw= text , reference set_host_address ut25mVfVRShtv19Mg+nvS5jVATc= text , reference set_host_ipv4 Cn5GM3RJyUENDJ/d6LnYVW+gkA4= text , reference set_host_ipv6 BryTExdDEUoZs6riyC1Qi0/NtPE= text , reference set_host_ipvfuture BQxPHhB2Uv0OyVbWf3e7/seXVX8= text , reference set_host_name Pt4icJRgJxULgQjbXV6yzBigNl8= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view s normal 1 set_encoded_params boost/url/url_base.hpp include/boost/url/url_base.hpp 2419 5 1 function S9fyQqerhxu7yBt8GhsEJ9RKJl8= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This sets the query params to the elements in the list, which may contain percent-escapes and can be empty. paragraph text An empty list of params is distinct from having no query. paragraph text Escapes in the string are preserved, and reserved characters in the string are percent-escaped in the result. heading text Example 1 code assert( url( "http://example.com" ).set_encoded_params( {"id", "42"} ).encoded_query() == "id=42" ); heading text Postconditions 1 code this->has_query() == true heading text Complexity 1 paragraph text Linear. heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Set the query params returns code text *this param text The params to set. ps throws text some element in code text ps text contains an invalid percent-encoding. reference system_error see reference set_params 6eTAKxxUVgfC1QD7w2yAukEvLs4= text , reference params wdcIrRY9aj9gn6bF1i59TpOAQb4= text , reference remove_query ZZWEzCK7DguUxc3TvUfizoGKplE= text , reference set_encoded_query QcQ13DUh8M8TR/zj/LDG3N/+i3c= text , reference set_query 99/QTSBQGLrNj3zGdw5VzYlqfnI= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base specialization 3tT5Y8vozttMWXrA/fNw4NcDYTE= initializer_list identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std ps normal 1 set_encoded_password boost/url/url_base.hpp include/boost/url/url_base.hpp 804 5 1 function qF7dDBIf4KkHxSuysLw1EJNSh2Y= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function sets the password in the userinfo to the string, which may contain percent-escapes. Escapes in the string are preserved, and reserved characters in the string are percent-escaped in the result. admonition paragraph text The interpretation of the userinfo as individual user and password components is scheme-dependent. Transmitting passwords in URLs is deprecated. note heading text Example 1 code assert( url("http://user@example.com").set_encoded_password( "pass" ).encoded_userinfo() == "user:pass" ); heading text Postconditions 1 code this->has_password() == true heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code userinfo = [ [ user ] [ ':' password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Set the password. returns code text *this param text The string to set. This string may contain any characters, including nulls. s throws code text s text contains an invalid percent-encoding. reference system_error see reference remove_password M5RIQPf9vzlN+m4Qn0PDNFKy8ak= text , reference set_encoded_password qF7dDBIf4KkHxSuysLw1EJNSh2Y= text , reference set_encoded_user YNLJGohUXCdL6mo1PM3ms9pRQyE= text , reference set_user GWy3y66sOX4ov+Eh3hxNRVsAEwY= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view s normal 1 set_encoded_path boost/url/url_base.hpp include/boost/url/url_base.hpp 1894 5 1 function GQGd+Ne+D3eTy4fe+x1cpa5zefU= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function sets the path to the string, which may contain percent-escapes and can be empty. Escapes in the string are preserved, and reserved characters in the string are percent-escaped in the result. admonition paragraph text The library may adjust the final result to ensure that no other parts of the url is semantically affected. note heading text Example 1 code url u( "http://www.example.com" ); u.set_encoded_path( "path/to/file.txt" ); assert( u.encoded_path() == "/path/to/file.txt" ); heading text Complexity 1 paragraph text Linear in code text this->size() + s.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text BNF 1 code path = path-abempty ; begins with "/" or is empty / path-absolute ; begins with "/" but not "//" / path-noscheme ; begins with a non-colon segment / path-rootless ; begins with a segment / path-empty ; zero characters path-abempty = *( "/" segment ) path-absolute = "/" [ segment-nz *( "/" segment ) ] path-noscheme = segment-nz-nc *( "/" segment ) path-rootless = segment-nz *( "/" segment ) path-empty = 0<pchar> heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text Set the path. returns code text *this param text The string to set. s throws code text s text contains an invalid percent-encoding. reference system_error see reference encoded_segments qeLAK8oZj7+xpHv7Pyh0yYASuqU= text , reference segments coMz0KQ2BIuACsWbIRZ/6lTOmuk= text , reference set_path 0VMn4mT6ruiabbTCXyOFe+JATBg= text , reference set_path_absolute BHDHQef0k/8vd3QskLyTrsv7+DE= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view s normal 1 set_encoded_query boost/url/url_base.hpp include/boost/url/url_base.hpp 2132 5 1 function QcQ13DUh8M8TR/zj/LDG3N/+i3c= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This sets the query to the string, which may contain percent-escapes and can be empty. An empty query is distinct from having no query. Escapes in the string are preserved, and reserved characters in the string are percent-escaped in the result. heading text Example 1 code assert( url( "http://example.com" ).set_encoded_query( "id=42" ).encoded_query() == "id=42" ); heading text Postconditions 1 code this->has_query() == true && this->query() == decode_view( s ); heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Set the query returns code text *this param text The string to set. s throws code text s text contains an invalid percent-encoding. reference system_error see reference encoded_params tDMWbnBabN2mGSH3Apn445gDMEQ= text , reference params wdcIrRY9aj9gn6bF1i59TpOAQb4= text , reference remove_query ZZWEzCK7DguUxc3TvUfizoGKplE= text , reference set_query 99/QTSBQGLrNj3zGdw5VzYlqfnI= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view s normal 1 set_encoded_user boost/url/url_base.hpp include/boost/url/url_base.hpp 692 5 1 function YNLJGohUXCdL6mo1PM3ms9pRQyE= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function sets the user part of the userinfo the the string, which may contain percent-escapes. Escapes in the string are preserved, and reserved characters in the string are percent-escaped in the result. heading text Example 1 code assert( url().set_encoded_user("john%20doe").userinfo() == "john doe" ); heading text Postconditions 1 code this->has_authority() == true && this->has_userinfo() == true heading text Complexity 1 paragraph text Linear in code text this->size() + s.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code userinfo = [ [ user ] [ ':' password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Set the user returns code text *this returns code text *this param text The string to set. s throws code text s text contains an invalid percent-encoding. reference system_error see reference remove_password M5RIQPf9vzlN+m4Qn0PDNFKy8ak= text , reference set_encoded_password qF7dDBIf4KkHxSuysLw1EJNSh2Y= text , reference set_password blkDquwzHtk7o5mJf/hdeY15zWg= text , reference set_user GWy3y66sOX4ov+Eh3hxNRVsAEwY= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view s normal 1 set_encoded_userinfo boost/url/url_base.hpp include/boost/url/url_base.hpp 542 5 1 function MLv0mdC6EhrEgdnFiOF+W8sw0/c= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text The userinfo is set to the given string, which may contain percent-escapes. Escapes in the string are preserved, and reserved characters in the string are percent-escaped in the result. The effects on the user and password depend on the presence of a colon (':') in the string: list paragraph text If an unescaped colon exists, the characters up to the colon become the user and the rest of the characters after the colon become the password. In this case reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text returns true. Otherwise, paragraph text If there is no colon, the user is set to the string. The function reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text returns false. unordered admonition paragraph text The interpretation of the userinfo as individual user and password components is scheme-dependent. Transmitting passwords in URLs is deprecated. note heading text Example 1 code assert( url( "http://example.com" ).set_encoded_userinfo( "john%20doe" ).user() == "john doe" ); heading text Complexity 1 paragraph text Linear in code text this->size() + s.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text BNF 1 code userinfo = [ [ user ] [ ':' password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Set the userinfo. returns code text *this param text The string to set. s throws code text s text contains an invalid percent-encoding. reference system_error see reference remove_userinfo PjTTglJlJuEwKHuRXGByi7wW8W8= text , reference set_userinfo s+5EFNaQxZ6HMzMRElE8AAODpm8= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view s normal 1 set_encoded_zone_id boost/url/url_base.hpp include/boost/url/url_base.hpp 1411 5 1 function /HsDRNr5aHRIzBwkJqZnZrdNZ/k= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function sets the zone ID for the host if the host is an IPv6 address. Escapes in the string are preserved, and reserved characters in the string are percent-escaped in the result. heading text Example 1 code assert( u.set_host_ipv6( ipv6_address( "fe80::1" ) ).set_encoded_zone_id( "eth0" ).buffer() == "https://[fe80::1%25eth0]" ); heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text Specification 1 list paragraph link text RFC 6874 https://datatracker.ietf.org/doc/html/rfc6874 unordered brief text Set the zone ID for an IPv6 address (percent-encoded). returns code text *this param text The zone ID to set. s throws code text s text contains an invalid percent-encoding. reference system_error identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view s normal 1 set_fragment boost/url/url_base.hpp include/boost/url/url_base.hpp 2556 5 1 function VHh7zoCWGsviuG3lWYA54cKWneU= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function sets the fragment to the specified string, which may be empty. An empty fragment is distinct from having no fragment. Reserved characters in the string are percent-escaped in the result. heading text Example 1 code assert( url("?first=john&last=doe" ).set_encoded_fragment( "john doe" ).encoded_fragment() == "john%20doe" ); heading text Postconditions 1 code this->has_fragment() == true && this->fragment() == s heading text Complexity 1 paragraph text Linear in code text this->size() + s.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code fragment = *( pchar / "/" / "?" ) heading text Specification 1 list paragraph link text 3.5. Fragment https://datatracker.ietf.org/doc/html/rfc3986#section-3.5 unordered brief text Set the fragment. returns code text *this param text The string to set. s see reference remove_fragment aGhIz5PP9XtdztICzhAvM4n92Sg= text , reference set_encoded_fragment ebU9NPxh5c4VwDAaQA1CXRWbSKk= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 set_host boost/url/url_base.hpp include/boost/url/url_base.hpp 941 5 1 function lhYybwvylnG/ieiGmyVfyExN3dw= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text Depending on the contents of the passed string, this function sets the host: list paragraph text If the string is a valid IPv4 address, then the host is set to the address. The host type is reference host_type::ipv4 49F64dAiji9HVbP6MxLQiqot7AY= text . paragraph text If the string is a valid IPv6 address enclosed in square brackets, then the host is set to that address. The host type is reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= text . paragraph text If the string is a valid IPvFuture address enclosed in square brackets, then the host is set to that address. The host type is reference host_type::ipvfuture TcYJaTwDFsx+0S2CkvHHARcCqWc= text . paragraph text Otherwise, the host name is set to the string, which may be empty. Reserved characters in the string are percent-escaped in the result. The host type is reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= text . unordered paragraph text In all cases, when this function returns, the URL contains an authority. heading text Example 1 code assert( url( "http://www.example.com" ).set_host( "127.0.0.1" ).buffer() == "http://127.0.0.1" ); heading text Postconditions 1 code this->has_authority() == true heading text Complexity 1 paragraph text Linear in code text this->size() + s.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPvFuture ) "]" reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text IPv4 (Wikipedia) https://en.wikipedia.org/wiki/IPv4 paragraph link text IP Version 6 Addressing Architecture (rfc4291) https://datatracker.ietf.org/doc/html/rfc4291 paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Set the host returns code text *this param text The string to set. s see reference set_encoded_host OgEcjvMpUkw5cqqrotx6BNVfYuA= text , reference set_encoded_host_address 51fvhkKEd4+UZEBsnLd4vUL/Svw= text , reference set_encoded_host_name Lz8KFSebh4YuJuAAf0STYQ/VPqk= text , reference set_host_address ut25mVfVRShtv19Mg+nvS5jVATc= text , reference set_host_ipv4 Cn5GM3RJyUENDJ/d6LnYVW+gkA4= text , reference set_host_ipv6 BryTExdDEUoZs6riyC1Qi0/NtPE= text , reference set_host_ipvfuture BQxPHhB2Uv0OyVbWf3e7/seXVX8= text , reference set_host_name Pt4icJRgJxULgQjbXV6yzBigNl8= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 set_host_address boost/url/url_base.hpp include/boost/url/url_base.hpp 1126 5 1 function ut25mVfVRShtv19Mg+nvS5jVATc= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text Depending on the contents of the passed string, this function sets the host: list paragraph text If the string is a valid IPv4 address, then the host is set to the address. The host type is reference host_type::ipv4 49F64dAiji9HVbP6MxLQiqot7AY= text . paragraph text If the string is a valid IPv6 address, then the host is set to that address. The host type is reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= text . paragraph text If the string is a valid IPvFuture, then the host is set to that address. The host type is reference host_type::ipvfuture TcYJaTwDFsx+0S2CkvHHARcCqWc= text . paragraph text Otherwise, the host name is set to the string, which may be empty. Reserved characters in the string are percent-escaped in the result. The host type is reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= text . unordered paragraph text In all cases, when this function returns, the URL contains an authority. heading text Example 1 code assert( url( "http://www.example.com" ).set_host_address( "127.0.0.1" ).buffer() == "http://127.0.0.1" ); heading text Postconditions 1 code this->has_authority() == true heading text Complexity 1 paragraph text Linear in code text s.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code IPv4address = dec-octet "." dec-octet "." dec-octet "." dec-octet dec-octet = DIGIT ; 0-9 / %x31-39 DIGIT ; 10-99 / "1" 2DIGIT ; 100-199 / "2" %x30-34 DIGIT ; 200-249 / "25" %x30-35 ; 250-255 IPv6address = 6( h16 ":" ) ls32 / "::" 5( h16 ":" ) ls32 / [ h16 ] "::" 4( h16 ":" ) ls32 / [ *1( h16 ":" ) h16 ] "::" 3( h16 ":" ) ls32 / [ *2( h16 ":" ) h16 ] "::" 2( h16 ":" ) ls32 / [ *3( h16 ":" ) h16 ] "::" h16 ":" ls32 / [ *4( h16 ":" ) h16 ] "::" ls32 / [ *5( h16 ":" ) h16 ] "::" h16 / [ *6( h16 ":" ) h16 ] "::" ls32 = ( h16 ":" h16 ) / IPv4address ; least-significant 32 bits of address h16 = 1*4HEXDIG ; 16 bits of address represented in hexadecimal IPvFuture = "v" 1*HEXDIG "." 1*( unreserved / sub-delims / ":" ) reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text IPv4 (Wikipedia) https://en.wikipedia.org/wiki/IPv4 paragraph link text IP Version 6 Addressing Architecture (rfc4291) https://datatracker.ietf.org/doc/html/rfc4291 paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Set the host to an address returns code text *this param text The string to set. s see reference set_encoded_host OgEcjvMpUkw5cqqrotx6BNVfYuA= text , reference set_encoded_host_address 51fvhkKEd4+UZEBsnLd4vUL/Svw= text , reference set_encoded_host_name Lz8KFSebh4YuJuAAf0STYQ/VPqk= text , reference set_host lhYybwvylnG/ieiGmyVfyExN3dw= text , reference set_host_address ut25mVfVRShtv19Mg+nvS5jVATc= text , reference set_host_ipv4 Cn5GM3RJyUENDJ/d6LnYVW+gkA4= text , reference set_host_ipv6 BryTExdDEUoZs6riyC1Qi0/NtPE= text , reference set_host_ipvfuture BQxPHhB2Uv0OyVbWf3e7/seXVX8= text , reference set_host_name Pt4icJRgJxULgQjbXV6yzBigNl8= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 set_host_ipv4 boost/url/url_base.hpp include/boost/url/url_base.hpp 1287 5 1 function Cn5GM3RJyUENDJ/d6LnYVW+gkA4= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text The host is set to the specified IPv4 address. The host type is reference host_type::ipv4 49F64dAiji9HVbP6MxLQiqot7AY= text . heading text Example 1 code assert( url("http://www.example.com").set_host_ipv4( ipv4_address( "127.0.0.1" ) ).buffer() == "http://127.0.0.1" ); heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Postconditions 1 code this->has_authority() == true && this->host_ipv4_address() == addr && this->host_type() == host_type::ipv4 heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code IPv4address = dec-octet "." dec-octet "." dec-octet "." dec-octet dec-octet = DIGIT ; 0-9 / %x31-39 DIGIT ; 10-99 / "1" 2DIGIT ; 100-199 / "2" %x30-34 DIGIT ; 200-249 / "25" %x30-35 ; 250-255 heading text Specification 1 list paragraph link text IPv4 (Wikipedia) https://en.wikipedia.org/wiki/IPv4 paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Set the host to an address returns code text *this param text The address to set. addr see reference set_encoded_host OgEcjvMpUkw5cqqrotx6BNVfYuA= text , reference set_encoded_host_address 51fvhkKEd4+UZEBsnLd4vUL/Svw= text , reference set_encoded_host_name Lz8KFSebh4YuJuAAf0STYQ/VPqk= text , reference set_host lhYybwvylnG/ieiGmyVfyExN3dw= text , reference set_host_address ut25mVfVRShtv19Mg+nvS5jVATc= text , reference set_host_ipv6 BryTExdDEUoZs6riyC1Qi0/NtPE= text , reference set_host_ipvfuture BQxPHhB2Uv0OyVbWf3e7/seXVX8= text , reference set_host_name Pt4icJRgJxULgQjbXV6yzBigNl8= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base 1 identifier /Wpp3ZZDp3kUHzbULeDoaOEhnVs= ipv4_address addr normal 1 set_host_ipv6 boost/url/url_base.hpp include/boost/url/url_base.hpp 1353 5 1 function BryTExdDEUoZs6riyC1Qi0/NtPE= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text The host is set to the specified IPv6 address. The host type is reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= text . heading text Example 1 code assert( url().set_host_ipv6( ipv6_address( "1::6:c0a8:1" ) ).authority().buffer() == "[1::6:c0a8:1]" ); heading text Postconditions 1 code this->has_authority() == true && this->host_ipv6_address() == addr && this->host_type() == host_type::ipv6 heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code IPv6address = 6( h16 ":" ) ls32 / "::" 5( h16 ":" ) ls32 / [ h16 ] "::" 4( h16 ":" ) ls32 / [ *1( h16 ":" ) h16 ] "::" 3( h16 ":" ) ls32 / [ *2( h16 ":" ) h16 ] "::" 2( h16 ":" ) ls32 / [ *3( h16 ":" ) h16 ] "::" h16 ":" ls32 / [ *4( h16 ":" ) h16 ] "::" ls32 / [ *5( h16 ":" ) h16 ] "::" h16 / [ *6( h16 ":" ) h16 ] "::" ls32 = ( h16 ":" h16 ) / IPv4address ; least-significant 32 bits of address h16 = 1*4HEXDIG ; 16 bits of address represented in hexadecimal heading text Specification 1 list paragraph link text IP Version 6 Addressing Architecture (rfc4291) https://datatracker.ietf.org/doc/html/rfc4291 paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Set the host to an address returns code text *this param text The address to set. addr see reference set_encoded_host OgEcjvMpUkw5cqqrotx6BNVfYuA= text , reference set_encoded_host_address 51fvhkKEd4+UZEBsnLd4vUL/Svw= text , reference set_encoded_host_name Lz8KFSebh4YuJuAAf0STYQ/VPqk= text , reference set_host lhYybwvylnG/ieiGmyVfyExN3dw= text , reference set_host_address ut25mVfVRShtv19Mg+nvS5jVATc= text , reference set_host_ipv4 Cn5GM3RJyUENDJ/d6LnYVW+gkA4= text , reference set_host_ipvfuture BQxPHhB2Uv0OyVbWf3e7/seXVX8= text , reference set_host_name Pt4icJRgJxULgQjbXV6yzBigNl8= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base 1 identifier dhMSRVBIIIItY0URHSc8rwHcdTQ= ipv6_address addr normal 1 set_host_ipvfuture boost/url/url_base.hpp include/boost/url/url_base.hpp 1464 5 1 function BQxPHhB2Uv0OyVbWf3e7/seXVX8= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text The host is set to the specified IPvFuture string. The host type is reference host_type::ipvfuture TcYJaTwDFsx+0S2CkvHHARcCqWc= text . heading text Example 1 code assert( url().set_host_ipvfuture( "v42.bis" ).buffer() == "//[v42.bis]" ); heading text Complexity 1 paragraph text Linear in code text this->size() + s.size() text . heading text Postconditions 1 code this->has_authority() == true && this->host_ipvfuture) == s && this->host_type() == host_type::ipvfuture heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text BNF 1 code IPvFuture = "v" 1*HEXDIG "." 1*( unreserved / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Set the host to an address returns code text *this param text The string to set. s throws code text s text contains an invalid percent-encoding. reference system_error see reference set_encoded_host OgEcjvMpUkw5cqqrotx6BNVfYuA= text , reference set_encoded_host_address 51fvhkKEd4+UZEBsnLd4vUL/Svw= text , reference set_encoded_host_name Lz8KFSebh4YuJuAAf0STYQ/VPqk= text , reference set_host lhYybwvylnG/ieiGmyVfyExN3dw= text , reference set_host_address ut25mVfVRShtv19Mg+nvS5jVATc= text , reference set_host_ipv4 Cn5GM3RJyUENDJ/d6LnYVW+gkA4= text , reference set_host_ipv6 BryTExdDEUoZs6riyC1Qi0/NtPE= text , reference set_host_name Pt4icJRgJxULgQjbXV6yzBigNl8= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 set_host_name boost/url/url_base.hpp include/boost/url/url_base.hpp 1512 5 1 function Pt4icJRgJxULgQjbXV6yzBigNl8= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text The host is set to the specified string, which may be empty. Reserved characters in the string are percent-escaped in the result. The host type is reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= text . heading text Example 1 code assert( url( "http://www.example.com/index.htm").set_host_name( "localhost" ).host_address() == "localhost" ); heading text Postconditions 1 code this->has_authority() == true && this->host_ipv6_address() == addr && this->host_type() == host_type::name heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Set the host to a name returns code text *this param text The string to set. s see reference set_encoded_host OgEcjvMpUkw5cqqrotx6BNVfYuA= text , reference set_encoded_host_address 51fvhkKEd4+UZEBsnLd4vUL/Svw= text , reference set_encoded_host_name Lz8KFSebh4YuJuAAf0STYQ/VPqk= text , reference set_host lhYybwvylnG/ieiGmyVfyExN3dw= text , reference set_host_address ut25mVfVRShtv19Mg+nvS5jVATc= text , reference set_host_ipv4 Cn5GM3RJyUENDJ/d6LnYVW+gkA4= text , reference set_host_ipv6 BryTExdDEUoZs6riyC1Qi0/NtPE= text , reference set_host_ipvfuture BQxPHhB2Uv0OyVbWf3e7/seXVX8= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 set_params boost/url/url_base.hpp include/boost/url/url_base.hpp 2355 5 1 function 6eTAKxxUVgfC1QD7w2yAukEvLs4= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This sets the query params to the list of param_view, which can be empty. paragraph text An empty list of params is distinct from having no params. paragraph text Reserved characters in the string are percent-escaped in the result. heading text Example 1 code assert( url( "http://example.com" ).set_params( {"id", "42"} ).query() == "id=42" ); heading text Postconditions 1 code this->has_query() == true heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text Complexity 1 paragraph text Linear. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text ://en.wikipedia.org/wiki/Query_string" >Query string (Wikipedia) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 >3.4. Query (rfc3986)</a> @li <a href= unordered brief text Set the query params returns code text *this param text The params to set. ps param text The options for encoding. opts see reference encoded_params tDMWbnBabN2mGSH3Apn445gDMEQ= text , reference remove_query ZZWEzCK7DguUxc3TvUfizoGKplE= text , reference set_encoded_query QcQ13DUh8M8TR/zj/LDG3N/+i3c= text , reference set_query 99/QTSBQGLrNj3zGdw5VzYlqfnI= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base specialization 3tT5Y8vozttMWXrA/fNw4NcDYTE= initializer_list identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std ps identifier Bb04pNwExynJkzlY9a9GCeeB13k= encoding_opts opts {} normal 1 set_password boost/url/url_base.hpp include/boost/url/url_base.hpp 746 5 1 function blkDquwzHtk7o5mJf/hdeY15zWg= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function sets the password in the userinfo to the string. Reserved characters in the string are percent-escaped in the result. admonition paragraph text The interpretation of the userinfo as individual user and password components is scheme-dependent. Transmitting passwords in URLs is deprecated. note heading text Example 1 code assert( url("http://user@example.com").set_password( "pass" ).encoded_userinfo() == "user:pass" ); heading text Postconditions 1 code this->has_password() == true && this->password() == s heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code userinfo = [ [ user ] [ ':' password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Set the password. returns code text *this param text The string to set. This string may contain any characters, including nulls. s see reference remove_password M5RIQPf9vzlN+m4Qn0PDNFKy8ak= text , reference set_encoded_password qF7dDBIf4KkHxSuysLw1EJNSh2Y= text , reference set_encoded_user YNLJGohUXCdL6mo1PM3ms9pRQyE= text , reference set_user GWy3y66sOX4ov+Eh3hxNRVsAEwY= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 set_path boost/url/url_base.hpp include/boost/url/url_base.hpp 1827 5 1 function 0VMn4mT6ruiabbTCXyOFe+JATBg= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function sets the path to the string, which may be empty. Reserved characters in the string are percent-escaped in the result. admonition paragraph text The library may adjust the final result to ensure that no other parts of the URL are semantically affected. note admonition paragraph text This function does not encode '/' chars, which are unreserved for paths but reserved for path segments. If a path segment should include encoded '/'s to differentiate it from path separators, the functions reference set_encoded_path GQGd+Ne+D3eTy4fe+x1cpa5zefU= text or reference segments coMz0KQ2BIuACsWbIRZ/6lTOmuk= text should be used instead. note heading text Example 1 code url u( "http://www.example.com" ); u.set_path( "path/to/file.txt" ); assert( u.path() == "/path/to/file.txt" ); heading text Complexity 1 paragraph text Linear in code text this->size() + s.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code path = path-abempty ; begins with "/" or is empty / path-absolute ; begins with "/" but not "//" / path-noscheme ; begins with a non-colon segment / path-rootless ; begins with a segment / path-empty ; zero characters path-abempty = *( "/" segment ) path-absolute = "/" [ segment-nz *( "/" segment ) ] path-noscheme = segment-nz-nc *( "/" segment ) path-rootless = segment-nz *( "/" segment ) path-empty = 0<pchar> heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text Set the path. returns code text *this param text The string to set. s see reference encoded_segments qeLAK8oZj7+xpHv7Pyh0yYASuqU= text , reference segments coMz0KQ2BIuACsWbIRZ/6lTOmuk= text , reference set_encoded_path GQGd+Ne+D3eTy4fe+x1cpa5zefU= text , reference set_path_absolute BHDHQef0k/8vd3QskLyTrsv7+DE= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 set_path_absolute boost/url/url_base.hpp include/boost/url/url_base.hpp 1760 5 1 function BHDHQef0k/8vd3QskLyTrsv7+DE= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function adjusts the path to make it absolute or not, depending on the parameter. admonition paragraph text If an authority is present, the path is always absolute. In this case, the function has no effect. note heading text Example 1 code url u( "path/to/file.txt" ); assert( u.set_path_absolute( true ) ); assert( u.buffer() == "/path/to/file.txt" ); heading text Postconditions 1 code this->is_path_absolute() == true && this->encoded_path().front() == '/' heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text BNF 1 code path = path-abempty ; begins with "/" or is empty / path-absolute ; begins with "/" but not "//" / path-noscheme ; begins with a non-colon segment / path-rootless ; begins with a segment / path-empty ; zero characters path-abempty = *( "/" segment ) path-absolute = "/" [ segment-nz *( "/" segment ) ] path-noscheme = segment-nz-nc *( "/" segment ) path-rootless = segment-nz *( "/" segment ) path-empty = 0<pchar> heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text Set if the path is absolute returns text true on success. param text If code text true text , the path is made absolute. absolute see reference encoded_segments qeLAK8oZj7+xpHv7Pyh0yYASuqU= text , reference segments coMz0KQ2BIuACsWbIRZ/6lTOmuk= text , reference set_encoded_path GQGd+Ne+D3eTy4fe+x1cpa5zefU= text , reference set_path 0VMn4mT6ruiabbTCXyOFe+JATBg= text . identifier bool identifier bool absolute normal 1 set_port boost/url/url_base.hpp include/boost/url/url_base.hpp 1656 5 1 function p1q1Ba+a+naWvTDfBuMPt0DJw2A= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This port is set to the string, which must contain only digits or be empty. An empty port string is distinct from having no port. heading text Example 1 code assert( url( "http://www.example.com" ).set_port( "8080" ).authority().buffer() == "www.example.com:8080" ); heading text Postconditions 1 code this->has_port() == true && this->port_number() == n && this->port() == std::to_string(n) heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text BNF 1 code port = *DIGIT heading text Specification 1 list paragraph link text 3.2.3. Port (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.3 unordered brief text Set the port returns code text *this param text The port string to set. s throws code text s text does not contain a valid port. reference system_error see reference remove_port ADa0xIsiS8APEAdL3+s0LoNowA8= text , reference set_port p1q1Ba+a+naWvTDfBuMPt0DJw2A= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 set_port_number boost/url/url_base.hpp include/boost/url/url_base.hpp 1612 5 1 function 4bptcCq14NmzqKQvnx54lE+28F0= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text The port is set to the specified integer. heading text Example 1 code assert( url( "http://www.example.com" ).set_port_number( 8080 ).authority().buffer() == "www.example.com:8080" ); heading text Postconditions 1 code this->has_authority() == true && this->has_port() == true && this->port_number() == n heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code authority = [ userinfo "@" ] host [ ":" port ] port = *DIGIT heading text Specification 1 list paragraph link text 3.2.3. Port (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.3 unordered brief text Set the port returns code text *this param text The port number to set. n see reference remove_port ADa0xIsiS8APEAdL3+s0LoNowA8= text , reference set_port p1q1Ba+a+naWvTDfBuMPt0DJw2A= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier Qvo2fOST20EZC7bSOAFZr+u3ITg= uint16_t n normal 1 set_query boost/url/url_base.hpp include/boost/url/url_base.hpp 2076 5 1 function 99/QTSBQGLrNj3zGdw5VzYlqfnI= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This sets the query to the string, which can be empty. An empty query is distinct from having no query. Reserved characters in the string are percent-escaped in the result. heading text Example 1 code assert( url( "http://example.com" ).set_query( "id=42" ).query() == "id=42" ); heading text Postconditions 1 code this->has_query() == true && this->query() == s heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Set the query returns code text *this param text The string to set. s see reference encoded_params tDMWbnBabN2mGSH3Apn445gDMEQ= text , reference params wdcIrRY9aj9gn6bF1i59TpOAQb4= text , reference remove_query ZZWEzCK7DguUxc3TvUfizoGKplE= text , reference set_encoded_query QcQ13DUh8M8TR/zj/LDG3N/+i3c= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 set_scheme boost/url/url_base.hpp include/boost/url/url_base.hpp 245 5 1 function rKQfFZ6dfzeuSqZL+PgPNpIFQ5g= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text The scheme is set to the specified string, which must contain a valid scheme without any trailing colon (':'). Note that schemes are case-insensitive, and the canonical form is lowercased. heading text Example 1 code assert( url( "http://www.example.com" ).set_scheme( "https" ).scheme_id() == scheme::https ); heading text Complexity 1 paragraph text Linear in code text this->size() + s.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text BNF 1 code scheme = ALPHA *( ALPHA / DIGIT / "+" / "-" / "." ) heading text Specification 1 list paragraph link text 3.1. Scheme (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.1 unordered brief text Set the scheme returns code text *this param text The scheme to set. s throws code text s text contains an invalid scheme. reference system_error see reference remove_scheme 1N2Tt1DokczwHdRgAZiZzhPQr4E= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 set_scheme_id boost/url/url_base.hpp include/boost/url/url_base.hpp 280 5 1 function iuTF0vS1Knzl0Hxr4iVhx35Fzdk= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function sets the scheme to the specified known reference urls::scheme P7uOjuAMILimKGOcbjDUSpMAL/U= text id, which may not be reference scheme::unknown LJxTyQ55ot1WYLH7f46nZvdGU78= text or else an exception is thrown. If the id is reference scheme::none VupiauVBXlZQ8Uix+vk8kSl+fM8= text , this function behaves as if reference remove_scheme 1N2Tt1DokczwHdRgAZiZzhPQr4E= text were called. heading text Example 1 code assert( url( "http://example.com/echo.cgi" ).set_scheme_id( scheme::wss ).buffer() == "wss://example.com/echo.cgi" ); heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text Specification 1 list paragraph link text 3.1. Scheme (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.1 unordered brief text Set the scheme returns code text *this param text The scheme to set. id throws text The scheme is invalid. reference system_error identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier P7uOjuAMILimKGOcbjDUSpMAL/U= scheme identifier dnk5XPfR2OaMpCYaH3cWSxcTdyc= urls id normal 1 set_user boost/url/url_base.hpp include/boost/url/url_base.hpp 635 5 1 function GWy3y66sOX4ov+Eh3hxNRVsAEwY= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function sets the user part of the userinfo to the string. Any special or reserved characters in the string are automatically percent-encoded. heading text Example 1 code assert( url().set_user("john doe").encoded_userinfo() == "john%20doe" ); heading text Postconditions 1 code this->has_authority() == true && this->has_userinfo() == true heading text Complexity 1 paragraph text Linear in code text this->size() + s.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code userinfo = [ [ user ] [ ':' password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Set the user returns code text *this param text The string to set. s see reference remove_password M5RIQPf9vzlN+m4Qn0PDNFKy8ak= text , reference set_encoded_password qF7dDBIf4KkHxSuysLw1EJNSh2Y= text , reference set_encoded_user YNLJGohUXCdL6mo1PM3ms9pRQyE= text , reference set_password blkDquwzHtk7o5mJf/hdeY15zWg= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 set_userinfo boost/url/url_base.hpp include/boost/url/url_base.hpp 475 5 1 function s+5EFNaQxZ6HMzMRElE8AAODpm8= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text The userinfo is set to the given string, which may contain percent-escapes. Any special or reserved characters in the string are automatically percent-encoded. The effects on the user and password depend on the presence of a colon (':') in the string: list paragraph text If an unescaped colon exists, the characters up to the colon become the user and the rest of the characters after the colon become the password. In this case reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text returns true. Otherwise, paragraph text If there is no colon, the user is set to the string. The function reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text returns false. unordered admonition paragraph text The interpretation of the userinfo as individual user and password components is scheme-dependent. Transmitting passwords in URLs is deprecated. note heading text Example 1 code assert( url( "http://example.com" ).set_userinfo( "user:pass" ).encoded_user() == "user" ); heading text Complexity 1 paragraph text Linear in code text this->size() + s.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code userinfo = [ [ user ] [ ':' password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Set the userinfo returns code text *this param text The string to set. s see reference remove_userinfo PjTTglJlJuEwKHuRXGByi7wW8W8= text , reference set_encoded_userinfo MLv0mdC6EhrEgdnFiOF+W8sw0/c= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 set_zone_id boost/url/url_base.hpp include/boost/url/url_base.hpp 1380 5 1 function eM5mUh7EZ/5wyXKQEoMXhHD+KJk= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function sets the zone ID for the host if the host is an IPv6 address. Reserved characters in the string are percent-escaped in the result. heading text Example 1 code assert( u.set_host_ipv6( ipv6_address( "fe80::1" ) ).set_zone_id( "eth0" ).buffer() == "https://[fe80::1%25eth0]" ); heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text Specification 1 list paragraph link text RFC 6874 https://datatracker.ietf.org/doc/html/rfc6874 unordered brief text Set the zone ID for an IPv6 address. returns code text *this param text The zone ID to set. s identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 size boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 201 5 1 function b5EwiMBFGrk0/BIGaiumuCVSoFM= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the number of characters in the url's encoded string, not including any null terminator, if present. heading text Example 1 code assert( url_view( "file:///Program%20Files" ).size() == 23 ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the number of characters in the url returns text The number of characters in the url. identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 1 user boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 848 5 1 function /oa6wZJEG852J9Yi1LQlnq1n1tM= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If present, this function returns a string representing the user (which may be empty). Otherwise it returns an empty string. Any percent-escapes in the string are decoded first. heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).user() == "jane-doe" ); heading text Complexity 1 paragraph text Linear in code text this->user().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code userinfo = user [ ":" [ password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return the user returns text The user as a string. param text The string token to use. token see reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text , reference has_userinfo i/v5Vfq44OnlLbuKgQ2KvgWgZqo= text , reference encoded_password W9oZv0BM5z4XAggQPbNAKIM7/ro= text , reference encoded_user oYwrnXcglhO4tlvhkxLGfFCYbAk= text , reference encoded_userinfo yzkq+uCmbTlXrfDuyd1fT0Zu6xw= text , reference password +ZB55yb2DeVYG+/eYqlMcGcedVE= text , reference userinfo S9yd7MVhXxF+598Xy2/+jwnCZzc= text . identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 userinfo boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 748 5 1 function S9yd7MVhXxF+598Xy2/+jwnCZzc= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If present, this function returns a string representing the userinfo (which may be empty). Otherwise it returns an empty string. Any percent-escapes in the string are decoded first. admonition paragraph text This function uses the string token return type customization. Depending on the token passed, the return type and behavior of the function can be different. See reference string_token::return_string +eBzDECNPyuTkJuxLUTMVIkHGO0= text for more information. note heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).userinfo() == "jane-doe:pass" ); heading text Complexity 1 paragraph text Linear in code text this->userinfo().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code userinfo = user [ ":" [ password ] ] authority = [ userinfo "@" ] host [ ":" port ] heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return the userinfo returns text When called with no arguments, a value of type code text std::string text is returned. Otherwise, the return type and meaning depends on the string token passed to the function. returns text The userinfo as a string. param text The string token to use. token see reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text , reference has_userinfo i/v5Vfq44OnlLbuKgQ2KvgWgZqo= text , reference encoded_password W9oZv0BM5z4XAggQPbNAKIM7/ro= text , reference encoded_user oYwrnXcglhO4tlvhkxLGfFCYbAk= text , reference encoded_userinfo yzkq+uCmbTlXrfDuyd1fT0Zu6xw= text , reference password +ZB55yb2DeVYG+/eYqlMcGcedVE= text , reference user /oa6wZJEG852J9Yi1LQlnq1n1tM= text . identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 zone_id boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1480 5 1 function rN6p9/aLARL9S9gn02k+M+j21q8= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If the host type is reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= text , this function returns the Zone ID as a string. Otherwise an empty string is returned. Any percent-escapes in the string are decoded first. heading text Example 1 code assert( url_view( "http://[fe80::1%25eth0]/" ).zone_id() == "eth0" ); heading text Complexity 1 paragraph text Linear in code text this->encoded_zone_id().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPv6addrz / IPvFuture ) "]" ZoneID = 1*( unreserved / pct-encoded ) IPv6addrz = IPv6address "%25" ZoneID heading text Specification 1 list paragraph link text Representing IPv6 Zone Identifiers in Address Literals and Uniform Resource Identifiers https://datatracker.ietf.org/doc/html/rfc6874 unordered brief text Return the IPv6 Zone ID returns text The Zone ID as a string. param text A string token customization. token identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 operator basic_string_view<char> boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 299 5 1 function 0JOtXYOmKvCl2dNIZYV6J7flgJE= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the URL as a core::string_view returns text A string view of the URL. identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core conversion 1 1 max_size boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 173 5 1 function mg8FRYZ94og9lKYjTEYdjucqHw4= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This represents the largest number of characters that are theoretically possible to represent in a url, not including any null terminator. In practice the actual possible size may be lower than this number. heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the maximum number of characters possible returns text The maximum number of characters. identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 digest boost/url/impl/url_view_base.hpp include/boost/url/impl/url_view_base.hpp 81 1 boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 146 5 1 function aSDB3babl7TsiU0T+gdHMM/NC5c= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function calculates a hash of the url as if it were always normalized. heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Throws nothing. brief text Calculate a hash of the url returns text A hash value suitable for use in hash-based containers. param text An initial value to add to the hash salt identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std salt 0 normal 1 1 url boost/url/url.hpp include/boost/url/url.hpp 63 1 1 record B4dRaSXMG3fDmuNKMW3KOeRu6kA= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text This container owns a url, represented by a null-terminated character buffer which is managed by performing dymamic memory allocations as needed. The contents may be inspected and modified, and the implementation maintains a useful invariant: changes to the url always leave it in a valid state. heading text Exception Safety 1 list paragraph text Functions marked code text noexcept text provide the no-throw guarantee, otherwise: paragraph text Functions which throw offer the strong exception safety guarantee. unordered heading text BNF 1 code URI-reference = URI / relative-ref URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] relative-ref = relative-part [ "?" query ] [ "#" fragment ] absolute-URI = scheme ":" hier-part [ "?" query ] heading text Specification 1 list paragraph link text Uniform Resource Identifier (URI): Generic Syntax (rfc3986) https://tools.ietf.org/html/rfc3986 unordered brief text A modifiable container for a URL. see reference parse_absolute_uri U3CVElRbcTcbg1JzOqhBCd5RSzM= text , reference parse_relative_ref QFzcl8vSLEeKOEO6w3mv1zGqX3k= text , reference parse_uri f+9kR517VGSM5ZPoS7g/RFb0g/0= text , reference parse_uri_reference 7d2b1xVBWJPgL/+PWFdoBaZJvMA= text , reference resolve 3Pi5l1khAbVAQHD3fWi5GoHEr5E= text . reference format LG7Qu14WVkSnLUAFX5+XlzESQwE= reference format WRjsPLk/mxfEVUX/NFq2baquRAU= reference format_to K7ofEKM2bNb4ZS9OFo0DX+7Ep9I= reference format_to ueXaMbO5jFzZWelOn6upDJcN55Y= reference operator!= QA2q/R+XvrJl2j8UnJwv+lnhdDA= reference operator< Si07vh35lnvnJy8tpXUIpiFEjGM= reference operator<= rRCHC/6GEaVZrjzAeFDlvaCydi0= reference operator== E2+0o+/H5dWqJ1IkTzJ6aHTaMHE= reference operator> ngGy21anUjaZiQQJidHT5lvOC2w= reference operator>= AdXFp/RvPKHF4rljfa5/5yBmyfs= reference resolve /6zWjIFN5df0PBj9zFsfNUjNY6s= class identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base pJetbo9l2lg+TIU79YIqZn0EO0k= 8gjwLQiwQO+79ahc+7KjA0ZXvN8= ZIZexDYs4hMSeQfo9DRohKSufAw= v5/R9LI0iKJDiBrNUt7k8qrVBdM= oDNnPxjP34HYhoUyyduWMZfqZs4= OUdGewqojyZZ2vohOsR/ce3sgdM= FPqXKVymUm0eRCsXV1yuMFlv4ug= PMYRGpyOUt7hbDyd33GRHTcxEj8= p+2L2asXUGpE7eey1ouRvFXKD1g= I2WjK21z+iS45kbL4TnzA8O5oE0= 5yR7btLz2K+NLHFnzfXMyGsq2fo= Ww04vLA2k7BwctuyNeP3KwoNr4M= M7+OzewsxChMvecRSytXqTCqKrY= EcGxt+esOtVfjloInubXUYLy5GY= yXsUZRbi+wInLqaUUVy9b7nIIBo= 9ptIMbwWSNtVv+KAUpHCO3bmTWg= 4URKnuP+gvIUVjIkywv/pXeFjv4= wG6ey1727HIj10Wh+OD/s8kuOjo= tDMWbnBabN2mGSH3Apn445gDMEQ= W9oZv0BM5z4XAggQPbNAKIM7/ro= GNlqbV0MSxGIA/gSjlOb2rfSHhU= suU4/MiRITTTYf61BFw2aI6WxdI= yLMNPjiW4s31xcLN4xOiqVySYLA= qeLAK8oZj7+xpHv7Pyh0yYASuqU= IcodRek43l5Zc13Z67L74PlhG0U= oYwrnXcglhO4tlvhkxLGfFCYbAk= yzkq+uCmbTlXrfDuyd1fT0Zu6xw= 5M2smbXDaSa2d/li//A+GmlDgDU= aA1Q9NAW4/TnG3SXhe4k1mNB5nk= gadV3YsYDjlGX+64Rtiz4S+QD4A= ZiWsQaQCAif94KdP6GXH9+F5GmM= 9JACnsebk8tFsoryabfDxE8VpnA= 5V5uOhRsy00O+TSEAkIb7uFoN2U= SLiWca6gUGmTh+r/BbU40NrICW8= iwSH2fvVkb89TkZj7KWLGSyc4sA= i/v5Vfq44OnlLbuKgQ2KvgWgZqo= ICcovOIyqnxhSMU6MuEekYg2z+E= F0RYzLwUP8ied6l3zmKvomgFHag= KL8F3KYxyzpC1e6fqoJy3B8IHhw= CvoRh2IpWg4QixngVwDjSKoeQVY= 55Yh68uToEiKy+IDTpyctuK/T3g= AhPhrC4hmBsZgd/ztqbkAuOkbBM= Nv9Emy6spILLI/mqyIz2uRNBJhU= eh5BeHbLjL3BuEY7ao3tbEAZnTw= uS6MtOtZL4NwRPb31WtogBq7xTA= V/k59YOgEYnss8lWiKPRddPXTrM= 1V2arTLLdHjeX3t8BPS00NhUbuw= yqEPQDxp1rFnCl0FANFNlHq7di4= ewBqUnH0R6CY50UChPClD5/LPh4= yw8gEO2DarlIt76PCQf2ychq86M= wdcIrRY9aj9gn6bF1i59TpOAQb4= +ZB55yb2DeVYG+/eYqlMcGcedVE= Q5NVO+d/+BmZ5v3/ogNb2XpUTKs= cRPG1npIXmfYC0K+C+idxOqIc04= OlWcRIIUl1cq5Ab9fLXGPyhYCfI= lctXu8FITJWg0+Y+yZVt5iv7QDM= 4epyMikskiBx2Gu+S87oAhrM/ZY= uEUUViG9fk8nPLVDhOEq0ZwSt4k= N46BFrejgcAWK9LoZJfnmCFfOQo= m11SsNcuMK9xjCcQTH9YgmTOKU0= 8csn1QWMkOmUIhniJ0RUu0RZwG4= odPyefMzS7RR8SxYOkeOFWrJWCo= lqzeYddpaDdNhabYJKbZcKVR1sc= xoEDWd6f1PiR0V17DuoUOwC8MtA= H68DAna577ehzNnUHjAoRKLb1Lo= R5AajT/eZPgijKrm8AxolAdhsRQ= 3Pi5l1khAbVAQHD3fWi5GoHEr5E= 43fxogaC5oVqfauhwXyN4s4ibEM= uM37WpBqetqzfHjns3M8/+CcoEU= coMz0KQ2BIuACsWbIRZ/6lTOmuk= vE7KhYOtypUWNHBo2RGCbzuduNc= Q/h1CpdR46KA14VnTvzSNYO/Z9M= QqGtJJ8cl1csXN2HqSLBxfqqw8I= 8vNpsCqkIshI8Vwi9MI/QwEbWNE= x6Se85PURXLDVUkc0nIMfry4QWk= 1EkZhuzR+KSDgGVlnI0A/GdR6Fs= d6h7pMb0CVly+yxJA3qTA9oUkyg= tlGS2xlooVieoE1F6taSONIunW8= FfxhA5mBZ2/8cwSUixtcx3WcR/k= FVik3N3tY4odaRANj5Yd7ryYKbM= ZR2L8oYjRtrb4ZxwO002IH7YyPQ= ewkXSEAgojrwUvfKobvwm5kK/0o= l0wVo04A61xkHZCraU8BRdp8FT0= NV17VD5RB4tRGVitD/ItS62klWA= RcbCWApESayzhWcmWzKY7sLRW3I= j1vvfyYzdHeOi3rAip91G6UwdI4= JXOJMhugDCIztmyysqXCpJe4+6Q= FAvM0R9wWtIopo0UEVBu36r+rLs= WX0WCadEsealUT2/UWMRohJ83A8= PXWUIWedy7d9zkfR48y2dfaPVDo= RT+5kxvCEY+rBBTsbgzooRi73rM= 8Nou0ZhJ8DhQBDRFYHX+OQrxd1g= BHDHQef0k/8vd3QskLyTrsv7+DE= ThaNWrwh5iKGzqCX2N+LX3KLHhE= Ap8PBa2tnaS+9s4pC2/HSbsJ2W8= 28viuAEHui7vd0hJTnE+g+nEWPM= l5PbLvVICdt8q5T3JPg6iGiNsQw= rOaH2oJeKO+BU3TB90QiuF0FRCw= bdwdrMSefiuKM7oY4Cga3Q9MJp4= tbHsdn3vwHk6vomi64efnJApwUQ= f8Xcvlga8PU/hVmzDg6ehOPfDYs= b5EwiMBFGrk0/BIGaiumuCVSoFM= iZ1eWw5IAl1ilQ72KPrht00pGzU= /oa6wZJEG852J9Yi1LQlnq1n1tM= S9yd7MVhXxF+598Xy2/+jwnCZzc= rN6p9/aLARL9S9gn02k+M+j21q8= 0JOtXYOmKvCl2dNIZYV6J7flgJE= mg8FRYZ94og9lKYjTEYdjucqHw4= aSDB3babl7TsiU0T+gdHMM/NC5c= 9DAm4036+OM2ZCo8Dglj0CrMA9w= RYHsOybZx+yargF5a1X48GbtRLc= whnmcnKv7dRUjrtNESri1iZ2f9w= gJMHR1tuRhXGsEnAaT7p2essWmM= OYksLx3pWEMUGsN+U67TKJt7xYc= Ud6C94vFacxg1f+zfpZVRydo7QY= r+2jsv/V/6eYTTn9n6oVkgy6U/Y= specialization hash identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std url boost/url/url.hpp include/boost/url/url.hpp 217 5 1 boost/url/url.hpp include/boost/url/url.hpp 120 5 1 boost/url/url.hpp include/boost/url/url.hpp 169 5 1 boost/url/url.hpp include/boost/url/url.hpp 194 5 1 overloads pJetbo9l2lg+TIU79YIqZn0EO0k= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= brief text Constructor param text The url to copy. u param text The string to parse. s throws code text u.size() > max_size() text . reference std::length_error throws text The input does not contain a valid url. reference system_error constructor 8Ih0d9yHn5x6rDTW+0U44b+zHcQ= 9wzWC4EmGwmpV2rTLilCJLj94RA= Eh0hD4ukhWXmI/0dX74NQsJFfzk= AmJe7CtsMMZmoh30mytIyGKwIe8= AWfbGWiWXIba/qYHse33W1kHUnY= identifier void url boost/url/url.hpp include/boost/url/url.hpp 120 5 1 function 8Ih0d9yHn5x6rDTW+0U44b+zHcQ= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text Default constructed urls contain a zero-length string. This matches the grammar for a relative-ref with an empty path and no query or fragment. heading text Example 1 code url u; heading text Postconditions 1 code this->empty() == true heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code relative-ref = relative-part [ "?" query ] [ "#" fragment ] heading text Specification 1 brief text Constructor identifier void constructor 1 url boost/url/url.hpp include/boost/url/url.hpp 243 5 1 function 9wzWC4EmGwmpV2rTLilCJLj94RA= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text The newly constructed object contains a copy of code text u text . heading text Postconditions 1 code this->buffer() == u.buffer() && this->buffer().data() != u.buffer().data() heading text Complexity 1 paragraph text Linear in code text u.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. brief text Constructor param text The url to copy. u throws code text u.size() > max_size() text . reference std::length_error identifier void 1 identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url u constructor 1 url boost/url/url.hpp include/boost/url/url.hpp 194 5 1 function Eh0hD4ukhWXmI/0dX74NQsJFfzk= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text The contents of code text u text are transferred to the newly constructed object, which includes the underlying character buffer. After construction, the moved-from object is as if default constructed. heading text Postconditions 1 code u.empty() == true heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Constructor param text The url to move from. u identifier void identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url u constructor 1 url boost/url/url.hpp include/boost/url/url.hpp 169 5 1 function AmJe7CtsMMZmoh30mytIyGKwIe8= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text This function constructs a URL from the string code text s text , which must contain a valid emph text URI text or emph text relative-ref text or else an exception is thrown. The new url retains ownership by allocating a copy of the passed string. heading text Example 1 code url u( "https://www.example.com" ); heading text Effects 1 code return url( parse_uri_reference( s ).value() ); heading text Postconditions 1 code this->buffer().data() != s.data() heading text Complexity 1 paragraph text Linear in code text s.size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. Exceptions thrown on invalid input. heading text BNF 1 code URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] relative-ref = relative-part [ "?" query ] [ "#" fragment ] heading text Specification 1 list paragraph link text 4.1. URI Reference https://datatracker.ietf.org/doc/html/rfc3986#section-4.1 unordered brief text Constructor param text The string to parse. s throws text The input does not contain a valid url. reference system_error identifier void identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s constructor 1 url boost/url/url.hpp include/boost/url/url.hpp 217 5 1 function AWfbGWiWXIba/qYHse33W1kHUnY= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text The newly constructed object contains a copy of code text u text . heading text Postconditions 1 code this->buffer() == u.buffer() && this->buffer().data() != u.buffer().data() heading text Complexity 1 paragraph text Linear in code text u.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. brief text Constructor param text The url to copy. u throws code text u.size() > max_size() text . reference std::length_error identifier void 1 identifier UEVNhDEjkZMXfjN1DxbtX0n2rCg= url_view_base u constructor 1 ~url boost/url/url.hpp include/boost/url/url.hpp 85 5 1 function 8gjwLQiwQO+79ahc+7KjA0ZXvN8= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text Any params, segments, iterators, or views which reference this object are invalidated. The underlying character buffer is destroyed, invalidating all references to it. brief text Destructor identifier void destructor 1 1 1 operator= boost/url/url.hpp include/boost/url/url.hpp 299 5 1 boost/url/url.hpp include/boost/url/url.hpp 272 5 1 overloads ZIZexDYs4hMSeQfo9DRohKSufAw= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= brief text Assignment returns text A reference to this object. param text The url to copy. u throws code text u.size() > max_size() text . reference std::length_error normal Y4IyJrOqprrb8HaheI5+ycWOhTU= krgrzyss3MdRjIlMP8Ne+a6k3V0= t1NUH4ftJ7Uw9eCFLD3V2tCUmGk= identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url operator= boost/url/url.hpp include/boost/url/url.hpp 329 5 1 function Y4IyJrOqprrb8HaheI5+ycWOhTU= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text The contents of code text u text are copied and the previous contents of code text this text are destroyed. Capacity is preserved, or increases. heading text Postconditions 1 code this->buffer() == u.buffer() && this->buffer().data() != u.buffer().data() heading text Complexity 1 paragraph text Linear in code text u.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. brief text Assignment returns text A reference to this object. param text The url to copy. u identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url 1 identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url u normal 1 operator= boost/url/url.hpp include/boost/url/url.hpp 272 5 1 function krgrzyss3MdRjIlMP8Ne+a6k3V0= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text The contents of code text u text are transferred to code text this text , including the underlying character buffer. The previous contents of code text this text are destroyed. After assignment, the moved-from object is as if default constructed. heading text Postconditions 1 code u.empty() == true heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Assignment returns text A reference to this object. param text The url to assign from. u identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url u normal 1 operator= boost/url/url.hpp include/boost/url/url.hpp 299 5 1 function t1NUH4ftJ7Uw9eCFLD3V2tCUmGk= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text The contents of code text u text are copied and the previous contents of code text this text are destroyed. Capacity is preserved, or increases. heading text Postconditions 1 code this->buffer() == u.buffer() && this->buffer().data() != u.buffer().data() heading text Complexity 1 paragraph text Linear in code text u.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. brief text Assignment returns text A reference to this object. param text The url to copy. u throws code text u.size() > max_size() text . reference std::length_error identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url 1 identifier UEVNhDEjkZMXfjN1DxbtX0n2rCg= url_view_base u normal 1 authority boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 564 5 1 function v5/R9LI0iKJDiBrNUt7k8qrVBdM= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the authority as an reference authority_view d/hMlyyC3Ave6L9McUD7B4TwENA= text . heading text Example 1 code authority_view a = url_view( "https://www.example.com:8080/index.htm" ).authority(); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code authority = [ userinfo "@" ] host [ ":" port ] heading text Specification 1 list paragraph link text 3.2. Authority (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2 unordered brief text Return the authority returns text An authority_view representing the authority. see reference encoded_authority Ww04vLA2k7BwctuyNeP3KwoNr4M= text , reference has_authority gadV3YsYDjlGX+64Rtiz4S+QD4A= text . identifier d/hMlyyC3Ave6L9McUD7B4TwENA= authority_view normal 1 1 buffer boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 282 5 1 function oDNnPxjP34HYhoUyyduWMZfqZs4= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the entire url, which may contain percent escapes. heading text Example 1 code assert( url_view( "http://www.example.com" ).buffer() == "http://www.example.com" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the url string returns text The url as a string. identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core normal 1 1 c_str boost/url/url_base.hpp include/boost/url/url_base.hpp 127 5 1 function OUdGewqojyZZ2vohOsR/ce3sgdM= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function returns a pointer to a null terminated string representing the url, which may contain percent escapes. heading text Example 1 code assert( std::strlen( url( "http://www.example.com" ).c_str() ) == 22 ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the url as a null-terminated string returns text A pointer to a null-terminated string containing the URL. 1 identifier char normal 1 1 capacity boost/url/url_base.hpp include/boost/url/url_base.hpp 146 5 1 function FPqXKVymUm0eRCsXV1yuMFlv4ug= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This does not include the null terminator, which is always present. heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the number of characters that can be stored without reallocating returns code text *this identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 1 clear boost/url/url_base.hpp include/boost/url/url_base.hpp 165 5 1 function PMYRGpyOUt7hbDyd33GRHTcxEj8= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= heading text Postconditions 1 code this->empty() == true heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text No-throw guarantee. brief text Clear the contents while preserving the capacity identifier void normal 1 compare boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2446 5 1 function p+2L2asXUGpE7eey1ouRvFXKD1g= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function compares two URLs according to Syntax-Based comparison algorithm. heading text Complexity 1 paragraph text Linear in code text min( u0.size(), u1.size() ) heading text Exception Safety 1 paragraph text Throws nothing. heading text Specification 1 list paragraph link text 6.2.2 Syntax-Based Normalization (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-6.2.2 unordered brief text Return the result of comparing this with another url returns text -1 if code text *this < other text , 0 if code text this == other text , and 1 if code text this > other text . param text The url to compare other identifier int 1 identifier UEVNhDEjkZMXfjN1DxbtX0n2rCg= url_view_base other normal 1 1 data boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 258 5 1 function I2WjK21z+iS45kbL4TnzA8O5oE0= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns a pointer to the first character of the url, which is not guaranteed to be null-terminated. heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return a pointer to the url's character buffer returns text A pointer to the first character. 1 identifier char normal 1 1 empty boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 238 5 1 function 5yR7btLz2K+NLHFnzfXMyGsq2fo= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text The empty string matches the emph text relative-ref text grammar. heading text Example 1 code assert( url_view( "" ).empty() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code relative-ref = relative-part [ "?" query ] [ "#" fragment ] relative-part = "//" authority path-abempty / path-absolute / path-noscheme / path-empty heading text Specification 1 list paragraph link text 4.2. Relative Reference (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-4.2 unordered brief text Return true if the url is empty returns code text true text if the url is empty. identifier bool normal 1 1 encoded_authority boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 601 5 1 function Ww04vLA2k7BwctuyNeP3KwoNr4M= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If present, this function returns a string representing the authority (which may be empty). Otherwise it returns an empty string. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "file://Network%20Drive/My%2DFiles" ).encoded_authority() == "Network%20Drive" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code authority = [ userinfo "@" ] host [ ":" port ] heading text Specification 1 list paragraph link text 3.2. Authority (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2 unordered brief text Return the authority. returns text The authority as a string. see reference authority v5/R9LI0iKJDiBrNUt7k8qrVBdM= text , reference has_authority gadV3YsYDjlGX+64Rtiz4S+QD4A= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_fragment boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2280 5 1 function M7+OzewsxChMvecRSytXqTCqKrY= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the fragment as a string with percent-escapes. Ownership is not transferred; the string returned references the underlying character buffer, which must remain valid or else undefined behavior occurs. heading text Example 1 code assert( url_view( "http://www.example.com/index.htm#a%2D1" ).encoded_fragment() == "a%2D1" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code fragment = *( pchar / "/" / "?" ) pchar = unreserved / pct-encoded / sub-delims / ":" / "@" heading text Specification 1 list paragraph link text 3.5. Fragment (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.5 unordered brief text Return the fragment returns text The fragment portion of the url. see reference fragment aA1Q9NAW4/TnG3SXhe4k1mNB5nk= text , reference has_fragment ZiWsQaQCAif94KdP6GXH9+F5GmM= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_host boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1120 5 1 function EcGxt+esOtVfjloInubXUYLy5GY= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the host portion of the authority as a string, or the empty string if there is no authority. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "https://www%2droot.example.com/" ).encoded_host() == "www%2droot.example.com" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPvFuture ) "]" reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host returns text The host address as a string. identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_host_address boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1237 5 1 function yXsUZRbi+wInLqaUUVy9b7nIIBo= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text The value returned by this function depends on the type of host returned from the function reference host_type Nv9Emy6spILLI/mqyIz2uRNBJhU= text . list paragraph text If the type is reference host_type::ipv4 49F64dAiji9HVbP6MxLQiqot7AY= text , then the IPv4 address string is returned. paragraph text If the type is reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= text , then the IPv6 address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::ipvfuture TcYJaTwDFsx+0S2CkvHHARcCqWc= text , then the IPvFuture address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= text , then the host name string is returned. Any percent-escapes in the string are decoded first. paragraph text If the type is reference host_type::none QyoMTu07h232/Sxqovu2mGoPgTo= text , then an empty string is returned. The returned string may contain percent escapes. unordered heading text Example 1 code assert( url_view( "https://www%2droot.example.com/" ).encoded_host_address() == "www%2droot.example.com" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPvFuture ) "]" reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host returns text The host address as a string. identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_host_and_port boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2325 5 1 function 9ptIMbwWSNtVv+KAUpHCO3bmTWg= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If an authority is present, this function returns the host and optional port as a string, which may be empty. Otherwise it returns an empty string. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "http://www.example.com:8080/index.htm" ).encoded_host_and_port() == "www.example.com:8080" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code authority = [ userinfo "@" ] host [ ":" port ] heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 paragraph link text 3.2.3. Port (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.3 unordered brief text Return the host and port returns text The host and port portion of the url. see reference has_port 5V5uOhRsy00O+TSEAkIb7uFoN2U= text , reference port OlWcRIIUl1cq5Ab9fLXGPyhYCfI= text , reference port_number lctXu8FITJWg0+Y+yZVt5iv7QDM= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_host_name boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1441 5 1 function 4URKnuP+gvIUVjIkywv/pXeFjv4= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If the host type is reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= text , this function returns the name as a string. Otherwise, if the host type is not an name, it returns an empty string. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "https://www%2droot.example.com/" ).encoded_host_name() == "www%2droot.example.com" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPvFuture ) "]" reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host name returns text The host name as a percent-encoded string. identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_origin boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2355 5 1 function wG6ey1727HIj10Wh+OD/s8kuOjo= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If an authority is present, this function returns the scheme and authority portion of the url. Otherwise, an empty string is returned. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "http://www.example.com:8080/index.htm?text=none#h1" ).encoded_origin() == "http://www.example.com:8080" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the origin returns text The origin portion of the url. see reference encoded_resource yLMNPjiW4s31xcLN4xOiqVySYLA= text , reference encoded_target IcodRek43l5Zc13Z67L74PlhG0U= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_params boost/url/url_base.hpp include/boost/url/url_base.hpp 2248 5 1 boost/url/url_base.hpp include/boost/url/url_base.hpp 2300 5 1 overloads tDMWbnBabN2mGSH3Apn445gDMEQ= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= brief text Return the query as a container of parameters returns code text *this returns text A bidirectional view of key/value pairs. see reference params wdcIrRY9aj9gn6bF1i59TpOAQb4= text , reference remove_query ZZWEzCK7DguUxc3TvUfizoGKplE= text , reference set_encoded_query QcQ13DUh8M8TR/zj/LDG3N/+i3c= text , reference set_query 99/QTSBQGLrNj3zGdw5VzYlqfnI= text . see reference encoded_query suU4/MiRITTTYf61BFw2aI6WxdI= text , reference has_query SLiWca6gUGmTh+r/BbU40NrICW8= text , reference params wdcIrRY9aj9gn6bF1i59TpOAQb4= text , reference query 4epyMikskiBx2Gu+S87oAhrM/ZY= text . normal aMmTh8VyfWGYracYniHLsug6OhI= JE/K4m/Ht4rR+eX6GaLeumryMhM= encoded_params boost/url/url_base.hpp include/boost/url/url_base.hpp 2300 5 1 function aMmTh8VyfWGYracYniHLsug6OhI= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function returns a bidirectional view of key/value pairs over the query. The returned view references the same underlying character buffer; ownership is not transferred. Strings returned when iterating the range may contain percent escapes. The container is modifiable; changes to the container are reflected in the underlying URL. heading text Example 1 code params_encoded_ref pv = url( "/sql?id=42&name=jane%2Ddoe&page+size=20" ).encoded_params(); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Return the query as a container of parameters returns code text *this see reference params wdcIrRY9aj9gn6bF1i59TpOAQb4= text , reference remove_query ZZWEzCK7DguUxc3TvUfizoGKplE= text , reference set_encoded_query QcQ13DUh8M8TR/zj/LDG3N/+i3c= text , reference set_query 99/QTSBQGLrNj3zGdw5VzYlqfnI= text . identifier oR5B5D0/JYTOQYvyFXRv+at91JE= params_encoded_ref normal 1 encoded_params boost/url/url_base.hpp include/boost/url/url_base.hpp 2248 5 1 function JE/K4m/Ht4rR+eX6GaLeumryMhM= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function returns a bidirectional view of key/value pairs over the query. The returned view references the same underlying character buffer; ownership is not transferred. Strings returned when iterating the range may contain percent escapes. heading text Example 1 code params_encoded_view pv = url_view( "/sql?id=42&name=jane%2Ddoe&page+size=20" ).encoded_params(); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Return the query as a container of parameters url_view_base::encoded_params returns text A bidirectional view of key/value pairs. see reference encoded_query suU4/MiRITTTYf61BFw2aI6WxdI= text , reference has_query SLiWca6gUGmTh+r/BbU40NrICW8= text , reference params wdcIrRY9aj9gn6bF1i59TpOAQb4= text , reference query 4epyMikskiBx2Gu+S87oAhrM/ZY= text . identifier 0nSfM4mK92fIx58KtzdWGiHuq2w= params_encoded_view normal 1 1 encoded_password boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 996 5 1 function W9oZv0BM5z4XAggQPbNAKIM7/ro= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the password portion of the userinfo as a percent-encoded string. heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).encoded_password() == "pass" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code userinfo = user [ ":" [ password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return the password returns text The password as a string. see reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text , reference has_userinfo i/v5Vfq44OnlLbuKgQ2KvgWgZqo= text , reference encoded_user oYwrnXcglhO4tlvhkxLGfFCYbAk= text , reference encoded_userinfo yzkq+uCmbTlXrfDuyd1fT0Zu6xw= text , reference password +ZB55yb2DeVYG+/eYqlMcGcedVE= text , reference user /oa6wZJEG852J9Yi1LQlnq1n1tM= text , reference userinfo S9yd7MVhXxF+598Xy2/+jwnCZzc= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_path boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1799 5 1 function GNlqbV0MSxGIA/gSjlOb2rfSHhU= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the path as a string. The path may be empty. Any percent-escapes in the string are decoded first. heading text Example 1 code assert( url_view( "file:///Program%20Files/Games/config.ini" ).encoded_path() == "/Program%20Files/Games/config.ini" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code path = path-abempty ; begins with "/" or is empty / path-absolute ; begins with "/" but not "//" / path-noscheme ; begins with a non-colon segment / path-rootless ; begins with a segment / path-empty ; zero characters path-abempty = *( "/" segment ) path-absolute = "/" [ segment-nz *( "/" segment ) ] path-noscheme = segment-nz-nc *( "/" segment ) path-rootless = segment-nz *( "/" segment ) path-empty = 0<pchar> heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text Return the path returns text The path as a string. see reference is_path_absolute eh5BeHbLjL3BuEY7ao3tbEAZnTw= text , reference encoded_segments xDk467Vs74WMTJdzZiv8izTuGQo= text . reference path Q5NVO+d/+BmZ5v3/ogNb2XpUTKs= text , reference segments txoybJuonJpAdGVWgiAsiI45+ok= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_query boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2040 5 1 function suU4/MiRITTTYf61BFw2aI6WxdI= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If this contains a query, it is returned as a string (which may be empty). Otherwise, an empty string is returned. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "/sql?id=42&name=jane%2Ddoe&page+size=20" ).encoded_query() == "id=42&name=jane%2Ddoe&page+size=20" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Return the query returns text The query as a string. see reference encoded_params YdRpQ6mNNA/rw8PqzTxP08VgNnY= text , reference has_query SLiWca6gUGmTh+r/BbU40NrICW8= text , reference params ZdlRIJ+RVbaF05I+w1pfQzUA0/0= text , reference query 4epyMikskiBx2Gu+S87oAhrM/ZY= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_resource boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2387 5 1 function yLMNPjiW4s31xcLN4xOiqVySYLA= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the resource, which is the portion of the url that includes only the path, query, and fragment. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "http://www.example.com/index.html?query#frag" ).encoded_resource() == "/index.html?query#frag" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 unordered brief text Return the resource returns text The resource portion of the url. see reference encoded_origin wG6ey1727HIj10Wh+OD/s8kuOjo= text , reference encoded_target IcodRek43l5Zc13Z67L74PlhG0U= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_segments boost/url/url_base.hpp include/boost/url/url_base.hpp 2018 5 1 boost/url/url_base.hpp include/boost/url/url_base.hpp 2014 5 1 overloads qeLAK8oZj7+xpHv7Pyh0yYASuqU= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= brief text Return the path as a container of segments returns code text *this returns text A bidirectional view of encoded segments. see reference encoded_segments 6FgVEvfQ0X7vaJ9TLmk6h3MBVPU= text , reference set_encoded_path GQGd+Ne+D3eTy4fe+x1cpa5zefU= text , reference set_path 0VMn4mT6ruiabbTCXyOFe+JATBg= text , reference set_path_absolute BHDHQef0k/8vd3QskLyTrsv7+DE= text . see reference is_path_absolute eh5BeHbLjL3BuEY7ao3tbEAZnTw= text , reference encoded_path GNlqbV0MSxGIA/gSjlOb2rfSHhU= text , reference path Q5NVO+d/+BmZ5v3/ogNb2XpUTKs= text , reference segments coMz0KQ2BIuACsWbIRZ/6lTOmuk= text , reference segments_encoded_view EvaX3SmNTAtai2Kf6Kma3fUkTkQ= text . normal 6FgVEvfQ0X7vaJ9TLmk6h3MBVPU= 5da2HmyZRkzKje3uZJyQ0Zr/GBI= encoded_segments boost/url/url_base.hpp include/boost/url/url_base.hpp 2014 5 1 function 6FgVEvfQ0X7vaJ9TLmk6h3MBVPU= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function returns a bidirectional view of segments over the path. The returned view references the same underlying character buffer; ownership is not transferred. Strings returned when iterating the range may contain percent escapes. The container is modifiable; changes to the container are reflected in the underlying URL. heading text Example 1 code url u( "http://example.com/path/to/file.txt" ); segments_encoded_ref sv = u.encoded_segments(); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code path = path-abempty ; begins with "/" or is empty / path-absolute ; begins with "/" but not "//" / path-noscheme ; begins with a non-colon segment / path-rootless ; begins with a segment / path-empty ; zero characters path-abempty = *( "/" segment ) path-absolute = "/" [ segment-nz *( "/" segment ) ] path-noscheme = segment-nz-nc *( "/" segment ) path-rootless = segment-nz *( "/" segment ) path-empty = 0<pchar> heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text Return the path as a container of segments returns code text *this see reference encoded_segments qeLAK8oZj7+xpHv7Pyh0yYASuqU= text , reference set_encoded_path GQGd+Ne+D3eTy4fe+x1cpa5zefU= text , reference set_path 0VMn4mT6ruiabbTCXyOFe+JATBg= text , reference set_path_absolute BHDHQef0k/8vd3QskLyTrsv7+DE= text . identifier TCUUfRiqZjX62kt7tK2fs//VWr0= segments_encoded_ref normal 1 encoded_segments boost/url/url_base.hpp include/boost/url/url_base.hpp 2018 5 1 function 5da2HmyZRkzKje3uZJyQ0Zr/GBI= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function returns a bidirectional view of strings over the path. The returned view references the same underlying character buffer; ownership is not transferred. Strings returned when iterating the range may contain percent escapes. heading text Example 1 code segments_encoded_view sv = url_view( "/path/to/file.txt" ).encoded_segments(); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code path = path-abempty ; begins with "/" or is empty / path-absolute ; begins with "/" but not "//" / path-noscheme ; begins with a non-colon segment / path-rootless ; begins with a segment / path-empty ; zero characters path-abempty = *( "/" segment ) path-absolute = "/" [ segment-nz *( "/" segment ) ] path-noscheme = segment-nz-nc *( "/" segment ) path-rootless = segment-nz *( "/" segment ) path-empty = 0<pchar> heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text Return the path as a container of segments url_view_base::encoded_segments returns text A bidirectional view of encoded segments. see reference is_path_absolute eh5BeHbLjL3BuEY7ao3tbEAZnTw= text , reference encoded_path GNlqbV0MSxGIA/gSjlOb2rfSHhU= text , reference path Q5NVO+d/+BmZ5v3/ogNb2XpUTKs= text , reference segments coMz0KQ2BIuACsWbIRZ/6lTOmuk= text , reference segments_encoded_view EvaX3SmNTAtai2Kf6Kma3fUkTkQ= text . identifier EvaX3SmNTAtai2Kf6Kma3fUkTkQ= segments_encoded_view normal 1 1 encoded_target boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2419 5 1 function IcodRek43l5Zc13Z67L74PlhG0U= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the target, which is the portion of the url that includes only the path and query. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "http://www.example.com/index.html?query#frag" ).encoded_target() == "/index.html?query" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 unordered brief text Return the target returns text The target portion of the url. see reference encoded_origin wG6ey1727HIj10Wh+OD/s8kuOjo= text , reference encoded_resource yLMNPjiW4s31xcLN4xOiqVySYLA= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_user boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 901 5 1 function oYwrnXcglhO4tlvhkxLGfFCYbAk= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If present, this function returns a string representing the user (which may be empty). Otherwise it returns an empty string. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).encoded_user() == "jane%2Ddoe" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code userinfo = user [ ":" [ password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return the user returns text The user as a string. see reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text , reference has_userinfo i/v5Vfq44OnlLbuKgQ2KvgWgZqo= text , reference encoded_password W9oZv0BM5z4XAggQPbNAKIM7/ro= text , reference encoded_userinfo yzkq+uCmbTlXrfDuyd1fT0Zu6xw= text , reference password +ZB55yb2DeVYG+/eYqlMcGcedVE= text , reference user /oa6wZJEG852J9Yi1LQlnq1n1tM= text , reference userinfo S9yd7MVhXxF+598Xy2/+jwnCZzc= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_userinfo boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 800 5 1 function yzkq+uCmbTlXrfDuyd1fT0Zu6xw= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If present, this function returns a string representing the userinfo (which may be empty). Otherwise it returns an empty string. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).encoded_userinfo() == "jane%2Ddoe:pass" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing heading text BNF 1 code userinfo = user [ ":" [ password ] ] authority = [ userinfo "@" ] host [ ":" port ] heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return the userinfo returns text The userinfo as a string. see reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text , reference has_userinfo i/v5Vfq44OnlLbuKgQ2KvgWgZqo= text , reference encoded_password W9oZv0BM5z4XAggQPbNAKIM7/ro= text , reference encoded_user oYwrnXcglhO4tlvhkxLGfFCYbAk= text , reference password +ZB55yb2DeVYG+/eYqlMcGcedVE= text , reference user /oa6wZJEG852J9Yi1LQlnq1n1tM= text , reference userinfo S9yd7MVhXxF+598Xy2/+jwnCZzc= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_zone_id boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1526 5 1 function 5M2smbXDaSa2d/li//A+GmlDgDU= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If the host type is reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= text , this function returns the Zone ID as a string. Otherwise an empty string is returned. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "http://[fe80::1%25eth0]/" ).encoded_zone_id() == "eth0" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPv6addrz / IPvFuture ) "]" ZoneID = 1*( unreserved / pct-encoded ) IPv6addrz = IPv6address "%25" ZoneID heading text Specification 1 list paragraph link text Representing IPv6 Zone Identifiers in Address Literals and Uniform Resource Identifiers https://datatracker.ietf.org/doc/html/rfc6874 unordered brief text Return the IPv6 Zone ID returns text The Zone ID as a percent-encoded string. identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 fragment boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2233 5 1 function aA1Q9NAW4/TnG3SXhe4k1mNB5nk= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function calculates the fragment of the url, with percent escapes decoded and without the leading pound sign ('#') whose presence indicates that the url contains a fragment. paragraph text This function accepts an optional emph text StringToken text parameter which controls the return type and behavior of the function: list paragraph text When called with no arguments, the return type of the function is code text std::string text . Otherwise paragraph text When called with a string token, the behavior and return type of the function depends on the type of string token being passed. unordered heading text Example 1 code assert( url_view( "http://www.example.com/index.htm#a%2D1" ).fragment() == "a-1" ); heading text Complexity 1 paragraph text Linear in code text this->fragment().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. String tokens may throw exceptions. heading text BNF 1 code fragment = *( pchar / "/" / "?" ) fragment-part = [ "#" fragment ] heading text Specification 1 list paragraph link text 3.5. Fragment (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.5 unordered brief text Return the fragment returns text The fragment portion of the url. param text An optional string token to use. If this parameter is omitted, the function returns a new code text std::string text . token see reference encoded_fragment M7+OzewsxChMvecRSytXqTCqKrY= text , reference has_fragment ZiWsQaQCAif94KdP6GXH9+F5GmM= text . identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 has_authority boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 528 5 1 function gadV3YsYDjlGX+64Rtiz4S+QD4A= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns true if the url contains an authority. The presence of an authority is denoted by a double slash ("//") at the beginning or after the scheme. heading text Example 1 code assert( url_view( "http://www.example.com/index.htm" ).has_authority() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code authority = [ userinfo "@" ] host [ ":" port ] URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] absolute-URI = scheme ":" hier-part [ "?" query ] URI-reference = URI / relative-ref relative-ref = relative-part [ "?" query ] [ "#" fragment ] hier-part = "//" authority path-abempty ; (more...) relative-part = "//" authority path-abempty ; (more...) heading text Specification 1 list paragraph link text 3.2. Authority (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2 unordered brief text Return true if an authority is present returns code text true text if the url contains an authority. see reference authority v5/R9LI0iKJDiBrNUt7k8qrVBdM= text , reference encoded_authority Ww04vLA2k7BwctuyNeP3KwoNr4M= text . identifier bool normal 1 1 has_fragment boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2173 5 1 function ZiWsQaQCAif94KdP6GXH9+F5GmM= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns true if the url contains a fragment. An empty fragment is distinct from no fragment. heading text Example 1 code assert( url_view( "http://www.example.com/index.htm#anchor" ).has_fragment() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] relative-ref = relative-part [ "?" query ] [ "#" fragment ] heading text Specification 1 list paragraph link text 3.5. Fragment (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.5 unordered brief text Return true if a fragment is present returns code text true text if the url contains a fragment. see reference encoded_fragment M7+OzewsxChMvecRSytXqTCqKrY= text , reference fragment aA1Q9NAW4/TnG3SXhe4k1mNB5nk= text . identifier bool normal 1 1 has_password boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 689 5 1 function 9JACnsebk8tFsoryabfDxE8VpnA= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns true if the userinfo is present and contains a password. heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).has_password() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code userinfo = user [ ":" [ password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return true if a password is present returns code text true text if the userinfo contains a password. see reference has_userinfo i/v5Vfq44OnlLbuKgQ2KvgWgZqo= text , reference encoded_password W9oZv0BM5z4XAggQPbNAKIM7/ro= text , reference encoded_user oYwrnXcglhO4tlvhkxLGfFCYbAk= text , reference encoded_userinfo yzkq+uCmbTlXrfDuyd1fT0Zu6xw= text , reference password +ZB55yb2DeVYG+/eYqlMcGcedVE= text , reference user /oa6wZJEG852J9Yi1LQlnq1n1tM= text , reference userinfo S9yd7MVhXxF+598Xy2/+jwnCZzc= text . identifier bool normal 1 1 has_port boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1568 5 1 function 5V5uOhRsy00O+TSEAkIb7uFoN2U= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns true if an authority is present and contains a port. heading text Example 1 code assert( url_view( "wss://www.example.com:443" ).has_port() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code authority = [ userinfo "@" ] host [ ":" port ] port = *DIGIT heading text Specification 1 list paragraph link text 3.2.3. Port (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.3 unordered brief text Return true if a port is present returns code text true text if a port is present, code text false text otherwise. see reference encoded_host_and_port 9ptIMbwWSNtVv+KAUpHCO3bmTWg= text , reference port OlWcRIIUl1cq5Ab9fLXGPyhYCfI= text , reference port_number lctXu8FITJWg0+Y+yZVt5iv7QDM= text . identifier bool normal 1 1 has_query boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1937 5 1 function SLiWca6gUGmTh+r/BbU40NrICW8= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns true if this contains a query. An empty query is distinct from having no query. heading text Example 1 code assert( url_view( "/sql?id=42&col=name&page-size=20" ).has_query() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Return true if a query is present returns code text true text if a query is present. see reference encoded_params YdRpQ6mNNA/rw8PqzTxP08VgNnY= text , reference encoded_query suU4/MiRITTTYf61BFw2aI6WxdI= text , reference params ZdlRIJ+RVbaF05I+w1pfQzUA0/0= text , reference query 4epyMikskiBx2Gu+S87oAhrM/ZY= text . identifier bool normal 1 1 has_scheme boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 384 5 1 function iwSH2fvVkb89TkZj7KWLGSyc4sA= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns true if this contains a scheme. heading text Example 1 code assert( url_view( "http://www.example.com" ).has_scheme() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] absolute-URI = scheme ":" hier-part [ "?" query ] scheme = ALPHA *( ALPHA / DIGIT / "+" / "-" / "." ) heading text Specification 1 list paragraph link text 3.1. Scheme (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.1 unordered brief text Return true a scheme is present returns code text true text if the url contains a scheme. see reference scheme 43fxogaC5oVqfauhwXyN4s4ibEM= text , reference scheme_id uM37WpBqetqzfHjns3M8/+CcoEU= text . identifier bool normal 1 1 has_userinfo boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 647 5 1 function i/v5Vfq44OnlLbuKgQ2KvgWgZqo= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns true if this contains a userinfo. heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).has_userinfo() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code userinfo = user [ ":" [ password ] ] authority = [ userinfo "@" ] host [ ":" port ] heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return true if a userinfo is present returns code text true text if the userinfo is present. see reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text , reference encoded_password W9oZv0BM5z4XAggQPbNAKIM7/ro= text , reference encoded_user oYwrnXcglhO4tlvhkxLGfFCYbAk= text , reference encoded_userinfo yzkq+uCmbTlXrfDuyd1fT0Zu6xw= text , reference password +ZB55yb2DeVYG+/eYqlMcGcedVE= text , reference user /oa6wZJEG852J9Yi1LQlnq1n1tM= text , reference userinfo S9yd7MVhXxF+598Xy2/+jwnCZzc= text . identifier bool normal 1 1 host boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1076 5 1 function ICcovOIyqnxhSMU6MuEekYg2z+E= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the host portion of the authority as a string, or the empty string if there is no authority. Any percent-escapes in the string are decoded first. heading text Example 1 code assert( url_view( "https://www%2droot.example.com/" ).host() == "www-root.example.com" ); heading text Complexity 1 paragraph text Linear in code text this->host().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPvFuture ) "]" reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host returns text The host address as a string. param text A string token customization token identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 host_address boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1174 5 1 function F0RYzLwUP8ied6l3zmKvomgFHag= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text The value returned by this function depends on the type of host returned from the function reference host_type Nv9Emy6spILLI/mqyIz2uRNBJhU= text . list paragraph text If the type is reference host_type::ipv4 49F64dAiji9HVbP6MxLQiqot7AY= text , then the IPv4 address string is returned. paragraph text If the type is reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= text , then the IPv6 address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::ipvfuture TcYJaTwDFsx+0S2CkvHHARcCqWc= text , then the IPvFuture address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= text , then the host name string is returned. Any percent-escapes in the string are decoded first. paragraph text If the type is reference host_type::none QyoMTu07h232/Sxqovu2mGoPgTo= text , then an empty string is returned. unordered heading text Example 1 code assert( url_view( "https://[1::6:c0a8:1]/" ).host_address() == "1::6:c0a8:1" ); heading text Complexity 1 paragraph text Linear in code text this->host_address().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPvFuture ) "]" reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host returns text The host address as a string. param text A string token customization token identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 host_ipv4_address boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1277 5 1 function KL8F3KYxyzpC1e6fqoJy3B8IHhw= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If the host type is reference host_type::ipv4 49F64dAiji9HVbP6MxLQiqot7AY= text , this function returns the address as a value of type reference ipv4_address /Wpp3ZZDp3kUHzbULeDoaOEhnVs= text . Otherwise, if the host type is not an IPv4 address, it returns a default-constructed value which is equal to the unspecified address "0.0.0.0". heading text Example 1 code assert( url_view( "http://127.0.0.1/index.htm?user=win95" ).host_ipv4_address() == ipv4_address( "127.0.0.1" ) ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code IPv4address = dec-octet "." dec-octet "." dec-octet "." dec-octet dec-octet = DIGIT ; 0-9 / %x31-39 DIGIT ; 10-99 / "1" 2DIGIT ; 100-199 / "2" %x30-34 DIGIT ; 200-249 / "25" %x30-35 ; 250-255 heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host IPv4 address returns text The IPv4 address as a value of type reference ipv4_address /Wpp3ZZDp3kUHzbULeDoaOEhnVs= text . identifier /Wpp3ZZDp3kUHzbULeDoaOEhnVs= ipv4_address normal 1 1 host_ipv6_address boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1325 5 1 function CvoRh2IpWg4QixngVwDjSKoeQVY= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If the host type is reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= text , this function returns the address as a value of type reference ipv6_address dhMSRVBIIIItY0URHSc8rwHcdTQ= text . Otherwise, if the host type is not an IPv6 address, it returns a default-constructed value which is equal to the unspecified address "0:0:0:0:0:0:0:0". heading text Example 1 code assert( url_view( "ftp://[::1]/" ).host_ipv6_address() == ipv6_address( "::1" ) ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code IPv6address = 6( h16 ":" ) ls32 / "::" 5( h16 ":" ) ls32 / [ h16 ] "::" 4( h16 ":" ) ls32 / [ *1( h16 ":" ) h16 ] "::" 3( h16 ":" ) ls32 / [ *2( h16 ":" ) h16 ] "::" 2( h16 ":" ) ls32 / [ *3( h16 ":" ) h16 ] "::" h16 ":" ls32 / [ *4( h16 ":" ) h16 ] "::" ls32 / [ *5( h16 ":" ) h16 ] "::" h16 / [ *6( h16 ":" ) h16 ] "::" ls32 = ( h16 ":" h16 ) / IPv4address ; least-significant 32 bits of address h16 = 1*4HEXDIG ; 16 bits of address represented in hexadecimal heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host IPv6 address returns text The IPv6 address as a value of type reference ipv6_address dhMSRVBIIIItY0URHSc8rwHcdTQ= text . identifier dhMSRVBIIIItY0URHSc8rwHcdTQ= ipv6_address normal 1 1 host_ipvfuture boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1358 5 1 function 55Yh68uToEiKy+IDTpyctuK/T3g= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If the host type is reference host_type::ipvfuture TcYJaTwDFsx+0S2CkvHHARcCqWc= text , this function returns the address as a string. Otherwise, if the host type is not an IPvFuture address, it returns an empty string. heading text Example 1 code assert( url_view( "http://[v1fe.d:9]/index.htm" ).host_ipvfuture() == "v1fe.d:9" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code IPvFuture = "v" 1*HEXDIG "." 1*( unreserved / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host IPvFuture address returns text The IPvFuture address as a string. identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core normal 1 1 host_name boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1395 5 1 function AhPhrC4hmBsZgd/ztqbkAuOkbBM= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If the host type is reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= text , this function returns the name as a string. Otherwise an empty string is returned. Any percent-escapes in the string are decoded first. heading text Example 1 code assert( url_view( "https://www%2droot.example.com/" ).host_name() == "www-root.example.com" ); heading text Complexity 1 paragraph text Linear in code text this->host_name().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPvFuture ) "]" reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host name returns text The host name as a string. param text A string token customization. token identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 host_type boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1036 5 1 function Nv9Emy6spILLI/mqyIz2uRNBJhU= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns one of the following constants representing the type of host present. list paragraph reference host_type::ipv4 49F64dAiji9HVbP6MxLQiqot7AY= paragraph reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= paragraph reference host_type::ipvfuture TcYJaTwDFsx+0S2CkvHHARcCqWc= paragraph reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= paragraph reference host_type::none QyoMTu07h232/Sxqovu2mGoPgTo= unordered paragraph text When reference has_authority gadV3YsYDjlGX+64Rtiz4S+QD4A= text is false, the host type is reference host_type::none QyoMTu07h232/Sxqovu2mGoPgTo= text . heading text Example 1 code assert( url_view( "https://192.168.0.1/local.htm" ).host_type() == host_type::ipv4 ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host type returns text The type of host present. identifier YLHFVyAYZGSFQe18DPGjn6XsAMs= host_type identifier dnk5XPfR2OaMpCYaH3cWSxcTdyc= urls normal 1 1 is_path_absolute boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1691 5 1 function eh5BeHbLjL3BuEY7ao3tbEAZnTw= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns true if the path begins with a forward slash ('/'). heading text Example 1 code assert( url_view( "/path/to/file.txt" ).is_path_absolute() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code path = path-abempty ; begins with "/" or is empty / path-absolute ; begins with "/" but not "//" / path-noscheme ; begins with a non-colon segment / path-rootless ; begins with a segment / path-empty ; zero characters path-abempty = *( "/" segment ) path-absolute = "/" [ segment-nz *( "/" segment ) ] path-noscheme = segment-nz-nc *( "/" segment ) path-rootless = segment-nz *( "/" segment ) path-empty = 0<pchar> heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text Return true if the path is absolute returns code text true text if the path is absolute, code text false text otherwise. see reference encoded_path GNlqbV0MSxGIA/gSjlOb2rfSHhU= text , reference encoded_segments xDk467Vs74WMTJdzZiv8izTuGQo= text . reference path Q5NVO+d/+BmZ5v3/ogNb2XpUTKs= text , reference segments txoybJuonJpAdGVWgiAsiI45+ok= text . identifier bool normal 1 1 normalize boost/url/url.hpp include/boost/url/url.hpp 499 5 1 function uS6MtOtZL4NwRPb31WtogBq7xTA= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text Applies Syntax-based normalization to all components of the URL. paragraph text The scheme is normalized to lowercase. code assert( url( "HTTP://www.example.com" ).normalize().buffer() == "http://www.example.com" ); paragraph text The host is normalized to lowercase. Percent-encoding triplets are normalized to uppercase letters. Percent-encoded octets that correspond to unreserved characters are decoded. code assert( url( "http://www.Example.com" ).normalize().buffer() == "http://www.example.com" ); assert( url( "http://www.%65xample.com" ).normalize().buffer() == "http://www.example.com" ); paragraph text Percent-encoding triplets in the path are normalized to uppercase letters. Percent-encoded octets that correspond to unreserved characters are decoded. Redundant path-segments "." and ".." are removed. code assert( url( "http://www.example.com/a/b/../c" ).normalize().buffer() == "http://www.example.com/a/c" ); assert( url( "http://www.example.com/a/./b" ).normalize().buffer() == "http://www.example.com/a/b" ); assert( url( "http://www.example.com/%63ss" ).normalize().buffer() == "http://www.example.com/css" ); paragraph text Percent-encoding triplets in the query are normalized to uppercase letters. Percent-encoded octets that correspond to unreserved characters are decoded. code assert( url( "http://www.example.com?a=%62" ).normalize().buffer() == "http://www.example.com?a=b" ); paragraph text Percent-encoding triplets in the fragment are normalized to uppercase letters. Percent-encoded octets that correspond to unreserved characters are decoded. code assert( url( "http://www.example.com#%61bc" ).normalize().buffer() == "http://www.example.com#abc" ); paragraph text Applying normalization to a URL with all components percent-encoded: code assert( url( "HTTP://www.Example.com/%70ath?%71uery#%66rag" ).normalize().buffer() == "http://www.example.com/path?query#frag" ); heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text Specification 1 list paragraph link text 6.2.2 Syntax-Based Normalization (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-6.2.2 unordered brief text Normalize the URL components url_base::normalize returns code text *this see reference normalize_scheme yw8gEO2DarlIt76PCQf2ychq86M= text , reference normalize_authority V/k59YOgEYnss8lWiKPRddPXTrM= text , reference normalize_path yqEPQDxp1rFnCl0FANFNlHq7di4= text , reference normalize_query ewBqUnH0R6CY50UChPClD5/LPh4= text , reference normalize_fragment 1V2arTLLdHjeX3t8BPS00NhUbuw= identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url normal 1 normalize_authority boost/url/url.hpp include/boost/url/url.hpp 503 5 1 function V/k59YOgEYnss8lWiKPRddPXTrM= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text Applies Syntax-based normalization to the URL authority. paragraph text The host is normalized to lowercase. Percent-encoding triplets are normalized to uppercase letters. Percent-encoded octets that correspond to unreserved characters are decoded. code assert( url( "http://www.Example.com" ).normalize_authority().buffer() == "http://www.example.com" ); assert( url( "http://www.%65xample.com" ).normalize_authority().buffer() == "http://www.example.com" ); heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text Specification 1 list paragraph link text 6.2.2 Syntax-Based Normalization (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-6.2.2 unordered brief text Normalize the URL authority url_base::normalize_authority returns code text *this identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url normal 1 normalize_fragment boost/url/url.hpp include/boost/url/url.hpp 509 5 1 function 1V2arTLLdHjeX3t8BPS00NhUbuw= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text Applies Syntax-based normalization to the URL fragment. paragraph text Percent-encoding triplets are normalized to uppercase letters. Percent-encoded octets that correspond to unreserved characters are decoded. code assert( url( "http://www.example.com#%61bc" ).normalize_fragment().buffer() == "http://www.example.com#abc" ); heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text Specification 1 list paragraph link text 6.2.2 Syntax-Based Normalization (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-6.2.2 unordered brief text Normalize the URL fragment url_base::normalize_fragment returns code text *this identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url normal 1 normalize_path boost/url/url.hpp include/boost/url/url.hpp 505 5 1 function yqEPQDxp1rFnCl0FANFNlHq7di4= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text Applies Syntax-based normalization to the URL path. paragraph text Percent-encoding triplets are normalized to uppercase letters. Percent-encoded octets that correspond to unreserved characters are decoded. Redundant path-segments "." and ".." are removed. code assert( url( "http://www.example.com/a/b/../c" ).normalize_path().buffer() == "http://www.example.com/a/c" ); assert( url( "http://www.example.com/a/./b" ).normalize_path().buffer() == "http://www.example.com/a/b" ); assert( url( "http://www.example.com/%63ss" ).normalize_path().buffer() == "http://www.example.com/css" ); heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text Specification 1 list paragraph link text 6.2.2 Syntax-Based Normalization (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-6.2.2 unordered brief text Normalize the URL path url_base::normalize_path returns code text *this identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url normal 1 normalize_query boost/url/url.hpp include/boost/url/url.hpp 507 5 1 function ewBqUnH0R6CY50UChPClD5/LPh4= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text Applies Syntax-based normalization to the URL query. paragraph text Percent-encoding triplets are normalized to uppercase letters. Percent-encoded octets that correspond to unreserved characters are decoded. code assert( url( "http://www.example.com?a=%62" ).normalize_query().buffer() == "http://www.example.com?a=b" ); heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text Specification 1 list paragraph link text 6.2.2 Syntax-Based Normalization (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-6.2.2 unordered brief text Normalize the URL query url_base::normalize_query returns code text *this identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url normal 1 normalize_scheme boost/url/url.hpp include/boost/url/url.hpp 501 5 1 function yw8gEO2DarlIt76PCQf2ychq86M= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text Applies Syntax-based normalization to the URL scheme. paragraph text The scheme is normalized to lowercase. code assert( url( "HTTP://www.example.com" ).normalize_scheme().buffer() == "http://www.example.com" ); heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text Specification 1 list paragraph link text 6.2.2 Syntax-Based Normalization (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-6.2.2 unordered brief text Normalize the URL scheme url_base::normalize_scheme returns code text *this identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url normal 1 params boost/url/url_base.hpp include/boost/url/url_base.hpp 2186 5 1 boost/url/url_base.hpp include/boost/url/url_base.hpp 2182 5 1 boost/url/url_base.hpp include/boost/url/url_base.hpp 2244 5 1 boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2087 5 overloads wdcIrRY9aj9gn6bF1i59TpOAQb4= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= brief text Return the query as a container of parameters returns code text *this returns text A bidirectional view of key/value pairs. returns text A range of references to the parameters. param text The options for decoding. If this parameter is omitted, the code text space_as_plus text is used. opt see reference encoded_params tDMWbnBabN2mGSH3Apn445gDMEQ= text , reference remove_query ZZWEzCK7DguUxc3TvUfizoGKplE= text , reference set_encoded_query QcQ13DUh8M8TR/zj/LDG3N/+i3c= text , reference set_query 99/QTSBQGLrNj3zGdw5VzYlqfnI= text . see reference encoded_params tDMWbnBabN2mGSH3Apn445gDMEQ= text , reference encoded_query suU4/MiRITTTYf61BFw2aI6WxdI= text , reference has_query SLiWca6gUGmTh+r/BbU40NrICW8= text , reference query 4epyMikskiBx2Gu+S87oAhrM/ZY= text . normal MYfnAHxNPsNhl4M31kQzwrirB9M= s9dRuYwynzv+XH3wi5E1LonuuYk= yOAcBK51dE1EJqsBF6ZGTSEnocA= V3u1IzKjTvUUsoIglN4qUAzgD4k= params boost/url/url_base.hpp include/boost/url/url_base.hpp 2182 5 1 function MYfnAHxNPsNhl4M31kQzwrirB9M= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function returns a bidirectional view of key/value pairs over the query. The returned view references the same underlying character buffer; ownership is not transferred. Any percent-escapes in strings returned when iterating the view are decoded first. The container is modifiable; changes to the container are reflected in the underlying URL. heading text Example 1 code params_ref pv = url( "/sql?id=42&name=jane%2Ddoe&page+size=20" ).params(); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Return the query as a container of parameters returns code text *this see reference encoded_params tDMWbnBabN2mGSH3Apn445gDMEQ= text , reference remove_query ZZWEzCK7DguUxc3TvUfizoGKplE= text , reference set_encoded_query QcQ13DUh8M8TR/zj/LDG3N/+i3c= text , reference set_query 99/QTSBQGLrNj3zGdw5VzYlqfnI= text . identifier 8S83BKvWBCDdTktlY8X93Mlo9E0= params_ref normal 1 params boost/url/url_base.hpp include/boost/url/url_base.hpp 2186 5 1 function s9dRuYwynzv+XH3wi5E1LonuuYk= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= brief text Return the query as a container of parameters url_view_base::params returns text A bidirectional view of key/value pairs. see reference encoded_params tDMWbnBabN2mGSH3Apn445gDMEQ= text , reference encoded_query suU4/MiRITTTYf61BFw2aI6WxdI= text , reference has_query SLiWca6gUGmTh+r/BbU40NrICW8= text , reference query 4epyMikskiBx2Gu+S87oAhrM/ZY= text . identifier DzqMpaJX2O25vPFxEN5EDTyU6uw= params_view normal 1 1 params boost/url/url_base.hpp include/boost/url/url_base.hpp 2244 5 1 function yOAcBK51dE1EJqsBF6ZGTSEnocA= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function returns a bidirectional view of key/value pairs over the query. The returned view references the same underlying character buffer; ownership is not transferred. Any percent-escapes in strings returned when iterating the view are decoded first. The container is modifiable; changes to the container are reflected in the underlying URL. heading text Example 1 code encoding_opts opt; opt.space_as_plus = true; params_ref pv = url( "/sql?id=42&name=jane+doe&page+size=20" ).params(opt); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Return the query as a container of parameters returns text A range of references to the parameters. param text The options for decoding. If this parameter is omitted, the code text space_as_plus text is used. opt see reference encoded_params tDMWbnBabN2mGSH3Apn445gDMEQ= text , reference remove_query ZZWEzCK7DguUxc3TvUfizoGKplE= text , reference set_encoded_query QcQ13DUh8M8TR/zj/LDG3N/+i3c= text , reference set_query 99/QTSBQGLrNj3zGdw5VzYlqfnI= text . identifier 8S83BKvWBCDdTktlY8X93Mlo9E0= params_ref identifier Bb04pNwExynJkzlY9a9GCeeB13k= encoding_opts opt normal 1 params boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2087 5 function V3u1IzKjTvUUsoIglN4qUAzgD4k= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= identifier DzqMpaJX2O25vPFxEN5EDTyU6uw= params_view identifier Bb04pNwExynJkzlY9a9GCeeB13k= encoding_opts opt normal 1 1 password boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 947 5 1 function +ZB55yb2DeVYG+/eYqlMcGcedVE= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If present, this function returns a string representing the password (which may be an empty string). Otherwise it returns an empty string. Any percent-escapes in the string are decoded first. heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).password() == "pass" ); heading text Complexity 1 paragraph text Linear in code text this->password().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code userinfo = user [ ":" [ password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return the password returns text The password as a string. param text The string token to use. token see reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text , reference has_userinfo i/v5Vfq44OnlLbuKgQ2KvgWgZqo= text , reference encoded_password W9oZv0BM5z4XAggQPbNAKIM7/ro= text , reference encoded_user oYwrnXcglhO4tlvhkxLGfFCYbAk= text , reference encoded_userinfo yzkq+uCmbTlXrfDuyd1fT0Zu6xw= text , reference user /oa6wZJEG852J9Yi1LQlnq1n1tM= text , reference userinfo S9yd7MVhXxF+598Xy2/+jwnCZzc= text . identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 path boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1744 5 1 function Q5NVO+d/+BmZ5v3/ogNb2XpUTKs= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the path as a string. The path may be empty. Any percent-escapes in the string are decoded first. heading text Example 1 code assert( url_view( "file:///Program%20Files/Games/config.ini" ).path() == "/Program Files/Games/config.ini" ); heading text Complexity 1 paragraph text Linear in code text this->path().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code path = path-abempty ; begins with "/" or is empty / path-absolute ; begins with "/" but not "//" / path-noscheme ; begins with a non-colon segment / path-rootless ; begins with a segment / path-empty ; zero characters path-abempty = *( "/" segment ) path-absolute = "/" [ segment-nz *( "/" segment ) ] path-noscheme = segment-nz-nc *( "/" segment ) path-rootless = segment-nz *( "/" segment ) path-empty = 0<pchar> heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text Return the path returns text The path as a string. param text A string token to use for the result. token see reference is_path_absolute eh5BeHbLjL3BuEY7ao3tbEAZnTw= text , reference encoded_path GNlqbV0MSxGIA/gSjlOb2rfSHhU= text , reference encoded_segments xDk467Vs74WMTJdzZiv8izTuGQo= text . reference segments txoybJuonJpAdGVWgiAsiI45+ok= text . identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 persist boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 341 5 1 function cRPG1npIXmfYC0K+C+idxOqIc04= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns a read-only copy of the url, with shared lifetime. The returned value owns (persists) the underlying string. The algorithm used to create the value minimizes the number of individual memory allocations, making it more efficient than when using direct standard library functions. heading text Example 1 code std::shared_ptr< url_view const > sp; { std::string s( "http://example.com" ); url_view u( s ); // u references characters in s assert( u.data() == s.data() ); // same buffer sp = u.persist(); assert( sp->data() != s.data() ); // different buffer assert( sp->buffer() == s); // same contents // s is destroyed and thus u // becomes invalid, but sp remains valid. } heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. brief text Return a shared, persistent copy of the url returns text A shared pointer to a read-only url_view. specialization yAZI7i9M7QvpFoRBZvP2RcJBIWs= shared_ptr identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 1 port boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1604 5 1 function OlWcRIIUl1cq5Ab9fLXGPyhYCfI= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If present, this function returns a string representing the port (which may be empty). Otherwise it returns an empty string. heading text Example 1 code assert( url_view( "http://localhost.com:8080" ).port() == "8080" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code port = *DIGIT heading text Specification 1 list paragraph link text 3.2.3. Port (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.3 unordered brief text Return the port returns text The port as a string. see reference encoded_host_and_port 9ptIMbwWSNtVv+KAUpHCO3bmTWg= text , reference has_port 5V5uOhRsy00O+TSEAkIb7uFoN2U= text , reference port_number lctXu8FITJWg0+Y+yZVt5iv7QDM= text . identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core normal 1 1 port_number boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1640 5 1 function lctXu8FITJWg0+Y+yZVt5iv7QDM= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If a port is present and the numerical value is representable, it is returned as an unsigned integer. Otherwise, the number zero is returned. heading text Example 1 code assert( url_view( "http://localhost.com:8080" ).port_number() == 8080 ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code port = *DIGIT heading text Specification 1 list paragraph link text 3.2.3. Port (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.3 unordered brief text Return the port returns text The port number as an unsigned integer. see reference encoded_host_and_port 9ptIMbwWSNtVv+KAUpHCO3bmTWg= text , reference has_port 5V5uOhRsy00O+TSEAkIb7uFoN2U= text , reference port OlWcRIIUl1cq5Ab9fLXGPyhYCfI= text . identifier Qvo2fOST20EZC7bSOAFZr+u3ITg= uint16_t normal 1 1 query boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1987 5 1 function 4epyMikskiBx2Gu+S87oAhrM/ZY= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If this contains a query, it is returned as a string (which may be empty). Otherwise, an empty string is returned. Any percent-escapes in the string are decoded first. paragraph text Literal plus signs remain unchanged by default to match RFC 3986. To treat '+' as a space, supply decoding options with code text space_as_plus = true text when calling this function. heading text Example 1 code assert( url_view( "/sql?id=42&name=jane%2Ddoe&page+size=20" ).query() == "id=42&name=jane-doe&page size=20" ); heading text Complexity 1 paragraph text Linear in code text this->query().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Return the query returns text The query as a string. param text A token to use for the returned string. token see reference encoded_params YdRpQ6mNNA/rw8PqzTxP08VgNnY= text , reference encoded_query suU4/MiRITTTYf61BFw2aI6WxdI= text , reference has_query SLiWca6gUGmTh+r/BbU40NrICW8= text , reference params ZdlRIJ+RVbaF05I+w1pfQzUA0/0= text . identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 remove_authority boost/url/url.hpp include/boost/url/url.hpp 422 5 1 function uEUUViG9fk8nPLVDhOEq0ZwSt4k= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text This function removes the authority, which includes the userinfo, host, and a port if present. heading text Example 1 code assert( url( "http://example.com/echo.cgi" ).remove_authority().buffer() == "http:/echo.cgi" ); heading text Postconditions 1 code this->has_authority() == false && this->has_userinfo() == false && this->has_port() == false heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code authority = [ userinfo "@" ] host [ ":" port ] userinfo = *( unreserved / pct-encoded / sub-delims / ":" ) host = IP-literal / IPv4address / reg-name port = *DIGIT heading text Specification 1 list paragraph link text 3.2. Authority (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2 unordered brief text Remove the authority url_base::remove_authority returns code text *this see reference set_encoded_authority vE7KhYOtypUWNHBo2RGCbzuduNc= text . identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url normal 1 remove_fragment boost/url/url.hpp include/boost/url/url.hpp 489 5 1 function N46BFrejgcAWK9LoZJfnmCFfOQo= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text This function removes the fragment. An empty fragment is distinct from having no fragment. heading text Example 1 code assert( url( "?first=john&last=doe#anchor" ).remove_fragment().buffer() == "?first=john&last=doe" ); heading text Postconditions 1 code this->has_fragment() == false && this->encoded_fragment() == "" heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code fragment = *( pchar / "/" / "?" ) heading text Specification 1 list paragraph link text 3.5. Fragment https://datatracker.ietf.org/doc/html/rfc3986#section-3.5 unordered brief text Remove the fragment url_base::remove_fragment returns code text *this see reference remove_fragment aGhIz5PP9XtdztICzhAvM4n92Sg= text , reference set_encoded_fragment ebU9NPxh5c4VwDAaQA1CXRWbSKk= text , reference set_fragment VHh7zoCWGsviuG3lWYA54cKWneU= text . identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url normal 1 remove_origin boost/url/url.hpp include/boost/url/url.hpp 496 5 1 function m11SsNcuMK9xjCcQTH9YgmTOKU0= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text This function removes the origin, which consists of the scheme and authority. heading text Example 1 code assert( url( "http://www.example.com/index.htm" ).remove_origin().buffer() == "/index.htm" ); heading text Postconditions 1 code this->scheme_id() == scheme::none && this->has_authority() == false heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Throws nothing. brief text Remove the origin component url_base::remove_origin returns code text *this identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url normal 1 remove_password boost/url/url.hpp include/boost/url/url.hpp 439 5 1 function 8csn1QWMkOmUIhniJ0RUu0RZwG4= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text This function removes the password from the userinfo if a password exists. If there is no userinfo or no authority, the call has no effect. admonition paragraph text The interpretation of the userinfo as individual user and password components is scheme-dependent. Transmitting passwords in URLs is deprecated. note heading text Example 1 code assert( url( "http://user:pass@example.com" ).remove_password().authority().buffer() == "user@example.com" ); heading text Postconditions 1 code this->has_password() == false && this->encoded_password().empty() == true heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code userinfo = [ [ user ] [ ':' password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Remove the password url_base::remove_password returns code text *this see reference set_encoded_password d6h7pMb0CVly+yxJA3qTA9oUkyg= text , reference set_encoded_user FVik3N3tY4odaRANj5Yd7ryYKbM= text , reference set_password RT+5kxvCEY+rBBTsbgzooRi73rM= text , reference set_user bdwdrMSefiuKM7oY4Cga3Q9MJp4= text . identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url normal 1 remove_port boost/url/url.hpp include/boost/url/url.hpp 468 5 1 function odPyefMzS7RR8SxYOkeOFWrJWCo= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text If a port exists, it is removed. The rest of the authority is unchanged. heading text Example 1 code assert( url( "http://www.example.com:80" ).remove_port().authority().buffer() == "www.example.com" ); heading text Postconditions 1 code this->has_port() == false && this->port_number() == 0 && this->port() == "" heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code authority = [ userinfo "@" ] host [ ":" port ] port = *DIGIT heading text Specification 1 list paragraph link text 3.2.3. Port (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.3 unordered brief text Remove the port url_base::remove_port returns code text *this see reference set_port ThaNWrwh5iKGzqCX2N+LX3KLHhE= text . identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url normal 1 remove_query boost/url/url.hpp include/boost/url/url.hpp 486 5 1 function lqzeYddpaDdNhabYJKbZcKVR1sc= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text If a query is present, it is removed. An empty query is distinct from having no query. heading text Example 1 code assert( url( "http://www.example.com?id=42" ).remove_query().buffer() == "http://www.example.com" ); heading text Postconditions 1 code this->has_query() == false && this->params().empty() heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Remove the query url_base::remove_query returns code text *this see reference encoded_params tDMWbnBabN2mGSH3Apn445gDMEQ= text , reference params wdcIrRY9aj9gn6bF1i59TpOAQb4= text , reference set_encoded_query FfxhA5mBZ2/8cwSUixtcx3WcR/k= text , reference set_query 28viuAEHui7vd0hJTnE+g+nEWPM= text . identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url normal 1 remove_scheme boost/url/url.hpp include/boost/url/url.hpp 417 5 1 function xoEDWd6f1PiR0V17DuoUOwC8MtA= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text This function removes the scheme if it is present. heading text Example 1 code assert( url("http://www.example.com/index.htm" ).remove_scheme().buffer() == "//www.example.com/index.htm" ); heading text Postconditions 1 code this->has_scheme() == false && this->scheme_id() == scheme::none heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] heading text Specification 1 list paragraph link text 3.1. Scheme (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.1 unordered brief text Remove the scheme url_base::remove_scheme returns code text *this see reference set_scheme rKQfFZ6dfzeuSqZL+PgPNpIFQ5g= text . identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url normal 1 remove_userinfo boost/url/url.hpp include/boost/url/url.hpp 429 5 1 function H68DAna577ehzNnUHjAoRKLb1Lo= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text This function removes the userinfo if present, without removing any authority. heading text Example 1 code assert( url( "http://user@example.com" ).remove_userinfo().has_userinfo() == false ); heading text Postconditions 1 code this->has_userinfo() == false && this->encoded_userinfo().empty == true heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code userinfo = [ [ user ] [ ':' password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Remove the userinfo url_base::remove_userinfo returns code text *this see reference set_encoded_userinfo MLv0mdC6EhrEgdnFiOF+W8sw0/c= text , reference set_userinfo s+5EFNaQxZ6HMzMRElE8AAODpm8= text . identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url normal 1 reserve boost/url/url_base.hpp include/boost/url/url_base.hpp 187 5 1 function R5AajT/eZPgijKrm8AxolAdhsRQ= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function adjusts the capacity of the container in characters, without affecting the current contents. Has no effect if code text n <= this->capacity() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. brief text Adjust the capacity without changing the size param text The capacity in characters, excluding any null terminator. n throws text Allocation failure reference bad_alloc identifier void identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std n normal 1 resolve boost/url/url_base.hpp include/boost/url/url_base.hpp 2973 5 1 function 3Pi5l1khAbVAQHD3fWi5GoHEr5E= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function attempts to resolve a URL reference code text ref text against this base URL in a manner similar to that of a web browser resolving an anchor tag. paragraph text This URL must satisfy the emph text URI text grammar. In other words, it must contain a scheme. paragraph text Relative references are only usable when in the context of a base absolute URI. This process of resolving a relative emph text reference text within the context of a emph text base text URI is defined in detail in rfc3986 (see below). paragraph text The resolution process works as if the relative reference is appended to the base URI and the result is normalized. paragraph text Given the input base URL, this function resolves the relative reference as if performing the following steps: list paragraph text Ensure the base URI has at least a scheme paragraph text Normalizing the reference path paragraph text Merge base and reference paths paragraph text Normalize the merged path unordered paragraph text This function places the result of the resolution into this URL in place. paragraph text If an error occurs, the contents of this URL are unspecified and a code text boost::system::result text with an code text system::error_code text is returned. admonition paragraph text Abnormal hrefs where the number of ".." segments exceeds the number of segments in the base path are handled by including the unmatched ".." segments in the result, as described in link text Errata 4547 https://www.rfc-editor.org/errata/eid4547 text . note heading text Example 1 code url base1( "/one/two/three" ); base1.resolve("four"); assert( base1.buffer() == "/one/two/four" ); url base2( "http://example.com/" ) base2.resolve("/one"); assert( base2.buffer() == "http://example.com/one" ); url base3( "http://example.com/one" ); base3.resolve("/two"); assert( base3.buffer() == "http://example.com/two" ); url base4( "http://a/b/c/d;p?q" ); base4.resolve("g#s"); assert( base4.buffer() == "http://a/b/c/g#s" ); heading text BNF 1 code absolute-URI = scheme ":" hier-part [ "?" query ] heading text Exception Safety 1 paragraph text Basic guarantee. Calls to allocate may throw. heading text Specification 1 brief text Resolve a URL reference against this base URL returns text An empty code text boost::system::result text upon success, otherwise an error code if code text !base.has_scheme() text . param text The URL reference to resolve. ref see reference url B4dRaSXMG3fDmuNKMW3KOeRu6kA= text , reference url_view wh3UbUToX9YDmRmnpcoM9EUEZo8= text . specialization O+YzwnquzbCEPErxi2iuhXKphsk= result identifier LWQB+dn+7lsRKPzx/twz66ZcOWI= system 1 identifier UEVNhDEjkZMXfjN1DxbtX0n2rCg= url_view_base ref normal 1 scheme boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 421 5 1 function 43fxogaC5oVqfauhwXyN4s4ibEM= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the scheme if it exists, without a trailing colon (':'). Otherwise it returns an empty string. Note that schemes are case-insensitive, and the canonical form is lowercased. heading text Example 1 code assert( url_view( "http://www.example.com" ).scheme() == "http" ); heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code scheme = ALPHA *( ALPHA / DIGIT / "+" / "-" / "." ) URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] absolute-URI = scheme ":" hier-part [ "?" query ] heading text Specification 1 list paragraph link text 3.1. Scheme (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.1 unordered brief text Return the scheme returns text The scheme as a string. see reference has_scheme iwSH2fvVkb89TkZj7KWLGSyc4sA= text , reference scheme_id uM37WpBqetqzfHjns3M8/+CcoEU= text . identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core normal 1 1 scheme_id boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 471 5 1 function uM37WpBqetqzfHjns3M8/+CcoEU= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns a value which depends on the scheme in the url: list paragraph text If the scheme is a well-known scheme, corresponding value from the enumeration reference urls::scheme P7uOjuAMILimKGOcbjDUSpMAL/U= text is returned. paragraph text If a scheme is present but is not a well-known scheme, the value returned is reference urls::scheme::unknown LJxTyQ55ot1WYLH7f46nZvdGU78= text . paragraph text Otherwise, if the scheme is absent the value returned is reference urls::scheme::none VupiauVBXlZQ8Uix+vk8kSl+fM8= text . unordered heading text Example 1 code assert( url_view( "wss://www.example.com/crypto.cgi" ).scheme_id() == scheme::wss ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] absolute-URI = scheme ":" hier-part [ "?" query ] scheme = ALPHA *( ALPHA / DIGIT / "+" / "-" / "." ) heading text Specification 1 list paragraph link text 3.1. Scheme (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.1 unordered brief text Return the scheme returns text The scheme as an enumeration value. see reference has_scheme iwSH2fvVkb89TkZj7KWLGSyc4sA= text , reference scheme 43fxogaC5oVqfauhwXyN4s4ibEM= text . identifier P7uOjuAMILimKGOcbjDUSpMAL/U= scheme identifier dnk5XPfR2OaMpCYaH3cWSxcTdyc= urls normal 1 1 segments boost/url/url_base.hpp include/boost/url/url_base.hpp 1955 5 1 boost/url/url_base.hpp include/boost/url/url_base.hpp 1951 5 1 overloads coMz0KQ2BIuACsWbIRZ/6lTOmuk= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= brief text Return the path as a container of segments returns code text *this returns text A bidirectional view of segments. see reference encoded_segments qeLAK8oZj7+xpHv7Pyh0yYASuqU= text , reference set_encoded_path GQGd+Ne+D3eTy4fe+x1cpa5zefU= text , reference set_path 0VMn4mT6ruiabbTCXyOFe+JATBg= text , reference set_path_absolute BHDHQef0k/8vd3QskLyTrsv7+DE= text . see reference is_path_absolute eh5BeHbLjL3BuEY7ao3tbEAZnTw= text , reference encoded_path GNlqbV0MSxGIA/gSjlOb2rfSHhU= text , reference encoded_segments qeLAK8oZj7+xpHv7Pyh0yYASuqU= text . reference path Q5NVO+d/+BmZ5v3/ogNb2XpUTKs= text , reference segments_view ZNJOLZ4RhCB2A2ooiNo7KxZJHrA= text . normal 7IUB1R6CP5b6VCTpQBgLFv27mfU= QP1V0/Bd4lTeXI0vaNEiUqgvkPQ= segments boost/url/url_base.hpp include/boost/url/url_base.hpp 1951 5 1 function 7IUB1R6CP5b6VCTpQBgLFv27mfU= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function returns a bidirectional view of segments over the path. The returned view references the same underlying character buffer; ownership is not transferred. Any percent-escapes in strings returned when iterating the view are decoded first. The container is modifiable; changes to the container are reflected in the underlying URL. heading text Example 1 code url u( "http://example.com/path/to/file.txt" ); segments sv = u.segments(); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code path = path-abempty ; begins with "/" or is empty / path-absolute ; begins with "/" but not "//" / path-noscheme ; begins with a non-colon segment / path-rootless ; begins with a segment / path-empty ; zero characters path-abempty = *( "/" segment ) path-absolute = "/" [ segment-nz *( "/" segment ) ] path-noscheme = segment-nz-nc *( "/" segment ) path-rootless = segment-nz *( "/" segment ) path-empty = 0<pchar> heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text Return the path as a container of segments returns code text *this see reference encoded_segments qeLAK8oZj7+xpHv7Pyh0yYASuqU= text , reference set_encoded_path GQGd+Ne+D3eTy4fe+x1cpa5zefU= text , reference set_path 0VMn4mT6ruiabbTCXyOFe+JATBg= text , reference set_path_absolute BHDHQef0k/8vd3QskLyTrsv7+DE= text . identifier zdr3gU7+2/G05oo6ta/IfHlkTF0= segments_ref identifier dnk5XPfR2OaMpCYaH3cWSxcTdyc= urls normal 1 segments boost/url/url_base.hpp include/boost/url/url_base.hpp 1955 5 1 function QP1V0/Bd4lTeXI0vaNEiUqgvkPQ= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function returns a bidirectional view of strings over the path. The returned view references the same underlying character buffer; ownership is not transferred. Any percent-escapes in strings returned when iterating the view are decoded first. heading text Example 1 code segments_view sv = url_view( "/path/to/file.txt" ).segments(); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code path = [ "/" ] segment *( "/" segment ) heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text Return the path as a container of segments url_view_base::segments returns text A bidirectional view of segments. see reference is_path_absolute eh5BeHbLjL3BuEY7ao3tbEAZnTw= text , reference encoded_path GNlqbV0MSxGIA/gSjlOb2rfSHhU= text , reference encoded_segments qeLAK8oZj7+xpHv7Pyh0yYASuqU= text . reference path Q5NVO+d/+BmZ5v3/ogNb2XpUTKs= text , reference segments_view ZNJOLZ4RhCB2A2ooiNo7KxZJHrA= text . identifier ZNJOLZ4RhCB2A2ooiNo7KxZJHrA= segments_view normal 1 1 set_encoded_authority boost/url/url.hpp include/boost/url/url.hpp 420 5 1 function vE7KhYOtypUWNHBo2RGCbzuduNc= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text This function sets the authority to the specified string. The string may contain percent-escapes. heading text Example 1 code assert( url().set_encoded_authority( "My%20Computer" ).has_authority() ); heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text BNF 1 code authority = [ userinfo "@" ] host [ ":" port ] userinfo = *( unreserved / pct-encoded / sub-delims / ":" ) host = IP-literal / IPv4address / reg-name port = *DIGIT heading text Specification 1 list paragraph link text 3.2. Authority (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2 unordered brief text Set the authority url_base::set_encoded_authority returns code text *this param text The authority string to set. s see reference remove_authority cjTKMEM0IWRzDexmJAiWOj6P+ZI= text . identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view s normal 1 set_encoded_fragment boost/url/url.hpp include/boost/url/url.hpp 493 5 1 function Q/h1CpdR46KA14VnTvzSNYO/Z9M= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text This function sets the fragment to the specified string, which may contain percent-escapes and which may be empty. An empty fragment is distinct from having no fragment. Escapes in the string are preserved, and reserved characters in the string are percent-escaped in the result. heading text Example 1 code assert( url("?first=john&last=doe" ).set_encoded_fragment( "john%2Ddoe" ).fragment() == "john-doe" ); heading text Postconditions 1 code this->has_fragment() == true && this->fragment() == decode_view( s ) heading text Complexity 1 paragraph text Linear in code text this->size() + s.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text BNF 1 code fragment = *( pchar / "/" / "?" ) heading text Specification 1 list paragraph link text 3.5. Fragment https://datatracker.ietf.org/doc/html/rfc3986#section-3.5 unordered brief text Set the fragment. url_base::set_encoded_fragment returns code text *this param text The string to set. s see reference remove_fragment aGhIz5PP9XtdztICzhAvM4n92Sg= text , reference set_fragment VHh7zoCWGsviuG3lWYA54cKWneU= text . identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view s normal 1 set_encoded_host boost/url/url.hpp include/boost/url/url.hpp 444 5 1 function QqGtJJ8cl1csXN2HqSLBxfqqw8I= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text Depending on the contents of the passed string, this function sets the host: list paragraph text If the string is a valid IPv4 address, then the host is set to the address. The host type is reference host_type::ipv4 49F64dAiji9HVbP6MxLQiqot7AY= text . paragraph text If the string is a valid IPv6 address enclosed in square brackets, then the host is set to that address. The host type is reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= text . paragraph text If the string is a valid IPvFuture address enclosed in square brackets, then the host is set to that address. The host type is reference host_type::ipvfuture TcYJaTwDFsx+0S2CkvHHARcCqWc= text . paragraph text Otherwise, the host name is set to the string. This string can contain percent escapes, or can be empty. Escapes in the string are preserved, and reserved characters in the string are percent-escaped in the result. The host type is reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= text . unordered paragraph text In all cases, when this function returns, the URL contains an authority. heading text Example 1 code assert( url( "http://www.example.com" ).set_host( "127.0.0.1" ).buffer() == "http://127.0.0.1" ); heading text Postconditions 1 code this->has_authority() == true heading text Complexity 1 paragraph text Linear in code text this->size() + s.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPvFuture ) "]" reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text IPv4 (Wikipedia) https://en.wikipedia.org/wiki/IPv4 paragraph link text IP Version 6 Addressing Architecture (rfc4291) https://datatracker.ietf.org/doc/html/rfc4291 paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Set the host url_base::set_encoded_host returns code text *this param text The string to set. s see reference set_encoded_host_address 51fvhkKEd4+UZEBsnLd4vUL/Svw= text , reference set_encoded_host_name Lz8KFSebh4YuJuAAf0STYQ/VPqk= text , reference set_host lhYybwvylnG/ieiGmyVfyExN3dw= text , reference set_host_address ut25mVfVRShtv19Mg+nvS5jVATc= text , reference set_host_ipv4 Cn5GM3RJyUENDJ/d6LnYVW+gkA4= text , reference set_host_ipv6 BryTExdDEUoZs6riyC1Qi0/NtPE= text , reference set_host_ipvfuture BQxPHhB2Uv0OyVbWf3e7/seXVX8= text , reference set_host_name Pt4icJRgJxULgQjbXV6yzBigNl8= text . identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view s normal 1 set_encoded_host_address boost/url/url.hpp include/boost/url/url.hpp 448 5 1 function 8vNpsCqkIshI8Vwi9MI/QwEbWNE= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text Depending on the contents of the passed string, this function sets the host: list paragraph text If the string is a valid IPv4 address, then the host is set to the address. The host type is reference host_type::ipv4 49F64dAiji9HVbP6MxLQiqot7AY= text . paragraph text If the string is a valid IPv6 address, then the host is set to that address. The host type is reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= text . paragraph text If the string is a valid IPvFuture, then the host is set to that address. The host type is reference host_type::ipvfuture TcYJaTwDFsx+0S2CkvHHARcCqWc= text . paragraph text Otherwise, the host name is set to the string. This string can contain percent escapes, or can be empty. Escapes in the string are preserved, and reserved characters in the string are percent-escaped in the result. The host type is reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= text . unordered paragraph text In all cases, when this function returns, the URL contains an authority. heading text Example 1 code assert( url( "http://www.example.com" ).set_host( "127.0.0.1" ).buffer() == "http://127.0.0.1" ); heading text Postconditions 1 code this->has_authority() == true heading text Complexity 1 paragraph text Linear in code text this->size() + s.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text BNF 1 code IPv4address = dec-octet "." dec-octet "." dec-octet "." dec-octet dec-octet = DIGIT ; 0-9 / %x31-39 DIGIT ; 10-99 / "1" 2DIGIT ; 100-199 / "2" %x30-34 DIGIT ; 200-249 / "25" %x30-35 ; 250-255 IPv6address = 6( h16 ":" ) ls32 / "::" 5( h16 ":" ) ls32 / [ h16 ] "::" 4( h16 ":" ) ls32 / [ *1( h16 ":" ) h16 ] "::" 3( h16 ":" ) ls32 / [ *2( h16 ":" ) h16 ] "::" 2( h16 ":" ) ls32 / [ *3( h16 ":" ) h16 ] "::" h16 ":" ls32 / [ *4( h16 ":" ) h16 ] "::" ls32 / [ *5( h16 ":" ) h16 ] "::" h16 / [ *6( h16 ":" ) h16 ] "::" ls32 = ( h16 ":" h16 ) / IPv4address ; least-significant 32 bits of address h16 = 1*4HEXDIG ; 16 bits of address represented in hexadecimal IPvFuture = "v" 1*HEXDIG "." 1*( unreserved / sub-delims / ":" ) reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text IPv4 (Wikipedia) https://en.wikipedia.org/wiki/IPv4 paragraph link text IP Version 6 Addressing Architecture (rfc4291) https://datatracker.ietf.org/doc/html/rfc4291 paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Set the host to an address url_base::set_encoded_host_address returns code text *this param text The string to set. s see reference set_encoded_host OgEcjvMpUkw5cqqrotx6BNVfYuA= text , reference set_encoded_host_name Lz8KFSebh4YuJuAAf0STYQ/VPqk= text , reference set_host lhYybwvylnG/ieiGmyVfyExN3dw= text , reference set_host_address ut25mVfVRShtv19Mg+nvS5jVATc= text , reference set_host_ipv4 Cn5GM3RJyUENDJ/d6LnYVW+gkA4= text , reference set_host_ipv6 BryTExdDEUoZs6riyC1Qi0/NtPE= text , reference set_host_ipvfuture BQxPHhB2Uv0OyVbWf3e7/seXVX8= text , reference set_host_name Pt4icJRgJxULgQjbXV6yzBigNl8= text . identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view s normal 1 set_encoded_host_name boost/url/url.hpp include/boost/url/url.hpp 462 5 1 function x6Se85PURXLDVUkc0nIMfry4QWk= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text The host is set to the specified string, which may contain percent-escapes and can be empty. Escapes in the string are preserved, and reserved characters in the string are percent-escaped in the result. The host type is reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= text . heading text Example 1 code assert( url( "http://www.example.com/index.htm").set_encoded_host_name( "localhost" ).host_address() == "localhost" ); heading text Postconditions 1 code this->has_authority() == true && this->host_ipv6_address() == addr && this->host_type() == host_type::name heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text BNF 1 code reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Set the host to a name url_base::set_encoded_host_name returns code text *this param text The string to set. s see reference set_encoded_host OgEcjvMpUkw5cqqrotx6BNVfYuA= text , reference set_encoded_host_address 51fvhkKEd4+UZEBsnLd4vUL/Svw= text , reference set_host lhYybwvylnG/ieiGmyVfyExN3dw= text , reference set_host_address ut25mVfVRShtv19Mg+nvS5jVATc= text , reference set_host_ipv4 Cn5GM3RJyUENDJ/d6LnYVW+gkA4= text , reference set_host_ipv6 BryTExdDEUoZs6riyC1Qi0/NtPE= text , reference set_host_ipvfuture BQxPHhB2Uv0OyVbWf3e7/seXVX8= text , reference set_host_name Pt4icJRgJxULgQjbXV6yzBigNl8= text . identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view s normal 1 set_encoded_params boost/url/url.hpp include/boost/url/url.hpp 484 5 1 function 1EkZhuzR+KSDgGVlnI0A/GdR6Fs= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text This sets the query params to the elements in the list, which may contain percent-escapes and can be empty. paragraph text An empty list of params is distinct from having no query. paragraph text Escapes in the string are preserved, and reserved characters in the string are percent-escaped in the result. heading text Example 1 code assert( url( "http://example.com" ).set_encoded_params( {"id", "42"} ).encoded_query() == "id=42" ); heading text Postconditions 1 code this->has_query() == true heading text Complexity 1 paragraph text Linear. heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Set the query params url_base::set_encoded_params returns code text *this param text The params to set. ps see reference set_params PXWUIWedy7d9zkfR48y2dfaPVDo= text , reference params wdcIrRY9aj9gn6bF1i59TpOAQb4= text , reference remove_query lqzeYddpaDdNhabYJKbZcKVR1sc= text , reference set_encoded_query FfxhA5mBZ2/8cwSUixtcx3WcR/k= text , reference set_query 28viuAEHui7vd0hJTnE+g+nEWPM= text . identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url specialization 3tT5Y8vozttMWXrA/fNw4NcDYTE= initializer_list identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std ps normal 1 set_encoded_password boost/url/url.hpp include/boost/url/url.hpp 437 5 1 function d6h7pMb0CVly+yxJA3qTA9oUkyg= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text This function sets the password in the userinfo to the string, which may contain percent-escapes. Escapes in the string are preserved, and reserved characters in the string are percent-escaped in the result. admonition paragraph text The interpretation of the userinfo as individual user and password components is scheme-dependent. Transmitting passwords in URLs is deprecated. note heading text Example 1 code assert( url("http://user@example.com").set_encoded_password( "pass" ).encoded_userinfo() == "user:pass" ); heading text Postconditions 1 code this->has_password() == true heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code userinfo = [ [ user ] [ ':' password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Set the password. url_base::set_encoded_password returns code text *this param text The string to set. This string may contain any characters, including nulls. s see reference remove_password M5RIQPf9vzlN+m4Qn0PDNFKy8ak= text , reference set_encoded_password qF7dDBIf4KkHxSuysLw1EJNSh2Y= text , reference set_encoded_user YNLJGohUXCdL6mo1PM3ms9pRQyE= text , reference set_user GWy3y66sOX4ov+Eh3hxNRVsAEwY= text . identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view s normal 1 set_encoded_path boost/url/url.hpp include/boost/url/url.hpp 475 5 1 function tlGS2xlooVieoE1F6taSONIunW8= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text This function sets the path to the string, which may contain percent-escapes and can be empty. Escapes in the string are preserved, and reserved characters in the string are percent-escaped in the result. admonition paragraph text The library may adjust the final result to ensure that no other parts of the url is semantically affected. note heading text Example 1 code url u( "http://www.example.com" ); u.set_encoded_path( "path/to/file.txt" ); assert( u.encoded_path() == "/path/to/file.txt" ); heading text Complexity 1 paragraph text Linear in code text this->size() + s.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text BNF 1 code path = path-abempty ; begins with "/" or is empty / path-absolute ; begins with "/" but not "//" / path-noscheme ; begins with a non-colon segment / path-rootless ; begins with a segment / path-empty ; zero characters path-abempty = *( "/" segment ) path-absolute = "/" [ segment-nz *( "/" segment ) ] path-noscheme = segment-nz-nc *( "/" segment ) path-rootless = segment-nz *( "/" segment ) path-empty = 0<pchar> heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text Set the path. url_base::set_encoded_path returns code text *this param text The string to set. s see reference encoded_segments qeLAK8oZj7+xpHv7Pyh0yYASuqU= text , reference segments coMz0KQ2BIuACsWbIRZ/6lTOmuk= text , reference set_path 8Nou0ZhJ8DhQBDRFYHX+OQrxd1g= text , reference set_path_absolute BHDHQef0k/8vd3QskLyTrsv7+DE= text . identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view s normal 1 set_encoded_query boost/url/url.hpp include/boost/url/url.hpp 480 5 1 function FfxhA5mBZ2/8cwSUixtcx3WcR/k= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text This sets the query to the string, which may contain percent-escapes and can be empty. An empty query is distinct from having no query. Escapes in the string are preserved, and reserved characters in the string are percent-escaped in the result. heading text Example 1 code assert( url( "http://example.com" ).set_encoded_query( "id=42" ).encoded_query() == "id=42" ); heading text Postconditions 1 code this->has_query() == true && this->query() == decode_view( s ); heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Set the query url_base::set_encoded_query returns code text *this param text The string to set. s see reference encoded_params tDMWbnBabN2mGSH3Apn445gDMEQ= text , reference params wdcIrRY9aj9gn6bF1i59TpOAQb4= text , reference remove_query lqzeYddpaDdNhabYJKbZcKVR1sc= text , reference set_query 28viuAEHui7vd0hJTnE+g+nEWPM= text . identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view s normal 1 set_encoded_user boost/url/url.hpp include/boost/url/url.hpp 433 5 1 function FVik3N3tY4odaRANj5Yd7ryYKbM= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text This function sets the user part of the userinfo the the string, which may contain percent-escapes. Escapes in the string are preserved, and reserved characters in the string are percent-escaped in the result. heading text Example 1 code assert( url().set_encoded_user("john%20doe").userinfo() == "john doe" ); heading text Postconditions 1 code this->has_authority() == true && this->has_userinfo() == true heading text Complexity 1 paragraph text Linear in code text this->size() + s.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code userinfo = [ [ user ] [ ':' password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Set the user url_base::set_encoded_user returns code text *this param text The string to set. s see reference remove_password M5RIQPf9vzlN+m4Qn0PDNFKy8ak= text , reference set_encoded_password qF7dDBIf4KkHxSuysLw1EJNSh2Y= text , reference set_password blkDquwzHtk7o5mJf/hdeY15zWg= text , reference set_user GWy3y66sOX4ov+Eh3hxNRVsAEwY= text . identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view s normal 1 set_encoded_userinfo boost/url/url.hpp include/boost/url/url.hpp 427 5 1 function ZR2L8oYjRtrb4ZxwO002IH7YyPQ= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text The userinfo is set to the given string, which may contain percent-escapes. Escapes in the string are preserved, and reserved characters in the string are percent-escaped in the result. The effects on the user and password depend on the presence of a colon (':') in the string: list paragraph text If an unescaped colon exists, the characters up to the colon become the user and the rest of the characters after the colon become the password. In this case reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text returns true. Otherwise, paragraph text If there is no colon, the user is set to the string. The function reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text returns false. unordered admonition paragraph text The interpretation of the userinfo as individual user and password components is scheme-dependent. Transmitting passwords in URLs is deprecated. note heading text Example 1 code assert( url( "http://example.com" ).set_encoded_userinfo( "john%20doe" ).user() == "john doe" ); heading text Complexity 1 paragraph text Linear in code text this->size() + s.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text BNF 1 code userinfo = [ [ user ] [ ':' password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Set the userinfo. url_base::set_encoded_userinfo returns code text *this param text The string to set. s see reference remove_userinfo H68DAna577ehzNnUHjAoRKLb1Lo= text , reference set_userinfo tbHsdn3vwHk6vomi64efnJApwUQ= text . identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view s normal 1 set_encoded_zone_id boost/url/url.hpp include/boost/url/url.hpp 456 5 1 boost/url/url_base.hpp include/boost/url/url_base.hpp 1411 5 1 overloads ewkXSEAgojrwUvfKobvwm5kK/0o= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= brief text Set the zone ID for an IPv6 address (percent-encoded). returns code text *this param text The zone ID to set. s throws code text s text contains an invalid percent-encoding. reference system_error normal /HsDRNr5aHRIzBwkJqZnZrdNZ/k= RMFUW/JJZyWG3XqrC9XU/QCaYC4= set_encoded_zone_id boost/url/url_base.hpp include/boost/url/url_base.hpp 1411 5 1 function /HsDRNr5aHRIzBwkJqZnZrdNZ/k= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function sets the zone ID for the host if the host is an IPv6 address. Escapes in the string are preserved, and reserved characters in the string are percent-escaped in the result. heading text Example 1 code assert( u.set_host_ipv6( ipv6_address( "fe80::1" ) ).set_encoded_zone_id( "eth0" ).buffer() == "https://[fe80::1%25eth0]" ); heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text Specification 1 list paragraph link text RFC 6874 https://datatracker.ietf.org/doc/html/rfc6874 unordered brief text Set the zone ID for an IPv6 address (percent-encoded). returns code text *this param text The zone ID to set. s throws code text s text contains an invalid percent-encoding. reference system_error identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view s normal 1 set_encoded_zone_id boost/url/url.hpp include/boost/url/url.hpp 456 5 1 function RMFUW/JJZyWG3XqrC9XU/QCaYC4= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text This function sets the zone ID for the host if the host is an IPv6 address. Escapes in the string are preserved, and reserved characters in the string are percent-escaped in the result. heading text Example 1 code assert( u.set_host_ipv6( ipv6_address( "fe80::1" ) ).set_encoded_zone_id( "eth0" ).buffer() == "https://[fe80::1%25eth0]" ); heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text Specification 1 list paragraph link text RFC 6874 https://datatracker.ietf.org/doc/html/rfc6874 unordered brief text Set the zone ID for an IPv6 address (percent-encoded). url_base::set_encoded_zone_id returns code text *this param text The zone ID to set. s identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url 1 identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view s normal 1 set_fragment boost/url/url.hpp include/boost/url/url.hpp 491 5 1 function l0wVo04A61xkHZCraU8BRdp8FT0= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text This function sets the fragment to the specified string, which may be empty. An empty fragment is distinct from having no fragment. Reserved characters in the string are percent-escaped in the result. heading text Example 1 code assert( url("?first=john&last=doe" ).set_encoded_fragment( "john doe" ).encoded_fragment() == "john%20doe" ); heading text Postconditions 1 code this->has_fragment() == true && this->fragment() == s heading text Complexity 1 paragraph text Linear in code text this->size() + s.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code fragment = *( pchar / "/" / "?" ) heading text Specification 1 list paragraph link text 3.5. Fragment https://datatracker.ietf.org/doc/html/rfc3986#section-3.5 unordered brief text Set the fragment. url_base::set_fragment returns code text *this param text The string to set. s see reference remove_fragment N46BFrejgcAWK9LoZJfnmCFfOQo= text , reference set_encoded_fragment Q/h1CpdR46KA14VnTvzSNYO/Z9M= text . identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 set_host boost/url/url.hpp include/boost/url/url.hpp 442 5 1 function NV17VD5RB4tRGVitD/ItS62klWA= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text Depending on the contents of the passed string, this function sets the host: list paragraph text If the string is a valid IPv4 address, then the host is set to the address. The host type is reference host_type::ipv4 49F64dAiji9HVbP6MxLQiqot7AY= text . paragraph text If the string is a valid IPv6 address enclosed in square brackets, then the host is set to that address. The host type is reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= text . paragraph text If the string is a valid IPvFuture address enclosed in square brackets, then the host is set to that address. The host type is reference host_type::ipvfuture TcYJaTwDFsx+0S2CkvHHARcCqWc= text . paragraph text Otherwise, the host name is set to the string, which may be empty. Reserved characters in the string are percent-escaped in the result. The host type is reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= text . unordered paragraph text In all cases, when this function returns, the URL contains an authority. heading text Example 1 code assert( url( "http://www.example.com" ).set_host( "127.0.0.1" ).buffer() == "http://127.0.0.1" ); heading text Postconditions 1 code this->has_authority() == true heading text Complexity 1 paragraph text Linear in code text this->size() + s.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPvFuture ) "]" reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text IPv4 (Wikipedia) https://en.wikipedia.org/wiki/IPv4 paragraph link text IP Version 6 Addressing Architecture (rfc4291) https://datatracker.ietf.org/doc/html/rfc4291 paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Set the host url_base::set_host returns code text *this param text The string to set. s see reference set_encoded_host OgEcjvMpUkw5cqqrotx6BNVfYuA= text , reference set_encoded_host_address 51fvhkKEd4+UZEBsnLd4vUL/Svw= text , reference set_encoded_host_name Lz8KFSebh4YuJuAAf0STYQ/VPqk= text , reference set_host_address ut25mVfVRShtv19Mg+nvS5jVATc= text , reference set_host_ipv4 Cn5GM3RJyUENDJ/d6LnYVW+gkA4= text , reference set_host_ipv6 BryTExdDEUoZs6riyC1Qi0/NtPE= text , reference set_host_ipvfuture BQxPHhB2Uv0OyVbWf3e7/seXVX8= text , reference set_host_name Pt4icJRgJxULgQjbXV6yzBigNl8= text . identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 set_host_address boost/url/url.hpp include/boost/url/url.hpp 446 5 1 function RcbCWApESayzhWcmWzKY7sLRW3I= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text Depending on the contents of the passed string, this function sets the host: list paragraph text If the string is a valid IPv4 address, then the host is set to the address. The host type is reference host_type::ipv4 49F64dAiji9HVbP6MxLQiqot7AY= text . paragraph text If the string is a valid IPv6 address, then the host is set to that address. The host type is reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= text . paragraph text If the string is a valid IPvFuture, then the host is set to that address. The host type is reference host_type::ipvfuture TcYJaTwDFsx+0S2CkvHHARcCqWc= text . paragraph text Otherwise, the host name is set to the string, which may be empty. Reserved characters in the string are percent-escaped in the result. The host type is reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= text . unordered paragraph text In all cases, when this function returns, the URL contains an authority. heading text Example 1 code assert( url( "http://www.example.com" ).set_host_address( "127.0.0.1" ).buffer() == "http://127.0.0.1" ); heading text Postconditions 1 code this->has_authority() == true heading text Complexity 1 paragraph text Linear in code text s.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code IPv4address = dec-octet "." dec-octet "." dec-octet "." dec-octet dec-octet = DIGIT ; 0-9 / %x31-39 DIGIT ; 10-99 / "1" 2DIGIT ; 100-199 / "2" %x30-34 DIGIT ; 200-249 / "25" %x30-35 ; 250-255 IPv6address = 6( h16 ":" ) ls32 / "::" 5( h16 ":" ) ls32 / [ h16 ] "::" 4( h16 ":" ) ls32 / [ *1( h16 ":" ) h16 ] "::" 3( h16 ":" ) ls32 / [ *2( h16 ":" ) h16 ] "::" 2( h16 ":" ) ls32 / [ *3( h16 ":" ) h16 ] "::" h16 ":" ls32 / [ *4( h16 ":" ) h16 ] "::" ls32 / [ *5( h16 ":" ) h16 ] "::" h16 / [ *6( h16 ":" ) h16 ] "::" ls32 = ( h16 ":" h16 ) / IPv4address ; least-significant 32 bits of address h16 = 1*4HEXDIG ; 16 bits of address represented in hexadecimal IPvFuture = "v" 1*HEXDIG "." 1*( unreserved / sub-delims / ":" ) reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text IPv4 (Wikipedia) https://en.wikipedia.org/wiki/IPv4 paragraph link text IP Version 6 Addressing Architecture (rfc4291) https://datatracker.ietf.org/doc/html/rfc4291 paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Set the host to an address url_base::set_host_address returns code text *this param text The string to set. s see reference set_encoded_host OgEcjvMpUkw5cqqrotx6BNVfYuA= text , reference set_encoded_host_address 51fvhkKEd4+UZEBsnLd4vUL/Svw= text , reference set_encoded_host_name Lz8KFSebh4YuJuAAf0STYQ/VPqk= text , reference set_host lhYybwvylnG/ieiGmyVfyExN3dw= text , reference set_host_address ut25mVfVRShtv19Mg+nvS5jVATc= text , reference set_host_ipv4 Cn5GM3RJyUENDJ/d6LnYVW+gkA4= text , reference set_host_ipv6 BryTExdDEUoZs6riyC1Qi0/NtPE= text , reference set_host_ipvfuture BQxPHhB2Uv0OyVbWf3e7/seXVX8= text , reference set_host_name Pt4icJRgJxULgQjbXV6yzBigNl8= text . identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 set_host_ipv4 boost/url/url.hpp include/boost/url/url.hpp 450 5 1 function j1vvfyYzdHeOi3rAip91G6UwdI4= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text The host is set to the specified IPv4 address. The host type is reference host_type::ipv4 49F64dAiji9HVbP6MxLQiqot7AY= text . heading text Example 1 code assert( url("http://www.example.com").set_host_ipv4( ipv4_address( "127.0.0.1" ) ).buffer() == "http://127.0.0.1" ); heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Postconditions 1 code this->has_authority() == true && this->host_ipv4_address() == addr && this->host_type() == host_type::ipv4 heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code IPv4address = dec-octet "." dec-octet "." dec-octet "." dec-octet dec-octet = DIGIT ; 0-9 / %x31-39 DIGIT ; 10-99 / "1" 2DIGIT ; 100-199 / "2" %x30-34 DIGIT ; 200-249 / "25" %x30-35 ; 250-255 heading text Specification 1 list paragraph link text IPv4 (Wikipedia) https://en.wikipedia.org/wiki/IPv4 paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Set the host to an address url_base::set_host_ipv4 returns code text *this param text The address to set. addr see reference set_encoded_host OgEcjvMpUkw5cqqrotx6BNVfYuA= text , reference set_encoded_host_address 51fvhkKEd4+UZEBsnLd4vUL/Svw= text , reference set_encoded_host_name Lz8KFSebh4YuJuAAf0STYQ/VPqk= text , reference set_host lhYybwvylnG/ieiGmyVfyExN3dw= text , reference set_host_address ut25mVfVRShtv19Mg+nvS5jVATc= text , reference set_host_ipv6 BryTExdDEUoZs6riyC1Qi0/NtPE= text , reference set_host_ipvfuture BQxPHhB2Uv0OyVbWf3e7/seXVX8= text , reference set_host_name Pt4icJRgJxULgQjbXV6yzBigNl8= text . identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url 1 identifier /Wpp3ZZDp3kUHzbULeDoaOEhnVs= ipv4_address addr normal 1 set_host_ipv6 boost/url/url.hpp include/boost/url/url.hpp 452 5 1 function JXOJMhugDCIztmyysqXCpJe4+6Q= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text The host is set to the specified IPv6 address. The host type is reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= text . heading text Example 1 code assert( url().set_host_ipv6( ipv6_address( "1::6:c0a8:1" ) ).authority().buffer() == "[1::6:c0a8:1]" ); heading text Postconditions 1 code this->has_authority() == true && this->host_ipv6_address() == addr && this->host_type() == host_type::ipv6 heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code IPv6address = 6( h16 ":" ) ls32 / "::" 5( h16 ":" ) ls32 / [ h16 ] "::" 4( h16 ":" ) ls32 / [ *1( h16 ":" ) h16 ] "::" 3( h16 ":" ) ls32 / [ *2( h16 ":" ) h16 ] "::" 2( h16 ":" ) ls32 / [ *3( h16 ":" ) h16 ] "::" h16 ":" ls32 / [ *4( h16 ":" ) h16 ] "::" ls32 / [ *5( h16 ":" ) h16 ] "::" h16 / [ *6( h16 ":" ) h16 ] "::" ls32 = ( h16 ":" h16 ) / IPv4address ; least-significant 32 bits of address h16 = 1*4HEXDIG ; 16 bits of address represented in hexadecimal heading text Specification 1 list paragraph link text IP Version 6 Addressing Architecture (rfc4291) https://datatracker.ietf.org/doc/html/rfc4291 paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Set the host to an address url_base::set_host_ipv6 returns code text *this param text The address to set. addr see reference set_encoded_host QqGtJJ8cl1csXN2HqSLBxfqqw8I= text , reference set_encoded_host_address 8vNpsCqkIshI8Vwi9MI/QwEbWNE= text , reference set_encoded_host_name x6Se85PURXLDVUkc0nIMfry4QWk= text , reference set_host NV17VD5RB4tRGVitD/ItS62klWA= text , reference set_host_address RcbCWApESayzhWcmWzKY7sLRW3I= text , reference set_host_ipv4 j1vvfyYzdHeOi3rAip91G6UwdI4= text , reference set_host_ipvfuture FAvM0R9wWtIopo0UEVBu36r+rLs= text , reference set_host_name WX0WCadEsealUT2/UWMRohJ83A8= text . identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url 1 identifier dhMSRVBIIIItY0URHSc8rwHcdTQ= ipv6_address addr normal 1 set_host_ipvfuture boost/url/url.hpp include/boost/url/url.hpp 458 5 1 function FAvM0R9wWtIopo0UEVBu36r+rLs= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text The host is set to the specified IPvFuture string. The host type is reference host_type::ipvfuture TcYJaTwDFsx+0S2CkvHHARcCqWc= text . heading text Example 1 code assert( url().set_host_ipvfuture( "v42.bis" ).buffer() == "//[v42.bis]" ); heading text Complexity 1 paragraph text Linear in code text this->size() + s.size() text . heading text Postconditions 1 code this->has_authority() == true && this->host_ipvfuture) == s && this->host_type() == host_type::ipvfuture heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text BNF 1 code IPvFuture = "v" 1*HEXDIG "." 1*( unreserved / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Set the host to an address url_base::set_host_ipvfuture returns code text *this param text The string to set. s see reference set_encoded_host OgEcjvMpUkw5cqqrotx6BNVfYuA= text , reference set_encoded_host_address 51fvhkKEd4+UZEBsnLd4vUL/Svw= text , reference set_encoded_host_name Lz8KFSebh4YuJuAAf0STYQ/VPqk= text , reference set_host lhYybwvylnG/ieiGmyVfyExN3dw= text , reference set_host_address ut25mVfVRShtv19Mg+nvS5jVATc= text , reference set_host_ipv4 Cn5GM3RJyUENDJ/d6LnYVW+gkA4= text , reference set_host_ipv6 BryTExdDEUoZs6riyC1Qi0/NtPE= text , reference set_host_name Pt4icJRgJxULgQjbXV6yzBigNl8= text . identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 set_host_name boost/url/url.hpp include/boost/url/url.hpp 460 5 1 function WX0WCadEsealUT2/UWMRohJ83A8= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text The host is set to the specified string, which may be empty. Reserved characters in the string are percent-escaped in the result. The host type is reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= text . heading text Example 1 code assert( url( "http://www.example.com/index.htm").set_host_name( "localhost" ).host_address() == "localhost" ); heading text Postconditions 1 code this->has_authority() == true && this->host_ipv6_address() == addr && this->host_type() == host_type::name heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Set the host to a name url_base::set_host_name returns code text *this param text The string to set. s see reference set_encoded_host OgEcjvMpUkw5cqqrotx6BNVfYuA= text , reference set_encoded_host_address 51fvhkKEd4+UZEBsnLd4vUL/Svw= text , reference set_encoded_host_name Lz8KFSebh4YuJuAAf0STYQ/VPqk= text , reference set_host lhYybwvylnG/ieiGmyVfyExN3dw= text , reference set_host_address ut25mVfVRShtv19Mg+nvS5jVATc= text , reference set_host_ipv4 Cn5GM3RJyUENDJ/d6LnYVW+gkA4= text , reference set_host_ipv6 BryTExdDEUoZs6riyC1Qi0/NtPE= text , reference set_host_ipvfuture BQxPHhB2Uv0OyVbWf3e7/seXVX8= text . identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 set_params boost/url/url.hpp include/boost/url/url.hpp 482 5 1 function PXWUIWedy7d9zkfR48y2dfaPVDo= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text This sets the query params to the list of param_view, which can be empty. paragraph text An empty list of params is distinct from having no params. paragraph text Reserved characters in the string are percent-escaped in the result. heading text Example 1 code assert( url( "http://example.com" ).set_params( {"id", "42"} ).query() == "id=42" ); heading text Postconditions 1 code this->has_query() == true heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text Complexity 1 paragraph text Linear. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text ://en.wikipedia.org/wiki/Query_string" >Query string (Wikipedia) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 >3.4. Query (rfc3986)</a> @li <a href= unordered brief text Set the query params url_base::set_params returns code text *this param text The params to set. ps param text The options for encoding. opts see reference encoded_params tDMWbnBabN2mGSH3Apn445gDMEQ= text , reference remove_query ZZWEzCK7DguUxc3TvUfizoGKplE= text , reference set_encoded_query QcQ13DUh8M8TR/zj/LDG3N/+i3c= text , reference set_query 99/QTSBQGLrNj3zGdw5VzYlqfnI= text . identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url specialization 3tT5Y8vozttMWXrA/fNw4NcDYTE= initializer_list identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std ps identifier Bb04pNwExynJkzlY9a9GCeeB13k= encoding_opts opts {} normal 1 set_password boost/url/url.hpp include/boost/url/url.hpp 435 5 1 function RT+5kxvCEY+rBBTsbgzooRi73rM= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text This function sets the password in the userinfo to the string. Reserved characters in the string are percent-escaped in the result. admonition paragraph text The interpretation of the userinfo as individual user and password components is scheme-dependent. Transmitting passwords in URLs is deprecated. note heading text Example 1 code assert( url("http://user@example.com").set_password( "pass" ).encoded_userinfo() == "user:pass" ); heading text Postconditions 1 code this->has_password() == true && this->password() == s heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code userinfo = [ [ user ] [ ':' password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Set the password. url_base::set_password returns code text *this param text The string to set. This string may contain any characters, including nulls. s see reference remove_password 8csn1QWMkOmUIhniJ0RUu0RZwG4= text , reference set_encoded_password d6h7pMb0CVly+yxJA3qTA9oUkyg= text , reference set_encoded_user FVik3N3tY4odaRANj5Yd7ryYKbM= text , reference set_user bdwdrMSefiuKM7oY4Cga3Q9MJp4= text . identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 set_path boost/url/url.hpp include/boost/url/url.hpp 473 5 1 function 8Nou0ZhJ8DhQBDRFYHX+OQrxd1g= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text This function sets the path to the string, which may be empty. Reserved characters in the string are percent-escaped in the result. admonition paragraph text The library may adjust the final result to ensure that no other parts of the URL are semantically affected. note admonition paragraph text This function does not encode '/' chars, which are unreserved for paths but reserved for path segments. If a path segment should include encoded '/'s to differentiate it from path separators, the functions reference set_encoded_path GQGd+Ne+D3eTy4fe+x1cpa5zefU= text or reference segments coMz0KQ2BIuACsWbIRZ/6lTOmuk= text should be used instead. note heading text Example 1 code url u( "http://www.example.com" ); u.set_path( "path/to/file.txt" ); assert( u.path() == "/path/to/file.txt" ); heading text Complexity 1 paragraph text Linear in code text this->size() + s.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code path = path-abempty ; begins with "/" or is empty / path-absolute ; begins with "/" but not "//" / path-noscheme ; begins with a non-colon segment / path-rootless ; begins with a segment / path-empty ; zero characters path-abempty = *( "/" segment ) path-absolute = "/" [ segment-nz *( "/" segment ) ] path-noscheme = segment-nz-nc *( "/" segment ) path-rootless = segment-nz *( "/" segment ) path-empty = 0<pchar> heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text Set the path. url_base::set_path returns code text *this param text The string to set. s see reference encoded_segments qeLAK8oZj7+xpHv7Pyh0yYASuqU= text , reference segments coMz0KQ2BIuACsWbIRZ/6lTOmuk= text , reference set_encoded_path GQGd+Ne+D3eTy4fe+x1cpa5zefU= text , reference set_path_absolute BHDHQef0k/8vd3QskLyTrsv7+DE= text . identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 set_path_absolute boost/url/url_base.hpp include/boost/url/url_base.hpp 1760 5 1 function BHDHQef0k/8vd3QskLyTrsv7+DE= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function adjusts the path to make it absolute or not, depending on the parameter. admonition paragraph text If an authority is present, the path is always absolute. In this case, the function has no effect. note heading text Example 1 code url u( "path/to/file.txt" ); assert( u.set_path_absolute( true ) ); assert( u.buffer() == "/path/to/file.txt" ); heading text Postconditions 1 code this->is_path_absolute() == true && this->encoded_path().front() == '/' heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text BNF 1 code path = path-abempty ; begins with "/" or is empty / path-absolute ; begins with "/" but not "//" / path-noscheme ; begins with a non-colon segment / path-rootless ; begins with a segment / path-empty ; zero characters path-abempty = *( "/" segment ) path-absolute = "/" [ segment-nz *( "/" segment ) ] path-noscheme = segment-nz-nc *( "/" segment ) path-rootless = segment-nz *( "/" segment ) path-empty = 0<pchar> heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text Set if the path is absolute returns text true on success. param text If code text true text , the path is made absolute. absolute see reference encoded_segments qeLAK8oZj7+xpHv7Pyh0yYASuqU= text , reference segments coMz0KQ2BIuACsWbIRZ/6lTOmuk= text , reference set_encoded_path GQGd+Ne+D3eTy4fe+x1cpa5zefU= text , reference set_path 0VMn4mT6ruiabbTCXyOFe+JATBg= text . identifier bool identifier bool absolute normal 1 set_port boost/url/url.hpp include/boost/url/url.hpp 466 5 1 function ThaNWrwh5iKGzqCX2N+LX3KLHhE= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text This port is set to the string, which must contain only digits or be empty. An empty port string is distinct from having no port. heading text Example 1 code assert( url( "http://www.example.com" ).set_port( "8080" ).authority().buffer() == "www.example.com:8080" ); heading text Postconditions 1 code this->has_port() == true && this->port_number() == n && this->port() == std::to_string(n) heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text BNF 1 code port = *DIGIT heading text Specification 1 list paragraph link text 3.2.3. Port (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.3 unordered brief text Set the port url_base::set_port returns code text *this param text The port string to set. s see reference remove_port odPyefMzS7RR8SxYOkeOFWrJWCo= text , reference set_port ThaNWrwh5iKGzqCX2N+LX3KLHhE= text . identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 set_port_number boost/url/url.hpp include/boost/url/url.hpp 464 5 1 function Ap8PBa2tnaS+9s4pC2/HSbsJ2W8= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text The port is set to the specified integer. heading text Example 1 code assert( url( "http://www.example.com" ).set_port_number( 8080 ).authority().buffer() == "www.example.com:8080" ); heading text Postconditions 1 code this->has_authority() == true && this->has_port() == true && this->port_number() == n heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code authority = [ userinfo "@" ] host [ ":" port ] port = *DIGIT heading text Specification 1 list paragraph link text 3.2.3. Port (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.3 unordered brief text Set the port url_base::set_port_number returns code text *this param text The port number to set. n see reference remove_port ADa0xIsiS8APEAdL3+s0LoNowA8= text , reference set_port p1q1Ba+a+naWvTDfBuMPt0DJw2A= text . identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url identifier Qvo2fOST20EZC7bSOAFZr+u3ITg= uint16_t n normal 1 set_query boost/url/url.hpp include/boost/url/url.hpp 478 5 1 function 28viuAEHui7vd0hJTnE+g+nEWPM= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text This sets the query to the string, which can be empty. An empty query is distinct from having no query. Reserved characters in the string are percent-escaped in the result. heading text Example 1 code assert( url( "http://example.com" ).set_query( "id=42" ).query() == "id=42" ); heading text Postconditions 1 code this->has_query() == true && this->query() == s heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Set the query url_base::set_query returns code text *this param text The string to set. s see reference encoded_params tDMWbnBabN2mGSH3Apn445gDMEQ= text , reference params wdcIrRY9aj9gn6bF1i59TpOAQb4= text , reference remove_query lqzeYddpaDdNhabYJKbZcKVR1sc= text , reference set_encoded_query FfxhA5mBZ2/8cwSUixtcx3WcR/k= text . identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 set_scheme boost/url/url.hpp include/boost/url/url.hpp 413 5 1 function l5PbLvVICdt8q5T3JPg6iGiNsQw= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text The scheme is set to the specified string, which must contain a valid scheme without any trailing colon (':'). Note that schemes are case-insensitive, and the canonical form is lowercased. heading text Example 1 code assert( url( "http://www.example.com" ).set_scheme( "https" ).scheme_id() == scheme::https ); heading text Complexity 1 paragraph text Linear in code text this->size() + s.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text BNF 1 code scheme = ALPHA *( ALPHA / DIGIT / "+" / "-" / "." ) heading text Specification 1 list paragraph link text 3.1. Scheme (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.1 unordered brief text Set the scheme url_base::set_scheme returns code text *this param text The scheme to set. s see reference remove_scheme xoEDWd6f1PiR0V17DuoUOwC8MtA= text . identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 set_scheme_id boost/url/url.hpp include/boost/url/url.hpp 415 5 1 function rOaH2oJeKO+BU3TB90QiuF0FRCw= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text This function sets the scheme to the specified known reference urls::scheme P7uOjuAMILimKGOcbjDUSpMAL/U= text id, which may not be reference scheme::unknown LJxTyQ55ot1WYLH7f46nZvdGU78= text or else an exception is thrown. If the id is reference scheme::none VupiauVBXlZQ8Uix+vk8kSl+fM8= text , this function behaves as if reference remove_scheme 1N2Tt1DokczwHdRgAZiZzhPQr4E= text were called. heading text Example 1 code assert( url( "http://example.com/echo.cgi" ).set_scheme_id( scheme::wss ).buffer() == "wss://example.com/echo.cgi" ); heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text Specification 1 list paragraph link text 3.1. Scheme (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.1 unordered brief text Set the scheme url_base::set_scheme_id returns code text *this param text The scheme to set. id identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url identifier P7uOjuAMILimKGOcbjDUSpMAL/U= scheme identifier dnk5XPfR2OaMpCYaH3cWSxcTdyc= urls id normal 1 set_user boost/url/url.hpp include/boost/url/url.hpp 431 5 1 function bdwdrMSefiuKM7oY4Cga3Q9MJp4= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text This function sets the user part of the userinfo to the string. Any special or reserved characters in the string are automatically percent-encoded. heading text Example 1 code assert( url().set_user("john doe").encoded_userinfo() == "john%20doe" ); heading text Postconditions 1 code this->has_authority() == true && this->has_userinfo() == true heading text Complexity 1 paragraph text Linear in code text this->size() + s.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code userinfo = [ [ user ] [ ':' password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Set the user url_base::set_user returns code text *this param text The string to set. s see reference remove_password M5RIQPf9vzlN+m4Qn0PDNFKy8ak= text , reference set_encoded_password qF7dDBIf4KkHxSuysLw1EJNSh2Y= text , reference set_encoded_user YNLJGohUXCdL6mo1PM3ms9pRQyE= text , reference set_password blkDquwzHtk7o5mJf/hdeY15zWg= text . identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 set_userinfo boost/url/url.hpp include/boost/url/url.hpp 425 5 1 function tbHsdn3vwHk6vomi64efnJApwUQ= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text The userinfo is set to the given string, which may contain percent-escapes. Any special or reserved characters in the string are automatically percent-encoded. The effects on the user and password depend on the presence of a colon (':') in the string: list paragraph text If an unescaped colon exists, the characters up to the colon become the user and the rest of the characters after the colon become the password. In this case reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text returns true. Otherwise, paragraph text If there is no colon, the user is set to the string. The function reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text returns false. unordered admonition paragraph text The interpretation of the userinfo as individual user and password components is scheme-dependent. Transmitting passwords in URLs is deprecated. note heading text Example 1 code assert( url( "http://example.com" ).set_userinfo( "user:pass" ).encoded_user() == "user" ); heading text Complexity 1 paragraph text Linear in code text this->size() + s.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code userinfo = [ [ user ] [ ':' password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Set the userinfo url_base::set_userinfo returns code text *this param text The string to set. s see reference remove_userinfo PjTTglJlJuEwKHuRXGByi7wW8W8= text , reference set_encoded_userinfo MLv0mdC6EhrEgdnFiOF+W8sw0/c= text . identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 set_zone_id boost/url/url.hpp include/boost/url/url.hpp 454 5 1 function f8Xcvlga8PU/hVmzDg6ehOPfDYs= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text This function sets the zone ID for the host if the host is an IPv6 address. Reserved characters in the string are percent-escaped in the result. heading text Example 1 code assert( u.set_host_ipv6( ipv6_address( "fe80::1" ) ).set_zone_id( "eth0" ).buffer() == "https://[fe80::1%25eth0]" ); heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text Specification 1 list paragraph link text RFC 6874 https://datatracker.ietf.org/doc/html/rfc6874 unordered brief text Set the zone ID for an IPv6 address. url_base::set_zone_id returns code text *this param text The zone ID to set. s identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 size boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 201 5 1 function b5EwiMBFGrk0/BIGaiumuCVSoFM= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the number of characters in the url's encoded string, not including any null terminator, if present. heading text Example 1 code assert( url_view( "file:///Program%20Files" ).size() == 23 ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the number of characters in the url returns text The number of characters in the url. identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 1 swap boost/url/url.hpp include/boost/url/url.hpp 363 5 1 function iZ1eWw5IAl1ilQ72KPrht00pGzU= regular B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph text Exchanges the contents of this url with another url. All views, iterators and references remain valid. paragraph text If code text this == &other text , this function call has no effect. heading text Example 1 code url u1( "https://www.example.com" ); url u2( "https://www.boost.org" ); u1.swap(u2); assert(u1 == "https://www.boost.org" ); assert(u2 == "https://www.example.com" ); heading text Complexity 1 paragraph text Constant heading text Exception Safety 1 paragraph text Throws nothing. brief text Swap the contents. param text The object to swap with other identifier void identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url other normal 1 user boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 848 5 1 function /oa6wZJEG852J9Yi1LQlnq1n1tM= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If present, this function returns a string representing the user (which may be empty). Otherwise it returns an empty string. Any percent-escapes in the string are decoded first. heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).user() == "jane-doe" ); heading text Complexity 1 paragraph text Linear in code text this->user().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code userinfo = user [ ":" [ password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return the user returns text The user as a string. param text The string token to use. token see reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text , reference has_userinfo i/v5Vfq44OnlLbuKgQ2KvgWgZqo= text , reference encoded_password W9oZv0BM5z4XAggQPbNAKIM7/ro= text , reference encoded_user oYwrnXcglhO4tlvhkxLGfFCYbAk= text , reference encoded_userinfo yzkq+uCmbTlXrfDuyd1fT0Zu6xw= text , reference password +ZB55yb2DeVYG+/eYqlMcGcedVE= text , reference userinfo S9yd7MVhXxF+598Xy2/+jwnCZzc= text . identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 userinfo boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 748 5 1 function S9yd7MVhXxF+598Xy2/+jwnCZzc= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If present, this function returns a string representing the userinfo (which may be empty). Otherwise it returns an empty string. Any percent-escapes in the string are decoded first. admonition paragraph text This function uses the string token return type customization. Depending on the token passed, the return type and behavior of the function can be different. See reference string_token::return_string +eBzDECNPyuTkJuxLUTMVIkHGO0= text for more information. note heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).userinfo() == "jane-doe:pass" ); heading text Complexity 1 paragraph text Linear in code text this->userinfo().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code userinfo = user [ ":" [ password ] ] authority = [ userinfo "@" ] host [ ":" port ] heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return the userinfo returns text When called with no arguments, a value of type code text std::string text is returned. Otherwise, the return type and meaning depends on the string token passed to the function. returns text The userinfo as a string. param text The string token to use. token see reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text , reference has_userinfo i/v5Vfq44OnlLbuKgQ2KvgWgZqo= text , reference encoded_password W9oZv0BM5z4XAggQPbNAKIM7/ro= text , reference encoded_user oYwrnXcglhO4tlvhkxLGfFCYbAk= text , reference encoded_userinfo yzkq+uCmbTlXrfDuyd1fT0Zu6xw= text , reference password +ZB55yb2DeVYG+/eYqlMcGcedVE= text , reference user /oa6wZJEG852J9Yi1LQlnq1n1tM= text . identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 zone_id boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1480 5 1 function rN6p9/aLARL9S9gn02k+M+j21q8= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If the host type is reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= text , this function returns the Zone ID as a string. Otherwise an empty string is returned. Any percent-escapes in the string are decoded first. heading text Example 1 code assert( url_view( "http://[fe80::1%25eth0]/" ).zone_id() == "eth0" ); heading text Complexity 1 paragraph text Linear in code text this->encoded_zone_id().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPv6addrz / IPvFuture ) "]" ZoneID = 1*( unreserved / pct-encoded ) IPv6addrz = IPv6address "%25" ZoneID heading text Specification 1 list paragraph link text Representing IPv6 Zone Identifiers in Address Literals and Uniform Resource Identifiers https://datatracker.ietf.org/doc/html/rfc6874 unordered brief text Return the IPv6 Zone ID returns text The Zone ID as a string. param text A string token customization. token identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 operator basic_string_view<char> boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 299 5 1 function 0JOtXYOmKvCl2dNIZYV6J7flgJE= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the URL as a core::string_view returns text A string view of the URL. identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core conversion 1 1 max_size boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 173 5 1 function mg8FRYZ94og9lKYjTEYdjucqHw4= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This represents the largest number of characters that are theoretically possible to represent in a url, not including any null terminator. In practice the actual possible size may be lower than this number. heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the maximum number of characters possible returns text The maximum number of characters. identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 digest boost/url/impl/url_view_base.hpp include/boost/url/impl/url_view_base.hpp 81 1 boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 146 5 1 function aSDB3babl7TsiU0T+gdHMM/NC5c= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function calculates a hash of the url as if it were always normalized. heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Throws nothing. brief text Calculate a hash of the url returns text A hash value suitable for use in hash-based containers. param text An initial value to add to the hash salt identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std salt 0 normal 1 1 url_base boost/url/url_base.hpp include/boost/url/url_base.hpp 61 1 1 boost/url/authority_view.hpp include/boost/url/authority_view.hpp 29 1 boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 23 1 boost/url/params_ref.hpp include/boost/url/params_ref.hpp 24 1 boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 23 1 boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 23 1 record aHkFCWJbYb0t+7FT+A5gCI0krpU= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text This base class is used by the library to provide common member functions for containers. This cannot be instantiated directly; Instead, use one of the containers or functions: heading text Containers 1 list paragraph reference url B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph reference url_view wh3UbUToX9YDmRmnpcoM9EUEZo8= paragraph reference static_url 4HBDcnMjZthTXFnhpS7z+UhDNjA= unordered heading text Functions 1 list paragraph reference parse_absolute_uri U3CVElRbcTcbg1JzOqhBCd5RSzM= paragraph reference parse_origin_form J4f05lEg7oi89R2SkpRaYiBhCIQ= paragraph reference parse_relative_ref QFzcl8vSLEeKOEO6w3mv1zGqX3k= paragraph reference parse_uri f+9kR517VGSM5ZPoS7g/RFb0g/0= paragraph reference parse_uri_reference 7d2b1xVBWJPgL/+PWFdoBaZJvMA= unordered brief text Common functionality for containers reference format_to K7ofEKM2bNb4ZS9OFo0DX+7Ep9I= reference format_to ueXaMbO5jFzZWelOn6upDJcN55Y= reference operator!= QA2q/R+XvrJl2j8UnJwv+lnhdDA= reference operator< Si07vh35lnvnJy8tpXUIpiFEjGM= reference operator<= rRCHC/6GEaVZrjzAeFDlvaCydi0= reference operator== E2+0o+/H5dWqJ1IkTzJ6aHTaMHE= reference operator> ngGy21anUjaZiQQJidHT5lvOC2w= reference operator>= AdXFp/RvPKHF4rljfa5/5yBmyfs= class identifier UEVNhDEjkZMXfjN1DxbtX0n2rCg= url_view_base dmsqdje8dXFRFgNB9wxOs9Y5nb8= B4dRaSXMG3fDmuNKMW3KOeRu6kA= v5/R9LI0iKJDiBrNUt7k8qrVBdM= oDNnPxjP34HYhoUyyduWMZfqZs4= OUdGewqojyZZ2vohOsR/ce3sgdM= FPqXKVymUm0eRCsXV1yuMFlv4ug= PMYRGpyOUt7hbDyd33GRHTcxEj8= p+2L2asXUGpE7eey1ouRvFXKD1g= I2WjK21z+iS45kbL4TnzA8O5oE0= 5yR7btLz2K+NLHFnzfXMyGsq2fo= Ww04vLA2k7BwctuyNeP3KwoNr4M= M7+OzewsxChMvecRSytXqTCqKrY= EcGxt+esOtVfjloInubXUYLy5GY= yXsUZRbi+wInLqaUUVy9b7nIIBo= 9ptIMbwWSNtVv+KAUpHCO3bmTWg= 4URKnuP+gvIUVjIkywv/pXeFjv4= wG6ey1727HIj10Wh+OD/s8kuOjo= tDMWbnBabN2mGSH3Apn445gDMEQ= W9oZv0BM5z4XAggQPbNAKIM7/ro= GNlqbV0MSxGIA/gSjlOb2rfSHhU= suU4/MiRITTTYf61BFw2aI6WxdI= yLMNPjiW4s31xcLN4xOiqVySYLA= qeLAK8oZj7+xpHv7Pyh0yYASuqU= IcodRek43l5Zc13Z67L74PlhG0U= oYwrnXcglhO4tlvhkxLGfFCYbAk= yzkq+uCmbTlXrfDuyd1fT0Zu6xw= 5M2smbXDaSa2d/li//A+GmlDgDU= aA1Q9NAW4/TnG3SXhe4k1mNB5nk= gadV3YsYDjlGX+64Rtiz4S+QD4A= ZiWsQaQCAif94KdP6GXH9+F5GmM= 9JACnsebk8tFsoryabfDxE8VpnA= 5V5uOhRsy00O+TSEAkIb7uFoN2U= SLiWca6gUGmTh+r/BbU40NrICW8= iwSH2fvVkb89TkZj7KWLGSyc4sA= i/v5Vfq44OnlLbuKgQ2KvgWgZqo= ICcovOIyqnxhSMU6MuEekYg2z+E= F0RYzLwUP8ied6l3zmKvomgFHag= KL8F3KYxyzpC1e6fqoJy3B8IHhw= CvoRh2IpWg4QixngVwDjSKoeQVY= 55Yh68uToEiKy+IDTpyctuK/T3g= AhPhrC4hmBsZgd/ztqbkAuOkbBM= Nv9Emy6spILLI/mqyIz2uRNBJhU= eh5BeHbLjL3BuEY7ao3tbEAZnTw= ldUmQToJNGQ58j33Mti85clcGbM= j2lB1y9ywFNpGt8xXYkZZuJbs30= R2y0tPa5JiRRSTNXgUjKdMoCOcA= pjVn3eVVaWNAixzkPBECE+lKByQ= 4CZ8ebKgivCQbRJoYD78PmOko2U= iyO2AawtEbzXMJkvSocn7BpBBrI= wdcIrRY9aj9gn6bF1i59TpOAQb4= +ZB55yb2DeVYG+/eYqlMcGcedVE= Q5NVO+d/+BmZ5v3/ogNb2XpUTKs= cRPG1npIXmfYC0K+C+idxOqIc04= OlWcRIIUl1cq5Ab9fLXGPyhYCfI= lctXu8FITJWg0+Y+yZVt5iv7QDM= 4epyMikskiBx2Gu+S87oAhrM/ZY= cjTKMEM0IWRzDexmJAiWOj6P+ZI= aGhIz5PP9XtdztICzhAvM4n92Sg= OqDHBYUjGSW4mGYuSUu09xFSlEc= M5RIQPf9vzlN+m4Qn0PDNFKy8ak= ADa0xIsiS8APEAdL3+s0LoNowA8= ZZWEzCK7DguUxc3TvUfizoGKplE= 1N2Tt1DokczwHdRgAZiZzhPQr4E= PjTTglJlJuEwKHuRXGByi7wW8W8= R5AajT/eZPgijKrm8AxolAdhsRQ= 3Pi5l1khAbVAQHD3fWi5GoHEr5E= 43fxogaC5oVqfauhwXyN4s4ibEM= uM37WpBqetqzfHjns3M8/+CcoEU= coMz0KQ2BIuACsWbIRZ/6lTOmuk= VTO/x6AChJRFyjVKxhaqmIAvYFI= ebU9NPxh5c4VwDAaQA1CXRWbSKk= OgEcjvMpUkw5cqqrotx6BNVfYuA= 51fvhkKEd4+UZEBsnLd4vUL/Svw= Lz8KFSebh4YuJuAAf0STYQ/VPqk= S9fyQqerhxu7yBt8GhsEJ9RKJl8= qF7dDBIf4KkHxSuysLw1EJNSh2Y= GQGd+Ne+D3eTy4fe+x1cpa5zefU= QcQ13DUh8M8TR/zj/LDG3N/+i3c= YNLJGohUXCdL6mo1PM3ms9pRQyE= MLv0mdC6EhrEgdnFiOF+W8sw0/c= /HsDRNr5aHRIzBwkJqZnZrdNZ/k= VHh7zoCWGsviuG3lWYA54cKWneU= lhYybwvylnG/ieiGmyVfyExN3dw= ut25mVfVRShtv19Mg+nvS5jVATc= Cn5GM3RJyUENDJ/d6LnYVW+gkA4= BryTExdDEUoZs6riyC1Qi0/NtPE= BQxPHhB2Uv0OyVbWf3e7/seXVX8= Pt4icJRgJxULgQjbXV6yzBigNl8= 6eTAKxxUVgfC1QD7w2yAukEvLs4= blkDquwzHtk7o5mJf/hdeY15zWg= 0VMn4mT6ruiabbTCXyOFe+JATBg= BHDHQef0k/8vd3QskLyTrsv7+DE= p1q1Ba+a+naWvTDfBuMPt0DJw2A= 4bptcCq14NmzqKQvnx54lE+28F0= 99/QTSBQGLrNj3zGdw5VzYlqfnI= rKQfFZ6dfzeuSqZL+PgPNpIFQ5g= iuTF0vS1Knzl0Hxr4iVhx35Fzdk= GWy3y66sOX4ov+Eh3hxNRVsAEwY= s+5EFNaQxZ6HMzMRElE8AAODpm8= eM5mUh7EZ/5wyXKQEoMXhHD+KJk= b5EwiMBFGrk0/BIGaiumuCVSoFM= /oa6wZJEG852J9Yi1LQlnq1n1tM= S9yd7MVhXxF+598Xy2/+jwnCZzc= rN6p9/aLARL9S9gn02k+M+j21q8= 0JOtXYOmKvCl2dNIZYV6J7flgJE= mg8FRYZ94og9lKYjTEYdjucqHw4= aSDB3babl7TsiU0T+gdHMM/NC5c= LrOuDwXSUVYVHAG+uDinzDEhTFI= ACv6cbyy+qwF4Grw2ImYMT37o6c= yEbPwcYlSGwS/WWr7Eyl1ZXTxgs= xOo+qJrpci08zieIESxPg3duK8Y= x88f9gEzqRzjzlddj+COZb+kOa4= v60EMn03FSngS5U+XQzRYPM66eI= jb1Do4Iq/2L6g8BMhGH4L+UKrrc= +VRlftH8tdsWB1hmgzFTfipryW4= sj+cIJ43zPPUeS2LmwuCMyg0ELQ= 0inzpZQv0vccxZpMxuq2LIhXdPY= nS6hMdp4qIidO3NruqkuUl0zp8g= tdZeYo0D3cI5JTEstZyrgENbKv8= kXN/2PpAfFV/f9+H/Irt0GkIBw4= 2+vwiNhRlQmuVGf6GZUA0E+7PZg= RmymeHKzAV7l4IQkmZIoPSssEfc= cjNYZqTKcBeohWDFxQ44iHZzEX0= oeOW51EVOmWS7hHJ3eoRVvDX/HU= SBQcwNR9Gb1qsGNk/fEZsCfC6vg= cPBLbSy4JTgJIt8kRS9TNUJTfhs= uFAOxEs+Pg5XgLMPb24pZrALgBo= cnoNWMH/7+WSnH+8Pjsu+fETdmk= Q2k7rhH19Azg4qHyvNZY5Pe32ng= JxfZIYaxQd5iJWcexl1uWenSVDI= SVP7xFpeV2teYX7syyH210MqK+k= qhwCL6gal6hnVMd7M8/RGfeo0sw= bq3uTBT6m16XZEQ239/VtJvLTxk= PUY/8ZYmgkmr4ZXd77klBn1jjJY= /6zWjIFN5df0PBj9zFsfNUjNY6s= identifier oR5B5D0/JYTOQYvyFXRv+at91JE= params_encoded_ref oR5B5D0/JYTOQYvyFXRv+at91JE= identifier TCUUfRiqZjX62kt7tK2fs//VWr0= segments_encoded_ref TCUUfRiqZjX62kt7tK2fs//VWr0= identifier zdr3gU7+2/G05oo6ta/IfHlkTF0= segments_ref zdr3gU7+2/G05oo6ta/IfHlkTF0= identifier 8S83BKvWBCDdTktlY8X93Mlo9E0= params_ref 8S83BKvWBCDdTktlY8X93Mlo9E0= identifier dmsqdje8dXFRFgNB9wxOs9Y5nb8= static_url_base dmsqdje8dXFRFgNB9wxOs9Y5nb8= identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url B4dRaSXMG3fDmuNKMW3KOeRu6kA= authority boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 564 5 1 function v5/R9LI0iKJDiBrNUt7k8qrVBdM= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the authority as an reference authority_view d/hMlyyC3Ave6L9McUD7B4TwENA= text . heading text Example 1 code authority_view a = url_view( "https://www.example.com:8080/index.htm" ).authority(); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code authority = [ userinfo "@" ] host [ ":" port ] heading text Specification 1 list paragraph link text 3.2. Authority (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2 unordered brief text Return the authority returns text An authority_view representing the authority. see reference encoded_authority Ww04vLA2k7BwctuyNeP3KwoNr4M= text , reference has_authority gadV3YsYDjlGX+64Rtiz4S+QD4A= text . identifier d/hMlyyC3Ave6L9McUD7B4TwENA= authority_view normal 1 1 buffer boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 282 5 1 function oDNnPxjP34HYhoUyyduWMZfqZs4= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the entire url, which may contain percent escapes. heading text Example 1 code assert( url_view( "http://www.example.com" ).buffer() == "http://www.example.com" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the url string returns text The url as a string. identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core normal 1 1 c_str boost/url/url_base.hpp include/boost/url/url_base.hpp 127 5 1 function OUdGewqojyZZ2vohOsR/ce3sgdM= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function returns a pointer to a null terminated string representing the url, which may contain percent escapes. heading text Example 1 code assert( std::strlen( url( "http://www.example.com" ).c_str() ) == 22 ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the url as a null-terminated string returns text A pointer to a null-terminated string containing the URL. 1 identifier char normal 1 1 capacity boost/url/url_base.hpp include/boost/url/url_base.hpp 146 5 1 function FPqXKVymUm0eRCsXV1yuMFlv4ug= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This does not include the null terminator, which is always present. heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the number of characters that can be stored without reallocating returns code text *this identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 1 clear boost/url/url_base.hpp include/boost/url/url_base.hpp 165 5 1 function PMYRGpyOUt7hbDyd33GRHTcxEj8= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= heading text Postconditions 1 code this->empty() == true heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text No-throw guarantee. brief text Clear the contents while preserving the capacity identifier void normal 1 compare boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2446 5 1 function p+2L2asXUGpE7eey1ouRvFXKD1g= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function compares two URLs according to Syntax-Based comparison algorithm. heading text Complexity 1 paragraph text Linear in code text min( u0.size(), u1.size() ) heading text Exception Safety 1 paragraph text Throws nothing. heading text Specification 1 list paragraph link text 6.2.2 Syntax-Based Normalization (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-6.2.2 unordered brief text Return the result of comparing this with another url returns text -1 if code text *this < other text , 0 if code text this == other text , and 1 if code text this > other text . param text The url to compare other identifier int 1 identifier UEVNhDEjkZMXfjN1DxbtX0n2rCg= url_view_base other normal 1 1 data boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 258 5 1 function I2WjK21z+iS45kbL4TnzA8O5oE0= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns a pointer to the first character of the url, which is not guaranteed to be null-terminated. heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return a pointer to the url's character buffer returns text A pointer to the first character. 1 identifier char normal 1 1 empty boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 238 5 1 function 5yR7btLz2K+NLHFnzfXMyGsq2fo= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text The empty string matches the emph text relative-ref text grammar. heading text Example 1 code assert( url_view( "" ).empty() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code relative-ref = relative-part [ "?" query ] [ "#" fragment ] relative-part = "//" authority path-abempty / path-absolute / path-noscheme / path-empty heading text Specification 1 list paragraph link text 4.2. Relative Reference (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-4.2 unordered brief text Return true if the url is empty returns code text true text if the url is empty. identifier bool normal 1 1 encoded_authority boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 601 5 1 function Ww04vLA2k7BwctuyNeP3KwoNr4M= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If present, this function returns a string representing the authority (which may be empty). Otherwise it returns an empty string. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "file://Network%20Drive/My%2DFiles" ).encoded_authority() == "Network%20Drive" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code authority = [ userinfo "@" ] host [ ":" port ] heading text Specification 1 list paragraph link text 3.2. Authority (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2 unordered brief text Return the authority. returns text The authority as a string. see reference authority v5/R9LI0iKJDiBrNUt7k8qrVBdM= text , reference has_authority gadV3YsYDjlGX+64Rtiz4S+QD4A= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_fragment boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2280 5 1 function M7+OzewsxChMvecRSytXqTCqKrY= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the fragment as a string with percent-escapes. Ownership is not transferred; the string returned references the underlying character buffer, which must remain valid or else undefined behavior occurs. heading text Example 1 code assert( url_view( "http://www.example.com/index.htm#a%2D1" ).encoded_fragment() == "a%2D1" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code fragment = *( pchar / "/" / "?" ) pchar = unreserved / pct-encoded / sub-delims / ":" / "@" heading text Specification 1 list paragraph link text 3.5. Fragment (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.5 unordered brief text Return the fragment returns text The fragment portion of the url. see reference fragment aA1Q9NAW4/TnG3SXhe4k1mNB5nk= text , reference has_fragment ZiWsQaQCAif94KdP6GXH9+F5GmM= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_host boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1120 5 1 function EcGxt+esOtVfjloInubXUYLy5GY= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the host portion of the authority as a string, or the empty string if there is no authority. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "https://www%2droot.example.com/" ).encoded_host() == "www%2droot.example.com" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPvFuture ) "]" reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host returns text The host address as a string. identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_host_address boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1237 5 1 function yXsUZRbi+wInLqaUUVy9b7nIIBo= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text The value returned by this function depends on the type of host returned from the function reference host_type Nv9Emy6spILLI/mqyIz2uRNBJhU= text . list paragraph text If the type is reference host_type::ipv4 49F64dAiji9HVbP6MxLQiqot7AY= text , then the IPv4 address string is returned. paragraph text If the type is reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= text , then the IPv6 address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::ipvfuture TcYJaTwDFsx+0S2CkvHHARcCqWc= text , then the IPvFuture address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= text , then the host name string is returned. Any percent-escapes in the string are decoded first. paragraph text If the type is reference host_type::none QyoMTu07h232/Sxqovu2mGoPgTo= text , then an empty string is returned. The returned string may contain percent escapes. unordered heading text Example 1 code assert( url_view( "https://www%2droot.example.com/" ).encoded_host_address() == "www%2droot.example.com" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPvFuture ) "]" reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host returns text The host address as a string. identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_host_and_port boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2325 5 1 function 9ptIMbwWSNtVv+KAUpHCO3bmTWg= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If an authority is present, this function returns the host and optional port as a string, which may be empty. Otherwise it returns an empty string. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "http://www.example.com:8080/index.htm" ).encoded_host_and_port() == "www.example.com:8080" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code authority = [ userinfo "@" ] host [ ":" port ] heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 paragraph link text 3.2.3. Port (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.3 unordered brief text Return the host and port returns text The host and port portion of the url. see reference has_port 5V5uOhRsy00O+TSEAkIb7uFoN2U= text , reference port OlWcRIIUl1cq5Ab9fLXGPyhYCfI= text , reference port_number lctXu8FITJWg0+Y+yZVt5iv7QDM= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_host_name boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1441 5 1 function 4URKnuP+gvIUVjIkywv/pXeFjv4= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If the host type is reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= text , this function returns the name as a string. Otherwise, if the host type is not an name, it returns an empty string. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "https://www%2droot.example.com/" ).encoded_host_name() == "www%2droot.example.com" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPvFuture ) "]" reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host name returns text The host name as a percent-encoded string. identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_origin boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2355 5 1 function wG6ey1727HIj10Wh+OD/s8kuOjo= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If an authority is present, this function returns the scheme and authority portion of the url. Otherwise, an empty string is returned. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "http://www.example.com:8080/index.htm?text=none#h1" ).encoded_origin() == "http://www.example.com:8080" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the origin returns text The origin portion of the url. see reference encoded_resource yLMNPjiW4s31xcLN4xOiqVySYLA= text , reference encoded_target IcodRek43l5Zc13Z67L74PlhG0U= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_params boost/url/url_base.hpp include/boost/url/url_base.hpp 2248 5 1 boost/url/url_base.hpp include/boost/url/url_base.hpp 2300 5 1 overloads tDMWbnBabN2mGSH3Apn445gDMEQ= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= brief text Return the query as a container of parameters returns code text *this returns text A bidirectional view of key/value pairs. see reference params wdcIrRY9aj9gn6bF1i59TpOAQb4= text , reference remove_query ZZWEzCK7DguUxc3TvUfizoGKplE= text , reference set_encoded_query QcQ13DUh8M8TR/zj/LDG3N/+i3c= text , reference set_query 99/QTSBQGLrNj3zGdw5VzYlqfnI= text . see reference encoded_query suU4/MiRITTTYf61BFw2aI6WxdI= text , reference has_query SLiWca6gUGmTh+r/BbU40NrICW8= text , reference params wdcIrRY9aj9gn6bF1i59TpOAQb4= text , reference query 4epyMikskiBx2Gu+S87oAhrM/ZY= text . normal aMmTh8VyfWGYracYniHLsug6OhI= JE/K4m/Ht4rR+eX6GaLeumryMhM= encoded_params boost/url/url_base.hpp include/boost/url/url_base.hpp 2300 5 1 function aMmTh8VyfWGYracYniHLsug6OhI= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function returns a bidirectional view of key/value pairs over the query. The returned view references the same underlying character buffer; ownership is not transferred. Strings returned when iterating the range may contain percent escapes. The container is modifiable; changes to the container are reflected in the underlying URL. heading text Example 1 code params_encoded_ref pv = url( "/sql?id=42&name=jane%2Ddoe&page+size=20" ).encoded_params(); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Return the query as a container of parameters returns code text *this see reference params wdcIrRY9aj9gn6bF1i59TpOAQb4= text , reference remove_query ZZWEzCK7DguUxc3TvUfizoGKplE= text , reference set_encoded_query QcQ13DUh8M8TR/zj/LDG3N/+i3c= text , reference set_query 99/QTSBQGLrNj3zGdw5VzYlqfnI= text . identifier oR5B5D0/JYTOQYvyFXRv+at91JE= params_encoded_ref normal 1 encoded_params boost/url/url_base.hpp include/boost/url/url_base.hpp 2248 5 1 function JE/K4m/Ht4rR+eX6GaLeumryMhM= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function returns a bidirectional view of key/value pairs over the query. The returned view references the same underlying character buffer; ownership is not transferred. Strings returned when iterating the range may contain percent escapes. heading text Example 1 code params_encoded_view pv = url_view( "/sql?id=42&name=jane%2Ddoe&page+size=20" ).encoded_params(); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Return the query as a container of parameters url_view_base::encoded_params returns text A bidirectional view of key/value pairs. see reference encoded_query suU4/MiRITTTYf61BFw2aI6WxdI= text , reference has_query SLiWca6gUGmTh+r/BbU40NrICW8= text , reference params wdcIrRY9aj9gn6bF1i59TpOAQb4= text , reference query 4epyMikskiBx2Gu+S87oAhrM/ZY= text . identifier 0nSfM4mK92fIx58KtzdWGiHuq2w= params_encoded_view normal 1 1 encoded_password boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 996 5 1 function W9oZv0BM5z4XAggQPbNAKIM7/ro= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the password portion of the userinfo as a percent-encoded string. heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).encoded_password() == "pass" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code userinfo = user [ ":" [ password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return the password returns text The password as a string. see reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text , reference has_userinfo i/v5Vfq44OnlLbuKgQ2KvgWgZqo= text , reference encoded_user oYwrnXcglhO4tlvhkxLGfFCYbAk= text , reference encoded_userinfo yzkq+uCmbTlXrfDuyd1fT0Zu6xw= text , reference password +ZB55yb2DeVYG+/eYqlMcGcedVE= text , reference user /oa6wZJEG852J9Yi1LQlnq1n1tM= text , reference userinfo S9yd7MVhXxF+598Xy2/+jwnCZzc= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_path boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1799 5 1 function GNlqbV0MSxGIA/gSjlOb2rfSHhU= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the path as a string. The path may be empty. Any percent-escapes in the string are decoded first. heading text Example 1 code assert( url_view( "file:///Program%20Files/Games/config.ini" ).encoded_path() == "/Program%20Files/Games/config.ini" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code path = path-abempty ; begins with "/" or is empty / path-absolute ; begins with "/" but not "//" / path-noscheme ; begins with a non-colon segment / path-rootless ; begins with a segment / path-empty ; zero characters path-abempty = *( "/" segment ) path-absolute = "/" [ segment-nz *( "/" segment ) ] path-noscheme = segment-nz-nc *( "/" segment ) path-rootless = segment-nz *( "/" segment ) path-empty = 0<pchar> heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text Return the path returns text The path as a string. see reference is_path_absolute eh5BeHbLjL3BuEY7ao3tbEAZnTw= text , reference encoded_segments xDk467Vs74WMTJdzZiv8izTuGQo= text . reference path Q5NVO+d/+BmZ5v3/ogNb2XpUTKs= text , reference segments txoybJuonJpAdGVWgiAsiI45+ok= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_query boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2040 5 1 function suU4/MiRITTTYf61BFw2aI6WxdI= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If this contains a query, it is returned as a string (which may be empty). Otherwise, an empty string is returned. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "/sql?id=42&name=jane%2Ddoe&page+size=20" ).encoded_query() == "id=42&name=jane%2Ddoe&page+size=20" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Return the query returns text The query as a string. see reference encoded_params YdRpQ6mNNA/rw8PqzTxP08VgNnY= text , reference has_query SLiWca6gUGmTh+r/BbU40NrICW8= text , reference params ZdlRIJ+RVbaF05I+w1pfQzUA0/0= text , reference query 4epyMikskiBx2Gu+S87oAhrM/ZY= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_resource boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2387 5 1 function yLMNPjiW4s31xcLN4xOiqVySYLA= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the resource, which is the portion of the url that includes only the path, query, and fragment. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "http://www.example.com/index.html?query#frag" ).encoded_resource() == "/index.html?query#frag" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 unordered brief text Return the resource returns text The resource portion of the url. see reference encoded_origin wG6ey1727HIj10Wh+OD/s8kuOjo= text , reference encoded_target IcodRek43l5Zc13Z67L74PlhG0U= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_segments boost/url/url_base.hpp include/boost/url/url_base.hpp 2018 5 1 boost/url/url_base.hpp include/boost/url/url_base.hpp 2014 5 1 overloads qeLAK8oZj7+xpHv7Pyh0yYASuqU= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= brief text Return the path as a container of segments returns code text *this returns text A bidirectional view of encoded segments. see reference encoded_segments 6FgVEvfQ0X7vaJ9TLmk6h3MBVPU= text , reference set_encoded_path GQGd+Ne+D3eTy4fe+x1cpa5zefU= text , reference set_path 0VMn4mT6ruiabbTCXyOFe+JATBg= text , reference set_path_absolute BHDHQef0k/8vd3QskLyTrsv7+DE= text . see reference is_path_absolute eh5BeHbLjL3BuEY7ao3tbEAZnTw= text , reference encoded_path GNlqbV0MSxGIA/gSjlOb2rfSHhU= text , reference path Q5NVO+d/+BmZ5v3/ogNb2XpUTKs= text , reference segments coMz0KQ2BIuACsWbIRZ/6lTOmuk= text , reference segments_encoded_view EvaX3SmNTAtai2Kf6Kma3fUkTkQ= text . normal 6FgVEvfQ0X7vaJ9TLmk6h3MBVPU= 5da2HmyZRkzKje3uZJyQ0Zr/GBI= encoded_segments boost/url/url_base.hpp include/boost/url/url_base.hpp 2014 5 1 function 6FgVEvfQ0X7vaJ9TLmk6h3MBVPU= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function returns a bidirectional view of segments over the path. The returned view references the same underlying character buffer; ownership is not transferred. Strings returned when iterating the range may contain percent escapes. The container is modifiable; changes to the container are reflected in the underlying URL. heading text Example 1 code url u( "http://example.com/path/to/file.txt" ); segments_encoded_ref sv = u.encoded_segments(); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code path = path-abempty ; begins with "/" or is empty / path-absolute ; begins with "/" but not "//" / path-noscheme ; begins with a non-colon segment / path-rootless ; begins with a segment / path-empty ; zero characters path-abempty = *( "/" segment ) path-absolute = "/" [ segment-nz *( "/" segment ) ] path-noscheme = segment-nz-nc *( "/" segment ) path-rootless = segment-nz *( "/" segment ) path-empty = 0<pchar> heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text Return the path as a container of segments returns code text *this see reference encoded_segments qeLAK8oZj7+xpHv7Pyh0yYASuqU= text , reference set_encoded_path GQGd+Ne+D3eTy4fe+x1cpa5zefU= text , reference set_path 0VMn4mT6ruiabbTCXyOFe+JATBg= text , reference set_path_absolute BHDHQef0k/8vd3QskLyTrsv7+DE= text . identifier TCUUfRiqZjX62kt7tK2fs//VWr0= segments_encoded_ref normal 1 encoded_segments boost/url/url_base.hpp include/boost/url/url_base.hpp 2018 5 1 function 5da2HmyZRkzKje3uZJyQ0Zr/GBI= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function returns a bidirectional view of strings over the path. The returned view references the same underlying character buffer; ownership is not transferred. Strings returned when iterating the range may contain percent escapes. heading text Example 1 code segments_encoded_view sv = url_view( "/path/to/file.txt" ).encoded_segments(); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code path = path-abempty ; begins with "/" or is empty / path-absolute ; begins with "/" but not "//" / path-noscheme ; begins with a non-colon segment / path-rootless ; begins with a segment / path-empty ; zero characters path-abempty = *( "/" segment ) path-absolute = "/" [ segment-nz *( "/" segment ) ] path-noscheme = segment-nz-nc *( "/" segment ) path-rootless = segment-nz *( "/" segment ) path-empty = 0<pchar> heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text Return the path as a container of segments url_view_base::encoded_segments returns text A bidirectional view of encoded segments. see reference is_path_absolute eh5BeHbLjL3BuEY7ao3tbEAZnTw= text , reference encoded_path GNlqbV0MSxGIA/gSjlOb2rfSHhU= text , reference path Q5NVO+d/+BmZ5v3/ogNb2XpUTKs= text , reference segments coMz0KQ2BIuACsWbIRZ/6lTOmuk= text , reference segments_encoded_view EvaX3SmNTAtai2Kf6Kma3fUkTkQ= text . identifier EvaX3SmNTAtai2Kf6Kma3fUkTkQ= segments_encoded_view normal 1 1 encoded_target boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2419 5 1 function IcodRek43l5Zc13Z67L74PlhG0U= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the target, which is the portion of the url that includes only the path and query. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "http://www.example.com/index.html?query#frag" ).encoded_target() == "/index.html?query" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 unordered brief text Return the target returns text The target portion of the url. see reference encoded_origin wG6ey1727HIj10Wh+OD/s8kuOjo= text , reference encoded_resource yLMNPjiW4s31xcLN4xOiqVySYLA= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_user boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 901 5 1 function oYwrnXcglhO4tlvhkxLGfFCYbAk= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If present, this function returns a string representing the user (which may be empty). Otherwise it returns an empty string. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).encoded_user() == "jane%2Ddoe" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code userinfo = user [ ":" [ password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return the user returns text The user as a string. see reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text , reference has_userinfo i/v5Vfq44OnlLbuKgQ2KvgWgZqo= text , reference encoded_password W9oZv0BM5z4XAggQPbNAKIM7/ro= text , reference encoded_userinfo yzkq+uCmbTlXrfDuyd1fT0Zu6xw= text , reference password +ZB55yb2DeVYG+/eYqlMcGcedVE= text , reference user /oa6wZJEG852J9Yi1LQlnq1n1tM= text , reference userinfo S9yd7MVhXxF+598Xy2/+jwnCZzc= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_userinfo boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 800 5 1 function yzkq+uCmbTlXrfDuyd1fT0Zu6xw= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If present, this function returns a string representing the userinfo (which may be empty). Otherwise it returns an empty string. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).encoded_userinfo() == "jane%2Ddoe:pass" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing heading text BNF 1 code userinfo = user [ ":" [ password ] ] authority = [ userinfo "@" ] host [ ":" port ] heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return the userinfo returns text The userinfo as a string. see reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text , reference has_userinfo i/v5Vfq44OnlLbuKgQ2KvgWgZqo= text , reference encoded_password W9oZv0BM5z4XAggQPbNAKIM7/ro= text , reference encoded_user oYwrnXcglhO4tlvhkxLGfFCYbAk= text , reference password +ZB55yb2DeVYG+/eYqlMcGcedVE= text , reference user /oa6wZJEG852J9Yi1LQlnq1n1tM= text , reference userinfo S9yd7MVhXxF+598Xy2/+jwnCZzc= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_zone_id boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1526 5 1 function 5M2smbXDaSa2d/li//A+GmlDgDU= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If the host type is reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= text , this function returns the Zone ID as a string. Otherwise an empty string is returned. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "http://[fe80::1%25eth0]/" ).encoded_zone_id() == "eth0" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPv6addrz / IPvFuture ) "]" ZoneID = 1*( unreserved / pct-encoded ) IPv6addrz = IPv6address "%25" ZoneID heading text Specification 1 list paragraph link text Representing IPv6 Zone Identifiers in Address Literals and Uniform Resource Identifiers https://datatracker.ietf.org/doc/html/rfc6874 unordered brief text Return the IPv6 Zone ID returns text The Zone ID as a percent-encoded string. identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 fragment boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2233 5 1 function aA1Q9NAW4/TnG3SXhe4k1mNB5nk= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function calculates the fragment of the url, with percent escapes decoded and without the leading pound sign ('#') whose presence indicates that the url contains a fragment. paragraph text This function accepts an optional emph text StringToken text parameter which controls the return type and behavior of the function: list paragraph text When called with no arguments, the return type of the function is code text std::string text . Otherwise paragraph text When called with a string token, the behavior and return type of the function depends on the type of string token being passed. unordered heading text Example 1 code assert( url_view( "http://www.example.com/index.htm#a%2D1" ).fragment() == "a-1" ); heading text Complexity 1 paragraph text Linear in code text this->fragment().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. String tokens may throw exceptions. heading text BNF 1 code fragment = *( pchar / "/" / "?" ) fragment-part = [ "#" fragment ] heading text Specification 1 list paragraph link text 3.5. Fragment (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.5 unordered brief text Return the fragment returns text The fragment portion of the url. param text An optional string token to use. If this parameter is omitted, the function returns a new code text std::string text . token see reference encoded_fragment M7+OzewsxChMvecRSytXqTCqKrY= text , reference has_fragment ZiWsQaQCAif94KdP6GXH9+F5GmM= text . identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 has_authority boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 528 5 1 function gadV3YsYDjlGX+64Rtiz4S+QD4A= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns true if the url contains an authority. The presence of an authority is denoted by a double slash ("//") at the beginning or after the scheme. heading text Example 1 code assert( url_view( "http://www.example.com/index.htm" ).has_authority() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code authority = [ userinfo "@" ] host [ ":" port ] URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] absolute-URI = scheme ":" hier-part [ "?" query ] URI-reference = URI / relative-ref relative-ref = relative-part [ "?" query ] [ "#" fragment ] hier-part = "//" authority path-abempty ; (more...) relative-part = "//" authority path-abempty ; (more...) heading text Specification 1 list paragraph link text 3.2. Authority (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2 unordered brief text Return true if an authority is present returns code text true text if the url contains an authority. see reference authority v5/R9LI0iKJDiBrNUt7k8qrVBdM= text , reference encoded_authority Ww04vLA2k7BwctuyNeP3KwoNr4M= text . identifier bool normal 1 1 has_fragment boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2173 5 1 function ZiWsQaQCAif94KdP6GXH9+F5GmM= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns true if the url contains a fragment. An empty fragment is distinct from no fragment. heading text Example 1 code assert( url_view( "http://www.example.com/index.htm#anchor" ).has_fragment() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] relative-ref = relative-part [ "?" query ] [ "#" fragment ] heading text Specification 1 list paragraph link text 3.5. Fragment (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.5 unordered brief text Return true if a fragment is present returns code text true text if the url contains a fragment. see reference encoded_fragment M7+OzewsxChMvecRSytXqTCqKrY= text , reference fragment aA1Q9NAW4/TnG3SXhe4k1mNB5nk= text . identifier bool normal 1 1 has_password boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 689 5 1 function 9JACnsebk8tFsoryabfDxE8VpnA= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns true if the userinfo is present and contains a password. heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).has_password() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code userinfo = user [ ":" [ password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return true if a password is present returns code text true text if the userinfo contains a password. see reference has_userinfo i/v5Vfq44OnlLbuKgQ2KvgWgZqo= text , reference encoded_password W9oZv0BM5z4XAggQPbNAKIM7/ro= text , reference encoded_user oYwrnXcglhO4tlvhkxLGfFCYbAk= text , reference encoded_userinfo yzkq+uCmbTlXrfDuyd1fT0Zu6xw= text , reference password +ZB55yb2DeVYG+/eYqlMcGcedVE= text , reference user /oa6wZJEG852J9Yi1LQlnq1n1tM= text , reference userinfo S9yd7MVhXxF+598Xy2/+jwnCZzc= text . identifier bool normal 1 1 has_port boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1568 5 1 function 5V5uOhRsy00O+TSEAkIb7uFoN2U= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns true if an authority is present and contains a port. heading text Example 1 code assert( url_view( "wss://www.example.com:443" ).has_port() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code authority = [ userinfo "@" ] host [ ":" port ] port = *DIGIT heading text Specification 1 list paragraph link text 3.2.3. Port (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.3 unordered brief text Return true if a port is present returns code text true text if a port is present, code text false text otherwise. see reference encoded_host_and_port 9ptIMbwWSNtVv+KAUpHCO3bmTWg= text , reference port OlWcRIIUl1cq5Ab9fLXGPyhYCfI= text , reference port_number lctXu8FITJWg0+Y+yZVt5iv7QDM= text . identifier bool normal 1 1 has_query boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1937 5 1 function SLiWca6gUGmTh+r/BbU40NrICW8= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns true if this contains a query. An empty query is distinct from having no query. heading text Example 1 code assert( url_view( "/sql?id=42&col=name&page-size=20" ).has_query() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Return true if a query is present returns code text true text if a query is present. see reference encoded_params YdRpQ6mNNA/rw8PqzTxP08VgNnY= text , reference encoded_query suU4/MiRITTTYf61BFw2aI6WxdI= text , reference params ZdlRIJ+RVbaF05I+w1pfQzUA0/0= text , reference query 4epyMikskiBx2Gu+S87oAhrM/ZY= text . identifier bool normal 1 1 has_scheme boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 384 5 1 function iwSH2fvVkb89TkZj7KWLGSyc4sA= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns true if this contains a scheme. heading text Example 1 code assert( url_view( "http://www.example.com" ).has_scheme() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] absolute-URI = scheme ":" hier-part [ "?" query ] scheme = ALPHA *( ALPHA / DIGIT / "+" / "-" / "." ) heading text Specification 1 list paragraph link text 3.1. Scheme (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.1 unordered brief text Return true a scheme is present returns code text true text if the url contains a scheme. see reference scheme 43fxogaC5oVqfauhwXyN4s4ibEM= text , reference scheme_id uM37WpBqetqzfHjns3M8/+CcoEU= text . identifier bool normal 1 1 has_userinfo boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 647 5 1 function i/v5Vfq44OnlLbuKgQ2KvgWgZqo= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns true if this contains a userinfo. heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).has_userinfo() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code userinfo = user [ ":" [ password ] ] authority = [ userinfo "@" ] host [ ":" port ] heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return true if a userinfo is present returns code text true text if the userinfo is present. see reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text , reference encoded_password W9oZv0BM5z4XAggQPbNAKIM7/ro= text , reference encoded_user oYwrnXcglhO4tlvhkxLGfFCYbAk= text , reference encoded_userinfo yzkq+uCmbTlXrfDuyd1fT0Zu6xw= text , reference password +ZB55yb2DeVYG+/eYqlMcGcedVE= text , reference user /oa6wZJEG852J9Yi1LQlnq1n1tM= text , reference userinfo S9yd7MVhXxF+598Xy2/+jwnCZzc= text . identifier bool normal 1 1 host boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1076 5 1 function ICcovOIyqnxhSMU6MuEekYg2z+E= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the host portion of the authority as a string, or the empty string if there is no authority. Any percent-escapes in the string are decoded first. heading text Example 1 code assert( url_view( "https://www%2droot.example.com/" ).host() == "www-root.example.com" ); heading text Complexity 1 paragraph text Linear in code text this->host().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPvFuture ) "]" reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host returns text The host address as a string. param text A string token customization token identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 host_address boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1174 5 1 function F0RYzLwUP8ied6l3zmKvomgFHag= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text The value returned by this function depends on the type of host returned from the function reference host_type Nv9Emy6spILLI/mqyIz2uRNBJhU= text . list paragraph text If the type is reference host_type::ipv4 49F64dAiji9HVbP6MxLQiqot7AY= text , then the IPv4 address string is returned. paragraph text If the type is reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= text , then the IPv6 address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::ipvfuture TcYJaTwDFsx+0S2CkvHHARcCqWc= text , then the IPvFuture address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= text , then the host name string is returned. Any percent-escapes in the string are decoded first. paragraph text If the type is reference host_type::none QyoMTu07h232/Sxqovu2mGoPgTo= text , then an empty string is returned. unordered heading text Example 1 code assert( url_view( "https://[1::6:c0a8:1]/" ).host_address() == "1::6:c0a8:1" ); heading text Complexity 1 paragraph text Linear in code text this->host_address().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPvFuture ) "]" reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host returns text The host address as a string. param text A string token customization token identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 host_ipv4_address boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1277 5 1 function KL8F3KYxyzpC1e6fqoJy3B8IHhw= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If the host type is reference host_type::ipv4 49F64dAiji9HVbP6MxLQiqot7AY= text , this function returns the address as a value of type reference ipv4_address /Wpp3ZZDp3kUHzbULeDoaOEhnVs= text . Otherwise, if the host type is not an IPv4 address, it returns a default-constructed value which is equal to the unspecified address "0.0.0.0". heading text Example 1 code assert( url_view( "http://127.0.0.1/index.htm?user=win95" ).host_ipv4_address() == ipv4_address( "127.0.0.1" ) ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code IPv4address = dec-octet "." dec-octet "." dec-octet "." dec-octet dec-octet = DIGIT ; 0-9 / %x31-39 DIGIT ; 10-99 / "1" 2DIGIT ; 100-199 / "2" %x30-34 DIGIT ; 200-249 / "25" %x30-35 ; 250-255 heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host IPv4 address returns text The IPv4 address as a value of type reference ipv4_address /Wpp3ZZDp3kUHzbULeDoaOEhnVs= text . identifier /Wpp3ZZDp3kUHzbULeDoaOEhnVs= ipv4_address normal 1 1 host_ipv6_address boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1325 5 1 function CvoRh2IpWg4QixngVwDjSKoeQVY= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If the host type is reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= text , this function returns the address as a value of type reference ipv6_address dhMSRVBIIIItY0URHSc8rwHcdTQ= text . Otherwise, if the host type is not an IPv6 address, it returns a default-constructed value which is equal to the unspecified address "0:0:0:0:0:0:0:0". heading text Example 1 code assert( url_view( "ftp://[::1]/" ).host_ipv6_address() == ipv6_address( "::1" ) ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code IPv6address = 6( h16 ":" ) ls32 / "::" 5( h16 ":" ) ls32 / [ h16 ] "::" 4( h16 ":" ) ls32 / [ *1( h16 ":" ) h16 ] "::" 3( h16 ":" ) ls32 / [ *2( h16 ":" ) h16 ] "::" 2( h16 ":" ) ls32 / [ *3( h16 ":" ) h16 ] "::" h16 ":" ls32 / [ *4( h16 ":" ) h16 ] "::" ls32 / [ *5( h16 ":" ) h16 ] "::" h16 / [ *6( h16 ":" ) h16 ] "::" ls32 = ( h16 ":" h16 ) / IPv4address ; least-significant 32 bits of address h16 = 1*4HEXDIG ; 16 bits of address represented in hexadecimal heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host IPv6 address returns text The IPv6 address as a value of type reference ipv6_address dhMSRVBIIIItY0URHSc8rwHcdTQ= text . identifier dhMSRVBIIIItY0URHSc8rwHcdTQ= ipv6_address normal 1 1 host_ipvfuture boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1358 5 1 function 55Yh68uToEiKy+IDTpyctuK/T3g= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If the host type is reference host_type::ipvfuture TcYJaTwDFsx+0S2CkvHHARcCqWc= text , this function returns the address as a string. Otherwise, if the host type is not an IPvFuture address, it returns an empty string. heading text Example 1 code assert( url_view( "http://[v1fe.d:9]/index.htm" ).host_ipvfuture() == "v1fe.d:9" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code IPvFuture = "v" 1*HEXDIG "." 1*( unreserved / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host IPvFuture address returns text The IPvFuture address as a string. identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core normal 1 1 host_name boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1395 5 1 function AhPhrC4hmBsZgd/ztqbkAuOkbBM= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If the host type is reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= text , this function returns the name as a string. Otherwise an empty string is returned. Any percent-escapes in the string are decoded first. heading text Example 1 code assert( url_view( "https://www%2droot.example.com/" ).host_name() == "www-root.example.com" ); heading text Complexity 1 paragraph text Linear in code text this->host_name().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPvFuture ) "]" reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host name returns text The host name as a string. param text A string token customization. token identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 host_type boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1036 5 1 function Nv9Emy6spILLI/mqyIz2uRNBJhU= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns one of the following constants representing the type of host present. list paragraph reference host_type::ipv4 49F64dAiji9HVbP6MxLQiqot7AY= paragraph reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= paragraph reference host_type::ipvfuture TcYJaTwDFsx+0S2CkvHHARcCqWc= paragraph reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= paragraph reference host_type::none QyoMTu07h232/Sxqovu2mGoPgTo= unordered paragraph text When reference has_authority gadV3YsYDjlGX+64Rtiz4S+QD4A= text is false, the host type is reference host_type::none QyoMTu07h232/Sxqovu2mGoPgTo= text . heading text Example 1 code assert( url_view( "https://192.168.0.1/local.htm" ).host_type() == host_type::ipv4 ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host type returns text The type of host present. identifier YLHFVyAYZGSFQe18DPGjn6XsAMs= host_type identifier dnk5XPfR2OaMpCYaH3cWSxcTdyc= urls normal 1 1 is_path_absolute boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1691 5 1 function eh5BeHbLjL3BuEY7ao3tbEAZnTw= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns true if the path begins with a forward slash ('/'). heading text Example 1 code assert( url_view( "/path/to/file.txt" ).is_path_absolute() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code path = path-abempty ; begins with "/" or is empty / path-absolute ; begins with "/" but not "//" / path-noscheme ; begins with a non-colon segment / path-rootless ; begins with a segment / path-empty ; zero characters path-abempty = *( "/" segment ) path-absolute = "/" [ segment-nz *( "/" segment ) ] path-noscheme = segment-nz-nc *( "/" segment ) path-rootless = segment-nz *( "/" segment ) path-empty = 0<pchar> heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text Return true if the path is absolute returns code text true text if the path is absolute, code text false text otherwise. see reference encoded_path GNlqbV0MSxGIA/gSjlOb2rfSHhU= text , reference encoded_segments xDk467Vs74WMTJdzZiv8izTuGQo= text . reference path Q5NVO+d/+BmZ5v3/ogNb2XpUTKs= text , reference segments txoybJuonJpAdGVWgiAsiI45+ok= text . identifier bool normal 1 1 normalize boost/url/url_base.hpp include/boost/url/url_base.hpp 2731 5 1 function ldUmQToJNGQ58j33Mti85clcGbM= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text Applies Syntax-based normalization to all components of the URL. paragraph text The scheme is normalized to lowercase. code assert( url( "HTTP://www.example.com" ).normalize().buffer() == "http://www.example.com" ); paragraph text The host is normalized to lowercase. Percent-encoding triplets are normalized to uppercase letters. Percent-encoded octets that correspond to unreserved characters are decoded. code assert( url( "http://www.Example.com" ).normalize().buffer() == "http://www.example.com" ); assert( url( "http://www.%65xample.com" ).normalize().buffer() == "http://www.example.com" ); paragraph text Percent-encoding triplets in the path are normalized to uppercase letters. Percent-encoded octets that correspond to unreserved characters are decoded. Redundant path-segments "." and ".." are removed. code assert( url( "http://www.example.com/a/b/../c" ).normalize().buffer() == "http://www.example.com/a/c" ); assert( url( "http://www.example.com/a/./b" ).normalize().buffer() == "http://www.example.com/a/b" ); assert( url( "http://www.example.com/%63ss" ).normalize().buffer() == "http://www.example.com/css" ); paragraph text Percent-encoding triplets in the query are normalized to uppercase letters. Percent-encoded octets that correspond to unreserved characters are decoded. code assert( url( "http://www.example.com?a=%62" ).normalize().buffer() == "http://www.example.com?a=b" ); paragraph text Percent-encoding triplets in the fragment are normalized to uppercase letters. Percent-encoded octets that correspond to unreserved characters are decoded. code assert( url( "http://www.example.com#%61bc" ).normalize().buffer() == "http://www.example.com#abc" ); paragraph text Applying normalization to a URL with all components percent-encoded: code assert( url( "HTTP://www.Example.com/%70ath?%71uery#%66rag" ).normalize().buffer() == "http://www.example.com/path?query#frag" ); heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text Specification 1 list paragraph link text 6.2.2 Syntax-Based Normalization (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-6.2.2 unordered brief text Normalize the URL components returns code text *this see reference normalize_scheme iyO2AawtEbzXMJkvSocn7BpBBrI= text , reference normalize_authority j2lB1y9ywFNpGt8xXYkZZuJbs30= text , reference normalize_path pjVn3eVVaWNAixzkPBECE+lKByQ= text , reference normalize_query 4CZ8ebKgivCQbRJoYD78PmOko2U= text , reference normalize_fragment R2y0tPa5JiRRSTNXgUjKdMoCOcA= identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base normal 1 normalize_authority boost/url/url_base.hpp include/boost/url/url_base.hpp 2786 5 1 function j2lB1y9ywFNpGt8xXYkZZuJbs30= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text Applies Syntax-based normalization to the URL authority. paragraph text The host is normalized to lowercase. Percent-encoding triplets are normalized to uppercase letters. Percent-encoded octets that correspond to unreserved characters are decoded. code assert( url( "http://www.Example.com" ).normalize_authority().buffer() == "http://www.example.com" ); assert( url( "http://www.%65xample.com" ).normalize_authority().buffer() == "http://www.example.com" ); heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text Specification 1 list paragraph link text 6.2.2 Syntax-Based Normalization (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-6.2.2 unordered brief text Normalize the URL authority returns code text *this identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base normal 1 normalize_fragment boost/url/url_base.hpp include/boost/url/url_base.hpp 2873 5 1 function R2y0tPa5JiRRSTNXgUjKdMoCOcA= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text Applies Syntax-based normalization to the URL fragment. paragraph text Percent-encoding triplets are normalized to uppercase letters. Percent-encoded octets that correspond to unreserved characters are decoded. code assert( url( "http://www.example.com#%61bc" ).normalize_fragment().buffer() == "http://www.example.com#abc" ); heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text Specification 1 list paragraph link text 6.2.2 Syntax-Based Normalization (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-6.2.2 unordered brief text Normalize the URL fragment returns code text *this identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base normal 1 normalize_path boost/url/url_base.hpp include/boost/url/url_base.hpp 2817 5 1 function pjVn3eVVaWNAixzkPBECE+lKByQ= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text Applies Syntax-based normalization to the URL path. paragraph text Percent-encoding triplets are normalized to uppercase letters. Percent-encoded octets that correspond to unreserved characters are decoded. Redundant path-segments "." and ".." are removed. code assert( url( "http://www.example.com/a/b/../c" ).normalize_path().buffer() == "http://www.example.com/a/c" ); assert( url( "http://www.example.com/a/./b" ).normalize_path().buffer() == "http://www.example.com/a/b" ); assert( url( "http://www.example.com/%63ss" ).normalize_path().buffer() == "http://www.example.com/css" ); heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text Specification 1 list paragraph link text 6.2.2 Syntax-Based Normalization (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-6.2.2 unordered brief text Normalize the URL path returns code text *this identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base normal 1 normalize_query boost/url/url_base.hpp include/boost/url/url_base.hpp 2845 5 1 function 4CZ8ebKgivCQbRJoYD78PmOko2U= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text Applies Syntax-based normalization to the URL query. paragraph text Percent-encoding triplets are normalized to uppercase letters. Percent-encoded octets that correspond to unreserved characters are decoded. code assert( url( "http://www.example.com?a=%62" ).normalize_query().buffer() == "http://www.example.com?a=b" ); heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text Specification 1 list paragraph link text 6.2.2 Syntax-Based Normalization (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-6.2.2 unordered brief text Normalize the URL query returns code text *this identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base normal 1 normalize_scheme boost/url/url_base.hpp include/boost/url/url_base.hpp 2756 5 1 function iyO2AawtEbzXMJkvSocn7BpBBrI= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text Applies Syntax-based normalization to the URL scheme. paragraph text The scheme is normalized to lowercase. code assert( url( "HTTP://www.example.com" ).normalize_scheme().buffer() == "http://www.example.com" ); heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text Specification 1 list paragraph link text 6.2.2 Syntax-Based Normalization (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-6.2.2 unordered brief text Normalize the URL scheme returns code text *this identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base normal 1 params boost/url/url_base.hpp include/boost/url/url_base.hpp 2186 5 1 boost/url/url_base.hpp include/boost/url/url_base.hpp 2182 5 1 boost/url/url_base.hpp include/boost/url/url_base.hpp 2244 5 1 boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2087 5 overloads wdcIrRY9aj9gn6bF1i59TpOAQb4= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= brief text Return the query as a container of parameters returns code text *this returns text A bidirectional view of key/value pairs. returns text A range of references to the parameters. param text The options for decoding. If this parameter is omitted, the code text space_as_plus text is used. opt see reference encoded_params tDMWbnBabN2mGSH3Apn445gDMEQ= text , reference remove_query ZZWEzCK7DguUxc3TvUfizoGKplE= text , reference set_encoded_query QcQ13DUh8M8TR/zj/LDG3N/+i3c= text , reference set_query 99/QTSBQGLrNj3zGdw5VzYlqfnI= text . see reference encoded_params tDMWbnBabN2mGSH3Apn445gDMEQ= text , reference encoded_query suU4/MiRITTTYf61BFw2aI6WxdI= text , reference has_query SLiWca6gUGmTh+r/BbU40NrICW8= text , reference query 4epyMikskiBx2Gu+S87oAhrM/ZY= text . normal MYfnAHxNPsNhl4M31kQzwrirB9M= s9dRuYwynzv+XH3wi5E1LonuuYk= yOAcBK51dE1EJqsBF6ZGTSEnocA= V3u1IzKjTvUUsoIglN4qUAzgD4k= params boost/url/url_base.hpp include/boost/url/url_base.hpp 2182 5 1 function MYfnAHxNPsNhl4M31kQzwrirB9M= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function returns a bidirectional view of key/value pairs over the query. The returned view references the same underlying character buffer; ownership is not transferred. Any percent-escapes in strings returned when iterating the view are decoded first. The container is modifiable; changes to the container are reflected in the underlying URL. heading text Example 1 code params_ref pv = url( "/sql?id=42&name=jane%2Ddoe&page+size=20" ).params(); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Return the query as a container of parameters returns code text *this see reference encoded_params tDMWbnBabN2mGSH3Apn445gDMEQ= text , reference remove_query ZZWEzCK7DguUxc3TvUfizoGKplE= text , reference set_encoded_query QcQ13DUh8M8TR/zj/LDG3N/+i3c= text , reference set_query 99/QTSBQGLrNj3zGdw5VzYlqfnI= text . identifier 8S83BKvWBCDdTktlY8X93Mlo9E0= params_ref normal 1 params boost/url/url_base.hpp include/boost/url/url_base.hpp 2186 5 1 function s9dRuYwynzv+XH3wi5E1LonuuYk= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= brief text Return the query as a container of parameters url_view_base::params returns text A bidirectional view of key/value pairs. see reference encoded_params tDMWbnBabN2mGSH3Apn445gDMEQ= text , reference encoded_query suU4/MiRITTTYf61BFw2aI6WxdI= text , reference has_query SLiWca6gUGmTh+r/BbU40NrICW8= text , reference query 4epyMikskiBx2Gu+S87oAhrM/ZY= text . identifier DzqMpaJX2O25vPFxEN5EDTyU6uw= params_view normal 1 1 params boost/url/url_base.hpp include/boost/url/url_base.hpp 2244 5 1 function yOAcBK51dE1EJqsBF6ZGTSEnocA= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function returns a bidirectional view of key/value pairs over the query. The returned view references the same underlying character buffer; ownership is not transferred. Any percent-escapes in strings returned when iterating the view are decoded first. The container is modifiable; changes to the container are reflected in the underlying URL. heading text Example 1 code encoding_opts opt; opt.space_as_plus = true; params_ref pv = url( "/sql?id=42&name=jane+doe&page+size=20" ).params(opt); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Return the query as a container of parameters returns text A range of references to the parameters. param text The options for decoding. If this parameter is omitted, the code text space_as_plus text is used. opt see reference encoded_params tDMWbnBabN2mGSH3Apn445gDMEQ= text , reference remove_query ZZWEzCK7DguUxc3TvUfizoGKplE= text , reference set_encoded_query QcQ13DUh8M8TR/zj/LDG3N/+i3c= text , reference set_query 99/QTSBQGLrNj3zGdw5VzYlqfnI= text . identifier 8S83BKvWBCDdTktlY8X93Mlo9E0= params_ref identifier Bb04pNwExynJkzlY9a9GCeeB13k= encoding_opts opt normal 1 params boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2087 5 function V3u1IzKjTvUUsoIglN4qUAzgD4k= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= identifier DzqMpaJX2O25vPFxEN5EDTyU6uw= params_view identifier Bb04pNwExynJkzlY9a9GCeeB13k= encoding_opts opt normal 1 1 password boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 947 5 1 function +ZB55yb2DeVYG+/eYqlMcGcedVE= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If present, this function returns a string representing the password (which may be an empty string). Otherwise it returns an empty string. Any percent-escapes in the string are decoded first. heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).password() == "pass" ); heading text Complexity 1 paragraph text Linear in code text this->password().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code userinfo = user [ ":" [ password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return the password returns text The password as a string. param text The string token to use. token see reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text , reference has_userinfo i/v5Vfq44OnlLbuKgQ2KvgWgZqo= text , reference encoded_password W9oZv0BM5z4XAggQPbNAKIM7/ro= text , reference encoded_user oYwrnXcglhO4tlvhkxLGfFCYbAk= text , reference encoded_userinfo yzkq+uCmbTlXrfDuyd1fT0Zu6xw= text , reference user /oa6wZJEG852J9Yi1LQlnq1n1tM= text , reference userinfo S9yd7MVhXxF+598Xy2/+jwnCZzc= text . identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 path boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1744 5 1 function Q5NVO+d/+BmZ5v3/ogNb2XpUTKs= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the path as a string. The path may be empty. Any percent-escapes in the string are decoded first. heading text Example 1 code assert( url_view( "file:///Program%20Files/Games/config.ini" ).path() == "/Program Files/Games/config.ini" ); heading text Complexity 1 paragraph text Linear in code text this->path().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code path = path-abempty ; begins with "/" or is empty / path-absolute ; begins with "/" but not "//" / path-noscheme ; begins with a non-colon segment / path-rootless ; begins with a segment / path-empty ; zero characters path-abempty = *( "/" segment ) path-absolute = "/" [ segment-nz *( "/" segment ) ] path-noscheme = segment-nz-nc *( "/" segment ) path-rootless = segment-nz *( "/" segment ) path-empty = 0<pchar> heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text Return the path returns text The path as a string. param text A string token to use for the result. token see reference is_path_absolute eh5BeHbLjL3BuEY7ao3tbEAZnTw= text , reference encoded_path GNlqbV0MSxGIA/gSjlOb2rfSHhU= text , reference encoded_segments xDk467Vs74WMTJdzZiv8izTuGQo= text . reference segments txoybJuonJpAdGVWgiAsiI45+ok= text . identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 persist boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 341 5 1 function cRPG1npIXmfYC0K+C+idxOqIc04= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns a read-only copy of the url, with shared lifetime. The returned value owns (persists) the underlying string. The algorithm used to create the value minimizes the number of individual memory allocations, making it more efficient than when using direct standard library functions. heading text Example 1 code std::shared_ptr< url_view const > sp; { std::string s( "http://example.com" ); url_view u( s ); // u references characters in s assert( u.data() == s.data() ); // same buffer sp = u.persist(); assert( sp->data() != s.data() ); // different buffer assert( sp->buffer() == s); // same contents // s is destroyed and thus u // becomes invalid, but sp remains valid. } heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. brief text Return a shared, persistent copy of the url returns text A shared pointer to a read-only url_view. specialization yAZI7i9M7QvpFoRBZvP2RcJBIWs= shared_ptr identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 1 port boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1604 5 1 function OlWcRIIUl1cq5Ab9fLXGPyhYCfI= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If present, this function returns a string representing the port (which may be empty). Otherwise it returns an empty string. heading text Example 1 code assert( url_view( "http://localhost.com:8080" ).port() == "8080" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code port = *DIGIT heading text Specification 1 list paragraph link text 3.2.3. Port (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.3 unordered brief text Return the port returns text The port as a string. see reference encoded_host_and_port 9ptIMbwWSNtVv+KAUpHCO3bmTWg= text , reference has_port 5V5uOhRsy00O+TSEAkIb7uFoN2U= text , reference port_number lctXu8FITJWg0+Y+yZVt5iv7QDM= text . identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core normal 1 1 port_number boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1640 5 1 function lctXu8FITJWg0+Y+yZVt5iv7QDM= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If a port is present and the numerical value is representable, it is returned as an unsigned integer. Otherwise, the number zero is returned. heading text Example 1 code assert( url_view( "http://localhost.com:8080" ).port_number() == 8080 ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code port = *DIGIT heading text Specification 1 list paragraph link text 3.2.3. Port (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.3 unordered brief text Return the port returns text The port number as an unsigned integer. see reference encoded_host_and_port 9ptIMbwWSNtVv+KAUpHCO3bmTWg= text , reference has_port 5V5uOhRsy00O+TSEAkIb7uFoN2U= text , reference port OlWcRIIUl1cq5Ab9fLXGPyhYCfI= text . identifier Qvo2fOST20EZC7bSOAFZr+u3ITg= uint16_t normal 1 1 query boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1987 5 1 function 4epyMikskiBx2Gu+S87oAhrM/ZY= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If this contains a query, it is returned as a string (which may be empty). Otherwise, an empty string is returned. Any percent-escapes in the string are decoded first. paragraph text Literal plus signs remain unchanged by default to match RFC 3986. To treat '+' as a space, supply decoding options with code text space_as_plus = true text when calling this function. heading text Example 1 code assert( url_view( "/sql?id=42&name=jane%2Ddoe&page+size=20" ).query() == "id=42&name=jane-doe&page size=20" ); heading text Complexity 1 paragraph text Linear in code text this->query().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Return the query returns text The query as a string. param text A token to use for the returned string. token see reference encoded_params YdRpQ6mNNA/rw8PqzTxP08VgNnY= text , reference encoded_query suU4/MiRITTTYf61BFw2aI6WxdI= text , reference has_query SLiWca6gUGmTh+r/BbU40NrICW8= text , reference params ZdlRIJ+RVbaF05I+w1pfQzUA0/0= text . identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 remove_authority boost/url/url_base.hpp include/boost/url/url_base.hpp 408 5 1 function cjTKMEM0IWRzDexmJAiWOj6P+ZI= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function removes the authority, which includes the userinfo, host, and a port if present. heading text Example 1 code assert( url( "http://example.com/echo.cgi" ).remove_authority().buffer() == "http:/echo.cgi" ); heading text Postconditions 1 code this->has_authority() == false && this->has_userinfo() == false && this->has_port() == false heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code authority = [ userinfo "@" ] host [ ":" port ] userinfo = *( unreserved / pct-encoded / sub-delims / ":" ) host = IP-literal / IPv4address / reg-name port = *DIGIT heading text Specification 1 list paragraph link text 3.2. Authority (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2 unordered brief text Remove the authority returns code text *this see reference set_encoded_authority VTO/x6AChJRFyjVKxhaqmIAvYFI= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base normal 1 remove_fragment boost/url/url_base.hpp include/boost/url/url_base.hpp 2510 5 1 function aGhIz5PP9XtdztICzhAvM4n92Sg= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function removes the fragment. An empty fragment is distinct from having no fragment. heading text Example 1 code assert( url( "?first=john&last=doe#anchor" ).remove_fragment().buffer() == "?first=john&last=doe" ); heading text Postconditions 1 code this->has_fragment() == false && this->encoded_fragment() == "" heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code fragment = *( pchar / "/" / "?" ) heading text Specification 1 list paragraph link text 3.5. Fragment https://datatracker.ietf.org/doc/html/rfc3986#section-3.5 unordered brief text Remove the fragment returns code text *this see reference remove_fragment aGhIz5PP9XtdztICzhAvM4n92Sg= text , reference set_encoded_fragment ebU9NPxh5c4VwDAaQA1CXRWbSKk= text , reference set_fragment VHh7zoCWGsviuG3lWYA54cKWneU= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base normal 1 remove_origin boost/url/url_base.hpp include/boost/url/url_base.hpp 2644 5 1 function OqDHBYUjGSW4mGYuSUu09xFSlEc= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function removes the origin, which consists of the scheme and authority. heading text Example 1 code assert( url( "http://www.example.com/index.htm" ).remove_origin().buffer() == "/index.htm" ); heading text Postconditions 1 code this->scheme_id() == scheme::none && this->has_authority() == false heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Throws nothing. brief text Remove the origin component returns code text *this identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base normal 1 remove_password boost/url/url_base.hpp include/boost/url/url_base.hpp 857 5 1 function M5RIQPf9vzlN+m4Qn0PDNFKy8ak= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function removes the password from the userinfo if a password exists. If there is no userinfo or no authority, the call has no effect. admonition paragraph text The interpretation of the userinfo as individual user and password components is scheme-dependent. Transmitting passwords in URLs is deprecated. note heading text Example 1 code assert( url( "http://user:pass@example.com" ).remove_password().authority().buffer() == "user@example.com" ); heading text Postconditions 1 code this->has_password() == false && this->encoded_password().empty() == true heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code userinfo = [ [ user ] [ ':' password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Remove the password returns code text *this see reference set_encoded_password qF7dDBIf4KkHxSuysLw1EJNSh2Y= text , reference set_encoded_user YNLJGohUXCdL6mo1PM3ms9pRQyE= text , reference set_password blkDquwzHtk7o5mJf/hdeY15zWg= text , reference set_user GWy3y66sOX4ov+Eh3hxNRVsAEwY= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base normal 1 remove_port boost/url/url_base.hpp include/boost/url/url_base.hpp 1696 5 1 function ADa0xIsiS8APEAdL3+s0LoNowA8= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text If a port exists, it is removed. The rest of the authority is unchanged. heading text Example 1 code assert( url( "http://www.example.com:80" ).remove_port().authority().buffer() == "www.example.com" ); heading text Postconditions 1 code this->has_port() == false && this->port_number() == 0 && this->port() == "" heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code authority = [ userinfo "@" ] host [ ":" port ] port = *DIGIT heading text Specification 1 list paragraph link text 3.2.3. Port (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.3 unordered brief text Remove the port returns code text *this see reference set_port p1q1Ba+a+naWvTDfBuMPt0DJw2A= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base normal 1 remove_query boost/url/url_base.hpp include/boost/url/url_base.hpp 2463 5 1 function ZZWEzCK7DguUxc3TvUfizoGKplE= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text If a query is present, it is removed. An empty query is distinct from having no query. heading text Example 1 code assert( url( "http://www.example.com?id=42" ).remove_query().buffer() == "http://www.example.com" ); heading text Postconditions 1 code this->has_query() == false && this->params().empty() heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Remove the query returns code text *this see reference encoded_params tDMWbnBabN2mGSH3Apn445gDMEQ= text , reference params wdcIrRY9aj9gn6bF1i59TpOAQb4= text , reference set_encoded_query QcQ13DUh8M8TR/zj/LDG3N/+i3c= text , reference set_query 99/QTSBQGLrNj3zGdw5VzYlqfnI= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base normal 1 remove_scheme boost/url/url_base.hpp include/boost/url/url_base.hpp 318 5 1 function 1N2Tt1DokczwHdRgAZiZzhPQr4E= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function removes the scheme if it is present. heading text Example 1 code assert( url("http://www.example.com/index.htm" ).remove_scheme().buffer() == "//www.example.com/index.htm" ); heading text Postconditions 1 code this->has_scheme() == false && this->scheme_id() == scheme::none heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] heading text Specification 1 list paragraph link text 3.1. Scheme (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.1 unordered brief text Remove the scheme returns code text *this see reference set_scheme rKQfFZ6dfzeuSqZL+PgPNpIFQ5g= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base normal 1 remove_userinfo boost/url/url_base.hpp include/boost/url/url_base.hpp 585 5 1 function PjTTglJlJuEwKHuRXGByi7wW8W8= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function removes the userinfo if present, without removing any authority. heading text Example 1 code assert( url( "http://user@example.com" ).remove_userinfo().has_userinfo() == false ); heading text Postconditions 1 code this->has_userinfo() == false && this->encoded_userinfo().empty == true heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code userinfo = [ [ user ] [ ':' password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Remove the userinfo returns code text *this see reference set_encoded_userinfo MLv0mdC6EhrEgdnFiOF+W8sw0/c= text , reference set_userinfo s+5EFNaQxZ6HMzMRElE8AAODpm8= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base normal 1 reserve boost/url/url_base.hpp include/boost/url/url_base.hpp 187 5 1 function R5AajT/eZPgijKrm8AxolAdhsRQ= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function adjusts the capacity of the container in characters, without affecting the current contents. Has no effect if code text n <= this->capacity() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. brief text Adjust the capacity without changing the size param text The capacity in characters, excluding any null terminator. n throws text Allocation failure reference bad_alloc identifier void identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std n normal 1 resolve boost/url/url_base.hpp include/boost/url/url_base.hpp 2973 5 1 function 3Pi5l1khAbVAQHD3fWi5GoHEr5E= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function attempts to resolve a URL reference code text ref text against this base URL in a manner similar to that of a web browser resolving an anchor tag. paragraph text This URL must satisfy the emph text URI text grammar. In other words, it must contain a scheme. paragraph text Relative references are only usable when in the context of a base absolute URI. This process of resolving a relative emph text reference text within the context of a emph text base text URI is defined in detail in rfc3986 (see below). paragraph text The resolution process works as if the relative reference is appended to the base URI and the result is normalized. paragraph text Given the input base URL, this function resolves the relative reference as if performing the following steps: list paragraph text Ensure the base URI has at least a scheme paragraph text Normalizing the reference path paragraph text Merge base and reference paths paragraph text Normalize the merged path unordered paragraph text This function places the result of the resolution into this URL in place. paragraph text If an error occurs, the contents of this URL are unspecified and a code text boost::system::result text with an code text system::error_code text is returned. admonition paragraph text Abnormal hrefs where the number of ".." segments exceeds the number of segments in the base path are handled by including the unmatched ".." segments in the result, as described in link text Errata 4547 https://www.rfc-editor.org/errata/eid4547 text . note heading text Example 1 code url base1( "/one/two/three" ); base1.resolve("four"); assert( base1.buffer() == "/one/two/four" ); url base2( "http://example.com/" ) base2.resolve("/one"); assert( base2.buffer() == "http://example.com/one" ); url base3( "http://example.com/one" ); base3.resolve("/two"); assert( base3.buffer() == "http://example.com/two" ); url base4( "http://a/b/c/d;p?q" ); base4.resolve("g#s"); assert( base4.buffer() == "http://a/b/c/g#s" ); heading text BNF 1 code absolute-URI = scheme ":" hier-part [ "?" query ] heading text Exception Safety 1 paragraph text Basic guarantee. Calls to allocate may throw. heading text Specification 1 brief text Resolve a URL reference against this base URL returns text An empty code text boost::system::result text upon success, otherwise an error code if code text !base.has_scheme() text . param text The URL reference to resolve. ref see reference url B4dRaSXMG3fDmuNKMW3KOeRu6kA= text , reference url_view wh3UbUToX9YDmRmnpcoM9EUEZo8= text . specialization O+YzwnquzbCEPErxi2iuhXKphsk= result identifier LWQB+dn+7lsRKPzx/twz66ZcOWI= system 1 identifier UEVNhDEjkZMXfjN1DxbtX0n2rCg= url_view_base ref normal 1 scheme boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 421 5 1 function 43fxogaC5oVqfauhwXyN4s4ibEM= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the scheme if it exists, without a trailing colon (':'). Otherwise it returns an empty string. Note that schemes are case-insensitive, and the canonical form is lowercased. heading text Example 1 code assert( url_view( "http://www.example.com" ).scheme() == "http" ); heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code scheme = ALPHA *( ALPHA / DIGIT / "+" / "-" / "." ) URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] absolute-URI = scheme ":" hier-part [ "?" query ] heading text Specification 1 list paragraph link text 3.1. Scheme (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.1 unordered brief text Return the scheme returns text The scheme as a string. see reference has_scheme iwSH2fvVkb89TkZj7KWLGSyc4sA= text , reference scheme_id uM37WpBqetqzfHjns3M8/+CcoEU= text . identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core normal 1 1 scheme_id boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 471 5 1 function uM37WpBqetqzfHjns3M8/+CcoEU= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns a value which depends on the scheme in the url: list paragraph text If the scheme is a well-known scheme, corresponding value from the enumeration reference urls::scheme P7uOjuAMILimKGOcbjDUSpMAL/U= text is returned. paragraph text If a scheme is present but is not a well-known scheme, the value returned is reference urls::scheme::unknown LJxTyQ55ot1WYLH7f46nZvdGU78= text . paragraph text Otherwise, if the scheme is absent the value returned is reference urls::scheme::none VupiauVBXlZQ8Uix+vk8kSl+fM8= text . unordered heading text Example 1 code assert( url_view( "wss://www.example.com/crypto.cgi" ).scheme_id() == scheme::wss ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] absolute-URI = scheme ":" hier-part [ "?" query ] scheme = ALPHA *( ALPHA / DIGIT / "+" / "-" / "." ) heading text Specification 1 list paragraph link text 3.1. Scheme (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.1 unordered brief text Return the scheme returns text The scheme as an enumeration value. see reference has_scheme iwSH2fvVkb89TkZj7KWLGSyc4sA= text , reference scheme 43fxogaC5oVqfauhwXyN4s4ibEM= text . identifier P7uOjuAMILimKGOcbjDUSpMAL/U= scheme identifier dnk5XPfR2OaMpCYaH3cWSxcTdyc= urls normal 1 1 segments boost/url/url_base.hpp include/boost/url/url_base.hpp 1955 5 1 boost/url/url_base.hpp include/boost/url/url_base.hpp 1951 5 1 overloads coMz0KQ2BIuACsWbIRZ/6lTOmuk= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= brief text Return the path as a container of segments returns code text *this returns text A bidirectional view of segments. see reference encoded_segments qeLAK8oZj7+xpHv7Pyh0yYASuqU= text , reference set_encoded_path GQGd+Ne+D3eTy4fe+x1cpa5zefU= text , reference set_path 0VMn4mT6ruiabbTCXyOFe+JATBg= text , reference set_path_absolute BHDHQef0k/8vd3QskLyTrsv7+DE= text . see reference is_path_absolute eh5BeHbLjL3BuEY7ao3tbEAZnTw= text , reference encoded_path GNlqbV0MSxGIA/gSjlOb2rfSHhU= text , reference encoded_segments qeLAK8oZj7+xpHv7Pyh0yYASuqU= text . reference path Q5NVO+d/+BmZ5v3/ogNb2XpUTKs= text , reference segments_view ZNJOLZ4RhCB2A2ooiNo7KxZJHrA= text . normal 7IUB1R6CP5b6VCTpQBgLFv27mfU= QP1V0/Bd4lTeXI0vaNEiUqgvkPQ= segments boost/url/url_base.hpp include/boost/url/url_base.hpp 1951 5 1 function 7IUB1R6CP5b6VCTpQBgLFv27mfU= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function returns a bidirectional view of segments over the path. The returned view references the same underlying character buffer; ownership is not transferred. Any percent-escapes in strings returned when iterating the view are decoded first. The container is modifiable; changes to the container are reflected in the underlying URL. heading text Example 1 code url u( "http://example.com/path/to/file.txt" ); segments sv = u.segments(); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code path = path-abempty ; begins with "/" or is empty / path-absolute ; begins with "/" but not "//" / path-noscheme ; begins with a non-colon segment / path-rootless ; begins with a segment / path-empty ; zero characters path-abempty = *( "/" segment ) path-absolute = "/" [ segment-nz *( "/" segment ) ] path-noscheme = segment-nz-nc *( "/" segment ) path-rootless = segment-nz *( "/" segment ) path-empty = 0<pchar> heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text Return the path as a container of segments returns code text *this see reference encoded_segments qeLAK8oZj7+xpHv7Pyh0yYASuqU= text , reference set_encoded_path GQGd+Ne+D3eTy4fe+x1cpa5zefU= text , reference set_path 0VMn4mT6ruiabbTCXyOFe+JATBg= text , reference set_path_absolute BHDHQef0k/8vd3QskLyTrsv7+DE= text . identifier zdr3gU7+2/G05oo6ta/IfHlkTF0= segments_ref identifier dnk5XPfR2OaMpCYaH3cWSxcTdyc= urls normal 1 segments boost/url/url_base.hpp include/boost/url/url_base.hpp 1955 5 1 function QP1V0/Bd4lTeXI0vaNEiUqgvkPQ= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function returns a bidirectional view of strings over the path. The returned view references the same underlying character buffer; ownership is not transferred. Any percent-escapes in strings returned when iterating the view are decoded first. heading text Example 1 code segments_view sv = url_view( "/path/to/file.txt" ).segments(); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code path = [ "/" ] segment *( "/" segment ) heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text Return the path as a container of segments url_view_base::segments returns text A bidirectional view of segments. see reference is_path_absolute eh5BeHbLjL3BuEY7ao3tbEAZnTw= text , reference encoded_path GNlqbV0MSxGIA/gSjlOb2rfSHhU= text , reference encoded_segments qeLAK8oZj7+xpHv7Pyh0yYASuqU= text . reference path Q5NVO+d/+BmZ5v3/ogNb2XpUTKs= text , reference segments_view ZNJOLZ4RhCB2A2ooiNo7KxZJHrA= text . identifier ZNJOLZ4RhCB2A2ooiNo7KxZJHrA= segments_view normal 1 1 set_encoded_authority boost/url/url_base.hpp include/boost/url/url_base.hpp 364 5 1 function VTO/x6AChJRFyjVKxhaqmIAvYFI= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function sets the authority to the specified string. The string may contain percent-escapes. heading text Example 1 code assert( url().set_encoded_authority( "My%20Computer" ).has_authority() ); heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text BNF 1 code authority = [ userinfo "@" ] host [ ":" port ] userinfo = *( unreserved / pct-encoded / sub-delims / ":" ) host = IP-literal / IPv4address / reg-name port = *DIGIT heading text Specification 1 list paragraph link text 3.2. Authority (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2 unordered brief text Set the authority returns code text *this param text The authority string to set. s throws text The string contains an invalid percent-encoding. reference system_eror see reference remove_authority cjTKMEM0IWRzDexmJAiWOj6P+ZI= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view s normal 1 set_encoded_fragment boost/url/url_base.hpp include/boost/url/url_base.hpp 2611 5 1 function ebU9NPxh5c4VwDAaQA1CXRWbSKk= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function sets the fragment to the specified string, which may contain percent-escapes and which may be empty. An empty fragment is distinct from having no fragment. Escapes in the string are preserved, and reserved characters in the string are percent-escaped in the result. heading text Example 1 code assert( url("?first=john&last=doe" ).set_encoded_fragment( "john%2Ddoe" ).fragment() == "john-doe" ); heading text Postconditions 1 code this->has_fragment() == true && this->fragment() == decode_view( s ) heading text Complexity 1 paragraph text Linear in code text this->size() + s.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text BNF 1 code fragment = *( pchar / "/" / "?" ) heading text Specification 1 list paragraph link text 3.5. Fragment https://datatracker.ietf.org/doc/html/rfc3986#section-3.5 unordered brief text Set the fragment. returns code text *this returns code text *this param text The string to set. s throws code text s text contains an invalid percent-encoding. reference system_error see reference remove_fragment aGhIz5PP9XtdztICzhAvM4n92Sg= text , reference set_fragment VHh7zoCWGsviuG3lWYA54cKWneU= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view s normal 1 set_encoded_host boost/url/url_base.hpp include/boost/url/url_base.hpp 1027 5 1 function OgEcjvMpUkw5cqqrotx6BNVfYuA= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text Depending on the contents of the passed string, this function sets the host: list paragraph text If the string is a valid IPv4 address, then the host is set to the address. The host type is reference host_type::ipv4 49F64dAiji9HVbP6MxLQiqot7AY= text . paragraph text If the string is a valid IPv6 address enclosed in square brackets, then the host is set to that address. The host type is reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= text . paragraph text If the string is a valid IPvFuture address enclosed in square brackets, then the host is set to that address. The host type is reference host_type::ipvfuture TcYJaTwDFsx+0S2CkvHHARcCqWc= text . paragraph text Otherwise, the host name is set to the string. This string can contain percent escapes, or can be empty. Escapes in the string are preserved, and reserved characters in the string are percent-escaped in the result. The host type is reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= text . unordered paragraph text In all cases, when this function returns, the URL contains an authority. heading text Example 1 code assert( url( "http://www.example.com" ).set_host( "127.0.0.1" ).buffer() == "http://127.0.0.1" ); heading text Postconditions 1 code this->has_authority() == true heading text Complexity 1 paragraph text Linear in code text this->size() + s.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPvFuture ) "]" reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text IPv4 (Wikipedia) https://en.wikipedia.org/wiki/IPv4 paragraph link text IP Version 6 Addressing Architecture (rfc4291) https://datatracker.ietf.org/doc/html/rfc4291 paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Set the host returns code text *this param text The string to set. s throws code text s text contains an invalid percent-encoding. reference system_error see reference set_encoded_host_address 51fvhkKEd4+UZEBsnLd4vUL/Svw= text , reference set_encoded_host_name Lz8KFSebh4YuJuAAf0STYQ/VPqk= text , reference set_host lhYybwvylnG/ieiGmyVfyExN3dw= text , reference set_host_address ut25mVfVRShtv19Mg+nvS5jVATc= text , reference set_host_ipv4 Cn5GM3RJyUENDJ/d6LnYVW+gkA4= text , reference set_host_ipv6 BryTExdDEUoZs6riyC1Qi0/NtPE= text , reference set_host_ipvfuture BQxPHhB2Uv0OyVbWf3e7/seXVX8= text , reference set_host_name Pt4icJRgJxULgQjbXV6yzBigNl8= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view s normal 1 set_encoded_host_address boost/url/url_base.hpp include/boost/url/url_base.hpp 1230 5 1 function 51fvhkKEd4+UZEBsnLd4vUL/Svw= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text Depending on the contents of the passed string, this function sets the host: list paragraph text If the string is a valid IPv4 address, then the host is set to the address. The host type is reference host_type::ipv4 49F64dAiji9HVbP6MxLQiqot7AY= text . paragraph text If the string is a valid IPv6 address, then the host is set to that address. The host type is reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= text . paragraph text If the string is a valid IPvFuture, then the host is set to that address. The host type is reference host_type::ipvfuture TcYJaTwDFsx+0S2CkvHHARcCqWc= text . paragraph text Otherwise, the host name is set to the string. This string can contain percent escapes, or can be empty. Escapes in the string are preserved, and reserved characters in the string are percent-escaped in the result. The host type is reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= text . unordered paragraph text In all cases, when this function returns, the URL contains an authority. heading text Example 1 code assert( url( "http://www.example.com" ).set_host( "127.0.0.1" ).buffer() == "http://127.0.0.1" ); heading text Postconditions 1 code this->has_authority() == true heading text Complexity 1 paragraph text Linear in code text this->size() + s.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text BNF 1 code IPv4address = dec-octet "." dec-octet "." dec-octet "." dec-octet dec-octet = DIGIT ; 0-9 / %x31-39 DIGIT ; 10-99 / "1" 2DIGIT ; 100-199 / "2" %x30-34 DIGIT ; 200-249 / "25" %x30-35 ; 250-255 IPv6address = 6( h16 ":" ) ls32 / "::" 5( h16 ":" ) ls32 / [ h16 ] "::" 4( h16 ":" ) ls32 / [ *1( h16 ":" ) h16 ] "::" 3( h16 ":" ) ls32 / [ *2( h16 ":" ) h16 ] "::" 2( h16 ":" ) ls32 / [ *3( h16 ":" ) h16 ] "::" h16 ":" ls32 / [ *4( h16 ":" ) h16 ] "::" ls32 / [ *5( h16 ":" ) h16 ] "::" h16 / [ *6( h16 ":" ) h16 ] "::" ls32 = ( h16 ":" h16 ) / IPv4address ; least-significant 32 bits of address h16 = 1*4HEXDIG ; 16 bits of address represented in hexadecimal IPvFuture = "v" 1*HEXDIG "." 1*( unreserved / sub-delims / ":" ) reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text IPv4 (Wikipedia) https://en.wikipedia.org/wiki/IPv4 paragraph link text IP Version 6 Addressing Architecture (rfc4291) https://datatracker.ietf.org/doc/html/rfc4291 paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Set the host to an address returns code text *this param text The string to set. s throws code text s text contains an invalid percent-encoding. reference system_error see reference set_encoded_host OgEcjvMpUkw5cqqrotx6BNVfYuA= text , reference set_encoded_host_name Lz8KFSebh4YuJuAAf0STYQ/VPqk= text , reference set_host lhYybwvylnG/ieiGmyVfyExN3dw= text , reference set_host_address ut25mVfVRShtv19Mg+nvS5jVATc= text , reference set_host_ipv4 Cn5GM3RJyUENDJ/d6LnYVW+gkA4= text , reference set_host_ipv6 BryTExdDEUoZs6riyC1Qi0/NtPE= text , reference set_host_ipvfuture BQxPHhB2Uv0OyVbWf3e7/seXVX8= text , reference set_host_name Pt4icJRgJxULgQjbXV6yzBigNl8= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view s normal 1 set_encoded_host_name boost/url/url_base.hpp include/boost/url/url_base.hpp 1566 5 1 function Lz8KFSebh4YuJuAAf0STYQ/VPqk= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text The host is set to the specified string, which may contain percent-escapes and can be empty. Escapes in the string are preserved, and reserved characters in the string are percent-escaped in the result. The host type is reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= text . heading text Example 1 code assert( url( "http://www.example.com/index.htm").set_encoded_host_name( "localhost" ).host_address() == "localhost" ); heading text Postconditions 1 code this->has_authority() == true && this->host_ipv6_address() == addr && this->host_type() == host_type::name heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text BNF 1 code reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Set the host to a name returns code text *this param text The string to set. s throws code text s text contains an invalid percent-encoding. reference system_error see reference set_encoded_host OgEcjvMpUkw5cqqrotx6BNVfYuA= text , reference set_encoded_host_address 51fvhkKEd4+UZEBsnLd4vUL/Svw= text , reference set_host lhYybwvylnG/ieiGmyVfyExN3dw= text , reference set_host_address ut25mVfVRShtv19Mg+nvS5jVATc= text , reference set_host_ipv4 Cn5GM3RJyUENDJ/d6LnYVW+gkA4= text , reference set_host_ipv6 BryTExdDEUoZs6riyC1Qi0/NtPE= text , reference set_host_ipvfuture BQxPHhB2Uv0OyVbWf3e7/seXVX8= text , reference set_host_name Pt4icJRgJxULgQjbXV6yzBigNl8= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view s normal 1 set_encoded_params boost/url/url_base.hpp include/boost/url/url_base.hpp 2419 5 1 function S9fyQqerhxu7yBt8GhsEJ9RKJl8= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This sets the query params to the elements in the list, which may contain percent-escapes and can be empty. paragraph text An empty list of params is distinct from having no query. paragraph text Escapes in the string are preserved, and reserved characters in the string are percent-escaped in the result. heading text Example 1 code assert( url( "http://example.com" ).set_encoded_params( {"id", "42"} ).encoded_query() == "id=42" ); heading text Postconditions 1 code this->has_query() == true heading text Complexity 1 paragraph text Linear. heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Set the query params returns code text *this param text The params to set. ps throws text some element in code text ps text contains an invalid percent-encoding. reference system_error see reference set_params 6eTAKxxUVgfC1QD7w2yAukEvLs4= text , reference params wdcIrRY9aj9gn6bF1i59TpOAQb4= text , reference remove_query ZZWEzCK7DguUxc3TvUfizoGKplE= text , reference set_encoded_query QcQ13DUh8M8TR/zj/LDG3N/+i3c= text , reference set_query 99/QTSBQGLrNj3zGdw5VzYlqfnI= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base specialization 3tT5Y8vozttMWXrA/fNw4NcDYTE= initializer_list identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std ps normal 1 set_encoded_password boost/url/url_base.hpp include/boost/url/url_base.hpp 804 5 1 function qF7dDBIf4KkHxSuysLw1EJNSh2Y= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function sets the password in the userinfo to the string, which may contain percent-escapes. Escapes in the string are preserved, and reserved characters in the string are percent-escaped in the result. admonition paragraph text The interpretation of the userinfo as individual user and password components is scheme-dependent. Transmitting passwords in URLs is deprecated. note heading text Example 1 code assert( url("http://user@example.com").set_encoded_password( "pass" ).encoded_userinfo() == "user:pass" ); heading text Postconditions 1 code this->has_password() == true heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code userinfo = [ [ user ] [ ':' password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Set the password. returns code text *this param text The string to set. This string may contain any characters, including nulls. s throws code text s text contains an invalid percent-encoding. reference system_error see reference remove_password M5RIQPf9vzlN+m4Qn0PDNFKy8ak= text , reference set_encoded_password qF7dDBIf4KkHxSuysLw1EJNSh2Y= text , reference set_encoded_user YNLJGohUXCdL6mo1PM3ms9pRQyE= text , reference set_user GWy3y66sOX4ov+Eh3hxNRVsAEwY= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view s normal 1 set_encoded_path boost/url/url_base.hpp include/boost/url/url_base.hpp 1894 5 1 function GQGd+Ne+D3eTy4fe+x1cpa5zefU= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function sets the path to the string, which may contain percent-escapes and can be empty. Escapes in the string are preserved, and reserved characters in the string are percent-escaped in the result. admonition paragraph text The library may adjust the final result to ensure that no other parts of the url is semantically affected. note heading text Example 1 code url u( "http://www.example.com" ); u.set_encoded_path( "path/to/file.txt" ); assert( u.encoded_path() == "/path/to/file.txt" ); heading text Complexity 1 paragraph text Linear in code text this->size() + s.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text BNF 1 code path = path-abempty ; begins with "/" or is empty / path-absolute ; begins with "/" but not "//" / path-noscheme ; begins with a non-colon segment / path-rootless ; begins with a segment / path-empty ; zero characters path-abempty = *( "/" segment ) path-absolute = "/" [ segment-nz *( "/" segment ) ] path-noscheme = segment-nz-nc *( "/" segment ) path-rootless = segment-nz *( "/" segment ) path-empty = 0<pchar> heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text Set the path. returns code text *this param text The string to set. s throws code text s text contains an invalid percent-encoding. reference system_error see reference encoded_segments qeLAK8oZj7+xpHv7Pyh0yYASuqU= text , reference segments coMz0KQ2BIuACsWbIRZ/6lTOmuk= text , reference set_path 0VMn4mT6ruiabbTCXyOFe+JATBg= text , reference set_path_absolute BHDHQef0k/8vd3QskLyTrsv7+DE= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view s normal 1 set_encoded_query boost/url/url_base.hpp include/boost/url/url_base.hpp 2132 5 1 function QcQ13DUh8M8TR/zj/LDG3N/+i3c= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This sets the query to the string, which may contain percent-escapes and can be empty. An empty query is distinct from having no query. Escapes in the string are preserved, and reserved characters in the string are percent-escaped in the result. heading text Example 1 code assert( url( "http://example.com" ).set_encoded_query( "id=42" ).encoded_query() == "id=42" ); heading text Postconditions 1 code this->has_query() == true && this->query() == decode_view( s ); heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Set the query returns code text *this param text The string to set. s throws code text s text contains an invalid percent-encoding. reference system_error see reference encoded_params tDMWbnBabN2mGSH3Apn445gDMEQ= text , reference params wdcIrRY9aj9gn6bF1i59TpOAQb4= text , reference remove_query ZZWEzCK7DguUxc3TvUfizoGKplE= text , reference set_query 99/QTSBQGLrNj3zGdw5VzYlqfnI= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view s normal 1 set_encoded_user boost/url/url_base.hpp include/boost/url/url_base.hpp 692 5 1 function YNLJGohUXCdL6mo1PM3ms9pRQyE= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function sets the user part of the userinfo the the string, which may contain percent-escapes. Escapes in the string are preserved, and reserved characters in the string are percent-escaped in the result. heading text Example 1 code assert( url().set_encoded_user("john%20doe").userinfo() == "john doe" ); heading text Postconditions 1 code this->has_authority() == true && this->has_userinfo() == true heading text Complexity 1 paragraph text Linear in code text this->size() + s.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code userinfo = [ [ user ] [ ':' password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Set the user returns code text *this returns code text *this param text The string to set. s throws code text s text contains an invalid percent-encoding. reference system_error see reference remove_password M5RIQPf9vzlN+m4Qn0PDNFKy8ak= text , reference set_encoded_password qF7dDBIf4KkHxSuysLw1EJNSh2Y= text , reference set_password blkDquwzHtk7o5mJf/hdeY15zWg= text , reference set_user GWy3y66sOX4ov+Eh3hxNRVsAEwY= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view s normal 1 set_encoded_userinfo boost/url/url_base.hpp include/boost/url/url_base.hpp 542 5 1 function MLv0mdC6EhrEgdnFiOF+W8sw0/c= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text The userinfo is set to the given string, which may contain percent-escapes. Escapes in the string are preserved, and reserved characters in the string are percent-escaped in the result. The effects on the user and password depend on the presence of a colon (':') in the string: list paragraph text If an unescaped colon exists, the characters up to the colon become the user and the rest of the characters after the colon become the password. In this case reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text returns true. Otherwise, paragraph text If there is no colon, the user is set to the string. The function reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text returns false. unordered admonition paragraph text The interpretation of the userinfo as individual user and password components is scheme-dependent. Transmitting passwords in URLs is deprecated. note heading text Example 1 code assert( url( "http://example.com" ).set_encoded_userinfo( "john%20doe" ).user() == "john doe" ); heading text Complexity 1 paragraph text Linear in code text this->size() + s.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text BNF 1 code userinfo = [ [ user ] [ ':' password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Set the userinfo. returns code text *this param text The string to set. s throws code text s text contains an invalid percent-encoding. reference system_error see reference remove_userinfo PjTTglJlJuEwKHuRXGByi7wW8W8= text , reference set_userinfo s+5EFNaQxZ6HMzMRElE8AAODpm8= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view s normal 1 set_encoded_zone_id boost/url/url_base.hpp include/boost/url/url_base.hpp 1411 5 1 function /HsDRNr5aHRIzBwkJqZnZrdNZ/k= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function sets the zone ID for the host if the host is an IPv6 address. Escapes in the string are preserved, and reserved characters in the string are percent-escaped in the result. heading text Example 1 code assert( u.set_host_ipv6( ipv6_address( "fe80::1" ) ).set_encoded_zone_id( "eth0" ).buffer() == "https://[fe80::1%25eth0]" ); heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text Specification 1 list paragraph link text RFC 6874 https://datatracker.ietf.org/doc/html/rfc6874 unordered brief text Set the zone ID for an IPv6 address (percent-encoded). returns code text *this param text The zone ID to set. s throws code text s text contains an invalid percent-encoding. reference system_error identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view s normal 1 set_fragment boost/url/url_base.hpp include/boost/url/url_base.hpp 2556 5 1 function VHh7zoCWGsviuG3lWYA54cKWneU= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function sets the fragment to the specified string, which may be empty. An empty fragment is distinct from having no fragment. Reserved characters in the string are percent-escaped in the result. heading text Example 1 code assert( url("?first=john&last=doe" ).set_encoded_fragment( "john doe" ).encoded_fragment() == "john%20doe" ); heading text Postconditions 1 code this->has_fragment() == true && this->fragment() == s heading text Complexity 1 paragraph text Linear in code text this->size() + s.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code fragment = *( pchar / "/" / "?" ) heading text Specification 1 list paragraph link text 3.5. Fragment https://datatracker.ietf.org/doc/html/rfc3986#section-3.5 unordered brief text Set the fragment. returns code text *this param text The string to set. s see reference remove_fragment aGhIz5PP9XtdztICzhAvM4n92Sg= text , reference set_encoded_fragment ebU9NPxh5c4VwDAaQA1CXRWbSKk= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 set_host boost/url/url_base.hpp include/boost/url/url_base.hpp 941 5 1 function lhYybwvylnG/ieiGmyVfyExN3dw= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text Depending on the contents of the passed string, this function sets the host: list paragraph text If the string is a valid IPv4 address, then the host is set to the address. The host type is reference host_type::ipv4 49F64dAiji9HVbP6MxLQiqot7AY= text . paragraph text If the string is a valid IPv6 address enclosed in square brackets, then the host is set to that address. The host type is reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= text . paragraph text If the string is a valid IPvFuture address enclosed in square brackets, then the host is set to that address. The host type is reference host_type::ipvfuture TcYJaTwDFsx+0S2CkvHHARcCqWc= text . paragraph text Otherwise, the host name is set to the string, which may be empty. Reserved characters in the string are percent-escaped in the result. The host type is reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= text . unordered paragraph text In all cases, when this function returns, the URL contains an authority. heading text Example 1 code assert( url( "http://www.example.com" ).set_host( "127.0.0.1" ).buffer() == "http://127.0.0.1" ); heading text Postconditions 1 code this->has_authority() == true heading text Complexity 1 paragraph text Linear in code text this->size() + s.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPvFuture ) "]" reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text IPv4 (Wikipedia) https://en.wikipedia.org/wiki/IPv4 paragraph link text IP Version 6 Addressing Architecture (rfc4291) https://datatracker.ietf.org/doc/html/rfc4291 paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Set the host returns code text *this param text The string to set. s see reference set_encoded_host OgEcjvMpUkw5cqqrotx6BNVfYuA= text , reference set_encoded_host_address 51fvhkKEd4+UZEBsnLd4vUL/Svw= text , reference set_encoded_host_name Lz8KFSebh4YuJuAAf0STYQ/VPqk= text , reference set_host_address ut25mVfVRShtv19Mg+nvS5jVATc= text , reference set_host_ipv4 Cn5GM3RJyUENDJ/d6LnYVW+gkA4= text , reference set_host_ipv6 BryTExdDEUoZs6riyC1Qi0/NtPE= text , reference set_host_ipvfuture BQxPHhB2Uv0OyVbWf3e7/seXVX8= text , reference set_host_name Pt4icJRgJxULgQjbXV6yzBigNl8= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 set_host_address boost/url/url_base.hpp include/boost/url/url_base.hpp 1126 5 1 function ut25mVfVRShtv19Mg+nvS5jVATc= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text Depending on the contents of the passed string, this function sets the host: list paragraph text If the string is a valid IPv4 address, then the host is set to the address. The host type is reference host_type::ipv4 49F64dAiji9HVbP6MxLQiqot7AY= text . paragraph text If the string is a valid IPv6 address, then the host is set to that address. The host type is reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= text . paragraph text If the string is a valid IPvFuture, then the host is set to that address. The host type is reference host_type::ipvfuture TcYJaTwDFsx+0S2CkvHHARcCqWc= text . paragraph text Otherwise, the host name is set to the string, which may be empty. Reserved characters in the string are percent-escaped in the result. The host type is reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= text . unordered paragraph text In all cases, when this function returns, the URL contains an authority. heading text Example 1 code assert( url( "http://www.example.com" ).set_host_address( "127.0.0.1" ).buffer() == "http://127.0.0.1" ); heading text Postconditions 1 code this->has_authority() == true heading text Complexity 1 paragraph text Linear in code text s.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code IPv4address = dec-octet "." dec-octet "." dec-octet "." dec-octet dec-octet = DIGIT ; 0-9 / %x31-39 DIGIT ; 10-99 / "1" 2DIGIT ; 100-199 / "2" %x30-34 DIGIT ; 200-249 / "25" %x30-35 ; 250-255 IPv6address = 6( h16 ":" ) ls32 / "::" 5( h16 ":" ) ls32 / [ h16 ] "::" 4( h16 ":" ) ls32 / [ *1( h16 ":" ) h16 ] "::" 3( h16 ":" ) ls32 / [ *2( h16 ":" ) h16 ] "::" 2( h16 ":" ) ls32 / [ *3( h16 ":" ) h16 ] "::" h16 ":" ls32 / [ *4( h16 ":" ) h16 ] "::" ls32 / [ *5( h16 ":" ) h16 ] "::" h16 / [ *6( h16 ":" ) h16 ] "::" ls32 = ( h16 ":" h16 ) / IPv4address ; least-significant 32 bits of address h16 = 1*4HEXDIG ; 16 bits of address represented in hexadecimal IPvFuture = "v" 1*HEXDIG "." 1*( unreserved / sub-delims / ":" ) reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text IPv4 (Wikipedia) https://en.wikipedia.org/wiki/IPv4 paragraph link text IP Version 6 Addressing Architecture (rfc4291) https://datatracker.ietf.org/doc/html/rfc4291 paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Set the host to an address returns code text *this param text The string to set. s see reference set_encoded_host OgEcjvMpUkw5cqqrotx6BNVfYuA= text , reference set_encoded_host_address 51fvhkKEd4+UZEBsnLd4vUL/Svw= text , reference set_encoded_host_name Lz8KFSebh4YuJuAAf0STYQ/VPqk= text , reference set_host lhYybwvylnG/ieiGmyVfyExN3dw= text , reference set_host_address ut25mVfVRShtv19Mg+nvS5jVATc= text , reference set_host_ipv4 Cn5GM3RJyUENDJ/d6LnYVW+gkA4= text , reference set_host_ipv6 BryTExdDEUoZs6riyC1Qi0/NtPE= text , reference set_host_ipvfuture BQxPHhB2Uv0OyVbWf3e7/seXVX8= text , reference set_host_name Pt4icJRgJxULgQjbXV6yzBigNl8= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 set_host_ipv4 boost/url/url_base.hpp include/boost/url/url_base.hpp 1287 5 1 function Cn5GM3RJyUENDJ/d6LnYVW+gkA4= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text The host is set to the specified IPv4 address. The host type is reference host_type::ipv4 49F64dAiji9HVbP6MxLQiqot7AY= text . heading text Example 1 code assert( url("http://www.example.com").set_host_ipv4( ipv4_address( "127.0.0.1" ) ).buffer() == "http://127.0.0.1" ); heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Postconditions 1 code this->has_authority() == true && this->host_ipv4_address() == addr && this->host_type() == host_type::ipv4 heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code IPv4address = dec-octet "." dec-octet "." dec-octet "." dec-octet dec-octet = DIGIT ; 0-9 / %x31-39 DIGIT ; 10-99 / "1" 2DIGIT ; 100-199 / "2" %x30-34 DIGIT ; 200-249 / "25" %x30-35 ; 250-255 heading text Specification 1 list paragraph link text IPv4 (Wikipedia) https://en.wikipedia.org/wiki/IPv4 paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Set the host to an address returns code text *this param text The address to set. addr see reference set_encoded_host OgEcjvMpUkw5cqqrotx6BNVfYuA= text , reference set_encoded_host_address 51fvhkKEd4+UZEBsnLd4vUL/Svw= text , reference set_encoded_host_name Lz8KFSebh4YuJuAAf0STYQ/VPqk= text , reference set_host lhYybwvylnG/ieiGmyVfyExN3dw= text , reference set_host_address ut25mVfVRShtv19Mg+nvS5jVATc= text , reference set_host_ipv6 BryTExdDEUoZs6riyC1Qi0/NtPE= text , reference set_host_ipvfuture BQxPHhB2Uv0OyVbWf3e7/seXVX8= text , reference set_host_name Pt4icJRgJxULgQjbXV6yzBigNl8= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base 1 identifier /Wpp3ZZDp3kUHzbULeDoaOEhnVs= ipv4_address addr normal 1 set_host_ipv6 boost/url/url_base.hpp include/boost/url/url_base.hpp 1353 5 1 function BryTExdDEUoZs6riyC1Qi0/NtPE= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text The host is set to the specified IPv6 address. The host type is reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= text . heading text Example 1 code assert( url().set_host_ipv6( ipv6_address( "1::6:c0a8:1" ) ).authority().buffer() == "[1::6:c0a8:1]" ); heading text Postconditions 1 code this->has_authority() == true && this->host_ipv6_address() == addr && this->host_type() == host_type::ipv6 heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code IPv6address = 6( h16 ":" ) ls32 / "::" 5( h16 ":" ) ls32 / [ h16 ] "::" 4( h16 ":" ) ls32 / [ *1( h16 ":" ) h16 ] "::" 3( h16 ":" ) ls32 / [ *2( h16 ":" ) h16 ] "::" 2( h16 ":" ) ls32 / [ *3( h16 ":" ) h16 ] "::" h16 ":" ls32 / [ *4( h16 ":" ) h16 ] "::" ls32 / [ *5( h16 ":" ) h16 ] "::" h16 / [ *6( h16 ":" ) h16 ] "::" ls32 = ( h16 ":" h16 ) / IPv4address ; least-significant 32 bits of address h16 = 1*4HEXDIG ; 16 bits of address represented in hexadecimal heading text Specification 1 list paragraph link text IP Version 6 Addressing Architecture (rfc4291) https://datatracker.ietf.org/doc/html/rfc4291 paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Set the host to an address returns code text *this param text The address to set. addr see reference set_encoded_host OgEcjvMpUkw5cqqrotx6BNVfYuA= text , reference set_encoded_host_address 51fvhkKEd4+UZEBsnLd4vUL/Svw= text , reference set_encoded_host_name Lz8KFSebh4YuJuAAf0STYQ/VPqk= text , reference set_host lhYybwvylnG/ieiGmyVfyExN3dw= text , reference set_host_address ut25mVfVRShtv19Mg+nvS5jVATc= text , reference set_host_ipv4 Cn5GM3RJyUENDJ/d6LnYVW+gkA4= text , reference set_host_ipvfuture BQxPHhB2Uv0OyVbWf3e7/seXVX8= text , reference set_host_name Pt4icJRgJxULgQjbXV6yzBigNl8= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base 1 identifier dhMSRVBIIIItY0URHSc8rwHcdTQ= ipv6_address addr normal 1 set_host_ipvfuture boost/url/url_base.hpp include/boost/url/url_base.hpp 1464 5 1 function BQxPHhB2Uv0OyVbWf3e7/seXVX8= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text The host is set to the specified IPvFuture string. The host type is reference host_type::ipvfuture TcYJaTwDFsx+0S2CkvHHARcCqWc= text . heading text Example 1 code assert( url().set_host_ipvfuture( "v42.bis" ).buffer() == "//[v42.bis]" ); heading text Complexity 1 paragraph text Linear in code text this->size() + s.size() text . heading text Postconditions 1 code this->has_authority() == true && this->host_ipvfuture) == s && this->host_type() == host_type::ipvfuture heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text BNF 1 code IPvFuture = "v" 1*HEXDIG "." 1*( unreserved / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Set the host to an address returns code text *this param text The string to set. s throws code text s text contains an invalid percent-encoding. reference system_error see reference set_encoded_host OgEcjvMpUkw5cqqrotx6BNVfYuA= text , reference set_encoded_host_address 51fvhkKEd4+UZEBsnLd4vUL/Svw= text , reference set_encoded_host_name Lz8KFSebh4YuJuAAf0STYQ/VPqk= text , reference set_host lhYybwvylnG/ieiGmyVfyExN3dw= text , reference set_host_address ut25mVfVRShtv19Mg+nvS5jVATc= text , reference set_host_ipv4 Cn5GM3RJyUENDJ/d6LnYVW+gkA4= text , reference set_host_ipv6 BryTExdDEUoZs6riyC1Qi0/NtPE= text , reference set_host_name Pt4icJRgJxULgQjbXV6yzBigNl8= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 set_host_name boost/url/url_base.hpp include/boost/url/url_base.hpp 1512 5 1 function Pt4icJRgJxULgQjbXV6yzBigNl8= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text The host is set to the specified string, which may be empty. Reserved characters in the string are percent-escaped in the result. The host type is reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= text . heading text Example 1 code assert( url( "http://www.example.com/index.htm").set_host_name( "localhost" ).host_address() == "localhost" ); heading text Postconditions 1 code this->has_authority() == true && this->host_ipv6_address() == addr && this->host_type() == host_type::name heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Set the host to a name returns code text *this param text The string to set. s see reference set_encoded_host OgEcjvMpUkw5cqqrotx6BNVfYuA= text , reference set_encoded_host_address 51fvhkKEd4+UZEBsnLd4vUL/Svw= text , reference set_encoded_host_name Lz8KFSebh4YuJuAAf0STYQ/VPqk= text , reference set_host lhYybwvylnG/ieiGmyVfyExN3dw= text , reference set_host_address ut25mVfVRShtv19Mg+nvS5jVATc= text , reference set_host_ipv4 Cn5GM3RJyUENDJ/d6LnYVW+gkA4= text , reference set_host_ipv6 BryTExdDEUoZs6riyC1Qi0/NtPE= text , reference set_host_ipvfuture BQxPHhB2Uv0OyVbWf3e7/seXVX8= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 set_params boost/url/url_base.hpp include/boost/url/url_base.hpp 2355 5 1 function 6eTAKxxUVgfC1QD7w2yAukEvLs4= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This sets the query params to the list of param_view, which can be empty. paragraph text An empty list of params is distinct from having no params. paragraph text Reserved characters in the string are percent-escaped in the result. heading text Example 1 code assert( url( "http://example.com" ).set_params( {"id", "42"} ).query() == "id=42" ); heading text Postconditions 1 code this->has_query() == true heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text Complexity 1 paragraph text Linear. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text ://en.wikipedia.org/wiki/Query_string" >Query string (Wikipedia) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 >3.4. Query (rfc3986)</a> @li <a href= unordered brief text Set the query params returns code text *this param text The params to set. ps param text The options for encoding. opts see reference encoded_params tDMWbnBabN2mGSH3Apn445gDMEQ= text , reference remove_query ZZWEzCK7DguUxc3TvUfizoGKplE= text , reference set_encoded_query QcQ13DUh8M8TR/zj/LDG3N/+i3c= text , reference set_query 99/QTSBQGLrNj3zGdw5VzYlqfnI= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base specialization 3tT5Y8vozttMWXrA/fNw4NcDYTE= initializer_list identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std ps identifier Bb04pNwExynJkzlY9a9GCeeB13k= encoding_opts opts {} normal 1 set_password boost/url/url_base.hpp include/boost/url/url_base.hpp 746 5 1 function blkDquwzHtk7o5mJf/hdeY15zWg= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function sets the password in the userinfo to the string. Reserved characters in the string are percent-escaped in the result. admonition paragraph text The interpretation of the userinfo as individual user and password components is scheme-dependent. Transmitting passwords in URLs is deprecated. note heading text Example 1 code assert( url("http://user@example.com").set_password( "pass" ).encoded_userinfo() == "user:pass" ); heading text Postconditions 1 code this->has_password() == true && this->password() == s heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code userinfo = [ [ user ] [ ':' password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Set the password. returns code text *this param text The string to set. This string may contain any characters, including nulls. s see reference remove_password M5RIQPf9vzlN+m4Qn0PDNFKy8ak= text , reference set_encoded_password qF7dDBIf4KkHxSuysLw1EJNSh2Y= text , reference set_encoded_user YNLJGohUXCdL6mo1PM3ms9pRQyE= text , reference set_user GWy3y66sOX4ov+Eh3hxNRVsAEwY= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 set_path boost/url/url_base.hpp include/boost/url/url_base.hpp 1827 5 1 function 0VMn4mT6ruiabbTCXyOFe+JATBg= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function sets the path to the string, which may be empty. Reserved characters in the string are percent-escaped in the result. admonition paragraph text The library may adjust the final result to ensure that no other parts of the URL are semantically affected. note admonition paragraph text This function does not encode '/' chars, which are unreserved for paths but reserved for path segments. If a path segment should include encoded '/'s to differentiate it from path separators, the functions reference set_encoded_path GQGd+Ne+D3eTy4fe+x1cpa5zefU= text or reference segments coMz0KQ2BIuACsWbIRZ/6lTOmuk= text should be used instead. note heading text Example 1 code url u( "http://www.example.com" ); u.set_path( "path/to/file.txt" ); assert( u.path() == "/path/to/file.txt" ); heading text Complexity 1 paragraph text Linear in code text this->size() + s.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code path = path-abempty ; begins with "/" or is empty / path-absolute ; begins with "/" but not "//" / path-noscheme ; begins with a non-colon segment / path-rootless ; begins with a segment / path-empty ; zero characters path-abempty = *( "/" segment ) path-absolute = "/" [ segment-nz *( "/" segment ) ] path-noscheme = segment-nz-nc *( "/" segment ) path-rootless = segment-nz *( "/" segment ) path-empty = 0<pchar> heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text Set the path. returns code text *this param text The string to set. s see reference encoded_segments qeLAK8oZj7+xpHv7Pyh0yYASuqU= text , reference segments coMz0KQ2BIuACsWbIRZ/6lTOmuk= text , reference set_encoded_path GQGd+Ne+D3eTy4fe+x1cpa5zefU= text , reference set_path_absolute BHDHQef0k/8vd3QskLyTrsv7+DE= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 set_path_absolute boost/url/url_base.hpp include/boost/url/url_base.hpp 1760 5 1 function BHDHQef0k/8vd3QskLyTrsv7+DE= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function adjusts the path to make it absolute or not, depending on the parameter. admonition paragraph text If an authority is present, the path is always absolute. In this case, the function has no effect. note heading text Example 1 code url u( "path/to/file.txt" ); assert( u.set_path_absolute( true ) ); assert( u.buffer() == "/path/to/file.txt" ); heading text Postconditions 1 code this->is_path_absolute() == true && this->encoded_path().front() == '/' heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text BNF 1 code path = path-abempty ; begins with "/" or is empty / path-absolute ; begins with "/" but not "//" / path-noscheme ; begins with a non-colon segment / path-rootless ; begins with a segment / path-empty ; zero characters path-abempty = *( "/" segment ) path-absolute = "/" [ segment-nz *( "/" segment ) ] path-noscheme = segment-nz-nc *( "/" segment ) path-rootless = segment-nz *( "/" segment ) path-empty = 0<pchar> heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text Set if the path is absolute returns text true on success. param text If code text true text , the path is made absolute. absolute see reference encoded_segments qeLAK8oZj7+xpHv7Pyh0yYASuqU= text , reference segments coMz0KQ2BIuACsWbIRZ/6lTOmuk= text , reference set_encoded_path GQGd+Ne+D3eTy4fe+x1cpa5zefU= text , reference set_path 0VMn4mT6ruiabbTCXyOFe+JATBg= text . identifier bool identifier bool absolute normal 1 set_port boost/url/url_base.hpp include/boost/url/url_base.hpp 1656 5 1 function p1q1Ba+a+naWvTDfBuMPt0DJw2A= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This port is set to the string, which must contain only digits or be empty. An empty port string is distinct from having no port. heading text Example 1 code assert( url( "http://www.example.com" ).set_port( "8080" ).authority().buffer() == "www.example.com:8080" ); heading text Postconditions 1 code this->has_port() == true && this->port_number() == n && this->port() == std::to_string(n) heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text BNF 1 code port = *DIGIT heading text Specification 1 list paragraph link text 3.2.3. Port (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.3 unordered brief text Set the port returns code text *this param text The port string to set. s throws code text s text does not contain a valid port. reference system_error see reference remove_port ADa0xIsiS8APEAdL3+s0LoNowA8= text , reference set_port p1q1Ba+a+naWvTDfBuMPt0DJw2A= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 set_port_number boost/url/url_base.hpp include/boost/url/url_base.hpp 1612 5 1 function 4bptcCq14NmzqKQvnx54lE+28F0= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text The port is set to the specified integer. heading text Example 1 code assert( url( "http://www.example.com" ).set_port_number( 8080 ).authority().buffer() == "www.example.com:8080" ); heading text Postconditions 1 code this->has_authority() == true && this->has_port() == true && this->port_number() == n heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code authority = [ userinfo "@" ] host [ ":" port ] port = *DIGIT heading text Specification 1 list paragraph link text 3.2.3. Port (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.3 unordered brief text Set the port returns code text *this param text The port number to set. n see reference remove_port ADa0xIsiS8APEAdL3+s0LoNowA8= text , reference set_port p1q1Ba+a+naWvTDfBuMPt0DJw2A= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier Qvo2fOST20EZC7bSOAFZr+u3ITg= uint16_t n normal 1 set_query boost/url/url_base.hpp include/boost/url/url_base.hpp 2076 5 1 function 99/QTSBQGLrNj3zGdw5VzYlqfnI= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This sets the query to the string, which can be empty. An empty query is distinct from having no query. Reserved characters in the string are percent-escaped in the result. heading text Example 1 code assert( url( "http://example.com" ).set_query( "id=42" ).query() == "id=42" ); heading text Postconditions 1 code this->has_query() == true && this->query() == s heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Set the query returns code text *this param text The string to set. s see reference encoded_params tDMWbnBabN2mGSH3Apn445gDMEQ= text , reference params wdcIrRY9aj9gn6bF1i59TpOAQb4= text , reference remove_query ZZWEzCK7DguUxc3TvUfizoGKplE= text , reference set_encoded_query QcQ13DUh8M8TR/zj/LDG3N/+i3c= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 set_scheme boost/url/url_base.hpp include/boost/url/url_base.hpp 245 5 1 function rKQfFZ6dfzeuSqZL+PgPNpIFQ5g= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text The scheme is set to the specified string, which must contain a valid scheme without any trailing colon (':'). Note that schemes are case-insensitive, and the canonical form is lowercased. heading text Example 1 code assert( url( "http://www.example.com" ).set_scheme( "https" ).scheme_id() == scheme::https ); heading text Complexity 1 paragraph text Linear in code text this->size() + s.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text BNF 1 code scheme = ALPHA *( ALPHA / DIGIT / "+" / "-" / "." ) heading text Specification 1 list paragraph link text 3.1. Scheme (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.1 unordered brief text Set the scheme returns code text *this param text The scheme to set. s throws code text s text contains an invalid scheme. reference system_error see reference remove_scheme 1N2Tt1DokczwHdRgAZiZzhPQr4E= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 set_scheme_id boost/url/url_base.hpp include/boost/url/url_base.hpp 280 5 1 function iuTF0vS1Knzl0Hxr4iVhx35Fzdk= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function sets the scheme to the specified known reference urls::scheme P7uOjuAMILimKGOcbjDUSpMAL/U= text id, which may not be reference scheme::unknown LJxTyQ55ot1WYLH7f46nZvdGU78= text or else an exception is thrown. If the id is reference scheme::none VupiauVBXlZQ8Uix+vk8kSl+fM8= text , this function behaves as if reference remove_scheme 1N2Tt1DokczwHdRgAZiZzhPQr4E= text were called. heading text Example 1 code assert( url( "http://example.com/echo.cgi" ).set_scheme_id( scheme::wss ).buffer() == "wss://example.com/echo.cgi" ); heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input. heading text Specification 1 list paragraph link text 3.1. Scheme (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.1 unordered brief text Set the scheme returns code text *this param text The scheme to set. id throws text The scheme is invalid. reference system_error identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier P7uOjuAMILimKGOcbjDUSpMAL/U= scheme identifier dnk5XPfR2OaMpCYaH3cWSxcTdyc= urls id normal 1 set_user boost/url/url_base.hpp include/boost/url/url_base.hpp 635 5 1 function GWy3y66sOX4ov+Eh3hxNRVsAEwY= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function sets the user part of the userinfo to the string. Any special or reserved characters in the string are automatically percent-encoded. heading text Example 1 code assert( url().set_user("john doe").encoded_userinfo() == "john%20doe" ); heading text Postconditions 1 code this->has_authority() == true && this->has_userinfo() == true heading text Complexity 1 paragraph text Linear in code text this->size() + s.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code userinfo = [ [ user ] [ ':' password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Set the user returns code text *this param text The string to set. s see reference remove_password M5RIQPf9vzlN+m4Qn0PDNFKy8ak= text , reference set_encoded_password qF7dDBIf4KkHxSuysLw1EJNSh2Y= text , reference set_encoded_user YNLJGohUXCdL6mo1PM3ms9pRQyE= text , reference set_password blkDquwzHtk7o5mJf/hdeY15zWg= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 set_userinfo boost/url/url_base.hpp include/boost/url/url_base.hpp 475 5 1 function s+5EFNaQxZ6HMzMRElE8AAODpm8= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text The userinfo is set to the given string, which may contain percent-escapes. Any special or reserved characters in the string are automatically percent-encoded. The effects on the user and password depend on the presence of a colon (':') in the string: list paragraph text If an unescaped colon exists, the characters up to the colon become the user and the rest of the characters after the colon become the password. In this case reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text returns true. Otherwise, paragraph text If there is no colon, the user is set to the string. The function reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text returns false. unordered admonition paragraph text The interpretation of the userinfo as individual user and password components is scheme-dependent. Transmitting passwords in URLs is deprecated. note heading text Example 1 code assert( url( "http://example.com" ).set_userinfo( "user:pass" ).encoded_user() == "user" ); heading text Complexity 1 paragraph text Linear in code text this->size() + s.size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text BNF 1 code userinfo = [ [ user ] [ ':' password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Set the userinfo returns code text *this param text The string to set. s see reference remove_userinfo PjTTglJlJuEwKHuRXGByi7wW8W8= text , reference set_encoded_userinfo MLv0mdC6EhrEgdnFiOF+W8sw0/c= text . identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 set_zone_id boost/url/url_base.hpp include/boost/url/url_base.hpp 1380 5 1 function eM5mUh7EZ/5wyXKQEoMXhHD+KJk= regular aHkFCWJbYb0t+7FT+A5gCI0krpU= paragraph text This function sets the zone ID for the host if the host is an IPv6 address. Reserved characters in the string are percent-escaped in the result. heading text Example 1 code assert( u.set_host_ipv6( ipv6_address( "fe80::1" ) ).set_zone_id( "eth0" ).buffer() == "https://[fe80::1%25eth0]" ); heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Strong guarantee. Calls to allocate may throw. heading text Specification 1 list paragraph link text RFC 6874 https://datatracker.ietf.org/doc/html/rfc6874 unordered brief text Set the zone ID for an IPv6 address. returns code text *this param text The zone ID to set. s identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal 1 size boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 201 5 1 function b5EwiMBFGrk0/BIGaiumuCVSoFM= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the number of characters in the url's encoded string, not including any null terminator, if present. heading text Example 1 code assert( url_view( "file:///Program%20Files" ).size() == 23 ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the number of characters in the url returns text The number of characters in the url. identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 1 user boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 848 5 1 function /oa6wZJEG852J9Yi1LQlnq1n1tM= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If present, this function returns a string representing the user (which may be empty). Otherwise it returns an empty string. Any percent-escapes in the string are decoded first. heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).user() == "jane-doe" ); heading text Complexity 1 paragraph text Linear in code text this->user().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code userinfo = user [ ":" [ password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return the user returns text The user as a string. param text The string token to use. token see reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text , reference has_userinfo i/v5Vfq44OnlLbuKgQ2KvgWgZqo= text , reference encoded_password W9oZv0BM5z4XAggQPbNAKIM7/ro= text , reference encoded_user oYwrnXcglhO4tlvhkxLGfFCYbAk= text , reference encoded_userinfo yzkq+uCmbTlXrfDuyd1fT0Zu6xw= text , reference password +ZB55yb2DeVYG+/eYqlMcGcedVE= text , reference userinfo S9yd7MVhXxF+598Xy2/+jwnCZzc= text . identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 userinfo boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 748 5 1 function S9yd7MVhXxF+598Xy2/+jwnCZzc= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If present, this function returns a string representing the userinfo (which may be empty). Otherwise it returns an empty string. Any percent-escapes in the string are decoded first. admonition paragraph text This function uses the string token return type customization. Depending on the token passed, the return type and behavior of the function can be different. See reference string_token::return_string +eBzDECNPyuTkJuxLUTMVIkHGO0= text for more information. note heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).userinfo() == "jane-doe:pass" ); heading text Complexity 1 paragraph text Linear in code text this->userinfo().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code userinfo = user [ ":" [ password ] ] authority = [ userinfo "@" ] host [ ":" port ] heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return the userinfo returns text When called with no arguments, a value of type code text std::string text is returned. Otherwise, the return type and meaning depends on the string token passed to the function. returns text The userinfo as a string. param text The string token to use. token see reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text , reference has_userinfo i/v5Vfq44OnlLbuKgQ2KvgWgZqo= text , reference encoded_password W9oZv0BM5z4XAggQPbNAKIM7/ro= text , reference encoded_user oYwrnXcglhO4tlvhkxLGfFCYbAk= text , reference encoded_userinfo yzkq+uCmbTlXrfDuyd1fT0Zu6xw= text , reference password +ZB55yb2DeVYG+/eYqlMcGcedVE= text , reference user /oa6wZJEG852J9Yi1LQlnq1n1tM= text . identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 zone_id boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1480 5 1 function rN6p9/aLARL9S9gn02k+M+j21q8= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If the host type is reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= text , this function returns the Zone ID as a string. Otherwise an empty string is returned. Any percent-escapes in the string are decoded first. heading text Example 1 code assert( url_view( "http://[fe80::1%25eth0]/" ).zone_id() == "eth0" ); heading text Complexity 1 paragraph text Linear in code text this->encoded_zone_id().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPv6addrz / IPvFuture ) "]" ZoneID = 1*( unreserved / pct-encoded ) IPv6addrz = IPv6address "%25" ZoneID heading text Specification 1 list paragraph link text Representing IPv6 Zone Identifiers in Address Literals and Uniform Resource Identifiers https://datatracker.ietf.org/doc/html/rfc6874 unordered brief text Return the IPv6 Zone ID returns text The Zone ID as a string. param text A string token customization. token identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 operator basic_string_view<char> boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 299 5 1 function 0JOtXYOmKvCl2dNIZYV6J7flgJE= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the URL as a core::string_view returns text A string view of the URL. identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core conversion 1 1 max_size boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 173 5 1 function mg8FRYZ94og9lKYjTEYdjucqHw4= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This represents the largest number of characters that are theoretically possible to represent in a url, not including any null terminator. In practice the actual possible size may be lower than this number. heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the maximum number of characters possible returns text The maximum number of characters. identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 digest boost/url/impl/url_view_base.hpp include/boost/url/impl/url_view_base.hpp 81 1 boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 146 5 1 function aSDB3babl7TsiU0T+gdHMM/NC5c= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function calculates a hash of the url as if it were always normalized. heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Throws nothing. brief text Calculate a hash of the url returns text A hash value suitable for use in hash-based containers. param text An initial value to add to the hash salt identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std salt 0 normal 1 1 url_view boost/url/url_view.hpp include/boost/url/url_view.hpp 81 1 1 boost/url/detail/url_impl.hpp include/boost/url/detail/url_impl.hpp 26 1 boost/url/rfc/absolute_uri_rule.hpp include/boost/url/rfc/absolute_uri_rule.hpp 20 1 boost/url/rfc/relative_ref_rule.hpp include/boost/url/rfc/relative_ref_rule.hpp 20 1 boost/url/rfc/uri_rule.hpp include/boost/url/rfc/uri_rule.hpp 20 1 boost/url/rfc/uri_reference_rule.hpp include/boost/url/rfc/uri_reference_rule.hpp 20 1 boost/url/rfc/origin_form_rule.hpp include/boost/url/rfc/origin_form_rule.hpp 20 1 record wh3UbUToX9YDmRmnpcoM9EUEZo8= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text Objects of this type represent valid URL strings constructed from a parsed, external character buffer whose storage is managed by the caller. That is, it acts like a code text core::string_view text in terms of ownership. The caller is responsible for ensuring that the lifetime of the underlying character buffer extends until it is no longer referenced. heading text Example 1 1 paragraph text Construction from a string parses the input as a emph text URI-reference text and throws an exception on error. Upon success, the constructed object points to the passed character buffer; ownership is not transferred. code url_view u( "https://www.example.com/index.htm?text=none#a1" ); heading text Example 2 1 paragraph text Parsing functions like reference parse_uri_reference 7d2b1xVBWJPgL/+PWFdoBaZJvMA= text return a code text boost::system::result text containing either a valid reference url_view wg5mELA0xi9IYzWSOSuNwa4P1aw= text upon success, otherwise they contain an error. The error can be converted to an exception by the caller if desired: code system::result< url_view > rv = parse_uri_reference( "https://www.example.com/index.htm?text=none#a1" ); heading text BNF 1 code URI-reference = URI / relative-ref URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] relative-ref = relative-part [ "?" query ] [ "#" fragment ] heading text Specification 1 list paragraph link text Uniform Resource Identifier (URI): Generic Syntax (rfc3986) https://tools.ietf.org/html/rfc3986 unordered brief text A non-owning reference to a valid URL see reference parse_absolute_uri U3CVElRbcTcbg1JzOqhBCd5RSzM= text , reference parse_origin_form J4f05lEg7oi89R2SkpRaYiBhCIQ= text , reference parse_relative_ref QFzcl8vSLEeKOEO6w3mv1zGqX3k= text , reference parse_uri f+9kR517VGSM5ZPoS7g/RFb0g/0= text , reference parse_uri_reference 7d2b1xVBWJPgL/+PWFdoBaZJvMA= text . reference operator!= QA2q/R+XvrJl2j8UnJwv+lnhdDA= reference operator< Si07vh35lnvnJy8tpXUIpiFEjGM= reference operator<= rRCHC/6GEaVZrjzAeFDlvaCydi0= reference operator== E2+0o+/H5dWqJ1IkTzJ6aHTaMHE= reference operator> ngGy21anUjaZiQQJidHT5lvOC2w= reference operator>= AdXFp/RvPKHF4rljfa5/5yBmyfs= reference parse_absolute_uri U3CVElRbcTcbg1JzOqhBCd5RSzM= reference parse_origin_form J4f05lEg7oi89R2SkpRaYiBhCIQ= reference parse_relative_ref QFzcl8vSLEeKOEO6w3mv1zGqX3k= reference parse_uri f+9kR517VGSM5ZPoS7g/RFb0g/0= reference parse_uri_reference 7d2b1xVBWJPgL/+PWFdoBaZJvMA= reference resolve /6zWjIFN5df0PBj9zFsfNUjNY6s= class identifier UEVNhDEjkZMXfjN1DxbtX0n2rCg= url_view_base wg5mELA0xi9IYzWSOSuNwa4P1aw= C2Z06VYQtT0f7SfP2ilcaOdS/FY= EF2Xp7R+V9zgbWT05m2yVZ5cl7k= v5/R9LI0iKJDiBrNUt7k8qrVBdM= oDNnPxjP34HYhoUyyduWMZfqZs4= p+2L2asXUGpE7eey1ouRvFXKD1g= I2WjK21z+iS45kbL4TnzA8O5oE0= 5yR7btLz2K+NLHFnzfXMyGsq2fo= Ww04vLA2k7BwctuyNeP3KwoNr4M= M7+OzewsxChMvecRSytXqTCqKrY= EcGxt+esOtVfjloInubXUYLy5GY= yXsUZRbi+wInLqaUUVy9b7nIIBo= 9ptIMbwWSNtVv+KAUpHCO3bmTWg= 4URKnuP+gvIUVjIkywv/pXeFjv4= wG6ey1727HIj10Wh+OD/s8kuOjo= YdRpQ6mNNA/rw8PqzTxP08VgNnY= W9oZv0BM5z4XAggQPbNAKIM7/ro= GNlqbV0MSxGIA/gSjlOb2rfSHhU= suU4/MiRITTTYf61BFw2aI6WxdI= yLMNPjiW4s31xcLN4xOiqVySYLA= xDk467Vs74WMTJdzZiv8izTuGQo= IcodRek43l5Zc13Z67L74PlhG0U= oYwrnXcglhO4tlvhkxLGfFCYbAk= yzkq+uCmbTlXrfDuyd1fT0Zu6xw= 5M2smbXDaSa2d/li//A+GmlDgDU= aA1Q9NAW4/TnG3SXhe4k1mNB5nk= gadV3YsYDjlGX+64Rtiz4S+QD4A= ZiWsQaQCAif94KdP6GXH9+F5GmM= 9JACnsebk8tFsoryabfDxE8VpnA= 5V5uOhRsy00O+TSEAkIb7uFoN2U= SLiWca6gUGmTh+r/BbU40NrICW8= iwSH2fvVkb89TkZj7KWLGSyc4sA= i/v5Vfq44OnlLbuKgQ2KvgWgZqo= ICcovOIyqnxhSMU6MuEekYg2z+E= F0RYzLwUP8ied6l3zmKvomgFHag= KL8F3KYxyzpC1e6fqoJy3B8IHhw= CvoRh2IpWg4QixngVwDjSKoeQVY= 55Yh68uToEiKy+IDTpyctuK/T3g= AhPhrC4hmBsZgd/ztqbkAuOkbBM= Nv9Emy6spILLI/mqyIz2uRNBJhU= eh5BeHbLjL3BuEY7ao3tbEAZnTw= ZdlRIJ+RVbaF05I+w1pfQzUA0/0= +ZB55yb2DeVYG+/eYqlMcGcedVE= Q5NVO+d/+BmZ5v3/ogNb2XpUTKs= cRPG1npIXmfYC0K+C+idxOqIc04= OlWcRIIUl1cq5Ab9fLXGPyhYCfI= lctXu8FITJWg0+Y+yZVt5iv7QDM= 4epyMikskiBx2Gu+S87oAhrM/ZY= 43fxogaC5oVqfauhwXyN4s4ibEM= uM37WpBqetqzfHjns3M8/+CcoEU= txoybJuonJpAdGVWgiAsiI45+ok= b5EwiMBFGrk0/BIGaiumuCVSoFM= /oa6wZJEG852J9Yi1LQlnq1n1tM= S9yd7MVhXxF+598Xy2/+jwnCZzc= rN6p9/aLARL9S9gn02k+M+j21q8= 0JOtXYOmKvCl2dNIZYV6J7flgJE= QnJpEPJCfRKAJAc/hcKWdTwH9qM= aSDB3babl7TsiU0T+gdHMM/NC5c= identifier 2+L1/+BrjUzoccWPIYkGu108y1I= params_encoded_base 2+L1/+BrjUzoccWPIYkGu108y1I= identifier paRP7A1SOQlKcnfXhxL4FgbVXKs= params_base paRP7A1SOQlKcnfXhxL4FgbVXKs= identifier UEVNhDEjkZMXfjN1DxbtX0n2rCg= url_view_base UEVNhDEjkZMXfjN1DxbtX0n2rCg= specialization hash identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std url_view boost/url/url_view.hpp include/boost/url/url_view.hpp 153 5 1 boost/url/url_view.hpp include/boost/url/url_view.hpp 205 5 1 overloads wg5mELA0xi9IYzWSOSuNwa4P1aw= regular wh3UbUToX9YDmRmnpcoM9EUEZo8= brief text Constructors param text The other view. other param text The string to parse. s throws text The input failed to parse correctly. reference system_error see reference parse_uri_reference 7d2b1xVBWJPgL/+PWFdoBaZJvMA= text . see reference parse_uri_reference 7d2b1xVBWJPgL/+PWFdoBaZJvMA= text . constructor y8C4V/JzeMyHgT6jXQyeDSDijOU= JLiDiNu2uu3W88aG1eQAtkdHqE4= gbM2u5DEximvrgg1xBuPV2jv5EI= JVsJtXdASd9pFyR6uj0leyapNx0= o5hoWO59ZGzDtMtMdE6TmCsd4Xs= BD2KyU57eYn46VC5vsT4glQD8rc= identifier void url_view boost/url/url_view.hpp include/boost/url/url_view.hpp 153 5 1 function y8C4V/JzeMyHgT6jXQyeDSDijOU= regular wh3UbUToX9YDmRmnpcoM9EUEZo8= paragraph text Default constructed views refer to a string with zero length, which always remains valid. This matches the grammar for a relative-ref with an empty path and no query or fragment. heading text Example 1 code url_view u; heading text Postconditions 1 code this->empty() == true heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code relative-ref = relative-part [ "?" query ] [ "#" fragment ] heading text Specification 1 brief text Constructor identifier void constructor 1 1 1 url_view boost/url/url_view.hpp include/boost/url/url_view.hpp 249 5 1 function JLiDiNu2uu3W88aG1eQAtkdHqE4= regular wh3UbUToX9YDmRmnpcoM9EUEZo8= paragraph text After construction, both views reference the same underlying character buffer. Ownership is not transferred. heading text Postconditions 1 code this->buffer().data() == other.buffer().data() heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Constructor param text The other view. other identifier void 1 identifier wh3UbUToX9YDmRmnpcoM9EUEZo8= url_view other constructor 1 1 1 url_view boost/url/url_view.hpp include/boost/url/url_view.hpp 255 5 1 function gbM2u5DEximvrgg1xBuPV2jv5EI= regular wh3UbUToX9YDmRmnpcoM9EUEZo8= brief text Move constructor param text The object to move construct from other identifier void identifier wh3UbUToX9YDmRmnpcoM9EUEZo8= url_view other constructor 1 1 1 url_view boost/url/url_view.hpp include/boost/url/url_view.hpp 205 5 1 function JVsJtXdASd9pFyR6uj0leyapNx0= regular wh3UbUToX9YDmRmnpcoM9EUEZo8= paragraph text This function constructs a URL from the string code text s text , which must contain a valid emph text URI text or emph text relative-ref text or else an exception is thrown. Upon successful construction, the view refers to the characters in the buffer pointed to by code text s text . Ownership is not transferred; The caller is responsible for ensuring that the lifetime of the buffer extends until it is no longer referenced. heading text Example 1 code url_view u( "http://www.example.com/index.htm" ); heading text Effects 1 code return parse_uri_reference( s ).value(); heading text Complexity 1 paragraph text Linear in code text s.size() text . heading text Exception Safety 1 paragraph text Exceptions thrown on invalid input. heading text BNF 1 code URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] relative-ref = relative-part [ "?" query ] [ "#" fragment ] heading text Specification 1 list paragraph link text 4.1. URI Reference https://datatracker.ietf.org/doc/html/rfc3986#section-4.1 unordered brief text Constructor param text The string to parse. s throws text The input failed to parse correctly. reference system_error see reference parse_uri_reference 7d2b1xVBWJPgL/+PWFdoBaZJvMA= text . identifier void identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s constructor 1 url_view boost/url/url_view.hpp include/boost/url/url_view.hpp 278 5 1 function o5hoWO59ZGzDtMtMdE6TmCsd4Xs= regular wh3UbUToX9YDmRmnpcoM9EUEZo8= paragraph text After construction, both views reference the same underlying character buffer. Ownership is not transferred. heading text Postconditions 1 code this->buffer().data() == other.buffer().data() heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Constructor param text The other view. other identifier void 1 identifier UEVNhDEjkZMXfjN1DxbtX0n2rCg= url_view_base other constructor 1 url_view boost/url/url_view.hpp include/boost/url/url_view.hpp 208 5 1 function BD2KyU57eYn46VC5vsT4glQD8rc= regular wh3UbUToX9YDmRmnpcoM9EUEZo8= paragraph text This function constructs a URL from the string code text s text , which must contain a valid emph text URI text or emph text relative-ref text or else an exception is thrown. Upon successful construction, the view refers to the characters in the buffer pointed to by code text s text . Ownership is not transferred; The caller is responsible for ensuring that the lifetime of the buffer extends until it is no longer referenced. heading text Example 1 code url_view u( "http://www.example.com/index.htm" ); heading text Effects 1 code return parse_uri_reference( s ).value(); heading text Complexity 1 paragraph text Linear in code text s.size() text . heading text Exception Safety 1 paragraph text Exceptions thrown on invalid input. heading text BNF 1 code URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] relative-ref = relative-part [ "?" query ] [ "#" fragment ] heading text Specification 1 list paragraph link text 4.1. URI Reference https://datatracker.ietf.org/doc/html/rfc3986#section-4.1 unordered brief text Constructor url_view(core::string_view) param text The string to parse. s see reference parse_uri_reference 7d2b1xVBWJPgL/+PWFdoBaZJvMA= text . identifier void 1 identifier String s constructor 1 ~url_view boost/url/url_view.hpp include/boost/url/url_view.hpp 117 5 1 function C2Z06VYQtT0f7SfP2ilcaOdS/FY= regular wh3UbUToX9YDmRmnpcoM9EUEZo8= paragraph text Any params, segments, iterators, or other views which reference the same underlying character buffer remain valid. brief text Destructor identifier void destructor 1 1 1 operator= boost/url/url_view.hpp include/boost/url/url_view.hpp 306 5 1 overloads EF2Xp7R+V9zgbWT05m2yVZ5cl7k= regular wh3UbUToX9YDmRmnpcoM9EUEZo8= brief text Assignment returns text A reference to this object. param text The other view. other normal Leg4hLDDg+v+m5FMUnCxCsdZbHI= /oYGu868uZxWMr7bWnu4SUbic7M= identifier wh3UbUToX9YDmRmnpcoM9EUEZo8= url_view operator= boost/url/url_view.hpp include/boost/url/url_view.hpp 306 5 1 function Leg4hLDDg+v+m5FMUnCxCsdZbHI= regular wh3UbUToX9YDmRmnpcoM9EUEZo8= paragraph text After assignment, both views reference the same underlying character buffer. Ownership is not transferred. heading text Postconditions 1 code this->buffer().data() == other.buffer().data() heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Assignment returns text A reference to this object. param text The other view. other identifier wh3UbUToX9YDmRmnpcoM9EUEZo8= url_view 1 identifier wh3UbUToX9YDmRmnpcoM9EUEZo8= url_view other normal 1 operator= boost/url/url_view.hpp include/boost/url/url_view.hpp 336 5 1 function /oYGu868uZxWMr7bWnu4SUbic7M= regular wh3UbUToX9YDmRmnpcoM9EUEZo8= paragraph text After assignment, both views reference the same underlying character buffer. Ownership is not transferred. heading text Postconditions 1 code this->buffer().data() == other.buffer().data() heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Assignment returns text A reference to this object. param text The other view. other identifier wh3UbUToX9YDmRmnpcoM9EUEZo8= url_view 1 identifier UEVNhDEjkZMXfjN1DxbtX0n2rCg= url_view_base other normal 1 authority boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 564 5 1 function v5/R9LI0iKJDiBrNUt7k8qrVBdM= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the authority as an reference authority_view d/hMlyyC3Ave6L9McUD7B4TwENA= text . heading text Example 1 code authority_view a = url_view( "https://www.example.com:8080/index.htm" ).authority(); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code authority = [ userinfo "@" ] host [ ":" port ] heading text Specification 1 list paragraph link text 3.2. Authority (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2 unordered brief text Return the authority returns text An authority_view representing the authority. see reference encoded_authority Ww04vLA2k7BwctuyNeP3KwoNr4M= text , reference has_authority gadV3YsYDjlGX+64Rtiz4S+QD4A= text . identifier d/hMlyyC3Ave6L9McUD7B4TwENA= authority_view normal 1 1 buffer boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 282 5 1 function oDNnPxjP34HYhoUyyduWMZfqZs4= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the entire url, which may contain percent escapes. heading text Example 1 code assert( url_view( "http://www.example.com" ).buffer() == "http://www.example.com" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the url string returns text The url as a string. identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core normal 1 1 compare boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2446 5 1 function p+2L2asXUGpE7eey1ouRvFXKD1g= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function compares two URLs according to Syntax-Based comparison algorithm. heading text Complexity 1 paragraph text Linear in code text min( u0.size(), u1.size() ) heading text Exception Safety 1 paragraph text Throws nothing. heading text Specification 1 list paragraph link text 6.2.2 Syntax-Based Normalization (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-6.2.2 unordered brief text Return the result of comparing this with another url returns text -1 if code text *this < other text , 0 if code text this == other text , and 1 if code text this > other text . param text The url to compare other identifier int 1 identifier UEVNhDEjkZMXfjN1DxbtX0n2rCg= url_view_base other normal 1 1 data boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 258 5 1 function I2WjK21z+iS45kbL4TnzA8O5oE0= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns a pointer to the first character of the url, which is not guaranteed to be null-terminated. heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return a pointer to the url's character buffer returns text A pointer to the first character. 1 identifier char normal 1 1 empty boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 238 5 1 function 5yR7btLz2K+NLHFnzfXMyGsq2fo= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text The empty string matches the emph text relative-ref text grammar. heading text Example 1 code assert( url_view( "" ).empty() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code relative-ref = relative-part [ "?" query ] [ "#" fragment ] relative-part = "//" authority path-abempty / path-absolute / path-noscheme / path-empty heading text Specification 1 list paragraph link text 4.2. Relative Reference (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-4.2 unordered brief text Return true if the url is empty returns code text true text if the url is empty. identifier bool normal 1 1 encoded_authority boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 601 5 1 function Ww04vLA2k7BwctuyNeP3KwoNr4M= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If present, this function returns a string representing the authority (which may be empty). Otherwise it returns an empty string. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "file://Network%20Drive/My%2DFiles" ).encoded_authority() == "Network%20Drive" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code authority = [ userinfo "@" ] host [ ":" port ] heading text Specification 1 list paragraph link text 3.2. Authority (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2 unordered brief text Return the authority. returns text The authority as a string. see reference authority v5/R9LI0iKJDiBrNUt7k8qrVBdM= text , reference has_authority gadV3YsYDjlGX+64Rtiz4S+QD4A= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_fragment boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2280 5 1 function M7+OzewsxChMvecRSytXqTCqKrY= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the fragment as a string with percent-escapes. Ownership is not transferred; the string returned references the underlying character buffer, which must remain valid or else undefined behavior occurs. heading text Example 1 code assert( url_view( "http://www.example.com/index.htm#a%2D1" ).encoded_fragment() == "a%2D1" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code fragment = *( pchar / "/" / "?" ) pchar = unreserved / pct-encoded / sub-delims / ":" / "@" heading text Specification 1 list paragraph link text 3.5. Fragment (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.5 unordered brief text Return the fragment returns text The fragment portion of the url. see reference fragment aA1Q9NAW4/TnG3SXhe4k1mNB5nk= text , reference has_fragment ZiWsQaQCAif94KdP6GXH9+F5GmM= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_host boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1120 5 1 function EcGxt+esOtVfjloInubXUYLy5GY= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the host portion of the authority as a string, or the empty string if there is no authority. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "https://www%2droot.example.com/" ).encoded_host() == "www%2droot.example.com" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPvFuture ) "]" reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host returns text The host address as a string. identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_host_address boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1237 5 1 function yXsUZRbi+wInLqaUUVy9b7nIIBo= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text The value returned by this function depends on the type of host returned from the function reference host_type Nv9Emy6spILLI/mqyIz2uRNBJhU= text . list paragraph text If the type is reference host_type::ipv4 49F64dAiji9HVbP6MxLQiqot7AY= text , then the IPv4 address string is returned. paragraph text If the type is reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= text , then the IPv6 address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::ipvfuture TcYJaTwDFsx+0S2CkvHHARcCqWc= text , then the IPvFuture address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= text , then the host name string is returned. Any percent-escapes in the string are decoded first. paragraph text If the type is reference host_type::none QyoMTu07h232/Sxqovu2mGoPgTo= text , then an empty string is returned. The returned string may contain percent escapes. unordered heading text Example 1 code assert( url_view( "https://www%2droot.example.com/" ).encoded_host_address() == "www%2droot.example.com" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPvFuture ) "]" reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host returns text The host address as a string. identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_host_and_port boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2325 5 1 function 9ptIMbwWSNtVv+KAUpHCO3bmTWg= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If an authority is present, this function returns the host and optional port as a string, which may be empty. Otherwise it returns an empty string. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "http://www.example.com:8080/index.htm" ).encoded_host_and_port() == "www.example.com:8080" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code authority = [ userinfo "@" ] host [ ":" port ] heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 paragraph link text 3.2.3. Port (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.3 unordered brief text Return the host and port returns text The host and port portion of the url. see reference has_port 5V5uOhRsy00O+TSEAkIb7uFoN2U= text , reference port OlWcRIIUl1cq5Ab9fLXGPyhYCfI= text , reference port_number lctXu8FITJWg0+Y+yZVt5iv7QDM= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_host_name boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1441 5 1 function 4URKnuP+gvIUVjIkywv/pXeFjv4= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If the host type is reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= text , this function returns the name as a string. Otherwise, if the host type is not an name, it returns an empty string. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "https://www%2droot.example.com/" ).encoded_host_name() == "www%2droot.example.com" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPvFuture ) "]" reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host name returns text The host name as a percent-encoded string. identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_origin boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2355 5 1 function wG6ey1727HIj10Wh+OD/s8kuOjo= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If an authority is present, this function returns the scheme and authority portion of the url. Otherwise, an empty string is returned. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "http://www.example.com:8080/index.htm?text=none#h1" ).encoded_origin() == "http://www.example.com:8080" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the origin returns text The origin portion of the url. see reference encoded_resource yLMNPjiW4s31xcLN4xOiqVySYLA= text , reference encoded_target IcodRek43l5Zc13Z67L74PlhG0U= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_params boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2130 5 1 function YdRpQ6mNNA/rw8PqzTxP08VgNnY= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns a bidirectional view of key/value pairs over the query. The returned view references the same underlying character buffer; ownership is not transferred. Strings returned when iterating the range may contain percent escapes. heading text Example 1 code params_encoded_view pv = url_view( "/sql?id=42&name=jane%2Ddoe&page+size=20" ).encoded_params(); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Return the query as a container of parameters returns text A bidirectional view of key/value pairs. see reference encoded_query suU4/MiRITTTYf61BFw2aI6WxdI= text , reference has_query SLiWca6gUGmTh+r/BbU40NrICW8= text , reference params ZdlRIJ+RVbaF05I+w1pfQzUA0/0= text , reference query 4epyMikskiBx2Gu+S87oAhrM/ZY= text . identifier 0nSfM4mK92fIx58KtzdWGiHuq2w= params_encoded_view normal 1 1 encoded_password boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 996 5 1 function W9oZv0BM5z4XAggQPbNAKIM7/ro= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the password portion of the userinfo as a percent-encoded string. heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).encoded_password() == "pass" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code userinfo = user [ ":" [ password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return the password returns text The password as a string. see reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text , reference has_userinfo i/v5Vfq44OnlLbuKgQ2KvgWgZqo= text , reference encoded_user oYwrnXcglhO4tlvhkxLGfFCYbAk= text , reference encoded_userinfo yzkq+uCmbTlXrfDuyd1fT0Zu6xw= text , reference password +ZB55yb2DeVYG+/eYqlMcGcedVE= text , reference user /oa6wZJEG852J9Yi1LQlnq1n1tM= text , reference userinfo S9yd7MVhXxF+598Xy2/+jwnCZzc= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_path boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1799 5 1 function GNlqbV0MSxGIA/gSjlOb2rfSHhU= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the path as a string. The path may be empty. Any percent-escapes in the string are decoded first. heading text Example 1 code assert( url_view( "file:///Program%20Files/Games/config.ini" ).encoded_path() == "/Program%20Files/Games/config.ini" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code path = path-abempty ; begins with "/" or is empty / path-absolute ; begins with "/" but not "//" / path-noscheme ; begins with a non-colon segment / path-rootless ; begins with a segment / path-empty ; zero characters path-abempty = *( "/" segment ) path-absolute = "/" [ segment-nz *( "/" segment ) ] path-noscheme = segment-nz-nc *( "/" segment ) path-rootless = segment-nz *( "/" segment ) path-empty = 0<pchar> heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text Return the path returns text The path as a string. see reference is_path_absolute eh5BeHbLjL3BuEY7ao3tbEAZnTw= text , reference encoded_segments xDk467Vs74WMTJdzZiv8izTuGQo= text . reference path Q5NVO+d/+BmZ5v3/ogNb2XpUTKs= text , reference segments txoybJuonJpAdGVWgiAsiI45+ok= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_query boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2040 5 1 function suU4/MiRITTTYf61BFw2aI6WxdI= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If this contains a query, it is returned as a string (which may be empty). Otherwise, an empty string is returned. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "/sql?id=42&name=jane%2Ddoe&page+size=20" ).encoded_query() == "id=42&name=jane%2Ddoe&page+size=20" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Return the query returns text The query as a string. see reference encoded_params YdRpQ6mNNA/rw8PqzTxP08VgNnY= text , reference has_query SLiWca6gUGmTh+r/BbU40NrICW8= text , reference params ZdlRIJ+RVbaF05I+w1pfQzUA0/0= text , reference query 4epyMikskiBx2Gu+S87oAhrM/ZY= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_resource boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2387 5 1 function yLMNPjiW4s31xcLN4xOiqVySYLA= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the resource, which is the portion of the url that includes only the path, query, and fragment. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "http://www.example.com/index.html?query#frag" ).encoded_resource() == "/index.html?query#frag" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 unordered brief text Return the resource returns text The resource portion of the url. see reference encoded_origin wG6ey1727HIj10Wh+OD/s8kuOjo= text , reference encoded_target IcodRek43l5Zc13Z67L74PlhG0U= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_segments boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1891 5 1 function xDk467Vs74WMTJdzZiv8izTuGQo= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns a bidirectional view of strings over the path. The returned view references the same underlying character buffer; ownership is not transferred. Strings returned when iterating the range may contain percent escapes. heading text Example 1 code segments_encoded_view sv = url_view( "/path/to/file.txt" ).encoded_segments(); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code path = path-abempty ; begins with "/" or is empty / path-absolute ; begins with "/" but not "//" / path-noscheme ; begins with a non-colon segment / path-rootless ; begins with a segment / path-empty ; zero characters path-abempty = *( "/" segment ) path-absolute = "/" [ segment-nz *( "/" segment ) ] path-noscheme = segment-nz-nc *( "/" segment ) path-rootless = segment-nz *( "/" segment ) path-empty = 0<pchar> heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text Return the path as a container of segments returns text A bidirectional view of encoded segments. see reference is_path_absolute eh5BeHbLjL3BuEY7ao3tbEAZnTw= text , reference encoded_path GNlqbV0MSxGIA/gSjlOb2rfSHhU= text , reference path Q5NVO+d/+BmZ5v3/ogNb2XpUTKs= text , reference segments txoybJuonJpAdGVWgiAsiI45+ok= text , reference segments_encoded_view EvaX3SmNTAtai2Kf6Kma3fUkTkQ= text . identifier EvaX3SmNTAtai2Kf6Kma3fUkTkQ= segments_encoded_view normal 1 1 encoded_target boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2419 5 1 function IcodRek43l5Zc13Z67L74PlhG0U= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the target, which is the portion of the url that includes only the path and query. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "http://www.example.com/index.html?query#frag" ).encoded_target() == "/index.html?query" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 unordered brief text Return the target returns text The target portion of the url. see reference encoded_origin wG6ey1727HIj10Wh+OD/s8kuOjo= text , reference encoded_resource yLMNPjiW4s31xcLN4xOiqVySYLA= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_user boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 901 5 1 function oYwrnXcglhO4tlvhkxLGfFCYbAk= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If present, this function returns a string representing the user (which may be empty). Otherwise it returns an empty string. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).encoded_user() == "jane%2Ddoe" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code userinfo = user [ ":" [ password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return the user returns text The user as a string. see reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text , reference has_userinfo i/v5Vfq44OnlLbuKgQ2KvgWgZqo= text , reference encoded_password W9oZv0BM5z4XAggQPbNAKIM7/ro= text , reference encoded_userinfo yzkq+uCmbTlXrfDuyd1fT0Zu6xw= text , reference password +ZB55yb2DeVYG+/eYqlMcGcedVE= text , reference user /oa6wZJEG852J9Yi1LQlnq1n1tM= text , reference userinfo S9yd7MVhXxF+598Xy2/+jwnCZzc= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_userinfo boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 800 5 1 function yzkq+uCmbTlXrfDuyd1fT0Zu6xw= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If present, this function returns a string representing the userinfo (which may be empty). Otherwise it returns an empty string. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).encoded_userinfo() == "jane%2Ddoe:pass" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing heading text BNF 1 code userinfo = user [ ":" [ password ] ] authority = [ userinfo "@" ] host [ ":" port ] heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return the userinfo returns text The userinfo as a string. see reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text , reference has_userinfo i/v5Vfq44OnlLbuKgQ2KvgWgZqo= text , reference encoded_password W9oZv0BM5z4XAggQPbNAKIM7/ro= text , reference encoded_user oYwrnXcglhO4tlvhkxLGfFCYbAk= text , reference password +ZB55yb2DeVYG+/eYqlMcGcedVE= text , reference user /oa6wZJEG852J9Yi1LQlnq1n1tM= text , reference userinfo S9yd7MVhXxF+598Xy2/+jwnCZzc= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_zone_id boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1526 5 1 function 5M2smbXDaSa2d/li//A+GmlDgDU= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If the host type is reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= text , this function returns the Zone ID as a string. Otherwise an empty string is returned. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "http://[fe80::1%25eth0]/" ).encoded_zone_id() == "eth0" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPv6addrz / IPvFuture ) "]" ZoneID = 1*( unreserved / pct-encoded ) IPv6addrz = IPv6address "%25" ZoneID heading text Specification 1 list paragraph link text Representing IPv6 Zone Identifiers in Address Literals and Uniform Resource Identifiers https://datatracker.ietf.org/doc/html/rfc6874 unordered brief text Return the IPv6 Zone ID returns text The Zone ID as a percent-encoded string. identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 fragment boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2233 5 1 function aA1Q9NAW4/TnG3SXhe4k1mNB5nk= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function calculates the fragment of the url, with percent escapes decoded and without the leading pound sign ('#') whose presence indicates that the url contains a fragment. paragraph text This function accepts an optional emph text StringToken text parameter which controls the return type and behavior of the function: list paragraph text When called with no arguments, the return type of the function is code text std::string text . Otherwise paragraph text When called with a string token, the behavior and return type of the function depends on the type of string token being passed. unordered heading text Example 1 code assert( url_view( "http://www.example.com/index.htm#a%2D1" ).fragment() == "a-1" ); heading text Complexity 1 paragraph text Linear in code text this->fragment().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. String tokens may throw exceptions. heading text BNF 1 code fragment = *( pchar / "/" / "?" ) fragment-part = [ "#" fragment ] heading text Specification 1 list paragraph link text 3.5. Fragment (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.5 unordered brief text Return the fragment returns text The fragment portion of the url. param text An optional string token to use. If this parameter is omitted, the function returns a new code text std::string text . token see reference encoded_fragment M7+OzewsxChMvecRSytXqTCqKrY= text , reference has_fragment ZiWsQaQCAif94KdP6GXH9+F5GmM= text . identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 has_authority boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 528 5 1 function gadV3YsYDjlGX+64Rtiz4S+QD4A= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns true if the url contains an authority. The presence of an authority is denoted by a double slash ("//") at the beginning or after the scheme. heading text Example 1 code assert( url_view( "http://www.example.com/index.htm" ).has_authority() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code authority = [ userinfo "@" ] host [ ":" port ] URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] absolute-URI = scheme ":" hier-part [ "?" query ] URI-reference = URI / relative-ref relative-ref = relative-part [ "?" query ] [ "#" fragment ] hier-part = "//" authority path-abempty ; (more...) relative-part = "//" authority path-abempty ; (more...) heading text Specification 1 list paragraph link text 3.2. Authority (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2 unordered brief text Return true if an authority is present returns code text true text if the url contains an authority. see reference authority v5/R9LI0iKJDiBrNUt7k8qrVBdM= text , reference encoded_authority Ww04vLA2k7BwctuyNeP3KwoNr4M= text . identifier bool normal 1 1 has_fragment boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2173 5 1 function ZiWsQaQCAif94KdP6GXH9+F5GmM= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns true if the url contains a fragment. An empty fragment is distinct from no fragment. heading text Example 1 code assert( url_view( "http://www.example.com/index.htm#anchor" ).has_fragment() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] relative-ref = relative-part [ "?" query ] [ "#" fragment ] heading text Specification 1 list paragraph link text 3.5. Fragment (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.5 unordered brief text Return true if a fragment is present returns code text true text if the url contains a fragment. see reference encoded_fragment M7+OzewsxChMvecRSytXqTCqKrY= text , reference fragment aA1Q9NAW4/TnG3SXhe4k1mNB5nk= text . identifier bool normal 1 1 has_password boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 689 5 1 function 9JACnsebk8tFsoryabfDxE8VpnA= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns true if the userinfo is present and contains a password. heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).has_password() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code userinfo = user [ ":" [ password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return true if a password is present returns code text true text if the userinfo contains a password. see reference has_userinfo i/v5Vfq44OnlLbuKgQ2KvgWgZqo= text , reference encoded_password W9oZv0BM5z4XAggQPbNAKIM7/ro= text , reference encoded_user oYwrnXcglhO4tlvhkxLGfFCYbAk= text , reference encoded_userinfo yzkq+uCmbTlXrfDuyd1fT0Zu6xw= text , reference password +ZB55yb2DeVYG+/eYqlMcGcedVE= text , reference user /oa6wZJEG852J9Yi1LQlnq1n1tM= text , reference userinfo S9yd7MVhXxF+598Xy2/+jwnCZzc= text . identifier bool normal 1 1 has_port boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1568 5 1 function 5V5uOhRsy00O+TSEAkIb7uFoN2U= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns true if an authority is present and contains a port. heading text Example 1 code assert( url_view( "wss://www.example.com:443" ).has_port() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code authority = [ userinfo "@" ] host [ ":" port ] port = *DIGIT heading text Specification 1 list paragraph link text 3.2.3. Port (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.3 unordered brief text Return true if a port is present returns code text true text if a port is present, code text false text otherwise. see reference encoded_host_and_port 9ptIMbwWSNtVv+KAUpHCO3bmTWg= text , reference port OlWcRIIUl1cq5Ab9fLXGPyhYCfI= text , reference port_number lctXu8FITJWg0+Y+yZVt5iv7QDM= text . identifier bool normal 1 1 has_query boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1937 5 1 function SLiWca6gUGmTh+r/BbU40NrICW8= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns true if this contains a query. An empty query is distinct from having no query. heading text Example 1 code assert( url_view( "/sql?id=42&col=name&page-size=20" ).has_query() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Return true if a query is present returns code text true text if a query is present. see reference encoded_params YdRpQ6mNNA/rw8PqzTxP08VgNnY= text , reference encoded_query suU4/MiRITTTYf61BFw2aI6WxdI= text , reference params ZdlRIJ+RVbaF05I+w1pfQzUA0/0= text , reference query 4epyMikskiBx2Gu+S87oAhrM/ZY= text . identifier bool normal 1 1 has_scheme boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 384 5 1 function iwSH2fvVkb89TkZj7KWLGSyc4sA= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns true if this contains a scheme. heading text Example 1 code assert( url_view( "http://www.example.com" ).has_scheme() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] absolute-URI = scheme ":" hier-part [ "?" query ] scheme = ALPHA *( ALPHA / DIGIT / "+" / "-" / "." ) heading text Specification 1 list paragraph link text 3.1. Scheme (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.1 unordered brief text Return true a scheme is present returns code text true text if the url contains a scheme. see reference scheme 43fxogaC5oVqfauhwXyN4s4ibEM= text , reference scheme_id uM37WpBqetqzfHjns3M8/+CcoEU= text . identifier bool normal 1 1 has_userinfo boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 647 5 1 function i/v5Vfq44OnlLbuKgQ2KvgWgZqo= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns true if this contains a userinfo. heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).has_userinfo() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code userinfo = user [ ":" [ password ] ] authority = [ userinfo "@" ] host [ ":" port ] heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return true if a userinfo is present returns code text true text if the userinfo is present. see reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text , reference encoded_password W9oZv0BM5z4XAggQPbNAKIM7/ro= text , reference encoded_user oYwrnXcglhO4tlvhkxLGfFCYbAk= text , reference encoded_userinfo yzkq+uCmbTlXrfDuyd1fT0Zu6xw= text , reference password +ZB55yb2DeVYG+/eYqlMcGcedVE= text , reference user /oa6wZJEG852J9Yi1LQlnq1n1tM= text , reference userinfo S9yd7MVhXxF+598Xy2/+jwnCZzc= text . identifier bool normal 1 1 host boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1076 5 1 function ICcovOIyqnxhSMU6MuEekYg2z+E= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the host portion of the authority as a string, or the empty string if there is no authority. Any percent-escapes in the string are decoded first. heading text Example 1 code assert( url_view( "https://www%2droot.example.com/" ).host() == "www-root.example.com" ); heading text Complexity 1 paragraph text Linear in code text this->host().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPvFuture ) "]" reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host returns text The host address as a string. param text A string token customization token identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 host_address boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1174 5 1 function F0RYzLwUP8ied6l3zmKvomgFHag= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text The value returned by this function depends on the type of host returned from the function reference host_type Nv9Emy6spILLI/mqyIz2uRNBJhU= text . list paragraph text If the type is reference host_type::ipv4 49F64dAiji9HVbP6MxLQiqot7AY= text , then the IPv4 address string is returned. paragraph text If the type is reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= text , then the IPv6 address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::ipvfuture TcYJaTwDFsx+0S2CkvHHARcCqWc= text , then the IPvFuture address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= text , then the host name string is returned. Any percent-escapes in the string are decoded first. paragraph text If the type is reference host_type::none QyoMTu07h232/Sxqovu2mGoPgTo= text , then an empty string is returned. unordered heading text Example 1 code assert( url_view( "https://[1::6:c0a8:1]/" ).host_address() == "1::6:c0a8:1" ); heading text Complexity 1 paragraph text Linear in code text this->host_address().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPvFuture ) "]" reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host returns text The host address as a string. param text A string token customization token identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 host_ipv4_address boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1277 5 1 function KL8F3KYxyzpC1e6fqoJy3B8IHhw= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If the host type is reference host_type::ipv4 49F64dAiji9HVbP6MxLQiqot7AY= text , this function returns the address as a value of type reference ipv4_address /Wpp3ZZDp3kUHzbULeDoaOEhnVs= text . Otherwise, if the host type is not an IPv4 address, it returns a default-constructed value which is equal to the unspecified address "0.0.0.0". heading text Example 1 code assert( url_view( "http://127.0.0.1/index.htm?user=win95" ).host_ipv4_address() == ipv4_address( "127.0.0.1" ) ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code IPv4address = dec-octet "." dec-octet "." dec-octet "." dec-octet dec-octet = DIGIT ; 0-9 / %x31-39 DIGIT ; 10-99 / "1" 2DIGIT ; 100-199 / "2" %x30-34 DIGIT ; 200-249 / "25" %x30-35 ; 250-255 heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host IPv4 address returns text The IPv4 address as a value of type reference ipv4_address /Wpp3ZZDp3kUHzbULeDoaOEhnVs= text . identifier /Wpp3ZZDp3kUHzbULeDoaOEhnVs= ipv4_address normal 1 1 host_ipv6_address boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1325 5 1 function CvoRh2IpWg4QixngVwDjSKoeQVY= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If the host type is reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= text , this function returns the address as a value of type reference ipv6_address dhMSRVBIIIItY0URHSc8rwHcdTQ= text . Otherwise, if the host type is not an IPv6 address, it returns a default-constructed value which is equal to the unspecified address "0:0:0:0:0:0:0:0". heading text Example 1 code assert( url_view( "ftp://[::1]/" ).host_ipv6_address() == ipv6_address( "::1" ) ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code IPv6address = 6( h16 ":" ) ls32 / "::" 5( h16 ":" ) ls32 / [ h16 ] "::" 4( h16 ":" ) ls32 / [ *1( h16 ":" ) h16 ] "::" 3( h16 ":" ) ls32 / [ *2( h16 ":" ) h16 ] "::" 2( h16 ":" ) ls32 / [ *3( h16 ":" ) h16 ] "::" h16 ":" ls32 / [ *4( h16 ":" ) h16 ] "::" ls32 / [ *5( h16 ":" ) h16 ] "::" h16 / [ *6( h16 ":" ) h16 ] "::" ls32 = ( h16 ":" h16 ) / IPv4address ; least-significant 32 bits of address h16 = 1*4HEXDIG ; 16 bits of address represented in hexadecimal heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host IPv6 address returns text The IPv6 address as a value of type reference ipv6_address dhMSRVBIIIItY0URHSc8rwHcdTQ= text . identifier dhMSRVBIIIItY0URHSc8rwHcdTQ= ipv6_address normal 1 1 host_ipvfuture boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1358 5 1 function 55Yh68uToEiKy+IDTpyctuK/T3g= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If the host type is reference host_type::ipvfuture TcYJaTwDFsx+0S2CkvHHARcCqWc= text , this function returns the address as a string. Otherwise, if the host type is not an IPvFuture address, it returns an empty string. heading text Example 1 code assert( url_view( "http://[v1fe.d:9]/index.htm" ).host_ipvfuture() == "v1fe.d:9" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code IPvFuture = "v" 1*HEXDIG "." 1*( unreserved / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host IPvFuture address returns text The IPvFuture address as a string. identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core normal 1 1 host_name boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1395 5 1 function AhPhrC4hmBsZgd/ztqbkAuOkbBM= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If the host type is reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= text , this function returns the name as a string. Otherwise an empty string is returned. Any percent-escapes in the string are decoded first. heading text Example 1 code assert( url_view( "https://www%2droot.example.com/" ).host_name() == "www-root.example.com" ); heading text Complexity 1 paragraph text Linear in code text this->host_name().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPvFuture ) "]" reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host name returns text The host name as a string. param text A string token customization. token identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 host_type boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1036 5 1 function Nv9Emy6spILLI/mqyIz2uRNBJhU= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns one of the following constants representing the type of host present. list paragraph reference host_type::ipv4 49F64dAiji9HVbP6MxLQiqot7AY= paragraph reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= paragraph reference host_type::ipvfuture TcYJaTwDFsx+0S2CkvHHARcCqWc= paragraph reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= paragraph reference host_type::none QyoMTu07h232/Sxqovu2mGoPgTo= unordered paragraph text When reference has_authority gadV3YsYDjlGX+64Rtiz4S+QD4A= text is false, the host type is reference host_type::none QyoMTu07h232/Sxqovu2mGoPgTo= text . heading text Example 1 code assert( url_view( "https://192.168.0.1/local.htm" ).host_type() == host_type::ipv4 ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host type returns text The type of host present. identifier YLHFVyAYZGSFQe18DPGjn6XsAMs= host_type identifier dnk5XPfR2OaMpCYaH3cWSxcTdyc= urls normal 1 1 is_path_absolute boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1691 5 1 function eh5BeHbLjL3BuEY7ao3tbEAZnTw= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns true if the path begins with a forward slash ('/'). heading text Example 1 code assert( url_view( "/path/to/file.txt" ).is_path_absolute() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code path = path-abempty ; begins with "/" or is empty / path-absolute ; begins with "/" but not "//" / path-noscheme ; begins with a non-colon segment / path-rootless ; begins with a segment / path-empty ; zero characters path-abempty = *( "/" segment ) path-absolute = "/" [ segment-nz *( "/" segment ) ] path-noscheme = segment-nz-nc *( "/" segment ) path-rootless = segment-nz *( "/" segment ) path-empty = 0<pchar> heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text Return true if the path is absolute returns code text true text if the path is absolute, code text false text otherwise. see reference encoded_path GNlqbV0MSxGIA/gSjlOb2rfSHhU= text , reference encoded_segments xDk467Vs74WMTJdzZiv8izTuGQo= text . reference path Q5NVO+d/+BmZ5v3/ogNb2XpUTKs= text , reference segments txoybJuonJpAdGVWgiAsiI45+ok= text . identifier bool normal 1 1 params boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2084 5 1 boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2087 5 overloads ZdlRIJ+RVbaF05I+w1pfQzUA0/0= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= brief text Return the query as a container of parameters returns text A bidirectional view of key/value pairs. see reference encoded_params text , reference encoded_query text , reference has_query text , reference query text . normal aUkcvLp4jz3VpXI6WKSgga7G2XE= V3u1IzKjTvUUsoIglN4qUAzgD4k= identifier DzqMpaJX2O25vPFxEN5EDTyU6uw= params_view params boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2084 5 1 function aUkcvLp4jz3VpXI6WKSgga7G2XE= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns a bidirectional view of key/value pairs over the query. The returned view references the same underlying character buffer; ownership is not transferred. Any percent-escapes in strings returned when iterating the view are decoded first. heading text Example 1 code params_view pv = url_view( "/sql?id=42&name=jane%2Ddoe&page+size=20" ).params(); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Return the query as a container of parameters returns text A bidirectional view of key/value pairs. see reference encoded_params YdRpQ6mNNA/rw8PqzTxP08VgNnY= text , reference encoded_query suU4/MiRITTTYf61BFw2aI6WxdI= text , reference has_query SLiWca6gUGmTh+r/BbU40NrICW8= text , reference query 4epyMikskiBx2Gu+S87oAhrM/ZY= text . identifier DzqMpaJX2O25vPFxEN5EDTyU6uw= params_view normal 1 1 params boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2087 5 function V3u1IzKjTvUUsoIglN4qUAzgD4k= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= identifier DzqMpaJX2O25vPFxEN5EDTyU6uw= params_view identifier Bb04pNwExynJkzlY9a9GCeeB13k= encoding_opts opt normal 1 1 password boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 947 5 1 function +ZB55yb2DeVYG+/eYqlMcGcedVE= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If present, this function returns a string representing the password (which may be an empty string). Otherwise it returns an empty string. Any percent-escapes in the string are decoded first. heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).password() == "pass" ); heading text Complexity 1 paragraph text Linear in code text this->password().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code userinfo = user [ ":" [ password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return the password returns text The password as a string. param text The string token to use. token see reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text , reference has_userinfo i/v5Vfq44OnlLbuKgQ2KvgWgZqo= text , reference encoded_password W9oZv0BM5z4XAggQPbNAKIM7/ro= text , reference encoded_user oYwrnXcglhO4tlvhkxLGfFCYbAk= text , reference encoded_userinfo yzkq+uCmbTlXrfDuyd1fT0Zu6xw= text , reference user /oa6wZJEG852J9Yi1LQlnq1n1tM= text , reference userinfo S9yd7MVhXxF+598Xy2/+jwnCZzc= text . identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 path boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1744 5 1 function Q5NVO+d/+BmZ5v3/ogNb2XpUTKs= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the path as a string. The path may be empty. Any percent-escapes in the string are decoded first. heading text Example 1 code assert( url_view( "file:///Program%20Files/Games/config.ini" ).path() == "/Program Files/Games/config.ini" ); heading text Complexity 1 paragraph text Linear in code text this->path().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code path = path-abempty ; begins with "/" or is empty / path-absolute ; begins with "/" but not "//" / path-noscheme ; begins with a non-colon segment / path-rootless ; begins with a segment / path-empty ; zero characters path-abempty = *( "/" segment ) path-absolute = "/" [ segment-nz *( "/" segment ) ] path-noscheme = segment-nz-nc *( "/" segment ) path-rootless = segment-nz *( "/" segment ) path-empty = 0<pchar> heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text Return the path returns text The path as a string. param text A string token to use for the result. token see reference is_path_absolute eh5BeHbLjL3BuEY7ao3tbEAZnTw= text , reference encoded_path GNlqbV0MSxGIA/gSjlOb2rfSHhU= text , reference encoded_segments xDk467Vs74WMTJdzZiv8izTuGQo= text . reference segments txoybJuonJpAdGVWgiAsiI45+ok= text . identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 persist boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 341 5 1 function cRPG1npIXmfYC0K+C+idxOqIc04= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns a read-only copy of the url, with shared lifetime. The returned value owns (persists) the underlying string. The algorithm used to create the value minimizes the number of individual memory allocations, making it more efficient than when using direct standard library functions. heading text Example 1 code std::shared_ptr< url_view const > sp; { std::string s( "http://example.com" ); url_view u( s ); // u references characters in s assert( u.data() == s.data() ); // same buffer sp = u.persist(); assert( sp->data() != s.data() ); // different buffer assert( sp->buffer() == s); // same contents // s is destroyed and thus u // becomes invalid, but sp remains valid. } heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. brief text Return a shared, persistent copy of the url returns text A shared pointer to a read-only url_view. specialization yAZI7i9M7QvpFoRBZvP2RcJBIWs= shared_ptr identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 1 port boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1604 5 1 function OlWcRIIUl1cq5Ab9fLXGPyhYCfI= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If present, this function returns a string representing the port (which may be empty). Otherwise it returns an empty string. heading text Example 1 code assert( url_view( "http://localhost.com:8080" ).port() == "8080" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code port = *DIGIT heading text Specification 1 list paragraph link text 3.2.3. Port (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.3 unordered brief text Return the port returns text The port as a string. see reference encoded_host_and_port 9ptIMbwWSNtVv+KAUpHCO3bmTWg= text , reference has_port 5V5uOhRsy00O+TSEAkIb7uFoN2U= text , reference port_number lctXu8FITJWg0+Y+yZVt5iv7QDM= text . identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core normal 1 1 port_number boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1640 5 1 function lctXu8FITJWg0+Y+yZVt5iv7QDM= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If a port is present and the numerical value is representable, it is returned as an unsigned integer. Otherwise, the number zero is returned. heading text Example 1 code assert( url_view( "http://localhost.com:8080" ).port_number() == 8080 ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code port = *DIGIT heading text Specification 1 list paragraph link text 3.2.3. Port (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.3 unordered brief text Return the port returns text The port number as an unsigned integer. see reference encoded_host_and_port 9ptIMbwWSNtVv+KAUpHCO3bmTWg= text , reference has_port 5V5uOhRsy00O+TSEAkIb7uFoN2U= text , reference port OlWcRIIUl1cq5Ab9fLXGPyhYCfI= text . identifier Qvo2fOST20EZC7bSOAFZr+u3ITg= uint16_t normal 1 1 query boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1987 5 1 function 4epyMikskiBx2Gu+S87oAhrM/ZY= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If this contains a query, it is returned as a string (which may be empty). Otherwise, an empty string is returned. Any percent-escapes in the string are decoded first. paragraph text Literal plus signs remain unchanged by default to match RFC 3986. To treat '+' as a space, supply decoding options with code text space_as_plus = true text when calling this function. heading text Example 1 code assert( url_view( "/sql?id=42&name=jane%2Ddoe&page+size=20" ).query() == "id=42&name=jane-doe&page size=20" ); heading text Complexity 1 paragraph text Linear in code text this->query().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Return the query returns text The query as a string. param text A token to use for the returned string. token see reference encoded_params YdRpQ6mNNA/rw8PqzTxP08VgNnY= text , reference encoded_query suU4/MiRITTTYf61BFw2aI6WxdI= text , reference has_query SLiWca6gUGmTh+r/BbU40NrICW8= text , reference params ZdlRIJ+RVbaF05I+w1pfQzUA0/0= text . identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 scheme boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 421 5 1 function 43fxogaC5oVqfauhwXyN4s4ibEM= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the scheme if it exists, without a trailing colon (':'). Otherwise it returns an empty string. Note that schemes are case-insensitive, and the canonical form is lowercased. heading text Example 1 code assert( url_view( "http://www.example.com" ).scheme() == "http" ); heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code scheme = ALPHA *( ALPHA / DIGIT / "+" / "-" / "." ) URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] absolute-URI = scheme ":" hier-part [ "?" query ] heading text Specification 1 list paragraph link text 3.1. Scheme (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.1 unordered brief text Return the scheme returns text The scheme as a string. see reference has_scheme iwSH2fvVkb89TkZj7KWLGSyc4sA= text , reference scheme_id uM37WpBqetqzfHjns3M8/+CcoEU= text . identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core normal 1 1 scheme_id boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 471 5 1 function uM37WpBqetqzfHjns3M8/+CcoEU= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns a value which depends on the scheme in the url: list paragraph text If the scheme is a well-known scheme, corresponding value from the enumeration reference urls::scheme P7uOjuAMILimKGOcbjDUSpMAL/U= text is returned. paragraph text If a scheme is present but is not a well-known scheme, the value returned is reference urls::scheme::unknown LJxTyQ55ot1WYLH7f46nZvdGU78= text . paragraph text Otherwise, if the scheme is absent the value returned is reference urls::scheme::none VupiauVBXlZQ8Uix+vk8kSl+fM8= text . unordered heading text Example 1 code assert( url_view( "wss://www.example.com/crypto.cgi" ).scheme_id() == scheme::wss ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] absolute-URI = scheme ":" hier-part [ "?" query ] scheme = ALPHA *( ALPHA / DIGIT / "+" / "-" / "." ) heading text Specification 1 list paragraph link text 3.1. Scheme (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.1 unordered brief text Return the scheme returns text The scheme as an enumeration value. see reference has_scheme iwSH2fvVkb89TkZj7KWLGSyc4sA= text , reference scheme 43fxogaC5oVqfauhwXyN4s4ibEM= text . identifier P7uOjuAMILimKGOcbjDUSpMAL/U= scheme identifier dnk5XPfR2OaMpCYaH3cWSxcTdyc= urls normal 1 1 segments boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1840 5 1 function txoybJuonJpAdGVWgiAsiI45+ok= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns a bidirectional view of strings over the path. The returned view references the same underlying character buffer; ownership is not transferred. Any percent-escapes in strings returned when iterating the view are decoded first. heading text Example 1 code segments_view sv = url_view( "/path/to/file.txt" ).segments(); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code path = [ "/" ] segment *( "/" segment ) heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text Return the path as a container of segments returns text A bidirectional view of segments. see reference is_path_absolute eh5BeHbLjL3BuEY7ao3tbEAZnTw= text , reference encoded_path GNlqbV0MSxGIA/gSjlOb2rfSHhU= text , reference encoded_segments xDk467Vs74WMTJdzZiv8izTuGQo= text . reference path Q5NVO+d/+BmZ5v3/ogNb2XpUTKs= text , reference segments_view ZNJOLZ4RhCB2A2ooiNo7KxZJHrA= text . identifier ZNJOLZ4RhCB2A2ooiNo7KxZJHrA= segments_view normal 1 1 size boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 201 5 1 function b5EwiMBFGrk0/BIGaiumuCVSoFM= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the number of characters in the url's encoded string, not including any null terminator, if present. heading text Example 1 code assert( url_view( "file:///Program%20Files" ).size() == 23 ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the number of characters in the url returns text The number of characters in the url. identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 1 user boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 848 5 1 function /oa6wZJEG852J9Yi1LQlnq1n1tM= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If present, this function returns a string representing the user (which may be empty). Otherwise it returns an empty string. Any percent-escapes in the string are decoded first. heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).user() == "jane-doe" ); heading text Complexity 1 paragraph text Linear in code text this->user().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code userinfo = user [ ":" [ password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return the user returns text The user as a string. param text The string token to use. token see reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text , reference has_userinfo i/v5Vfq44OnlLbuKgQ2KvgWgZqo= text , reference encoded_password W9oZv0BM5z4XAggQPbNAKIM7/ro= text , reference encoded_user oYwrnXcglhO4tlvhkxLGfFCYbAk= text , reference encoded_userinfo yzkq+uCmbTlXrfDuyd1fT0Zu6xw= text , reference password +ZB55yb2DeVYG+/eYqlMcGcedVE= text , reference userinfo S9yd7MVhXxF+598Xy2/+jwnCZzc= text . identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 userinfo boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 748 5 1 function S9yd7MVhXxF+598Xy2/+jwnCZzc= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If present, this function returns a string representing the userinfo (which may be empty). Otherwise it returns an empty string. Any percent-escapes in the string are decoded first. admonition paragraph text This function uses the string token return type customization. Depending on the token passed, the return type and behavior of the function can be different. See reference string_token::return_string +eBzDECNPyuTkJuxLUTMVIkHGO0= text for more information. note heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).userinfo() == "jane-doe:pass" ); heading text Complexity 1 paragraph text Linear in code text this->userinfo().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code userinfo = user [ ":" [ password ] ] authority = [ userinfo "@" ] host [ ":" port ] heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return the userinfo returns text When called with no arguments, a value of type code text std::string text is returned. Otherwise, the return type and meaning depends on the string token passed to the function. returns text The userinfo as a string. param text The string token to use. token see reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text , reference has_userinfo i/v5Vfq44OnlLbuKgQ2KvgWgZqo= text , reference encoded_password W9oZv0BM5z4XAggQPbNAKIM7/ro= text , reference encoded_user oYwrnXcglhO4tlvhkxLGfFCYbAk= text , reference encoded_userinfo yzkq+uCmbTlXrfDuyd1fT0Zu6xw= text , reference password +ZB55yb2DeVYG+/eYqlMcGcedVE= text , reference user /oa6wZJEG852J9Yi1LQlnq1n1tM= text . identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 zone_id boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1480 5 1 function rN6p9/aLARL9S9gn02k+M+j21q8= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If the host type is reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= text , this function returns the Zone ID as a string. Otherwise an empty string is returned. Any percent-escapes in the string are decoded first. heading text Example 1 code assert( url_view( "http://[fe80::1%25eth0]/" ).zone_id() == "eth0" ); heading text Complexity 1 paragraph text Linear in code text this->encoded_zone_id().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPv6addrz / IPvFuture ) "]" ZoneID = 1*( unreserved / pct-encoded ) IPv6addrz = IPv6address "%25" ZoneID heading text Specification 1 list paragraph link text Representing IPv6 Zone Identifiers in Address Literals and Uniform Resource Identifiers https://datatracker.ietf.org/doc/html/rfc6874 unordered brief text Return the IPv6 Zone ID returns text The Zone ID as a string. param text A string token customization. token identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 operator basic_string_view<char> boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 299 5 1 function 0JOtXYOmKvCl2dNIZYV6J7flgJE= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the URL as a core::string_view returns text A string view of the URL. identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core conversion 1 1 max_size boost/url/url_view.hpp include/boost/url/url_view.hpp 365 5 1 function QnJpEPJCfRKAJAc/hcKWdTwH9qM= regular wh3UbUToX9YDmRmnpcoM9EUEZo8= paragraph text This represents the largest number of characters that are possible in a url, not including any null terminator. heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the maximum number of characters possible returns text The maximum number of characters possible. identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 digest boost/url/impl/url_view_base.hpp include/boost/url/impl/url_view_base.hpp 81 1 boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 146 5 1 function aSDB3babl7TsiU0T+gdHMM/NC5c= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function calculates a hash of the url as if it were always normalized. heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Throws nothing. brief text Calculate a hash of the url returns text A hash value suitable for use in hash-based containers. param text An initial value to add to the hash salt identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std salt 0 normal 1 1 url_view_base boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 65 1 1 record UEVNhDEjkZMXfjN1DxbtX0n2rCg= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text This base class is used by the library to provide common member functions for containers. This cannot be instantiated directly; Instead, use one of the containers or functions: heading text Containers 1 list paragraph reference url B4dRaSXMG3fDmuNKMW3KOeRu6kA= paragraph reference url_view wh3UbUToX9YDmRmnpcoM9EUEZo8= paragraph reference static_url 4HBDcnMjZthTXFnhpS7z+UhDNjA= unordered heading text Functions 1 list paragraph reference parse_absolute_uri U3CVElRbcTcbg1JzOqhBCd5RSzM= paragraph reference parse_origin_form J4f05lEg7oi89R2SkpRaYiBhCIQ= paragraph reference parse_relative_ref QFzcl8vSLEeKOEO6w3mv1zGqX3k= paragraph reference parse_uri f+9kR517VGSM5ZPoS7g/RFb0g/0= paragraph reference parse_uri_reference 7d2b1xVBWJPgL/+PWFdoBaZJvMA= unordered brief text Common functionality for containers reference resolve /6zWjIFN5df0PBj9zFsfNUjNY6s= class aHkFCWJbYb0t+7FT+A5gCI0krpU= wh3UbUToX9YDmRmnpcoM9EUEZo8= v5/R9LI0iKJDiBrNUt7k8qrVBdM= oDNnPxjP34HYhoUyyduWMZfqZs4= p+2L2asXUGpE7eey1ouRvFXKD1g= I2WjK21z+iS45kbL4TnzA8O5oE0= 5yR7btLz2K+NLHFnzfXMyGsq2fo= Ww04vLA2k7BwctuyNeP3KwoNr4M= M7+OzewsxChMvecRSytXqTCqKrY= EcGxt+esOtVfjloInubXUYLy5GY= yXsUZRbi+wInLqaUUVy9b7nIIBo= 9ptIMbwWSNtVv+KAUpHCO3bmTWg= 4URKnuP+gvIUVjIkywv/pXeFjv4= wG6ey1727HIj10Wh+OD/s8kuOjo= YdRpQ6mNNA/rw8PqzTxP08VgNnY= W9oZv0BM5z4XAggQPbNAKIM7/ro= GNlqbV0MSxGIA/gSjlOb2rfSHhU= suU4/MiRITTTYf61BFw2aI6WxdI= yLMNPjiW4s31xcLN4xOiqVySYLA= xDk467Vs74WMTJdzZiv8izTuGQo= IcodRek43l5Zc13Z67L74PlhG0U= oYwrnXcglhO4tlvhkxLGfFCYbAk= yzkq+uCmbTlXrfDuyd1fT0Zu6xw= 5M2smbXDaSa2d/li//A+GmlDgDU= aA1Q9NAW4/TnG3SXhe4k1mNB5nk= gadV3YsYDjlGX+64Rtiz4S+QD4A= ZiWsQaQCAif94KdP6GXH9+F5GmM= 9JACnsebk8tFsoryabfDxE8VpnA= 5V5uOhRsy00O+TSEAkIb7uFoN2U= SLiWca6gUGmTh+r/BbU40NrICW8= iwSH2fvVkb89TkZj7KWLGSyc4sA= i/v5Vfq44OnlLbuKgQ2KvgWgZqo= ICcovOIyqnxhSMU6MuEekYg2z+E= F0RYzLwUP8ied6l3zmKvomgFHag= KL8F3KYxyzpC1e6fqoJy3B8IHhw= CvoRh2IpWg4QixngVwDjSKoeQVY= 55Yh68uToEiKy+IDTpyctuK/T3g= AhPhrC4hmBsZgd/ztqbkAuOkbBM= Nv9Emy6spILLI/mqyIz2uRNBJhU= eh5BeHbLjL3BuEY7ao3tbEAZnTw= ZdlRIJ+RVbaF05I+w1pfQzUA0/0= +ZB55yb2DeVYG+/eYqlMcGcedVE= Q5NVO+d/+BmZ5v3/ogNb2XpUTKs= cRPG1npIXmfYC0K+C+idxOqIc04= OlWcRIIUl1cq5Ab9fLXGPyhYCfI= lctXu8FITJWg0+Y+yZVt5iv7QDM= 4epyMikskiBx2Gu+S87oAhrM/ZY= 43fxogaC5oVqfauhwXyN4s4ibEM= uM37WpBqetqzfHjns3M8/+CcoEU= txoybJuonJpAdGVWgiAsiI45+ok= b5EwiMBFGrk0/BIGaiumuCVSoFM= /oa6wZJEG852J9Yi1LQlnq1n1tM= S9yd7MVhXxF+598Xy2/+jwnCZzc= rN6p9/aLARL9S9gn02k+M+j21q8= 0JOtXYOmKvCl2dNIZYV6J7flgJE= mg8FRYZ94og9lKYjTEYdjucqHw4= aSDB3babl7TsiU0T+gdHMM/NC5c= CXgg6jYJMxKo6JzfJnvC5y6t0Nc= FKzNv7BNGorFnUHFmR4Io68XCuc= HKZfmWVqLkCihxjQZ+A5w5w4nDA= Dsb5U3JEUbgxX5qsD7K2wZxpteo= WJksxKMywVduLSLIPfJesj3Ve7k= NbVWJ3CaY7IQ5RA9hDBv+MGqm7Q= bC1c/JFizQvhSZRsJASq9oQCKqc= yLKqd4lj1Ql3zbXuflxEjNzw+Bk= VQ8wN5VmWJfoSxg1rKYLnwDRsjU= AdXFp/RvPKHF4rljfa5/5yBmyfs= ngGy21anUjaZiQQJidHT5lvOC2w= rRCHC/6GEaVZrjzAeFDlvaCydi0= Si07vh35lnvnJy8tpXUIpiFEjGM= QA2q/R+XvrJl2j8UnJwv+lnhdDA= E2+0o+/H5dWqJ1IkTzJ6aHTaMHE= identifier ZNJOLZ4RhCB2A2ooiNo7KxZJHrA= segments_view ZNJOLZ4RhCB2A2ooiNo7KxZJHrA= identifier zdr3gU7+2/G05oo6ta/IfHlkTF0= segments_ref zdr3gU7+2/G05oo6ta/IfHlkTF0= identifier EvaX3SmNTAtai2Kf6Kma3fUkTkQ= segments_encoded_view EvaX3SmNTAtai2Kf6Kma3fUkTkQ= identifier TCUUfRiqZjX62kt7tK2fs//VWr0= segments_encoded_ref TCUUfRiqZjX62kt7tK2fs//VWr0= identifier qs4TNMM406MPgeboXz6oVUmcauE= segments_encoded_base qs4TNMM406MPgeboXz6oVUmcauE= identifier ge9cOBTN19ywbVTnB5ajdJUC46Q= segments_base ge9cOBTN19ywbVTnB5ajdJUC46Q= identifier DzqMpaJX2O25vPFxEN5EDTyU6uw= params_view DzqMpaJX2O25vPFxEN5EDTyU6uw= identifier 8S83BKvWBCDdTktlY8X93Mlo9E0= params_ref 8S83BKvWBCDdTktlY8X93Mlo9E0= identifier 0nSfM4mK92fIx58KtzdWGiHuq2w= params_encoded_view 0nSfM4mK92fIx58KtzdWGiHuq2w= identifier oR5B5D0/JYTOQYvyFXRv+at91JE= params_encoded_ref oR5B5D0/JYTOQYvyFXRv+at91JE= identifier 2+L1/+BrjUzoccWPIYkGu108y1I= params_encoded_base 2+L1/+BrjUzoccWPIYkGu108y1I= identifier paRP7A1SOQlKcnfXhxL4FgbVXKs= params_base paRP7A1SOQlKcnfXhxL4FgbVXKs= identifier dmsqdje8dXFRFgNB9wxOs9Y5nb8= static_url_base dmsqdje8dXFRFgNB9wxOs9Y5nb8= identifier wh3UbUToX9YDmRmnpcoM9EUEZo8= url_view wh3UbUToX9YDmRmnpcoM9EUEZo8= identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base aHkFCWJbYb0t+7FT+A5gCI0krpU= identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url B4dRaSXMG3fDmuNKMW3KOeRu6kA= authority boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 564 5 1 function v5/R9LI0iKJDiBrNUt7k8qrVBdM= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the authority as an reference authority_view d/hMlyyC3Ave6L9McUD7B4TwENA= text . heading text Example 1 code authority_view a = url_view( "https://www.example.com:8080/index.htm" ).authority(); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code authority = [ userinfo "@" ] host [ ":" port ] heading text Specification 1 list paragraph link text 3.2. Authority (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2 unordered brief text Return the authority returns text An authority_view representing the authority. see reference encoded_authority Ww04vLA2k7BwctuyNeP3KwoNr4M= text , reference has_authority gadV3YsYDjlGX+64Rtiz4S+QD4A= text . identifier d/hMlyyC3Ave6L9McUD7B4TwENA= authority_view normal 1 1 buffer boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 282 5 1 function oDNnPxjP34HYhoUyyduWMZfqZs4= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the entire url, which may contain percent escapes. heading text Example 1 code assert( url_view( "http://www.example.com" ).buffer() == "http://www.example.com" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the url string returns text The url as a string. identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core normal 1 1 compare boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2446 5 1 function p+2L2asXUGpE7eey1ouRvFXKD1g= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function compares two URLs according to Syntax-Based comparison algorithm. heading text Complexity 1 paragraph text Linear in code text min( u0.size(), u1.size() ) heading text Exception Safety 1 paragraph text Throws nothing. heading text Specification 1 list paragraph link text 6.2.2 Syntax-Based Normalization (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-6.2.2 unordered brief text Return the result of comparing this with another url returns text -1 if code text *this < other text , 0 if code text this == other text , and 1 if code text this > other text . param text The url to compare other identifier int 1 identifier UEVNhDEjkZMXfjN1DxbtX0n2rCg= url_view_base other normal 1 1 data boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 258 5 1 function I2WjK21z+iS45kbL4TnzA8O5oE0= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns a pointer to the first character of the url, which is not guaranteed to be null-terminated. heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return a pointer to the url's character buffer returns text A pointer to the first character. 1 identifier char normal 1 1 empty boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 238 5 1 function 5yR7btLz2K+NLHFnzfXMyGsq2fo= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text The empty string matches the emph text relative-ref text grammar. heading text Example 1 code assert( url_view( "" ).empty() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code relative-ref = relative-part [ "?" query ] [ "#" fragment ] relative-part = "//" authority path-abempty / path-absolute / path-noscheme / path-empty heading text Specification 1 list paragraph link text 4.2. Relative Reference (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-4.2 unordered brief text Return true if the url is empty returns code text true text if the url is empty. identifier bool normal 1 1 encoded_authority boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 601 5 1 function Ww04vLA2k7BwctuyNeP3KwoNr4M= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If present, this function returns a string representing the authority (which may be empty). Otherwise it returns an empty string. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "file://Network%20Drive/My%2DFiles" ).encoded_authority() == "Network%20Drive" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code authority = [ userinfo "@" ] host [ ":" port ] heading text Specification 1 list paragraph link text 3.2. Authority (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2 unordered brief text Return the authority. returns text The authority as a string. see reference authority v5/R9LI0iKJDiBrNUt7k8qrVBdM= text , reference has_authority gadV3YsYDjlGX+64Rtiz4S+QD4A= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_fragment boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2280 5 1 function M7+OzewsxChMvecRSytXqTCqKrY= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the fragment as a string with percent-escapes. Ownership is not transferred; the string returned references the underlying character buffer, which must remain valid or else undefined behavior occurs. heading text Example 1 code assert( url_view( "http://www.example.com/index.htm#a%2D1" ).encoded_fragment() == "a%2D1" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code fragment = *( pchar / "/" / "?" ) pchar = unreserved / pct-encoded / sub-delims / ":" / "@" heading text Specification 1 list paragraph link text 3.5. Fragment (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.5 unordered brief text Return the fragment returns text The fragment portion of the url. see reference fragment aA1Q9NAW4/TnG3SXhe4k1mNB5nk= text , reference has_fragment ZiWsQaQCAif94KdP6GXH9+F5GmM= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_host boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1120 5 1 function EcGxt+esOtVfjloInubXUYLy5GY= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the host portion of the authority as a string, or the empty string if there is no authority. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "https://www%2droot.example.com/" ).encoded_host() == "www%2droot.example.com" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPvFuture ) "]" reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host returns text The host address as a string. identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_host_address boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1237 5 1 function yXsUZRbi+wInLqaUUVy9b7nIIBo= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text The value returned by this function depends on the type of host returned from the function reference host_type Nv9Emy6spILLI/mqyIz2uRNBJhU= text . list paragraph text If the type is reference host_type::ipv4 49F64dAiji9HVbP6MxLQiqot7AY= text , then the IPv4 address string is returned. paragraph text If the type is reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= text , then the IPv6 address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::ipvfuture TcYJaTwDFsx+0S2CkvHHARcCqWc= text , then the IPvFuture address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= text , then the host name string is returned. Any percent-escapes in the string are decoded first. paragraph text If the type is reference host_type::none QyoMTu07h232/Sxqovu2mGoPgTo= text , then an empty string is returned. The returned string may contain percent escapes. unordered heading text Example 1 code assert( url_view( "https://www%2droot.example.com/" ).encoded_host_address() == "www%2droot.example.com" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPvFuture ) "]" reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host returns text The host address as a string. identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_host_and_port boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2325 5 1 function 9ptIMbwWSNtVv+KAUpHCO3bmTWg= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If an authority is present, this function returns the host and optional port as a string, which may be empty. Otherwise it returns an empty string. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "http://www.example.com:8080/index.htm" ).encoded_host_and_port() == "www.example.com:8080" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code authority = [ userinfo "@" ] host [ ":" port ] heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 paragraph link text 3.2.3. Port (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.3 unordered brief text Return the host and port returns text The host and port portion of the url. see reference has_port 5V5uOhRsy00O+TSEAkIb7uFoN2U= text , reference port OlWcRIIUl1cq5Ab9fLXGPyhYCfI= text , reference port_number lctXu8FITJWg0+Y+yZVt5iv7QDM= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_host_name boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1441 5 1 function 4URKnuP+gvIUVjIkywv/pXeFjv4= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If the host type is reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= text , this function returns the name as a string. Otherwise, if the host type is not an name, it returns an empty string. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "https://www%2droot.example.com/" ).encoded_host_name() == "www%2droot.example.com" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPvFuture ) "]" reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host name returns text The host name as a percent-encoded string. identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_origin boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2355 5 1 function wG6ey1727HIj10Wh+OD/s8kuOjo= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If an authority is present, this function returns the scheme and authority portion of the url. Otherwise, an empty string is returned. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "http://www.example.com:8080/index.htm?text=none#h1" ).encoded_origin() == "http://www.example.com:8080" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the origin returns text The origin portion of the url. see reference encoded_resource yLMNPjiW4s31xcLN4xOiqVySYLA= text , reference encoded_target IcodRek43l5Zc13Z67L74PlhG0U= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_params boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2130 5 1 function YdRpQ6mNNA/rw8PqzTxP08VgNnY= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns a bidirectional view of key/value pairs over the query. The returned view references the same underlying character buffer; ownership is not transferred. Strings returned when iterating the range may contain percent escapes. heading text Example 1 code params_encoded_view pv = url_view( "/sql?id=42&name=jane%2Ddoe&page+size=20" ).encoded_params(); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Return the query as a container of parameters returns text A bidirectional view of key/value pairs. see reference encoded_query suU4/MiRITTTYf61BFw2aI6WxdI= text , reference has_query SLiWca6gUGmTh+r/BbU40NrICW8= text , reference params ZdlRIJ+RVbaF05I+w1pfQzUA0/0= text , reference query 4epyMikskiBx2Gu+S87oAhrM/ZY= text . identifier 0nSfM4mK92fIx58KtzdWGiHuq2w= params_encoded_view normal 1 1 encoded_password boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 996 5 1 function W9oZv0BM5z4XAggQPbNAKIM7/ro= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the password portion of the userinfo as a percent-encoded string. heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).encoded_password() == "pass" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code userinfo = user [ ":" [ password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return the password returns text The password as a string. see reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text , reference has_userinfo i/v5Vfq44OnlLbuKgQ2KvgWgZqo= text , reference encoded_user oYwrnXcglhO4tlvhkxLGfFCYbAk= text , reference encoded_userinfo yzkq+uCmbTlXrfDuyd1fT0Zu6xw= text , reference password +ZB55yb2DeVYG+/eYqlMcGcedVE= text , reference user /oa6wZJEG852J9Yi1LQlnq1n1tM= text , reference userinfo S9yd7MVhXxF+598Xy2/+jwnCZzc= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_path boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1799 5 1 function GNlqbV0MSxGIA/gSjlOb2rfSHhU= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the path as a string. The path may be empty. Any percent-escapes in the string are decoded first. heading text Example 1 code assert( url_view( "file:///Program%20Files/Games/config.ini" ).encoded_path() == "/Program%20Files/Games/config.ini" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code path = path-abempty ; begins with "/" or is empty / path-absolute ; begins with "/" but not "//" / path-noscheme ; begins with a non-colon segment / path-rootless ; begins with a segment / path-empty ; zero characters path-abempty = *( "/" segment ) path-absolute = "/" [ segment-nz *( "/" segment ) ] path-noscheme = segment-nz-nc *( "/" segment ) path-rootless = segment-nz *( "/" segment ) path-empty = 0<pchar> heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text Return the path returns text The path as a string. see reference is_path_absolute eh5BeHbLjL3BuEY7ao3tbEAZnTw= text , reference encoded_segments xDk467Vs74WMTJdzZiv8izTuGQo= text . reference path Q5NVO+d/+BmZ5v3/ogNb2XpUTKs= text , reference segments txoybJuonJpAdGVWgiAsiI45+ok= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_query boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2040 5 1 function suU4/MiRITTTYf61BFw2aI6WxdI= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If this contains a query, it is returned as a string (which may be empty). Otherwise, an empty string is returned. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "/sql?id=42&name=jane%2Ddoe&page+size=20" ).encoded_query() == "id=42&name=jane%2Ddoe&page+size=20" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Return the query returns text The query as a string. see reference encoded_params YdRpQ6mNNA/rw8PqzTxP08VgNnY= text , reference has_query SLiWca6gUGmTh+r/BbU40NrICW8= text , reference params ZdlRIJ+RVbaF05I+w1pfQzUA0/0= text , reference query 4epyMikskiBx2Gu+S87oAhrM/ZY= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_resource boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2387 5 1 function yLMNPjiW4s31xcLN4xOiqVySYLA= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the resource, which is the portion of the url that includes only the path, query, and fragment. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "http://www.example.com/index.html?query#frag" ).encoded_resource() == "/index.html?query#frag" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 unordered brief text Return the resource returns text The resource portion of the url. see reference encoded_origin wG6ey1727HIj10Wh+OD/s8kuOjo= text , reference encoded_target IcodRek43l5Zc13Z67L74PlhG0U= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_segments boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1891 5 1 function xDk467Vs74WMTJdzZiv8izTuGQo= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns a bidirectional view of strings over the path. The returned view references the same underlying character buffer; ownership is not transferred. Strings returned when iterating the range may contain percent escapes. heading text Example 1 code segments_encoded_view sv = url_view( "/path/to/file.txt" ).encoded_segments(); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code path = path-abempty ; begins with "/" or is empty / path-absolute ; begins with "/" but not "//" / path-noscheme ; begins with a non-colon segment / path-rootless ; begins with a segment / path-empty ; zero characters path-abempty = *( "/" segment ) path-absolute = "/" [ segment-nz *( "/" segment ) ] path-noscheme = segment-nz-nc *( "/" segment ) path-rootless = segment-nz *( "/" segment ) path-empty = 0<pchar> heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text Return the path as a container of segments returns text A bidirectional view of encoded segments. see reference is_path_absolute eh5BeHbLjL3BuEY7ao3tbEAZnTw= text , reference encoded_path GNlqbV0MSxGIA/gSjlOb2rfSHhU= text , reference path Q5NVO+d/+BmZ5v3/ogNb2XpUTKs= text , reference segments txoybJuonJpAdGVWgiAsiI45+ok= text , reference segments_encoded_view EvaX3SmNTAtai2Kf6Kma3fUkTkQ= text . identifier EvaX3SmNTAtai2Kf6Kma3fUkTkQ= segments_encoded_view normal 1 1 encoded_target boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2419 5 1 function IcodRek43l5Zc13Z67L74PlhG0U= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the target, which is the portion of the url that includes only the path and query. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "http://www.example.com/index.html?query#frag" ).encoded_target() == "/index.html?query" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 unordered brief text Return the target returns text The target portion of the url. see reference encoded_origin wG6ey1727HIj10Wh+OD/s8kuOjo= text , reference encoded_resource yLMNPjiW4s31xcLN4xOiqVySYLA= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_user boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 901 5 1 function oYwrnXcglhO4tlvhkxLGfFCYbAk= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If present, this function returns a string representing the user (which may be empty). Otherwise it returns an empty string. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).encoded_user() == "jane%2Ddoe" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code userinfo = user [ ":" [ password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return the user returns text The user as a string. see reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text , reference has_userinfo i/v5Vfq44OnlLbuKgQ2KvgWgZqo= text , reference encoded_password W9oZv0BM5z4XAggQPbNAKIM7/ro= text , reference encoded_userinfo yzkq+uCmbTlXrfDuyd1fT0Zu6xw= text , reference password +ZB55yb2DeVYG+/eYqlMcGcedVE= text , reference user /oa6wZJEG852J9Yi1LQlnq1n1tM= text , reference userinfo S9yd7MVhXxF+598Xy2/+jwnCZzc= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_userinfo boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 800 5 1 function yzkq+uCmbTlXrfDuyd1fT0Zu6xw= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If present, this function returns a string representing the userinfo (which may be empty). Otherwise it returns an empty string. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).encoded_userinfo() == "jane%2Ddoe:pass" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing heading text BNF 1 code userinfo = user [ ":" [ password ] ] authority = [ userinfo "@" ] host [ ":" port ] heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return the userinfo returns text The userinfo as a string. see reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text , reference has_userinfo i/v5Vfq44OnlLbuKgQ2KvgWgZqo= text , reference encoded_password W9oZv0BM5z4XAggQPbNAKIM7/ro= text , reference encoded_user oYwrnXcglhO4tlvhkxLGfFCYbAk= text , reference password +ZB55yb2DeVYG+/eYqlMcGcedVE= text , reference user /oa6wZJEG852J9Yi1LQlnq1n1tM= text , reference userinfo S9yd7MVhXxF+598Xy2/+jwnCZzc= text . identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 encoded_zone_id boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1526 5 1 function 5M2smbXDaSa2d/li//A+GmlDgDU= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If the host type is reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= text , this function returns the Zone ID as a string. Otherwise an empty string is returned. The returned string may contain percent escapes. heading text Example 1 code assert( url_view( "http://[fe80::1%25eth0]/" ).encoded_zone_id() == "eth0" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPv6addrz / IPvFuture ) "]" ZoneID = 1*( unreserved / pct-encoded ) IPv6addrz = IPv6address "%25" ZoneID heading text Specification 1 list paragraph link text Representing IPv6 Zone Identifiers in Address Literals and Uniform Resource Identifiers https://datatracker.ietf.org/doc/html/rfc6874 unordered brief text Return the IPv6 Zone ID returns text The Zone ID as a percent-encoded string. identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view normal 1 1 fragment boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2233 5 1 function aA1Q9NAW4/TnG3SXhe4k1mNB5nk= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function calculates the fragment of the url, with percent escapes decoded and without the leading pound sign ('#') whose presence indicates that the url contains a fragment. paragraph text This function accepts an optional emph text StringToken text parameter which controls the return type and behavior of the function: list paragraph text When called with no arguments, the return type of the function is code text std::string text . Otherwise paragraph text When called with a string token, the behavior and return type of the function depends on the type of string token being passed. unordered heading text Example 1 code assert( url_view( "http://www.example.com/index.htm#a%2D1" ).fragment() == "a-1" ); heading text Complexity 1 paragraph text Linear in code text this->fragment().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. String tokens may throw exceptions. heading text BNF 1 code fragment = *( pchar / "/" / "?" ) fragment-part = [ "#" fragment ] heading text Specification 1 list paragraph link text 3.5. Fragment (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.5 unordered brief text Return the fragment returns text The fragment portion of the url. param text An optional string token to use. If this parameter is omitted, the function returns a new code text std::string text . token see reference encoded_fragment M7+OzewsxChMvecRSytXqTCqKrY= text , reference has_fragment ZiWsQaQCAif94KdP6GXH9+F5GmM= text . identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 has_authority boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 528 5 1 function gadV3YsYDjlGX+64Rtiz4S+QD4A= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns true if the url contains an authority. The presence of an authority is denoted by a double slash ("//") at the beginning or after the scheme. heading text Example 1 code assert( url_view( "http://www.example.com/index.htm" ).has_authority() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code authority = [ userinfo "@" ] host [ ":" port ] URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] absolute-URI = scheme ":" hier-part [ "?" query ] URI-reference = URI / relative-ref relative-ref = relative-part [ "?" query ] [ "#" fragment ] hier-part = "//" authority path-abempty ; (more...) relative-part = "//" authority path-abempty ; (more...) heading text Specification 1 list paragraph link text 3.2. Authority (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2 unordered brief text Return true if an authority is present returns code text true text if the url contains an authority. see reference authority v5/R9LI0iKJDiBrNUt7k8qrVBdM= text , reference encoded_authority Ww04vLA2k7BwctuyNeP3KwoNr4M= text . identifier bool normal 1 1 has_fragment boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2173 5 1 function ZiWsQaQCAif94KdP6GXH9+F5GmM= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns true if the url contains a fragment. An empty fragment is distinct from no fragment. heading text Example 1 code assert( url_view( "http://www.example.com/index.htm#anchor" ).has_fragment() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] relative-ref = relative-part [ "?" query ] [ "#" fragment ] heading text Specification 1 list paragraph link text 3.5. Fragment (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.5 unordered brief text Return true if a fragment is present returns code text true text if the url contains a fragment. see reference encoded_fragment M7+OzewsxChMvecRSytXqTCqKrY= text , reference fragment aA1Q9NAW4/TnG3SXhe4k1mNB5nk= text . identifier bool normal 1 1 has_password boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 689 5 1 function 9JACnsebk8tFsoryabfDxE8VpnA= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns true if the userinfo is present and contains a password. heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).has_password() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code userinfo = user [ ":" [ password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return true if a password is present returns code text true text if the userinfo contains a password. see reference has_userinfo i/v5Vfq44OnlLbuKgQ2KvgWgZqo= text , reference encoded_password W9oZv0BM5z4XAggQPbNAKIM7/ro= text , reference encoded_user oYwrnXcglhO4tlvhkxLGfFCYbAk= text , reference encoded_userinfo yzkq+uCmbTlXrfDuyd1fT0Zu6xw= text , reference password +ZB55yb2DeVYG+/eYqlMcGcedVE= text , reference user /oa6wZJEG852J9Yi1LQlnq1n1tM= text , reference userinfo S9yd7MVhXxF+598Xy2/+jwnCZzc= text . identifier bool normal 1 1 has_port boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1568 5 1 function 5V5uOhRsy00O+TSEAkIb7uFoN2U= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns true if an authority is present and contains a port. heading text Example 1 code assert( url_view( "wss://www.example.com:443" ).has_port() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code authority = [ userinfo "@" ] host [ ":" port ] port = *DIGIT heading text Specification 1 list paragraph link text 3.2.3. Port (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.3 unordered brief text Return true if a port is present returns code text true text if a port is present, code text false text otherwise. see reference encoded_host_and_port 9ptIMbwWSNtVv+KAUpHCO3bmTWg= text , reference port OlWcRIIUl1cq5Ab9fLXGPyhYCfI= text , reference port_number lctXu8FITJWg0+Y+yZVt5iv7QDM= text . identifier bool normal 1 1 has_query boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1937 5 1 function SLiWca6gUGmTh+r/BbU40NrICW8= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns true if this contains a query. An empty query is distinct from having no query. heading text Example 1 code assert( url_view( "/sql?id=42&col=name&page-size=20" ).has_query() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Return true if a query is present returns code text true text if a query is present. see reference encoded_params YdRpQ6mNNA/rw8PqzTxP08VgNnY= text , reference encoded_query suU4/MiRITTTYf61BFw2aI6WxdI= text , reference params ZdlRIJ+RVbaF05I+w1pfQzUA0/0= text , reference query 4epyMikskiBx2Gu+S87oAhrM/ZY= text . identifier bool normal 1 1 has_scheme boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 384 5 1 function iwSH2fvVkb89TkZj7KWLGSyc4sA= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns true if this contains a scheme. heading text Example 1 code assert( url_view( "http://www.example.com" ).has_scheme() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] absolute-URI = scheme ":" hier-part [ "?" query ] scheme = ALPHA *( ALPHA / DIGIT / "+" / "-" / "." ) heading text Specification 1 list paragraph link text 3.1. Scheme (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.1 unordered brief text Return true a scheme is present returns code text true text if the url contains a scheme. see reference scheme 43fxogaC5oVqfauhwXyN4s4ibEM= text , reference scheme_id uM37WpBqetqzfHjns3M8/+CcoEU= text . identifier bool normal 1 1 has_userinfo boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 647 5 1 function i/v5Vfq44OnlLbuKgQ2KvgWgZqo= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns true if this contains a userinfo. heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).has_userinfo() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code userinfo = user [ ":" [ password ] ] authority = [ userinfo "@" ] host [ ":" port ] heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return true if a userinfo is present returns code text true text if the userinfo is present. see reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text , reference encoded_password W9oZv0BM5z4XAggQPbNAKIM7/ro= text , reference encoded_user oYwrnXcglhO4tlvhkxLGfFCYbAk= text , reference encoded_userinfo yzkq+uCmbTlXrfDuyd1fT0Zu6xw= text , reference password +ZB55yb2DeVYG+/eYqlMcGcedVE= text , reference user /oa6wZJEG852J9Yi1LQlnq1n1tM= text , reference userinfo S9yd7MVhXxF+598Xy2/+jwnCZzc= text . identifier bool normal 1 1 host boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1076 5 1 function ICcovOIyqnxhSMU6MuEekYg2z+E= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the host portion of the authority as a string, or the empty string if there is no authority. Any percent-escapes in the string are decoded first. heading text Example 1 code assert( url_view( "https://www%2droot.example.com/" ).host() == "www-root.example.com" ); heading text Complexity 1 paragraph text Linear in code text this->host().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPvFuture ) "]" reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host returns text The host address as a string. param text A string token customization token identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 host_address boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1174 5 1 function F0RYzLwUP8ied6l3zmKvomgFHag= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text The value returned by this function depends on the type of host returned from the function reference host_type Nv9Emy6spILLI/mqyIz2uRNBJhU= text . list paragraph text If the type is reference host_type::ipv4 49F64dAiji9HVbP6MxLQiqot7AY= text , then the IPv4 address string is returned. paragraph text If the type is reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= text , then the IPv6 address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::ipvfuture TcYJaTwDFsx+0S2CkvHHARcCqWc= text , then the IPvFuture address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= text , then the host name string is returned. Any percent-escapes in the string are decoded first. paragraph text If the type is reference host_type::none QyoMTu07h232/Sxqovu2mGoPgTo= text , then an empty string is returned. unordered heading text Example 1 code assert( url_view( "https://[1::6:c0a8:1]/" ).host_address() == "1::6:c0a8:1" ); heading text Complexity 1 paragraph text Linear in code text this->host_address().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPvFuture ) "]" reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host returns text The host address as a string. param text A string token customization token identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 host_ipv4_address boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1277 5 1 function KL8F3KYxyzpC1e6fqoJy3B8IHhw= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If the host type is reference host_type::ipv4 49F64dAiji9HVbP6MxLQiqot7AY= text , this function returns the address as a value of type reference ipv4_address /Wpp3ZZDp3kUHzbULeDoaOEhnVs= text . Otherwise, if the host type is not an IPv4 address, it returns a default-constructed value which is equal to the unspecified address "0.0.0.0". heading text Example 1 code assert( url_view( "http://127.0.0.1/index.htm?user=win95" ).host_ipv4_address() == ipv4_address( "127.0.0.1" ) ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code IPv4address = dec-octet "." dec-octet "." dec-octet "." dec-octet dec-octet = DIGIT ; 0-9 / %x31-39 DIGIT ; 10-99 / "1" 2DIGIT ; 100-199 / "2" %x30-34 DIGIT ; 200-249 / "25" %x30-35 ; 250-255 heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host IPv4 address returns text The IPv4 address as a value of type reference ipv4_address /Wpp3ZZDp3kUHzbULeDoaOEhnVs= text . identifier /Wpp3ZZDp3kUHzbULeDoaOEhnVs= ipv4_address normal 1 1 host_ipv6_address boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1325 5 1 function CvoRh2IpWg4QixngVwDjSKoeQVY= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If the host type is reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= text , this function returns the address as a value of type reference ipv6_address dhMSRVBIIIItY0URHSc8rwHcdTQ= text . Otherwise, if the host type is not an IPv6 address, it returns a default-constructed value which is equal to the unspecified address "0:0:0:0:0:0:0:0". heading text Example 1 code assert( url_view( "ftp://[::1]/" ).host_ipv6_address() == ipv6_address( "::1" ) ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code IPv6address = 6( h16 ":" ) ls32 / "::" 5( h16 ":" ) ls32 / [ h16 ] "::" 4( h16 ":" ) ls32 / [ *1( h16 ":" ) h16 ] "::" 3( h16 ":" ) ls32 / [ *2( h16 ":" ) h16 ] "::" 2( h16 ":" ) ls32 / [ *3( h16 ":" ) h16 ] "::" h16 ":" ls32 / [ *4( h16 ":" ) h16 ] "::" ls32 / [ *5( h16 ":" ) h16 ] "::" h16 / [ *6( h16 ":" ) h16 ] "::" ls32 = ( h16 ":" h16 ) / IPv4address ; least-significant 32 bits of address h16 = 1*4HEXDIG ; 16 bits of address represented in hexadecimal heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host IPv6 address returns text The IPv6 address as a value of type reference ipv6_address dhMSRVBIIIItY0URHSc8rwHcdTQ= text . identifier dhMSRVBIIIItY0URHSc8rwHcdTQ= ipv6_address normal 1 1 host_ipvfuture boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1358 5 1 function 55Yh68uToEiKy+IDTpyctuK/T3g= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If the host type is reference host_type::ipvfuture TcYJaTwDFsx+0S2CkvHHARcCqWc= text , this function returns the address as a string. Otherwise, if the host type is not an IPvFuture address, it returns an empty string. heading text Example 1 code assert( url_view( "http://[v1fe.d:9]/index.htm" ).host_ipvfuture() == "v1fe.d:9" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code IPvFuture = "v" 1*HEXDIG "." 1*( unreserved / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host IPvFuture address returns text The IPvFuture address as a string. identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core normal 1 1 host_name boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1395 5 1 function AhPhrC4hmBsZgd/ztqbkAuOkbBM= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If the host type is reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= text , this function returns the name as a string. Otherwise an empty string is returned. Any percent-escapes in the string are decoded first. heading text Example 1 code assert( url_view( "https://www%2droot.example.com/" ).host_name() == "www-root.example.com" ); heading text Complexity 1 paragraph text Linear in code text this->host_name().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPvFuture ) "]" reg-name = *( unreserved / pct-encoded / "-" / ".") heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host name returns text The host name as a string. param text A string token customization. token identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 host_type boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1036 5 1 function Nv9Emy6spILLI/mqyIz2uRNBJhU= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns one of the following constants representing the type of host present. list paragraph reference host_type::ipv4 49F64dAiji9HVbP6MxLQiqot7AY= paragraph reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= paragraph reference host_type::ipvfuture TcYJaTwDFsx+0S2CkvHHARcCqWc= paragraph reference host_type::name HUq75uZ3LBPW3yvUAfpdNzqcfjc= paragraph reference host_type::none QyoMTu07h232/Sxqovu2mGoPgTo= unordered paragraph text When reference has_authority gadV3YsYDjlGX+64Rtiz4S+QD4A= text is false, the host type is reference host_type::none QyoMTu07h232/Sxqovu2mGoPgTo= text . heading text Example 1 code assert( url_view( "https://192.168.0.1/local.htm" ).host_type() == host_type::ipv4 ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text Specification 1 list paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Return the host type returns text The type of host present. identifier YLHFVyAYZGSFQe18DPGjn6XsAMs= host_type identifier dnk5XPfR2OaMpCYaH3cWSxcTdyc= urls normal 1 1 is_path_absolute boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1691 5 1 function eh5BeHbLjL3BuEY7ao3tbEAZnTw= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns true if the path begins with a forward slash ('/'). heading text Example 1 code assert( url_view( "/path/to/file.txt" ).is_path_absolute() ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code path = path-abempty ; begins with "/" or is empty / path-absolute ; begins with "/" but not "//" / path-noscheme ; begins with a non-colon segment / path-rootless ; begins with a segment / path-empty ; zero characters path-abempty = *( "/" segment ) path-absolute = "/" [ segment-nz *( "/" segment ) ] path-noscheme = segment-nz-nc *( "/" segment ) path-rootless = segment-nz *( "/" segment ) path-empty = 0<pchar> heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text Return true if the path is absolute returns code text true text if the path is absolute, code text false text otherwise. see reference encoded_path GNlqbV0MSxGIA/gSjlOb2rfSHhU= text , reference encoded_segments xDk467Vs74WMTJdzZiv8izTuGQo= text . reference path Q5NVO+d/+BmZ5v3/ogNb2XpUTKs= text , reference segments txoybJuonJpAdGVWgiAsiI45+ok= text . identifier bool normal 1 1 params boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2084 5 1 boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2087 5 overloads ZdlRIJ+RVbaF05I+w1pfQzUA0/0= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= brief text Return the query as a container of parameters returns text A bidirectional view of key/value pairs. see reference encoded_params text , reference encoded_query text , reference has_query text , reference query text . normal aUkcvLp4jz3VpXI6WKSgga7G2XE= V3u1IzKjTvUUsoIglN4qUAzgD4k= identifier DzqMpaJX2O25vPFxEN5EDTyU6uw= params_view params boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2084 5 1 function aUkcvLp4jz3VpXI6WKSgga7G2XE= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns a bidirectional view of key/value pairs over the query. The returned view references the same underlying character buffer; ownership is not transferred. Any percent-escapes in strings returned when iterating the view are decoded first. heading text Example 1 code params_view pv = url_view( "/sql?id=42&name=jane%2Ddoe&page+size=20" ).params(); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Return the query as a container of parameters returns text A bidirectional view of key/value pairs. see reference encoded_params YdRpQ6mNNA/rw8PqzTxP08VgNnY= text , reference encoded_query suU4/MiRITTTYf61BFw2aI6WxdI= text , reference has_query SLiWca6gUGmTh+r/BbU40NrICW8= text , reference query 4epyMikskiBx2Gu+S87oAhrM/ZY= text . identifier DzqMpaJX2O25vPFxEN5EDTyU6uw= params_view normal 1 1 params boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2087 5 function V3u1IzKjTvUUsoIglN4qUAzgD4k= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= identifier DzqMpaJX2O25vPFxEN5EDTyU6uw= params_view identifier Bb04pNwExynJkzlY9a9GCeeB13k= encoding_opts opt normal 1 1 password boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 947 5 1 function +ZB55yb2DeVYG+/eYqlMcGcedVE= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If present, this function returns a string representing the password (which may be an empty string). Otherwise it returns an empty string. Any percent-escapes in the string are decoded first. heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).password() == "pass" ); heading text Complexity 1 paragraph text Linear in code text this->password().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code userinfo = user [ ":" [ password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return the password returns text The password as a string. param text The string token to use. token see reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text , reference has_userinfo i/v5Vfq44OnlLbuKgQ2KvgWgZqo= text , reference encoded_password W9oZv0BM5z4XAggQPbNAKIM7/ro= text , reference encoded_user oYwrnXcglhO4tlvhkxLGfFCYbAk= text , reference encoded_userinfo yzkq+uCmbTlXrfDuyd1fT0Zu6xw= text , reference user /oa6wZJEG852J9Yi1LQlnq1n1tM= text , reference userinfo S9yd7MVhXxF+598Xy2/+jwnCZzc= text . identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 path boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1744 5 1 function Q5NVO+d/+BmZ5v3/ogNb2XpUTKs= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the path as a string. The path may be empty. Any percent-escapes in the string are decoded first. heading text Example 1 code assert( url_view( "file:///Program%20Files/Games/config.ini" ).path() == "/Program Files/Games/config.ini" ); heading text Complexity 1 paragraph text Linear in code text this->path().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code path = path-abempty ; begins with "/" or is empty / path-absolute ; begins with "/" but not "//" / path-noscheme ; begins with a non-colon segment / path-rootless ; begins with a segment / path-empty ; zero characters path-abempty = *( "/" segment ) path-absolute = "/" [ segment-nz *( "/" segment ) ] path-noscheme = segment-nz-nc *( "/" segment ) path-rootless = segment-nz *( "/" segment ) path-empty = 0<pchar> heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text Return the path returns text The path as a string. param text A string token to use for the result. token see reference is_path_absolute eh5BeHbLjL3BuEY7ao3tbEAZnTw= text , reference encoded_path GNlqbV0MSxGIA/gSjlOb2rfSHhU= text , reference encoded_segments xDk467Vs74WMTJdzZiv8izTuGQo= text . reference segments txoybJuonJpAdGVWgiAsiI45+ok= text . identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 persist boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 341 5 1 function cRPG1npIXmfYC0K+C+idxOqIc04= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns a read-only copy of the url, with shared lifetime. The returned value owns (persists) the underlying string. The algorithm used to create the value minimizes the number of individual memory allocations, making it more efficient than when using direct standard library functions. heading text Example 1 code std::shared_ptr< url_view const > sp; { std::string s( "http://example.com" ); url_view u( s ); // u references characters in s assert( u.data() == s.data() ); // same buffer sp = u.persist(); assert( sp->data() != s.data() ); // different buffer assert( sp->buffer() == s); // same contents // s is destroyed and thus u // becomes invalid, but sp remains valid. } heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. brief text Return a shared, persistent copy of the url returns text A shared pointer to a read-only url_view. specialization yAZI7i9M7QvpFoRBZvP2RcJBIWs= shared_ptr identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 1 port boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1604 5 1 function OlWcRIIUl1cq5Ab9fLXGPyhYCfI= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If present, this function returns a string representing the port (which may be empty). Otherwise it returns an empty string. heading text Example 1 code assert( url_view( "http://localhost.com:8080" ).port() == "8080" ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code port = *DIGIT heading text Specification 1 list paragraph link text 3.2.3. Port (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.3 unordered brief text Return the port returns text The port as a string. see reference encoded_host_and_port 9ptIMbwWSNtVv+KAUpHCO3bmTWg= text , reference has_port 5V5uOhRsy00O+TSEAkIb7uFoN2U= text , reference port_number lctXu8FITJWg0+Y+yZVt5iv7QDM= text . identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core normal 1 1 port_number boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1640 5 1 function lctXu8FITJWg0+Y+yZVt5iv7QDM= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If a port is present and the numerical value is representable, it is returned as an unsigned integer. Otherwise, the number zero is returned. heading text Example 1 code assert( url_view( "http://localhost.com:8080" ).port_number() == 8080 ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code port = *DIGIT heading text Specification 1 list paragraph link text 3.2.3. Port (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.3 unordered brief text Return the port returns text The port number as an unsigned integer. see reference encoded_host_and_port 9ptIMbwWSNtVv+KAUpHCO3bmTWg= text , reference has_port 5V5uOhRsy00O+TSEAkIb7uFoN2U= text , reference port OlWcRIIUl1cq5Ab9fLXGPyhYCfI= text . identifier Qvo2fOST20EZC7bSOAFZr+u3ITg= uint16_t normal 1 1 query boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1987 5 1 function 4epyMikskiBx2Gu+S87oAhrM/ZY= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If this contains a query, it is returned as a string (which may be empty). Otherwise, an empty string is returned. Any percent-escapes in the string are decoded first. paragraph text Literal plus signs remain unchanged by default to match RFC 3986. To treat '+' as a space, supply decoding options with code text space_as_plus = true text when calling this function. heading text Example 1 code assert( url_view( "/sql?id=42&name=jane%2Ddoe&page+size=20" ).query() == "id=42&name=jane-doe&page size=20" ); heading text Complexity 1 paragraph text Linear in code text this->query().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code query = *( pchar / "/" / "?" ) query-param = key [ "=" value ] query-params = [ query-param ] *( "&" query-param ) heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 paragraph link text Query string (Wikipedia) https://en.wikipedia.org/wiki/Query_string unordered brief text Return the query returns text The query as a string. param text A token to use for the returned string. token see reference encoded_params YdRpQ6mNNA/rw8PqzTxP08VgNnY= text , reference encoded_query suU4/MiRITTTYf61BFw2aI6WxdI= text , reference has_query SLiWca6gUGmTh+r/BbU40NrICW8= text , reference params ZdlRIJ+RVbaF05I+w1pfQzUA0/0= text . identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 scheme boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 421 5 1 function 43fxogaC5oVqfauhwXyN4s4ibEM= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the scheme if it exists, without a trailing colon (':'). Otherwise it returns an empty string. Note that schemes are case-insensitive, and the canonical form is lowercased. heading text Example 1 code assert( url_view( "http://www.example.com" ).scheme() == "http" ); heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code scheme = ALPHA *( ALPHA / DIGIT / "+" / "-" / "." ) URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] absolute-URI = scheme ":" hier-part [ "?" query ] heading text Specification 1 list paragraph link text 3.1. Scheme (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.1 unordered brief text Return the scheme returns text The scheme as a string. see reference has_scheme iwSH2fvVkb89TkZj7KWLGSyc4sA= text , reference scheme_id uM37WpBqetqzfHjns3M8/+CcoEU= text . identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core normal 1 1 scheme_id boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 471 5 1 function uM37WpBqetqzfHjns3M8/+CcoEU= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns a value which depends on the scheme in the url: list paragraph text If the scheme is a well-known scheme, corresponding value from the enumeration reference urls::scheme P7uOjuAMILimKGOcbjDUSpMAL/U= text is returned. paragraph text If a scheme is present but is not a well-known scheme, the value returned is reference urls::scheme::unknown LJxTyQ55ot1WYLH7f46nZvdGU78= text . paragraph text Otherwise, if the scheme is absent the value returned is reference urls::scheme::none VupiauVBXlZQ8Uix+vk8kSl+fM8= text . unordered heading text Example 1 code assert( url_view( "wss://www.example.com/crypto.cgi" ).scheme_id() == scheme::wss ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] absolute-URI = scheme ":" hier-part [ "?" query ] scheme = ALPHA *( ALPHA / DIGIT / "+" / "-" / "." ) heading text Specification 1 list paragraph link text 3.1. Scheme (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.1 unordered brief text Return the scheme returns text The scheme as an enumeration value. see reference has_scheme iwSH2fvVkb89TkZj7KWLGSyc4sA= text , reference scheme 43fxogaC5oVqfauhwXyN4s4ibEM= text . identifier P7uOjuAMILimKGOcbjDUSpMAL/U= scheme identifier dnk5XPfR2OaMpCYaH3cWSxcTdyc= urls normal 1 1 segments boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1840 5 1 function txoybJuonJpAdGVWgiAsiI45+ok= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns a bidirectional view of strings over the path. The returned view references the same underlying character buffer; ownership is not transferred. Any percent-escapes in strings returned when iterating the view are decoded first. heading text Example 1 code segments_view sv = url_view( "/path/to/file.txt" ).segments(); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. heading text BNF 1 code path = [ "/" ] segment *( "/" segment ) heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text Return the path as a container of segments returns text A bidirectional view of segments. see reference is_path_absolute eh5BeHbLjL3BuEY7ao3tbEAZnTw= text , reference encoded_path GNlqbV0MSxGIA/gSjlOb2rfSHhU= text , reference encoded_segments xDk467Vs74WMTJdzZiv8izTuGQo= text . reference path Q5NVO+d/+BmZ5v3/ogNb2XpUTKs= text , reference segments_view ZNJOLZ4RhCB2A2ooiNo7KxZJHrA= text . identifier ZNJOLZ4RhCB2A2ooiNo7KxZJHrA= segments_view normal 1 1 size boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 201 5 1 function b5EwiMBFGrk0/BIGaiumuCVSoFM= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function returns the number of characters in the url's encoded string, not including any null terminator, if present. heading text Example 1 code assert( url_view( "file:///Program%20Files" ).size() == 23 ); heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the number of characters in the url returns text The number of characters in the url. identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 1 user boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 848 5 1 function /oa6wZJEG852J9Yi1LQlnq1n1tM= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If present, this function returns a string representing the user (which may be empty). Otherwise it returns an empty string. Any percent-escapes in the string are decoded first. heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).user() == "jane-doe" ); heading text Complexity 1 paragraph text Linear in code text this->user().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code userinfo = user [ ":" [ password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return the user returns text The user as a string. param text The string token to use. token see reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text , reference has_userinfo i/v5Vfq44OnlLbuKgQ2KvgWgZqo= text , reference encoded_password W9oZv0BM5z4XAggQPbNAKIM7/ro= text , reference encoded_user oYwrnXcglhO4tlvhkxLGfFCYbAk= text , reference encoded_userinfo yzkq+uCmbTlXrfDuyd1fT0Zu6xw= text , reference password +ZB55yb2DeVYG+/eYqlMcGcedVE= text , reference userinfo S9yd7MVhXxF+598Xy2/+jwnCZzc= text . identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 userinfo boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 748 5 1 function S9yd7MVhXxF+598Xy2/+jwnCZzc= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If present, this function returns a string representing the userinfo (which may be empty). Otherwise it returns an empty string. Any percent-escapes in the string are decoded first. admonition paragraph text This function uses the string token return type customization. Depending on the token passed, the return type and behavior of the function can be different. See reference string_token::return_string +eBzDECNPyuTkJuxLUTMVIkHGO0= text for more information. note heading text Example 1 code assert( url_view( "http://jane%2Ddoe:pass@example.com" ).userinfo() == "jane-doe:pass" ); heading text Complexity 1 paragraph text Linear in code text this->userinfo().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code userinfo = user [ ":" [ password ] ] authority = [ userinfo "@" ] host [ ":" port ] heading text Specification 1 list paragraph link text 3.2.1. User Information (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1 unordered brief text Return the userinfo returns text When called with no arguments, a value of type code text std::string text is returned. Otherwise, the return type and meaning depends on the string token passed to the function. returns text The userinfo as a string. param text The string token to use. token see reference has_password 9JACnsebk8tFsoryabfDxE8VpnA= text , reference has_userinfo i/v5Vfq44OnlLbuKgQ2KvgWgZqo= text , reference encoded_password W9oZv0BM5z4XAggQPbNAKIM7/ro= text , reference encoded_user oYwrnXcglhO4tlvhkxLGfFCYbAk= text , reference encoded_userinfo yzkq+uCmbTlXrfDuyd1fT0Zu6xw= text , reference password +ZB55yb2DeVYG+/eYqlMcGcedVE= text , reference user /oa6wZJEG852J9Yi1LQlnq1n1tM= text . identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 zone_id boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1480 5 1 function rN6p9/aLARL9S9gn02k+M+j21q8= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text If the host type is reference host_type::ipv6 jTh/N5N+Bz51cZo2Mwmh6tzxPOc= text , this function returns the Zone ID as a string. Otherwise an empty string is returned. Any percent-escapes in the string are decoded first. heading text Example 1 code assert( url_view( "http://[fe80::1%25eth0]/" ).zone_id() == "eth0" ); heading text Complexity 1 paragraph text Linear in code text this->encoded_zone_id().size() text . heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text BNF 1 code host = IP-literal / IPv4address / reg-name IP-literal = "[" ( IPv6address / IPv6addrz / IPvFuture ) "]" ZoneID = 1*( unreserved / pct-encoded ) IPv6addrz = IPv6address "%25" ZoneID heading text Specification 1 list paragraph link text Representing IPv6 Zone Identifiers in Address Literals and Uniform Resource Identifiers https://datatracker.ietf.org/doc/html/rfc6874 unordered brief text Return the IPv6 Zone ID returns text The Zone ID as a string. param text A string token customization. token identifier result_type identifier StringToken identifier StringToken token {} normal 1 1 operator basic_string_view<char> boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 299 5 1 function 0JOtXYOmKvCl2dNIZYV6J7flgJE= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the URL as a core::string_view returns text A string view of the URL. identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core conversion 1 1 max_size boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 173 5 1 function mg8FRYZ94og9lKYjTEYdjucqHw4= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This represents the largest number of characters that are theoretically possible to represent in a url, not including any null terminator. In practice the actual possible size may be lower than this number. heading text Complexity 1 paragraph text Constant. heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the maximum number of characters possible returns text The maximum number of characters. identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std normal 1 digest boost/url/impl/url_view_base.hpp include/boost/url/impl/url_view_base.hpp 81 1 boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 146 5 1 function aSDB3babl7TsiU0T+gdHMM/NC5c= regular UEVNhDEjkZMXfjN1DxbtX0n2rCg= paragraph text This function calculates a hash of the url as if it were always normalized. heading text Complexity 1 paragraph text Linear in code text this->size() text . heading text Exception Safety 1 paragraph text Throws nothing. brief text Calculate a hash of the url returns text A hash value suitable for use in hash-based containers. param text An initial value to add to the hash salt identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std salt 0 normal 1 1 error boost/url/error.hpp include/boost/url/error.hpp 22 1 1 enum 0CIF+QeihUmkg/SM/JmNHthVUUc= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= brief text Error codes returned the library 1 identifier int S78C0hJzEkT4nSltCBLafTAq6+Q= sAQ6ltLKCd2RVUTyS3bIBWMnWEw= jxp4eZ+qInaZo038XQyMf0vyv4s= LDuXVizApX0QRaohMHxF3T5Z7Z0= o+k4/5uZDm7wAIoZrwqQIpA9bTA= qUh3tTyr9Byv5NZxujjrZ9LKDQ0= X94qcYTTQmA8e36ujC1IwCRUQaQ= Q9+GxgxVPBEJSy9NNuR09HPwdjY= 7xVhcfBF1rACJbe3gKTKCTfQc9o= success boost/url/error.hpp include/boost/url/error.hpp 30 5 1 enum-constant S78C0hJzEkT4nSltCBLafTAq6+Q= regular 0CIF+QeihUmkg/SM/JmNHthVUUc= brief text The operation completed successfully. 0 illegal_null boost/url/error.hpp include/boost/url/error.hpp 35 5 1 enum-constant sAQ6ltLKCd2RVUTyS3bIBWMnWEw= regular 0CIF+QeihUmkg/SM/JmNHthVUUc= brief text Null encountered in pct-encoded. illegal_reserved_char boost/url/error.hpp include/boost/url/error.hpp 40 5 1 enum-constant jxp4eZ+qInaZo038XQyMf0vyv4s= regular 0CIF+QeihUmkg/SM/JmNHthVUUc= brief text Illegal reserved character in encoded string. non_canonical boost/url/error.hpp include/boost/url/error.hpp 45 5 1 enum-constant LDuXVizApX0QRaohMHxF3T5Z7Z0= regular 0CIF+QeihUmkg/SM/JmNHthVUUc= brief text A grammar element was not in canonical form. bad_pct_hexdig boost/url/error.hpp include/boost/url/error.hpp 54 5 1 enum-constant o+k4/5uZDm7wAIoZrwqQIpA9bTA= regular 0CIF+QeihUmkg/SM/JmNHthVUUc= paragraph text This error condition is fatal. brief text Bad hexadecimal digit. incomplete_encoding boost/url/error.hpp include/boost/url/error.hpp 61 5 1 enum-constant qUh3tTyr9Byv5NZxujjrZ9LKDQ0= regular 0CIF+QeihUmkg/SM/JmNHthVUUc= paragraph text This error condition is fatal. brief text The percent-encoded sequence is incomplete. missing_pct_hexdig boost/url/error.hpp include/boost/url/error.hpp 68 5 1 enum-constant X94qcYTTQmA8e36ujC1IwCRUQaQ= regular 0CIF+QeihUmkg/SM/JmNHthVUUc= paragraph text This error condition is fatal. brief text Missing hexadecimal digit. no_space boost/url/error.hpp include/boost/url/error.hpp 77 5 1 enum-constant Q9+GxgxVPBEJSy9NNuR09HPwdjY= regular 0CIF+QeihUmkg/SM/JmNHthVUUc= paragraph text This error is returned when a provided output buffer was too small to hold the complete result of an algorithm. brief text No space in output buffer not_a_base boost/url/error.hpp include/boost/url/error.hpp 82 5 1 enum-constant 7xVhcfBF1rACJbe3gKTKCTfQc9o= regular 0CIF+QeihUmkg/SM/JmNHthVUUc= brief text The URL is not a base URL host_type boost/url/host_type.hpp include/boost/url/host_type.hpp 24 1 1 enum YLHFVyAYZGSFQe18DPGjn6XsAMs= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text Values of this type are returned by URL views and containers to indicate the type of host present in a URL. brief text Identifies the type of host in a URL. 1 identifier int QyoMTu07h232/Sxqovu2mGoPgTo= HUq75uZ3LBPW3yvUAfpdNzqcfjc= 49F64dAiji9HVbP6MxLQiqot7AY= jTh/N5N+Bz51cZo2Mwmh6tzxPOc= TcYJaTwDFsx+0S2CkvHHARcCqWc= none boost/url/host_type.hpp include/boost/url/host_type.hpp 32 5 1 enum-constant QyoMTu07h232/Sxqovu2mGoPgTo= regular YLHFVyAYZGSFQe18DPGjn6XsAMs= brief text No host is specified. name boost/url/host_type.hpp include/boost/url/host_type.hpp 37 5 1 enum-constant HUq75uZ3LBPW3yvUAfpdNzqcfjc= regular YLHFVyAYZGSFQe18DPGjn6XsAMs= brief text A host is specified by reg-name. ipv4 boost/url/host_type.hpp include/boost/url/host_type.hpp 42 5 1 enum-constant 49F64dAiji9HVbP6MxLQiqot7AY= regular YLHFVyAYZGSFQe18DPGjn6XsAMs= brief text A host is specified by reference ipv4_address /Wpp3ZZDp3kUHzbULeDoaOEhnVs= text . ipv6 boost/url/host_type.hpp include/boost/url/host_type.hpp 47 5 1 enum-constant jTh/N5N+Bz51cZo2Mwmh6tzxPOc= regular YLHFVyAYZGSFQe18DPGjn6XsAMs= brief text A host is specified by reference ipv6_address dhMSRVBIIIItY0URHSc8rwHcdTQ= text . ipvfuture boost/url/host_type.hpp include/boost/url/host_type.hpp 52 5 1 enum-constant TcYJaTwDFsx+0S2CkvHHARcCqWc= regular YLHFVyAYZGSFQe18DPGjn6XsAMs= brief text A host is specified by IPvFuture. scheme boost/url/scheme.hpp include/boost/url/scheme.hpp 34 1 1 enum P7uOjuAMILimKGOcbjDUSpMAL/U= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= heading text Specification 1 list paragraph link text 3.1. Scheme (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.1 unordered brief text Identifies a known URL scheme reference default_port 0hWNSMZWo7QSp/muF+6J2s3jsLA= reference string_to_scheme ViRFbAhqyfzry2qMQUxKJSvsEQU= reference to_string bWzp24u26R/CcIVKOEeAZxMwSG4= 1 identifier unsigned short VupiauVBXlZQ8Uix+vk8kSl+fM8= LJxTyQ55ot1WYLH7f46nZvdGU78= d8ubP8DxtHLPeCxOxFoziqGWz9o= u8zbBY+jioTYeE8MzAi9S7L7smU= /I4c+UqzLCwTbgp49iEtHVWFSWI= KEmCYq306TIiGIOzHXbK0/jECDM= Kv7F3ajld9rhGt3jt2+KM7KcXo0= MoEJAAjP0vroIo1/vRGApCagYjI= none boost/url/scheme.hpp include/boost/url/scheme.hpp 38 5 1 enum-constant VupiauVBXlZQ8Uix+vk8kSl+fM8= regular P7uOjuAMILimKGOcbjDUSpMAL/U= brief text Indicates that no scheme is present 0 unknown boost/url/scheme.hpp include/boost/url/scheme.hpp 42 5 1 enum-constant LJxTyQ55ot1WYLH7f46nZvdGU78= regular P7uOjuAMILimKGOcbjDUSpMAL/U= brief text Indicates the scheme is not a well-known scheme ftp boost/url/scheme.hpp include/boost/url/scheme.hpp 56 5 1 enum-constant d8ubP8DxtHLPeCxOxFoziqGWz9o= regular P7uOjuAMILimKGOcbjDUSpMAL/U= paragraph text FTP is a standard communication protocol used for the transfer of computer files from a server to a client on a computer network. heading text Specification 1 list paragraph link text The 'ftp' URI Scheme https://datatracker.ietf.org/doc/html/draft-yevstifeyev-ftp-uri-scheme unordered brief text File Transfer Protocol (FTP) file boost/url/scheme.hpp include/boost/url/scheme.hpp 69 5 1 enum-constant u8zbBY+jioTYeE8MzAi9S7L7smU= regular P7uOjuAMILimKGOcbjDUSpMAL/U= paragraph text The File URI Scheme is typically used to retrieve files from within one's own computer. heading text Specification 1 list paragraph link text The "file" URI Scheme (rfc8089) https://datatracker.ietf.org/doc/html/rfc8089 unordered brief text File URI Scheme http boost/url/scheme.hpp include/boost/url/scheme.hpp 81 5 1 enum-constant /I4c+UqzLCwTbgp49iEtHVWFSWI= regular P7uOjuAMILimKGOcbjDUSpMAL/U= paragraph text URLs of this type indicate a resource which is interacted with using the HTTP protocol. heading text Specification 1 list paragraph link text Hypertext Transfer Protocol (HTTP/1.1) (rfc7230) https://datatracker.ietf.org/doc/html/rfc7230 unordered brief text The Hypertext Transfer Protocol URI Scheme https boost/url/scheme.hpp include/boost/url/scheme.hpp 94 5 1 enum-constant KEmCYq306TIiGIOzHXbK0/jECDM= regular P7uOjuAMILimKGOcbjDUSpMAL/U= paragraph text URLs of this type indicate a resource which is interacted with using the Secure HTTP protocol. heading text Specification 1 list paragraph link text Hypertext Transfer Protocol (HTTP/1.1) (rfc7230) https://datatracker.ietf.org/doc/html/rfc7230 unordered brief text The Secure Hypertext Transfer Protocol URI Scheme ws boost/url/scheme.hpp include/boost/url/scheme.hpp 106 5 1 enum-constant Kv7F3ajld9rhGt3jt2+KM7KcXo0= regular P7uOjuAMILimKGOcbjDUSpMAL/U= paragraph text URLs of this type indicate a resource which is interacted with using the WebSocket protocol. heading text Specification 1 list paragraph link text The WebSocket Protocol (rfc6455) https://datatracker.ietf.org/doc/html/rfc6455 unordered brief text The WebSocket URI Scheme wss boost/url/scheme.hpp include/boost/url/scheme.hpp 119 5 1 enum-constant MoEJAAjP0vroIo1/vRGApCagYjI= regular P7uOjuAMILimKGOcbjDUSpMAL/U= paragraph text URLs of this type indicate a resource which is interacted with using the Secure WebSocket protocol. heading text Specification 1 list paragraph link text The WebSocket Protocol (rfc6455) https://datatracker.ietf.org/doc/html/rfc6455 unordered brief text The Secure WebSocket URI Scheme arg boost/url/format.hpp include/boost/url/format.hpp 476 1 1 function IQym8fO7DIG67s+M2rtFQszkoaY= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text Construct a named argument for a format URL string that contains named replacement fields. paragraph text The function parameters should be convertible to an implementation defined type able to store the name and a reference to any type potentially used as a format argument. heading text Example 1 code assert(format( "https://example.com/~{username}", arg("username", "mark") ).buffer() == "https://example.com/~mark"); brief text Designate a named argument for a replacement field returns text A temporary object with reference semantics for a named argument param text The format argument name name param text The format argument value arg see reference format ZTww0Dx20RT0z0QTruz8U8gZuIY= text , reference format_to FNXbTBfIxbiM2pjYEryMCZH+yoY= text . specialization HO2ZXp4PSbe153fApaGEDkq0ks0= named_arg identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core name 1 identifier T arg normal decode boost/url/decode.hpp include/boost/url/decode.hpp 100 1 1 boost/url/decode.hpp include/boost/url/decode.hpp 146 1 1 overloads EWBg+x5e110QbcM7IDtIDwumEw0= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= brief code text decode text overloads returns text A result containing the decoded string in the format described by the passed string token. returns text The number of characters written to the destination buffer, or an error. param text The string to decode. s param text The decoding options. If omitted, the default options are used. opt param text A string token. token param text The destination buffer to write to. dest param text The number of writable characters pointed to by code text dest text . If this is less than the decoded size, the result is truncated. size see reference decode f6SMJY0utW4jjzEEem/onyA+8JQ= text , reference decoded_size /AThCMbL32Ow06PKJyfrPXN/Yxg= text , reference encoding_opts Bb04pNwExynJkzlY9a9GCeeB13k= text , reference string_token::return_string +eBzDECNPyuTkJuxLUTMVIkHGO0= text . see reference decoded_size /AThCMbL32Ow06PKJyfrPXN/Yxg= text , reference encoding_opts Bb04pNwExynJkzlY9a9GCeeB13k= text , reference make_pct_string_view mgIS/AfQlcgKNFKOdLRtjihgyFk= text . normal f6SMJY0utW4jjzEEem/onyA+8JQ= N4ajMeeDngO5adJblho20S1BvW4= decode boost/url/decode.hpp include/boost/url/decode.hpp 146 1 1 function f6SMJY0utW4jjzEEem/onyA+8JQ= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text This function percent-decodes the specified string and returns the result using any reference string_token MOmWJXtSzgLTSr4XFeqs4WKGaYg= text . The string is validated before decoding; malformed escapes cause the returned result to hold an error. heading text Example 1 code auto plain = decode( "My%20Stuff" ); assert( plain && *plain == "My Stuff" ); heading text Exception Safety 1 paragraph text Calls to allocate may throw. Validation errors are reported in the returned result. heading text Specification 1 list paragraph link text 2.1. Percent-Encoding (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-2.1 unordered brief text Return a percent-decoded string returns text A result containing the decoded string in the format described by the passed string token. param text The string to decode. s param text The decoding options. If omitted, the default options are used. opt param text A string token. token see reference decode EWBg+x5e110QbcM7IDtIDwumEw0= text , reference decoded_size /AThCMbL32Ow06PKJyfrPXN/Yxg= text , reference encoding_opts Bb04pNwExynJkzlY9a9GCeeB13k= text , reference string_token::return_string +eBzDECNPyuTkJuxLUTMVIkHGO0= text . specialization O+YzwnquzbCEPErxi2iuhXKphsk= result identifier LWQB+dn+7lsRKPzx/twz66ZcOWI= system identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s identifier Bb04pNwExynJkzlY9a9GCeeB13k= encoding_opts opt {} identifier StringToken token {} normal decode boost/url/decode.hpp include/boost/url/decode.hpp 100 1 1 function N4ajMeeDngO5adJblho20S1BvW4= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text This function percent-decodes the specified string into the destination buffer provided by the caller. The input is validated first; malformed escapes cause the returned result to hold an error instead of a size. If the buffer is too small, the output is truncated and the number of bytes actually written is returned. heading text Example 1 code char buf[100]; auto n = decode( buf, sizeof(buf), "Program%20Files" ); assert( n && *n == 13 ); heading text Exception Safety 1 paragraph text Throws nothing. Validation errors are reported in the returned result. heading text Specification 1 list paragraph link text 2.1. Percent-Encoding (rfc3986) https://datatracker.ietf.org/dodc/html/rfc3986#section-2.1 unordered brief text Apply percent-decoding to an arbitrary string returns text The number of characters written to the destination buffer, or an error. param text The destination buffer to write to. dest param text The number of writable characters pointed to by code text dest text . If this is less than the decoded size, the result is truncated. size param text The string to decode. s param text The decoding options. If omitted, the default options are used. opt see reference decoded_size /AThCMbL32Ow06PKJyfrPXN/Yxg= text , reference encoding_opts Bb04pNwExynJkzlY9a9GCeeB13k= text , reference make_pct_string_view mgIS/AfQlcgKNFKOdLRtjihgyFk= text . specialization O+YzwnquzbCEPErxi2iuhXKphsk= result identifier LWQB+dn+7lsRKPzx/twz66ZcOWI= system identifier char dest identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std size identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s identifier Bb04pNwExynJkzlY9a9GCeeB13k= encoding_opts opt {} normal decoded_size boost/url/decode.hpp include/boost/url/decode.hpp 54 1 1 function /AThCMbL32Ow06PKJyfrPXN/Yxg= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text This function returns the exact number of bytes needed to store the decoded form of the specified string using the given options. The string is validated before the size is computed; malformed escapes cause the returned result to contain an error instead. heading text Example 1 code auto n = decoded_size( "My%20Stuff" ); assert( n && *n == 8 ); heading text Exception Safety 1 paragraph text Throws nothing. Validation errors are reported in the returned result. heading text Specification 1 list paragraph link text 2.1. Percent-Encoding (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-2.1 unordered brief text Return the buffer size needed for percent-decoding returns text A result containing the decoded size, excluding any null terminator. param text The string to measure. s see reference decode EWBg+x5e110QbcM7IDtIDwumEw0= text , reference encoding_opts Bb04pNwExynJkzlY9a9GCeeB13k= text , reference make_pct_string_view mgIS/AfQlcgKNFKOdLRtjihgyFk= text . specialization O+YzwnquzbCEPErxi2iuhXKphsk= result identifier LWQB+dn+7lsRKPzx/twz66ZcOWI= system identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal default_port boost/url/scheme.hpp include/boost/url/scheme.hpp 173 1 1 function 0hWNSMZWo7QSp/muF+6J2s3jsLA= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text This function returns the default port for the known schemes. If the value does not represent a known scheme or the scheme does not represent a protocol, the function returns zero. paragraph text The following ports are returned by the function: list paragraph reference scheme::ftp d8ubP8DxtHLPeCxOxFoziqGWz9o= text = 21 paragraph reference scheme::http /I4c+UqzLCwTbgp49iEtHVWFSWI= text , reference scheme::ws Kv7F3ajld9rhGt3jt2+KM7KcXo0= text = 80 paragraph reference scheme::https KEmCYq306TIiGIOzHXbK0/jECDM= text , reference scheme::wss MoEJAAjP0vroIo1/vRGApCagYjI= text = 443 unordered brief text Return the default port for a known scheme returns text An integer with the default port number param text The known scheme constant s reference scheme P7uOjuAMILimKGOcbjDUSpMAL/U= identifier Qvo2fOST20EZC7bSOAFZr+u3ITg= uint16_t identifier P7uOjuAMILimKGOcbjDUSpMAL/U= scheme s normal encode boost/url/encode.hpp include/boost/url/encode.hpp 119 1 1 boost/url/encode.hpp include/boost/url/encode.hpp 180 1 1 overloads 09aIpdxxNNYbVZSULaBGficRxZ4= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= brief code text encode text overloads returns text The string returns text The number of characters written to the destination buffer. param text The string to encode. s param text The set of characters that is not percent-encoded. allowed param text The options for encoding. If this parameter is omitted, the default options are used. opt param text A string token. token param text The destination buffer to write to. dest param text The number of writable characters pointed to by code text dest text . If this is less than code text encoded_size(s) text , the result is truncated. size see reference encode QFVACvvXYpvLaEockXLrw3Ob91A= text , reference encoded_size Xq8kBc9a/F5Bpmn1q4OszstzJ4g= text , reference encoding_opts Bb04pNwExynJkzlY9a9GCeeB13k= text , see reference encode QFVACvvXYpvLaEockXLrw3Ob91A= text , reference encoded_size Xq8kBc9a/F5Bpmn1q4OszstzJ4g= text , reference make_pct_string_view mgIS/AfQlcgKNFKOdLRtjihgyFk= text . normal QFVACvvXYpvLaEockXLrw3Ob91A= mv6LvkkTac7FhXwK+aU779HMEVw= encode boost/url/encode.hpp include/boost/url/encode.hpp 180 1 1 function QFVACvvXYpvLaEockXLrw3Ob91A= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text This function applies percent-encoding to the string using the given options and character set, and returns the result as a string when called with default arguments. heading text Example 1 code encoding_opts opt; opt.space_as_plus = true; std::string s = encode( "My Stuff", opt, pchars ); assert( s == "My+Stuff" ); heading text Exception Safety 1 paragraph text Calls to allocate may throw. heading text Specification 1 list paragraph link text 2.1. Percent-Encoding (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-2.1 unordered brief text Return a percent-encoded string returns text The string param text The string to encode. s param text The set of characters that is not percent-encoded. allowed param text The options for encoding. If this parameter is omitted, the default options are used. opt param text A string token. token see reference encode 09aIpdxxNNYbVZSULaBGficRxZ4= text , reference encoded_size Xq8kBc9a/F5Bpmn1q4OszstzJ4g= text , reference encoding_opts Bb04pNwExynJkzlY9a9GCeeB13k= text , identifier result_type identifier StringToken identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s 1 identifier CS allowed identifier Bb04pNwExynJkzlY9a9GCeeB13k= encoding_opts opt {} identifier StringToken token {} normal encode boost/url/encode.hpp include/boost/url/encode.hpp 119 1 1 function mv6LvkkTac7FhXwK+aU779HMEVw= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text This function applies percent-encoding to the string using the given options and character set. The destination buffer provided by the caller is used to store the result, which may be truncated if there is insufficient space. heading text Example 1 code char buf[100]; assert( encode( buf, sizeof(buf), "Program Files", pchars ) == 15 ); heading text Exception Safety 1 paragraph text Throws nothing. heading text Specification 1 list paragraph link text 2.1. Percent-Encoding (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-2.1 unordered brief text Apply percent-encoding to a string returns text The number of characters written to the destination buffer. param text The destination buffer to write to. dest param text The number of writable characters pointed to by code text dest text . If this is less than code text encoded_size(s) text , the result is truncated. size param text The string to encode. s param text The set of characters that is not percent-encoded. allowed param text The options for encoding. If this parameter is omitted, the default options are used. opt see reference encode 09aIpdxxNNYbVZSULaBGficRxZ4= text , reference encoded_size Xq8kBc9a/F5Bpmn1q4OszstzJ4g= text , reference make_pct_string_view mgIS/AfQlcgKNFKOdLRtjihgyFk= text . identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std identifier char dest identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std size identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s 1 identifier CS allowed identifier Bb04pNwExynJkzlY9a9GCeeB13k= encoding_opts opt {} normal encode_unsafe boost/url/encode.hpp include/boost/url/encode.hpp 128 1 function ydZ7bTykSMnwehDU9NtjTjWeB+I= implementation-defined dnk5XPfR2OaMpCYaH3cWSxcTdyc= identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std identifier char dest identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std size identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s 1 identifier CS allowed identifier Bb04pNwExynJkzlY9a9GCeeB13k= encoding_opts opt normal encoded_size boost/url/encode.hpp include/boost/url/encode.hpp 63 1 1 function Xq8kBc9a/F5Bpmn1q4OszstzJ4g= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text This function returns the exact number of bytes necessary to store the result of applying percent-encoding to the string using the given options and character set. No encoding is actually performed. heading text Example 1 code assert( encoded_size( "My Stuff", pchars ) == 10 ); heading text Exception Safety 1 paragraph text Throws nothing. heading text Specification 1 list paragraph link text 2.1. Percent-Encoding (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-2.1 unordered brief text Return the buffer size needed for percent-encoding returns text The number of bytes needed, excluding any null terminator. param text The string to measure. s param text The set of characters that is not percent-encoded. allowed param text The options for encoding. If this parameter is omitted, the default options are be used. opt see reference encode 09aIpdxxNNYbVZSULaBGficRxZ4= text , reference encoding_opts Bb04pNwExynJkzlY9a9GCeeB13k= text , reference make_pct_string_view mgIS/AfQlcgKNFKOdLRtjihgyFk= text . identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s 1 identifier CS allowed identifier Bb04pNwExynJkzlY9a9GCeeB13k= encoding_opts opt {} normal format boost/url/format.hpp include/boost/url/format.hpp 159 1 1 overloads ZTww0Dx20RT0z0QTruz8U8gZuIY= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= brief text Format arguments into a URL returns text A URL holding the formatted result. param text The format URL string. fmt param text Arguments to be formatted. args throws code text fmt text contains an invalid format string and the result contains an invalid URL after replacements are applied. reference system_error see reference format_to FNXbTBfIxbiM2pjYEryMCZH+yoY= text . see reference format_to FNXbTBfIxbiM2pjYEryMCZH+yoY= text , reference arg IQym8fO7DIG67s+M2rtFQszkoaY= text . normal LG7Qu14WVkSnLUAFX5+XlzESQwE= WRjsPLk/mxfEVUX/NFq2baquRAU= identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url format boost/url/format.hpp include/boost/url/format.hpp 338 1 1 function LG7Qu14WVkSnLUAFX5+XlzESQwE= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text Format arguments according to the format URL string into a reference url B4dRaSXMG3fDmuNKMW3KOeRu6kA= text . paragraph text This overload allows type-erased arguments to be passed as an initializer_list, which is mostly convenient for named parameters. paragraph text All arguments must be convertible to a implementation defined type able to store a type-erased reference to any valid format argument. paragraph text The rules for a format URL string are the same as for a code text std::format_string text , where replacement fields are delimited by curly braces. paragraph text The URL components to which replacement fields belong are identified before replacement is applied and any invalid characters for that formatted argument are percent-escaped. paragraph text Hence, the delimiters between URL components, such as code text : text , code text // text , code text ? text , and code text # text , should be included in the URL format string. Likewise, a format string with a single code text "{}" text is interpreted as a path and any replacement characters invalid in this component will be encoded to form a valid URL. heading text Example 1 code assert(format( "{scheme}://{host}:{port}/{dir}/{file}", {{"scheme", "https"}, {"port", 80}, {"host", "example.com"}, {"dir", "path/to"}, {"file", "file.txt"}} ).buffer() == "https://example.com:80/path/to/file.txt"); heading text Preconditions 1 paragraph text All replacement fields must be valid and the resulting URL should be valid after arguments are formatted into the URL. paragraph text Because any invalid characters for a URL component are encoded by this function, only replacements in the scheme and port components might be invalid, as these components do not allow percent-encoding of arbitrary characters. heading text BNF 1 code replacement_field ::= "{" [arg_id] [":" (format_spec | chrono_format_spec)] "}" arg_id ::= integer | identifier integer ::= digit+ digit ::= "0"..."9" identifier ::= id_start id_continue* id_start ::= "a"..."z" | "A"..."Z" | "_" id_continue ::= id_start | digit heading text Specification 1 list paragraph link text Format String Syntax https://fmt.dev/latest/syntax.html unordered brief text Format arguments into a URL returns text A URL holding the formatted result. param text The format URL string. fmt param text Arguments to be formatted. args throws code text fmt text contains an invalid format string and the result contains an invalid URL after replacements are applied. reference system_error see reference format_to FNXbTBfIxbiM2pjYEryMCZH+yoY= text . reference url B4dRaSXMG3fDmuNKMW3KOeRu6kA= identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core fmt specialization 3tT5Y8vozttMWXrA/fNw4NcDYTE= initializer_list identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std args normal format boost/url/format.hpp include/boost/url/format.hpp 159 1 1 function WRjsPLk/mxfEVUX/NFq2baquRAU= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text Format arguments according to the format URL string into a reference url B4dRaSXMG3fDmuNKMW3KOeRu6kA= text . paragraph text The rules for a format URL string are the same as for a code text std::format_string text , where replacement fields are delimited by curly braces. paragraph text The URL components to which replacement fields belong are identified before replacement is applied and any invalid characters for that formatted argument are percent-escaped. paragraph text Hence, the delimiters between URL components, such as code text : text , code text // text , code text ? text , and code text # text , should be included in the URL format string. Likewise, a format string with a single code text "{}" text is interpreted as a path and any replacement characters invalid in this component will be encoded to form a valid URL. heading text Example 1 code assert(format("{}://{}:{}/rfc/{}", "https", "www.ietf.org", 80, "rfc2396.txt" ).buffer() == "https://www.ietf.org:80/rfc/rfc2396.txt"); paragraph text Arguments that contain special characters are automatically percent-encoded for the URL component where they appear: code assert(format("https://example.com/~{}", "John Doe" ).buffer() == "https://example.com/~John%20Doe"); admonition paragraph text The formatting machinery relies on language and library features that are broken on GCC 4.8 and GCC 5.x, so this function is not supported on those compilers. note heading text Preconditions 1 paragraph text All replacement fields must be valid and the resulting URL should be valid after arguments are formatted into the URL. paragraph text Because any invalid characters for a URL component are encoded by this function, only replacements in the scheme and port components might be invalid, as these components do not allow percent-encoding of arbitrary characters. heading text BNF 1 code replacement_field ::= "{" [arg_id] [":" (format_spec | chrono_format_spec)] "}" arg_id ::= integer | identifier integer ::= digit+ digit ::= "0"..."9" identifier ::= id_start id_continue* id_start ::= "a"..."z" | "A"..."Z" | "_" id_continue ::= id_start | digit heading text Specification 1 list paragraph link text Format String Syntax https://fmt.dev/latest/syntax.html unordered brief text Format arguments into a URL returns text A URL holding the formatted result. param text The format URL string. fmt param text Arguments to be formatted. args throws code text fmt text contains an invalid format string and the result contains an invalid URL after replacements are applied. reference system_error see reference format_to FNXbTBfIxbiM2pjYEryMCZH+yoY= text , reference arg IQym8fO7DIG67s+M2rtFQszkoaY= text . reference url B4dRaSXMG3fDmuNKMW3KOeRu6kA= identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core fmt 1 identifier Args args normal format_to boost/url/format.hpp include/boost/url/format.hpp 243 1 1 overloads FNXbTBfIxbiM2pjYEryMCZH+yoY= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= brief text Format arguments into a URL param text An object that derives from reference url_base aHkFCWJbYb0t+7FT+A5gCI0krpU= text . u param text The format URL string. fmt param text Arguments to be formatted. args throws code text fmt text contains an invalid format string and code text u text contains an invalid URL after replacements are applied. reference system_error see reference format ZTww0Dx20RT0z0QTruz8U8gZuIY= text . normal ueXaMbO5jFzZWelOn6upDJcN55Y= K7ofEKM2bNb4ZS9OFo0DX+7Ep9I= identifier void format_to boost/url/format.hpp include/boost/url/format.hpp 435 1 1 function ueXaMbO5jFzZWelOn6upDJcN55Y= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text Format arguments according to the format URL string into a reference url_base aHkFCWJbYb0t+7FT+A5gCI0krpU= text . paragraph text This overload allows type-erased arguments to be passed as an initializer_list, which is mostly convenient for named parameters. paragraph text All arguments must be convertible to a implementation defined type able to store a type-erased reference to any valid format argument. paragraph text The rules for a format URL string are the same as for a code text std::format_string text , where replacement fields are delimited by curly braces. paragraph text The URL components to which replacement fields belong are identified before replacement is applied and any invalid characters for that formatted argument are percent-escaped. paragraph text Hence, the delimiters between URL components, such as code text : text , code text // text , code text ? text , and code text # text , should be included in the URL format string. Likewise, a format string with a single code text "{}" text is interpreted as a path and any replacement characters invalid in this component will be encoded to form a valid URL. heading text Example 1 code url u; format_to(u, "{scheme}://{host}:{port}/{dir}/{file}", {{"scheme", "https"}, {"port", 80}, {"host", "example.com"}, {"dir", "path/to"}, {"file", "file.txt"}}); assert(u.buffer() == "https://example.com:80/path/to/file.txt"); heading text Preconditions 1 paragraph text All replacement fields must be valid and the resulting URL should be valid after arguments are formatted into the URL. paragraph text Because any invalid characters for a URL component are encoded by this function, only replacements in the scheme and port components might be invalid, as these components do not allow percent-encoding of arbitrary characters. heading text Exception Safety 1 paragraph text Strong guarantee. heading text BNF 1 code replacement_field ::= "{" [arg_id] [":" (format_spec | chrono_format_spec)] "}" arg_id ::= integer | identifier integer ::= digit+ digit ::= "0"..."9" identifier ::= id_start id_continue* id_start ::= "a"..."z" | "A"..."Z" | "_" id_continue ::= id_start | digit heading text Specification 1 list paragraph link text Format String Syntax https://fmt.dev/latest/syntax.html unordered brief text Format arguments into a URL param text An object that derives from reference url_base aHkFCWJbYb0t+7FT+A5gCI0krpU= text . u param text The format URL string. fmt param text Arguments to be formatted. args throws code text fmt text contains an invalid format string and code text u text contains an invalid URL after replacements are applied. reference system_error see reference format ZTww0Dx20RT0z0QTruz8U8gZuIY= text . reference static_url 4HBDcnMjZthTXFnhpS7z+UhDNjA= reference static_url_base dmsqdje8dXFRFgNB9wxOs9Y5nb8= reference url B4dRaSXMG3fDmuNKMW3KOeRu6kA= reference url_base aHkFCWJbYb0t+7FT+A5gCI0krpU= identifier void identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base u identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core fmt specialization 3tT5Y8vozttMWXrA/fNw4NcDYTE= initializer_list identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std args normal format_to boost/url/format.hpp include/boost/url/format.hpp 243 1 1 function K7ofEKM2bNb4ZS9OFo0DX+7Ep9I= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text Format arguments according to the format URL string into a reference url_base aHkFCWJbYb0t+7FT+A5gCI0krpU= text . paragraph text The rules for a format URL string are the same as for a code text std::format_string text , where replacement fields are delimited by curly braces. paragraph text The URL components to which replacement fields belong are identified before replacement is applied and any invalid characters for that formatted argument are percent-escaped. paragraph text Hence, the delimiters between URL components, such as code text : text , code text // text , code text ? text , and code text # text , should be included in the URL format string. Likewise, a format string with a single code text "{}" text is interpreted as a path and any replacement characters invalid in this component will be encoded to form a valid URL. heading text Example 1 code static_url<50> u; format_to(u, "{}://{}:{}/rfc/{}", "https", "www.ietf.org", 80, "rfc2396.txt"); assert(u.buffer() == "https://www.ietf.org:80/rfc/rfc2396.txt"); heading text Preconditions 1 paragraph text All replacement fields must be valid and the resulting URL should be valid after arguments are formatted into the URL. paragraph text Because any invalid characters for a URL component are encoded by this function, only replacements in the scheme and port components might be invalid, as these components do not allow percent-encoding of arbitrary characters. heading text Exception Safety 1 paragraph text Strong guarantee. heading text BNF 1 code replacement_field ::= "{" [arg_id] [":" (format_spec | chrono_format_spec)] "}" arg_id ::= integer | identifier integer ::= digit+ digit ::= "0"..."9" identifier ::= id_start id_continue* id_start ::= "a"..."z" | "A"..."Z" | "_" id_continue ::= id_start | digit heading text Specification 1 list paragraph link text Format String Syntax https://fmt.dev/latest/syntax.html unordered brief text Format arguments into a URL param text An object that derives from reference url_base aHkFCWJbYb0t+7FT+A5gCI0krpU= text . u param text The format URL string. fmt param text Arguments to be formatted. args throws code text fmt text contains an invalid format string and code text u text contains an invalid URL after replacements are applied. reference system_error see reference format ZTww0Dx20RT0z0QTruz8U8gZuIY= text . reference static_url 4HBDcnMjZthTXFnhpS7z+UhDNjA= reference static_url_base dmsqdje8dXFRFgNB9wxOs9Y5nb8= reference url B4dRaSXMG3fDmuNKMW3KOeRu6kA= reference url_base aHkFCWJbYb0t+7FT+A5gCI0krpU= identifier void identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base u identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core fmt 1 identifier Args args normal make_pct_string_view boost/url/pct_string_view.hpp include/boost/url/pct_string_view.hpp 260 5 boost/url/pct_string_view.hpp include/boost/url/pct_string_view.hpp 432 1 1 function mgIS/AfQlcgKNFKOdLRtjihgyFk= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text If code text s text is a valid percent-encoded string, the function returns the buffer as a valid view which may be used to perform decoding or measurements. Otherwise the result contains an error code. Upon success, the returned view references the original character buffer; Ownership is not transferred. heading text Complexity 1 paragraph text Linear in code text s.size() text . heading text Exception Safety 1 paragraph text Throws nothing. brief text Return a valid percent-encoded string returns text On success, the valid percent-encoded string. param text The string to validate. s specialization O+YzwnquzbCEPErxi2iuhXKphsk= result identifier LWQB+dn+7lsRKPzx/twz66ZcOWI= system identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal make_pct_string_view_unsafe boost/url/pct_string_view.hpp include/boost/url/pct_string_view.hpp 438 1 boost/url/pct_string_view.hpp include/boost/url/pct_string_view.hpp 35 1 function LmKHQZfsj3PYKU9ldLJvacNvZaA= implementation-defined dnk5XPfR2OaMpCYaH3cWSxcTdyc= identifier t9KlfUmMV/Lq0e5tGD9d/eCq+X0= pct_string_view 1 identifier char data identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std size identifier RryF7mzsZp/0nbj7TMvRsykMXng= size_t identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std decoded_size normal parse_absolute_uri boost/url/parse.hpp include/boost/url/parse.hpp 63 1 1 function U3CVElRbcTcbg1JzOqhBCd5RSzM= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text This function parses a string according to the grammar below and returns a view referencing the passed string upon success, else returns an error. Ownership of the string is not transferred; the caller is responsible for ensuring that the lifetime of the character buffer extends until the view is no longer being accessed. heading text Example 1 code system::result< url_view > rv = parse_absolute_uri( "http://example.com/index.htm?id=1" ); heading text BNF 1 code absolute-URI = scheme ":" hier-part [ "?" query ] hier-part = "//" authority path-abempty / path-absolute / path-rootless / path-empty heading text Specification 1 list paragraph link text 4.3. Absolute URI (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-4.3 unordered brief text Return a reference to a parsed URL string returns text A view to the parsed URL param text The string to parse s throws code text s.size() > url_view::max_size reference std::length_error see reference parse_origin_form J4f05lEg7oi89R2SkpRaYiBhCIQ= text , reference parse_relative_ref QFzcl8vSLEeKOEO6w3mv1zGqX3k= text , reference parse_uri f+9kR517VGSM5ZPoS7g/RFb0g/0= text , reference parse_uri_reference 7d2b1xVBWJPgL/+PWFdoBaZJvMA= text , reference url_view wh3UbUToX9YDmRmnpcoM9EUEZo8= text . reference url_view wh3UbUToX9YDmRmnpcoM9EUEZo8= specialization O+YzwnquzbCEPErxi2iuhXKphsk= result identifier LWQB+dn+7lsRKPzx/twz66ZcOWI= system identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal parse_authority boost/url/authority_view.hpp include/boost/url/authority_view.hpp 1589 1 1 function dl7C/yP8Suze9+hv0RfYWxZaWCY= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text This function parses a string according to the authority grammar below, and returns an reference authority_view d/hMlyyC3Ave6L9McUD7B4TwENA= text referencing the string. Ownership of the string is not transferred; the caller is responsible for ensuring that the lifetime of the string extends until the view is no longer being accessed. heading text BNF 1 code authority = [ userinfo "@" ] host [ ":" port ] userinfo = user [ ":" [ password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) host = IP-literal / IPv4address / reg-name port = *DIGIT heading text Exception Safety 1 paragraph text Throws nothing. heading text Specification 1 list paragraph link text 3.2. Authority (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2 unordered brief text Parse an authority returns text A view to the parsed authority param text The string to parse s see reference authority_view d/hMlyyC3Ave6L9McUD7B4TwENA= text . reference authority_view d/hMlyyC3Ave6L9McUD7B4TwENA= specialization O+YzwnquzbCEPErxi2iuhXKphsk= result identifier LWQB+dn+7lsRKPzx/twz66ZcOWI= system identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal parse_ipv4_address boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 361 1 1 function 3H1nFll3jIwKtiUjrAoL1itMXS8= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= brief text Return an IPv4 address from an IP address string in dotted decimal form returns text The parsed address, or an error code. param text The string to parse. s reference ipv4_address /Wpp3ZZDp3kUHzbULeDoaOEhnVs= specialization O+YzwnquzbCEPErxi2iuhXKphsk= result identifier LWQB+dn+7lsRKPzx/twz66ZcOWI= system identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal parse_ipv6_address boost/url/ipv6_address.hpp include/boost/url/ipv6_address.hpp 404 1 1 function bEw/qaAlNfZy1QraETx5dipoF+I= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text This function attempts to parse the string as an IPv6 address and returns a result containing the address upon success, or an error code if the string does not contain a valid IPv6 address. heading text Exception Safety 1 paragraph text Throws nothing. brief text Parse a string containing an IPv6 address. returns text A result containing the address. param text The string to parse. s reference ipv6_address dhMSRVBIIIItY0URHSc8rwHcdTQ= specialization O+YzwnquzbCEPErxi2iuhXKphsk= result identifier LWQB+dn+7lsRKPzx/twz66ZcOWI= system identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal parse_origin_form boost/url/parse.hpp include/boost/url/parse.hpp 109 1 1 function J4f05lEg7oi89R2SkpRaYiBhCIQ= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text This function parses a string according to the grammar below and returns a view referencing the passed string upon success, else returns an error. Ownership of the string is not transferred; the caller is responsible for ensuring that the lifetime of the character buffer extends until the view is no longer being accessed. heading text Example 1 code system::result< url_view > = parse_origin_form( "/index.htm?layout=mobile" ); heading text BNF 1 code origin-form = absolute-path [ "?" query ] absolute-path = 1*( "/" segment ) heading text Specification 1 list paragraph link text 5.3.1. origin-form (rfc7230) https://datatracker.ietf.org/doc/html/rfc7230#section-5.3.1 unordered brief text Return a reference to a parsed URL string returns text A view to the parsed URL param text The string to parse s throws code text s.size() > url_view::max_size reference std::length_error see reference parse_absolute_uri U3CVElRbcTcbg1JzOqhBCd5RSzM= text , reference parse_relative_ref QFzcl8vSLEeKOEO6w3mv1zGqX3k= text , reference parse_uri f+9kR517VGSM5ZPoS7g/RFb0g/0= text , reference parse_uri_reference 7d2b1xVBWJPgL/+PWFdoBaZJvMA= text , reference url_view wh3UbUToX9YDmRmnpcoM9EUEZo8= text . reference url_view wh3UbUToX9YDmRmnpcoM9EUEZo8= specialization O+YzwnquzbCEPErxi2iuhXKphsk= result identifier LWQB+dn+7lsRKPzx/twz66ZcOWI= system identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal parse_path boost/url/segments_encoded_view.hpp include/boost/url/segments_encoded_view.hpp 299 5 boost/url/segments_encoded_view.hpp include/boost/url/segments_encoded_view.hpp 308 1 boost/url/parse_path.hpp include/boost/url/parse_path.hpp 48 1 1 function UGT2YeR0J7z0ZcyG8/VStlmtGhU= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text This function parses the string and returns the corresponding path object if the string is valid, otherwise returns an error. heading text BNF 1 code path = [ "/" ] segment *( "/" segment ) heading text Exception Safety 1 paragraph text No-throw guarantee. heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text Parse a string and return an encoded segment view returns text A valid view on success, otherwise an error code. param text The string to parse s see reference segments_encoded_view EvaX3SmNTAtai2Kf6Kma3fUkTkQ= text . specialization O+YzwnquzbCEPErxi2iuhXKphsk= result identifier LWQB+dn+7lsRKPzx/twz66ZcOWI= system identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal parse_query boost/url/params_encoded_view.hpp include/boost/url/params_encoded_view.hpp 234 5 boost/url/params_encoded_view.hpp include/boost/url/params_encoded_view.hpp 243 1 boost/url/parse_query.hpp include/boost/url/parse_query.hpp 47 1 1 function uNT8hVd3FIORJnihg+axBbyOnBE= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text This function parses the string and returns the corresponding params object if the string is valid, otherwise returns an error. heading text BNF 1 code query = *( pchar / "/" / "?" ) heading text Exception Safety 1 paragraph text No-throw guarantee. heading text Specification 1 brief text Parse a string and return an encoded params view returns text A valid view on success, otherwise an error code. param text The string to parse s see reference params_encoded_view 0nSfM4mK92fIx58KtzdWGiHuq2w= text . specialization O+YzwnquzbCEPErxi2iuhXKphsk= result identifier LWQB+dn+7lsRKPzx/twz66ZcOWI= system identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal parse_relative_ref boost/url/parse.hpp include/boost/url/parse.hpp 161 1 1 function QFzcl8vSLEeKOEO6w3mv1zGqX3k= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text This function parses a string according to the grammar below and returns a view referencing the passed string upon success, else returns an error. Ownership of the string is not transferred; the caller is responsible for ensuring that the lifetime of the character buffer extends until the view is no longer being accessed. heading text Example 1 code system::result< url_view > = parse_relative_ref( "images/dot.gif?v=hide#a" ); heading text BNF 1 code relative-ref = relative-part [ "?" query ] [ "#" fragment ] relative-part = "//" authority path-abempty / path-absolute / path-noscheme / path-abempty / path-empty heading text Specification 1 list paragraph link text 4.2. Relative Reference (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-4.2 paragraph link text Errata ID: 5428 (rfc3986) https://www.rfc-editor.org/errata/eid5428 unordered brief text Return a reference to a parsed URL string returns text A view to the parsed URL param text The string to parse s throws code text s.size() > url_view::max_size reference std::length_error see reference parse_absolute_uri U3CVElRbcTcbg1JzOqhBCd5RSzM= text , reference parse_origin_form J4f05lEg7oi89R2SkpRaYiBhCIQ= text , reference parse_uri f+9kR517VGSM5ZPoS7g/RFb0g/0= text , reference parse_uri_reference 7d2b1xVBWJPgL/+PWFdoBaZJvMA= text , reference url_view wh3UbUToX9YDmRmnpcoM9EUEZo8= text . reference url_view wh3UbUToX9YDmRmnpcoM9EUEZo8= specialization O+YzwnquzbCEPErxi2iuhXKphsk= result identifier LWQB+dn+7lsRKPzx/twz66ZcOWI= system identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal parse_uri boost/url/parse.hpp include/boost/url/parse.hpp 210 1 1 function f+9kR517VGSM5ZPoS7g/RFb0g/0= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text This function parses a string according to the grammar below and returns a view referencing the passed string upon success, else returns an error. Ownership of the string is not transferred; the caller is responsible for ensuring that the lifetime of the character buffer extends until the view is no longer being accessed. heading text Example 1 code system::result< url_view > = parse_uri( "https://www.example.com/index.htm?id=guest#s1" ); heading text BNF 1 code URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] hier-part = "//" authority path-abempty / path-absolute / path-rootless / path-empty heading text Specification 1 list paragraph link text 3. Syntax Components (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3 unordered brief text Return a reference to a parsed URL string returns text A code text boost::system::result text containing a value or an error param text The string to parse s throws code text s.size() > url_view::max_size reference std::length_error see reference parse_absolute_uri U3CVElRbcTcbg1JzOqhBCd5RSzM= text , reference parse_origin_form J4f05lEg7oi89R2SkpRaYiBhCIQ= text , reference parse_relative_ref QFzcl8vSLEeKOEO6w3mv1zGqX3k= text , reference parse_uri_reference 7d2b1xVBWJPgL/+PWFdoBaZJvMA= text , reference url_view wh3UbUToX9YDmRmnpcoM9EUEZo8= text . reference url_view wh3UbUToX9YDmRmnpcoM9EUEZo8= specialization O+YzwnquzbCEPErxi2iuhXKphsk= result identifier LWQB+dn+7lsRKPzx/twz66ZcOWI= system identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal parse_uri_reference boost/url/parse.hpp include/boost/url/parse.hpp 271 1 1 function 7d2b1xVBWJPgL/+PWFdoBaZJvMA= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text This function parses a string according to the grammar below and returns a view referencing the passed string upon success, else returns an error. Ownership of the string is not transferred; the caller is responsible for ensuring that the lifetime of the character buffer extends until the view is no longer being accessed. heading text Example 1 code system::result< url_view > = parse_uri_reference( "ws://echo.example.com/?name=boost#demo" ); heading text BNF 1 code URI-reference = URI / relative-ref URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] relative-ref = relative-part [ "?" query ] [ "#" fragment ] hier-part = "//" authority path-abempty / path-absolute / path-rootless / path-empty relative-part = "//" authority path-abempty / path-absolute / path-noscheme / path-abempty / path-empty heading text Specification 1 list paragraph link text 4.1. URI Reference (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-4.1 paragraph link text Errata ID: 5428 (rfc3986) https://www.rfc-editor.org/errata/eid5428 unordered brief text Return a reference to a parsed URL string returns text A view to the parsed URL param text The string to parse s throws code text s.size() > url_view::max_size reference std::length_error see reference parse_absolute_uri U3CVElRbcTcbg1JzOqhBCd5RSzM= text , reference parse_origin_form J4f05lEg7oi89R2SkpRaYiBhCIQ= text , reference parse_relative_ref QFzcl8vSLEeKOEO6w3mv1zGqX3k= text , reference parse_uri f+9kR517VGSM5ZPoS7g/RFb0g/0= text , reference url_view wh3UbUToX9YDmRmnpcoM9EUEZo8= text . reference url_view wh3UbUToX9YDmRmnpcoM9EUEZo8= specialization O+YzwnquzbCEPErxi2iuhXKphsk= result identifier LWQB+dn+7lsRKPzx/twz66ZcOWI= system identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal pct_encoded_rule boost/url/rfc/pct_encoded_rule.hpp include/boost/url/rfc/pct_encoded_rule.hpp 86 1 1 function tqgOJBBmkI71v1H8Vjo+5AjUBNk= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text This function returns a rule which matches a percent-encoded string, permitting characters in the string which are also in the specified character set to be used unescaped. heading text Value Type 1 code using value_type = pct_string_view; heading text Example 1 paragraph text Rules are used with the function reference grammar::parse laQxW+BBeJINbRrZtau+U15+v7c= text . code // pchar = unreserved / pct-encoded / sub-delims / ":" / "@" system::result< pct_string_view > rv = grammar::parse( "Program%20Files", pct_encoded_rule( pchars ) ); heading text BNF 1 code pct-encoded = "%" HEXDIG HEXDIG heading text Specification 1 list paragraph link text 2.1. Percent-Encoding (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-2.1 unordered brief text Rule for a string with percent-encoded escapes returns text A rule object. param text The character set indicating which characters are allowed without escapes. Any character which is not in this set must be escaped, or else parsing returns an error. cs see reference grammar::parse laQxW+BBeJINbRrZtau+U15+v7c= text , reference pchars 2V+Z9ecepqbZRna6GFcGry1dzDs= text , reference pct_string_view t9KlfUmMV/Lq0e5tGD9d/eCq+X0= text . specialization CQTpJwwMukasfaQaxylb5piRLpU= pct_encoded_rule_t identifier xCd2tUlylXT9zvj8ZcHXybU4P/k= implementation_defined 1 identifier CS cs normal 1 resolve boost/url/url_base.hpp include/boost/url/url_base.hpp 3151 1 1 boost/url/url_base.hpp include/boost/url/url_base.hpp 2977 5 function /6zWjIFN5df0PBj9zFsfNUjNY6s= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text This function attempts to resolve a URL reference code text ref text against the base URL code text base text in a manner similar to that of a web browser resolving an anchor tag. paragraph text The base URL must satisfy the emph text URI text grammar. In other words, it must contain a scheme. paragraph text Relative references are only usable when in the context of a base absolute URI. This process of resolving a relative emph text reference text within the context of a emph text base text URI is defined in detail in rfc3986 (see below). paragraph text The resolution process works as if the relative reference is appended to the base URI and the result is normalized. paragraph text Given the input base URL, this function resolves the relative reference as if performing the following steps: list paragraph text Ensure the base URI has at least a scheme paragraph text Normalizing the reference path paragraph text Merge base and reference paths paragraph text Normalize the merged path unordered paragraph text This function places the result of the resolution into code text dest text , which can be any of the url containers that inherit from reference url_base aHkFCWJbYb0t+7FT+A5gCI0krpU= text . paragraph text If an error occurs, the contents of code text dest text is unspecified and code text ec text is set. admonition paragraph text Abnormal hrefs where the number of ".." segments exceeds the number of segments in the base path are handled by including the unmatched ".." segments in the result, as described in link text Errata 4547 https://www.rfc-editor.org/errata/eid4547 text . note heading text Example 1 code url dest; system::error_code ec; resolve("/one/two/three", "four", dest, ec); assert( dest.str() == "/one/two/four" ); resolve("http://example.com/", "/one", dest, ec); assert( dest.str() == "http://example.com/one" ); resolve("http://example.com/one", "/two", dest, ec); assert( dest.str() == "http://example.com/two" ); resolve("http://a/b/c/d;p?q", "g#s", dest, ec); assert( dest.str() == "http://a/b/c/g#s" ); heading text BNF 1 code absolute-URI = scheme ":" hier-part [ "?" query ] heading text Exception Safety 1 paragraph text Basic guarantee. Calls to allocate may throw. heading text Specification 1 brief text Resolve a URL reference against a base URL returns text An empty code text boost::system::result text upon success, otherwise an error code if code text !base.has_scheme() text . param text The base URL to resolve against. base param text The URL reference to resolve. ref param text The container where the result is written, upon success. dest see reference url B4dRaSXMG3fDmuNKMW3KOeRu6kA= text , reference url_view wh3UbUToX9YDmRmnpcoM9EUEZo8= text . reference static_url 4HBDcnMjZthTXFnhpS7z+UhDNjA= reference static_url_base dmsqdje8dXFRFgNB9wxOs9Y5nb8= reference url B4dRaSXMG3fDmuNKMW3KOeRu6kA= reference url_view wh3UbUToX9YDmRmnpcoM9EUEZo8= reference url_view_base UEVNhDEjkZMXfjN1DxbtX0n2rCg= specialization O+YzwnquzbCEPErxi2iuhXKphsk= result identifier LWQB+dn+7lsRKPzx/twz66ZcOWI= system 1 identifier UEVNhDEjkZMXfjN1DxbtX0n2rCg= url_view_base base 1 identifier UEVNhDEjkZMXfjN1DxbtX0n2rCg= url_view_base ref identifier aHkFCWJbYb0t+7FT+A5gCI0krpU= url_base dest normal string_to_scheme boost/url/scheme.hpp include/boost/url/scheme.hpp 141 1 1 function ViRFbAhqyfzry2qMQUxKJSvsEQU= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text If the string does not identify a known scheme, the value reference scheme::unknown LJxTyQ55ot1WYLH7f46nZvdGU78= text is returned. heading text BNF 1 code scheme = ALPHA *( ALPHA / DIGIT / "+" / "-" / "." ) heading text Specification 1 list paragraph link text 3.1. Scheme (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.1 unordered brief text Return the known scheme for a non-normalized string, if known returns text The known scheme param text The string holding the scheme s reference scheme P7uOjuAMILimKGOcbjDUSpMAL/U= identifier P7uOjuAMILimKGOcbjDUSpMAL/U= scheme identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core s normal swap boost/url/url.hpp include/boost/url/url.hpp 400 5 1 function r+2jsv/V/6eYTTn9n6oVkgy6U/Y= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text Exchanges the contents of code text v0 text with another code text v1 text . All views, iterators and references remain valid. paragraph text If code text &v0 == &v1 text , this function call has no effect. heading text Example 1 code url u1( "https://www.example.com" ); url u2( "https://www.boost.org" ); std::swap(u1, u2); assert(u1 == "https://www.boost.org" ); assert(u2 == "https://www.example.com" ); heading text Effects 1 code v0.swap( v1 ); heading text Complexity 1 paragraph text Constant heading text Exception Safety 1 paragraph text Throws nothing brief text Swap param text The first object to swap v0 param text The second object to swap v1 see reference url::swap iZ1eWw5IAl1ilQ72KPrht00pGzU= identifier void identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url v0 identifier B4dRaSXMG3fDmuNKMW3KOeRu6kA= url v1 normal to_string boost/url/scheme.hpp include/boost/url/scheme.hpp 151 1 1 function bWzp24u26R/CcIVKOEeAZxMwSG4= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= brief text Return the normalized string for a known scheme returns text A string representing the known scheme param text The known scheme constant s reference scheme P7uOjuAMILimKGOcbjDUSpMAL/U= identifier UU713q4e9nAhffTdQymLf8qVeZ4= string_view identifier jfKMZmwdQz1vi4olOs8HBTBDdw4= core identifier P7uOjuAMILimKGOcbjDUSpMAL/U= scheme s normal operator<< boost/url/authority_view.hpp include/boost/url/authority_view.hpp 1516 5 1 boost/url/authority_view.hpp include/boost/url/authority_view.hpp 1544 1 1 boost/url/decode_view.hpp include/boost/url/decode_view.hpp 1044 1 1 boost/url/params_base.hpp include/boost/url/params_base.hpp 566 1 1 boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 597 1 1 boost/url/segments_base.hpp include/boost/url/segments_base.hpp 329 1 1 boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 337 1 1 boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2801 1 1 overloads SdFdcdup2kXvm4kt7IFusgel9jM= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= brief text Stream insertion operators returns text The output stream, for chaining. returns text The output stream. returns text A reference to the output stream, for chaining returns text A reference to the output stream. param text The output stream to write to. os param text The address to write. addr param text The decoded view to write s param text The url to write. u param text The URL to write a param text The params to write qp param text The object to format. ps normal AQru1yEUVgiZfLKcjFmVLcOmOik= CD4PSGOm3yi6rHmmIS6wEJujXKY= Rq3dRXMGOM1zfmg72uddgjVtVqQ= VQ8wN5VmWJfoSxg1rKYLnwDRsjU= 62w3cvZ1uSKt/7VWLepmVSNqb5s= uB1oB8J15hQo5Z7Skm2tX7pjkw4= wjh7llL0udXOq6c/9Siig65RA1c= F3NCE1oaqTgrvCMClW+OzMZiIC4= uYw4zaXIgOZdayhgwTcIbe+Y0D8= identifier XKE0Et5ctFFXvBqg+zp74PL65qE= ostream identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std operator<< boost/url/ipv6_address.hpp include/boost/url/ipv6_address.hpp 360 5 1 function AQru1yEUVgiZfLKcjFmVLcOmOik= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text This function writes the address to an output stream using standard notation. brief text Format the address to an output stream returns text The output stream, for chaining. param text The output stream to write to. os param text The address to write. addr identifier XKE0Et5ctFFXvBqg+zp74PL65qE= ostream identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std identifier XKE0Et5ctFFXvBqg+zp74PL65qE= ostream identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std os 1 identifier dhMSRVBIIIItY0URHSc8rwHcdTQ= ipv6_address addr normal operator<< boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 325 5 1 function CD4PSGOm3yi6rHmmIS6wEJujXKY= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text IPv4 addresses written to output streams are written in their dotted decimal format. brief text Format the address to an output stream. returns text The output stream. param text The output stream. os param text The address to format. addr identifier XKE0Et5ctFFXvBqg+zp74PL65qE= ostream identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std identifier XKE0Et5ctFFXvBqg+zp74PL65qE= ostream identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std os 1 identifier /Wpp3ZZDp3kUHzbULeDoaOEhnVs= ipv4_address addr normal operator<< boost/url/decode_view.hpp include/boost/url/decode_view.hpp 1016 5 1 boost/url/decode_view.hpp include/boost/url/decode_view.hpp 1044 1 1 function Rq3dRXMGOM1zfmg72uddgjVtVqQ= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text This hidden friend function serializes the decoded view to the output stream. paragraph text Format the string with percent-decoding applied to the output stream paragraph text This function serializes the decoded view to the output stream. brief text Format the string with percent-decoding applied to the output stream returns text A reference to the output stream, for chaining param text The output stream to write to os param text The decoded view to write s identifier XKE0Et5ctFFXvBqg+zp74PL65qE= ostream identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std identifier XKE0Et5ctFFXvBqg+zp74PL65qE= ostream identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std os 1 identifier IhE/V16b2wBX2q+s4QtlgzozWlQ= decode_view s normal operator<< boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2745 5 1 boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2801 1 1 function VQ8wN5VmWJfoSxg1rKYLnwDRsjU= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text This function serializes the url to the specified output stream. Any percent-escapes are emitted as-is; no decoding is performed. heading text Example 1 code url_view u( "http://www.example.com/index.htm" ); std::stringstream ss; ss << u; assert( ss.str() == "http://www.example.com/index.htm" ); heading text Effects 1 code return os << u.buffer(); heading text Complexity 1 paragraph text Linear in code text u.buffer().size() heading text Exception Safety 1 paragraph text Basic guarantee. paragraph text Format the url to the output stream paragraph text This function serializes the url to the specified output stream. Any percent-escapes are emitted as-is; no decoding is performed. heading text Example 1 code url_view u( "http://www.example.com/index.htm" ); std::stringstream ss; ss << u; assert( ss.str() == "http://www.example.com/index.htm" ); heading text Effects 1 code return os << u.buffer(); heading text Complexity 1 paragraph text Linear in code text u.buffer().size() heading text Exception Safety 1 paragraph text Basic guarantee. brief text Format the url to the output stream returns text A reference to the output stream, for chaining param text The output stream to write to. os param text The url to write. u identifier XKE0Et5ctFFXvBqg+zp74PL65qE= ostream identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std identifier XKE0Et5ctFFXvBqg+zp74PL65qE= ostream identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std os 1 identifier UEVNhDEjkZMXfjN1DxbtX0n2rCg= url_view_base u normal operator<< boost/url/authority_view.hpp include/boost/url/authority_view.hpp 1516 5 1 boost/url/authority_view.hpp include/boost/url/authority_view.hpp 1544 1 1 function 62w3cvZ1uSKt/7VWLepmVSNqb5s= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text This hidden friend function serializes the encoded URL to the output stream. heading text Example 1 code authority_view a( "www.example.com" ); std::cout << a << std::endl; paragraph text Format the encoded authority to the output stream paragraph text This function serializes the encoded URL to the output stream. heading text Example 1 code authority_view a( "www.example.com" ); std::cout << a << std::endl; brief text Format the encoded authority to the output stream returns text A reference to the output stream, for chaining param text The output stream to write to os param text The URL to write a identifier XKE0Et5ctFFXvBqg+zp74PL65qE= ostream identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std identifier XKE0Et5ctFFXvBqg+zp74PL65qE= ostream identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std os 1 identifier d/hMlyyC3Ave6L9McUD7B4TwENA= authority_view a normal operator<< boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 597 1 1 function uB1oB8J15hQo5Z7Skm2tX7pjkw4= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text Any percent-escapes are emitted as-is; no decoding is performed. heading text Complexity 1 paragraph text Linear in code text ps.buffer().size() text . heading text Effects 1 code return os << ps.buffer(); brief text Format to an output stream returns text A reference to the output stream, for chaining param text The output stream to write to os param text The params to write qp identifier XKE0Et5ctFFXvBqg+zp74PL65qE= ostream identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std identifier XKE0Et5ctFFXvBqg+zp74PL65qE= ostream identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std os 1 identifier 2+L1/+BrjUzoccWPIYkGu108y1I= params_encoded_base qp normal operator<< boost/url/params_base.hpp include/boost/url/params_base.hpp 566 1 1 function wjh7llL0udXOq6c/9Siig65RA1c= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text Any percent-escapes are emitted as-is; no decoding is performed. heading text Complexity 1 paragraph text Linear in code text ps.buffer().size() text . heading text Effects 1 code return os << ps.buffer(); brief text Format to an output stream returns text A reference to the output stream, for chaining param text The output stream to write to os param text The parameters to write qp identifier XKE0Et5ctFFXvBqg+zp74PL65qE= ostream identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std identifier XKE0Et5ctFFXvBqg+zp74PL65qE= ostream identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std os 1 identifier paRP7A1SOQlKcnfXhxL4FgbVXKs= params_base qp normal operator<< boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 337 1 1 function F3NCE1oaqTgrvCMClW+OzMZiIC4= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text Any percent-escapes are emitted as-is; no decoding is performed. heading text Complexity 1 paragraph text Linear in code text ps.buffer().size() text . heading text Effects 1 code return os << ps.buffer(); brief text Format to an output stream returns text A reference to the output stream. param text The output stream to write to. os param text The object to format. ps identifier XKE0Et5ctFFXvBqg+zp74PL65qE= ostream identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std identifier XKE0Et5ctFFXvBqg+zp74PL65qE= ostream identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std os 1 identifier qs4TNMM406MPgeboXz6oVUmcauE= segments_encoded_base ps normal operator<< boost/url/segments_base.hpp include/boost/url/segments_base.hpp 329 1 1 function uYw4zaXIgOZdayhgwTcIbe+Y0D8= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text Any percent-escapes are emitted as-is; no decoding is performed. heading text Complexity 1 paragraph text Linear in code text ps.buffer().size() text . heading text Effects 1 code return os << ps.buffer(); brief text Format to an output stream returns text A reference to the output stream. param text The output stream to write to. os param text The segments to write. ps identifier XKE0Et5ctFFXvBqg+zp74PL65qE= ostream identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std identifier XKE0Et5ctFFXvBqg+zp74PL65qE= ostream identifier eIvg7iueGIPcE8p1NVfngsp2ojw= std os 1 identifier ge9cOBTN19ywbVTnB5ajdJUC46Q= segments_base ps normal operator== boost/url/authority_view.hpp include/boost/url/authority_view.hpp 1367 5 1 overloads EUEfV2/Q0PUKk4boBo8vxNymBsw= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= brief text Equality operators returns code text true text if the addresses are equal returns code text true text if the addresses are equal, otherwise code text false text . returns code text true text if decoded code text lhs text is equal to the decoded code text rhs returns code text true text if code text u0 == u1 returns code text true text if code text a0 == a1 text , otherwise code text false param text The first address to compare. a1 param text The second address to compare. a2 param text The left-hand-side decode view to compare lhs param text The right-hand-side decode view to compare rhs param text The first url to compare u0 param text The second url to compare u1 param text The first authority to compare a0 normal /Rx5cBJ8hgc8Yigu7zsZeyTHTTc= 8obEUnt+lW3Tn+hrzU1C0MkLqg0= LXfbkHmiZLmAZU/h8W/FYVwBH3o= kAkiATsPkDLw0dMpRFfiCYb0Nb0= kUOudipymtwCZViHCF1w2siMg5M= E2+0o+/H5dWqJ1IkTzJ6aHTaMHE= 3b8LtWJdyf2AUFgD88j68/LgT7s= ktBT7dVJ8LGHL6lYOr37Ts3gI4I= identifier bool operator== boost/url/ipv6_address.hpp include/boost/url/ipv6_address.hpp 308 5 1 function /Rx5cBJ8hgc8Yigu7zsZeyTHTTc= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= brief text Return true if two addresses are equal returns code text true text if the addresses are equal param text The first address to compare. a1 param text The second address to compare. a2 identifier bool 1 identifier dhMSRVBIIIItY0URHSc8rwHcdTQ= ipv6_address a1 1 identifier dhMSRVBIIIItY0URHSc8rwHcdTQ= ipv6_address a2 normal operator== boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 259 5 1 function 8obEUnt+lW3Tn+hrzU1C0MkLqg0= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= brief text Return true if two addresses are equal returns code text true text if the addresses are equal, otherwise code text false text . param text The first address to compare. a1 param text The second address to compare. a2 identifier bool 1 identifier /Wpp3ZZDp3kUHzbULeDoaOEhnVs= ipv4_address a1 1 identifier /Wpp3ZZDp3kUHzbULeDoaOEhnVs= ipv4_address a2 normal operator== boost/url/decode_view.hpp include/boost/url/decode_view.hpp 659 5 1 function LXfbkHmiZLmAZU/h8W/FYVwBH3o= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= brief text Compare two decode views for equality returns code text true text if decoded code text lhs text is equal to the decoded code text rhs param text The left-hand-side decode view to compare lhs param text The right-hand-side decode view to compare rhs identifier bool 1 identifier S lhs 1 identifier IhE/V16b2wBX2q+s4QtlgzozWlQ= decode_view rhs normal operator== boost/url/decode_view.hpp include/boost/url/decode_view.hpp 642 5 1 function kAkiATsPkDLw0dMpRFfiCYb0Nb0= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= brief text Compare two decode views for equality returns code text true text if decoded code text lhs text is equal to the decoded code text rhs param text The left-hand-side decode view to compare lhs param text The right-hand-side decode view to compare rhs identifier bool 1 identifier IhE/V16b2wBX2q+s4QtlgzozWlQ= decode_view lhs 1 identifier S rhs normal operator== boost/url/decode_view.hpp include/boost/url/decode_view.hpp 625 5 1 function kUOudipymtwCZViHCF1w2siMg5M= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= brief text Compare two decode views for equality returns code text true text if decoded code text lhs text is equal to the decoded code text rhs param text The left-hand-side decode view to compare lhs param text The right-hand-side decode view to compare rhs identifier bool 1 identifier IhE/V16b2wBX2q+s4QtlgzozWlQ= decode_view lhs 1 identifier IhE/V16b2wBX2q+s4QtlgzozWlQ= decode_view rhs normal operator== boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2484 5 1 function E2+0o+/H5dWqJ1IkTzJ6aHTaMHE= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text The URLs are compared component by component as if they were first normalized. heading text Example 1 code url_view u0( "http://www.a.com/index.htm" ); url_view u1( "http://www.a.com/index.htm" ); assert( u0 == u1 ); heading text Effects 1 code url a(u0); a.normalize(); url b(u1); b.normalize(); return a.buffer() == b.buffer(); heading text Complexity 1 paragraph text Linear in code text min( u0.size(), u1.size() ) heading text Exception Safety 1 paragraph text Throws nothing heading text Specification 1 list paragraph link text 6.2.2 Syntax-Based Normalization (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-6.2.2 unordered brief text Return the result of comparing two URLs returns code text true text if code text u0 == u1 param text The first url to compare u0 param text The second url to compare u1 reference static_url 4HBDcnMjZthTXFnhpS7z+UhDNjA= reference static_url_base dmsqdje8dXFRFgNB9wxOs9Y5nb8= reference url B4dRaSXMG3fDmuNKMW3KOeRu6kA= reference url_base aHkFCWJbYb0t+7FT+A5gCI0krpU= reference url_view wh3UbUToX9YDmRmnpcoM9EUEZo8= identifier bool 1 identifier UEVNhDEjkZMXfjN1DxbtX0n2rCg= url_view_base u0 1 identifier UEVNhDEjkZMXfjN1DxbtX0n2rCg= url_view_base u1 normal operator== boost/url/authority_view.hpp include/boost/url/authority_view.hpp 1367 5 1 function ktBT7dVJ8LGHL6lYOr37Ts3gI4I= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= heading text Complexity 1 paragraph text Linear in code text min( a0.size(), a1.size() ) heading text Exception Safety 1 paragraph text Throws nothing brief text Return the result of comparing two authorities. The authorities are compared component by component as if they were first normalized. returns code text true text if code text a0 == a1 text , otherwise code text false param text The first authority to compare a0 param text The second authority to compare a1 identifier bool 1 identifier d/hMlyyC3Ave6L9McUD7B4TwENA= authority_view a0 1 identifier d/hMlyyC3Ave6L9McUD7B4TwENA= authority_view a1 normal operator!= boost/url/authority_view.hpp include/boost/url/authority_view.hpp 1391 5 1 overloads TcVr8Ed3rRtx/zQttClcoTybe2s= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= brief text Inequality operators returns code text true text if the addresses are not equal returns code text true text if the addresses are not equal, otherwise code text false text . returns code text true text if decoded code text lhs text is not equal to the decoded code text rhs returns code text true text if code text u0 != u1 returns code text true text if code text a0 != a1 text , otherwise code text false param text The first address to compare. a1 param text The second address to compare. a2 param text The left-hand-side decode view to compare lhs param text The right-hand-side decode view to compare rhs param text The first url to compare u0 param text The second url to compare u1 param text The first authority to compare a0 normal cqaXRu9n2E1Aq+fNQVQILaVo/Ss= Lk6u1xBQtbEyGW+iFcIykNQyhVo= vSmsDLb1jKJxuRaLWtT+wXrZDEQ= YH1cQI8sFN/t7l0ziTbCiZ8hyKc= gnCCLTp9Yc1Gqma6vl3Zy+AGvl8= QA2q/R+XvrJl2j8UnJwv+lnhdDA= +mbgraIEKxYlGRnrtbl+juVak7Y= NxK2yg1Y7T4SxurWSwoUG97wrN0= identifier bool operator!= boost/url/ipv6_address.hpp include/boost/url/ipv6_address.hpp 323 5 1 function cqaXRu9n2E1Aq+fNQVQILaVo/Ss= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= brief text Return true if two addresses are not equal returns code text true text if the addresses are not equal param text The first address to compare. a1 param text The second address to compare. a2 identifier bool 1 identifier dhMSRVBIIIItY0URHSc8rwHcdTQ= ipv6_address a1 1 identifier dhMSRVBIIIItY0URHSc8rwHcdTQ= ipv6_address a2 normal operator!= boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 274 5 1 function Lk6u1xBQtbEyGW+iFcIykNQyhVo= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= brief text Return true if two addresses are not equal returns code text true text if the addresses are not equal, otherwise code text false text . param text The first address to compare. a1 param text The second address to compare. a2 identifier bool 1 identifier /Wpp3ZZDp3kUHzbULeDoaOEhnVs= ipv4_address a1 1 identifier /Wpp3ZZDp3kUHzbULeDoaOEhnVs= ipv4_address a2 normal operator!= boost/url/decode_view.hpp include/boost/url/decode_view.hpp 726 5 1 function vSmsDLb1jKJxuRaLWtT+wXrZDEQ= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= brief text Compare two decode views for inequality returns code text true text if decoded code text lhs text is not equal to the decoded code text rhs param text The left-hand-side decode view to compare lhs param text The right-hand-side decode view to compare rhs identifier bool 1 identifier S lhs 1 identifier IhE/V16b2wBX2q+s4QtlgzozWlQ= decode_view rhs normal operator!= boost/url/decode_view.hpp include/boost/url/decode_view.hpp 709 5 1 function YH1cQI8sFN/t7l0ziTbCiZ8hyKc= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= brief text Compare two decode views for inequality returns code text true text if decoded code text lhs text is not equal to the decoded code text rhs param text The left-hand-side decode view to compare lhs param text The right-hand-side decode view to compare rhs identifier bool 1 identifier IhE/V16b2wBX2q+s4QtlgzozWlQ= decode_view lhs 1 identifier S rhs normal operator!= boost/url/decode_view.hpp include/boost/url/decode_view.hpp 692 5 1 function gnCCLTp9Yc1Gqma6vl3Zy+AGvl8= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= brief text Compare two decode views for inequality returns code text true text if decoded code text lhs text is not equal to the decoded code text rhs param text The left-hand-side decode view to compare lhs param text The right-hand-side decode view to compare rhs identifier bool 1 identifier IhE/V16b2wBX2q+s4QtlgzozWlQ= decode_view lhs 1 identifier IhE/V16b2wBX2q+s4QtlgzozWlQ= decode_view rhs normal operator!= boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2528 5 1 function QA2q/R+XvrJl2j8UnJwv+lnhdDA= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text The URLs are compared component by component as if they were first normalized. heading text Example 1 code url_view u0( "http://www.a.com/index.htm" ); url_view u1( "http://www.b.com/index.htm" ); assert( u0 != u1 ); heading text Effects 1 code url a(u0); a.normalize(); url b(u1); b.normalize(); return a.buffer() != b.buffer(); heading text Complexity 1 paragraph text Linear in code text min( u0.size(), u1.size() ) heading text Exception Safety 1 paragraph text Throws nothing heading text Specification 1 list paragraph link text 6.2.2 Syntax-Based Normalization (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-6.2.2 unordered brief text Return the result of comparing two URLs returns code text true text if code text u0 != u1 param text The first url to compare u0 param text The second url to compare u1 reference static_url 4HBDcnMjZthTXFnhpS7z+UhDNjA= reference static_url_base dmsqdje8dXFRFgNB9wxOs9Y5nb8= reference url B4dRaSXMG3fDmuNKMW3KOeRu6kA= reference url_base aHkFCWJbYb0t+7FT+A5gCI0krpU= reference url_view wh3UbUToX9YDmRmnpcoM9EUEZo8= identifier bool 1 identifier UEVNhDEjkZMXfjN1DxbtX0n2rCg= url_view_base u0 1 identifier UEVNhDEjkZMXfjN1DxbtX0n2rCg= url_view_base u1 normal operator!= boost/url/authority_view.hpp include/boost/url/authority_view.hpp 1391 5 1 function NxK2yg1Y7T4SxurWSwoUG97wrN0= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= heading text Complexity 1 paragraph text Linear in code text min( a0.size(), a1.size() ) heading text Exception Safety 1 paragraph text Throws nothing brief text Return the result of comparing two authorities. The authorities are compared component by component as if they were first normalized. returns code text true text if code text a0 != a1 text , otherwise code text false param text The first authority to compare a0 param text The second authority to compare a1 identifier bool 1 identifier d/hMlyyC3Ave6L9McUD7B4TwENA= authority_view a0 1 identifier d/hMlyyC3Ave6L9McUD7B4TwENA= authority_view a1 normal operator< boost/url/authority_view.hpp include/boost/url/authority_view.hpp 1415 5 1 overloads XBk4cGiSAiq2cC42CccYfpnYrn4= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= brief text Less-than operators returns code text true text if decoded code text lhs text is less than to the decoded code text rhs returns code text true text if code text u0 < u1 returns code text true text if code text a0 < a1 text , otherwise code text false param text The left-hand-side decode view to compare lhs param text The right-hand-side decode view to compare rhs param text The first url to compare u0 param text The second url to compare u1 param text The first authority to compare a0 param text The second authority to compare a1 normal OVm8/SgmvpzcmT0wU0//KbTy63M= R4RSA/p1I3uroTWbOqtfvFR/cF0= UbZF/ZfCDoPCOIiSZu6q2PC/Edk= Si07vh35lnvnJy8tpXUIpiFEjGM= qFHmi5LkvIRpILiiWOHp9hOpYQA= identifier bool operator< boost/url/decode_view.hpp include/boost/url/decode_view.hpp 793 5 1 function OVm8/SgmvpzcmT0wU0//KbTy63M= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= brief text Compare two decode views for less than returns code text true text if decoded code text lhs text is less than to the decoded code text rhs param text The left-hand-side decode view to compare lhs param text The right-hand-side decode view to compare rhs identifier bool 1 identifier S lhs 1 identifier IhE/V16b2wBX2q+s4QtlgzozWlQ= decode_view rhs normal operator< boost/url/decode_view.hpp include/boost/url/decode_view.hpp 776 5 1 function R4RSA/p1I3uroTWbOqtfvFR/cF0= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= brief text Compare two decode views for less than returns code text true text if decoded code text lhs text is less than to the decoded code text rhs param text The left-hand-side decode view to compare lhs param text The right-hand-side decode view to compare rhs identifier bool 1 identifier IhE/V16b2wBX2q+s4QtlgzozWlQ= decode_view lhs 1 identifier S rhs normal operator< boost/url/decode_view.hpp include/boost/url/decode_view.hpp 759 5 1 function UbZF/ZfCDoPCOIiSZu6q2PC/Edk= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= brief text Compare two decode views for less than returns code text true text if decoded code text lhs text is less than to the decoded code text rhs param text The left-hand-side decode view to compare lhs param text The right-hand-side decode view to compare rhs identifier bool 1 identifier IhE/V16b2wBX2q+s4QtlgzozWlQ= decode_view lhs 1 identifier IhE/V16b2wBX2q+s4QtlgzozWlQ= decode_view rhs normal operator< boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2572 5 1 function Si07vh35lnvnJy8tpXUIpiFEjGM= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text The URLs are compared component by component as if they were first normalized. heading text Example 1 code url_view u0( "http://www.a.com/index.htm" ); url_view u1( "http://www.b.com/index.htm" ); assert( u0 < u1 ); heading text Effects 1 code url a(u0); a.normalize(); url b(u1); b.normalize(); return a.buffer() < b.buffer(); heading text Complexity 1 paragraph text Linear in code text min( u0.size(), u1.size() ) heading text Exception Safety 1 paragraph text Throws nothing heading text Specification 1 list paragraph link text 6.2.2 Syntax-Based Normalization (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-6.2.2 unordered brief text Return the result of comparing two URLs returns code text true text if code text u0 < u1 param text The first url to compare u0 param text The second url to compare u1 reference static_url 4HBDcnMjZthTXFnhpS7z+UhDNjA= reference static_url_base dmsqdje8dXFRFgNB9wxOs9Y5nb8= reference url B4dRaSXMG3fDmuNKMW3KOeRu6kA= reference url_base aHkFCWJbYb0t+7FT+A5gCI0krpU= reference url_view wh3UbUToX9YDmRmnpcoM9EUEZo8= identifier bool 1 identifier UEVNhDEjkZMXfjN1DxbtX0n2rCg= url_view_base u0 1 identifier UEVNhDEjkZMXfjN1DxbtX0n2rCg= url_view_base u1 normal operator< boost/url/authority_view.hpp include/boost/url/authority_view.hpp 1415 5 1 function qFHmi5LkvIRpILiiWOHp9hOpYQA= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= heading text Complexity 1 paragraph text Linear in code text min( a0.size(), a1.size() ) heading text Exception Safety 1 paragraph text Throws nothing brief text Return the result of comparing two authorities. The authorities are compared component by component as if they were first normalized. returns code text true text if code text a0 < a1 text , otherwise code text false param text The first authority to compare a0 param text The second authority to compare a1 identifier bool 1 identifier d/hMlyyC3Ave6L9McUD7B4TwENA= authority_view a0 1 identifier d/hMlyyC3Ave6L9McUD7B4TwENA= authority_view a1 normal operator<= boost/url/authority_view.hpp include/boost/url/authority_view.hpp 1439 5 1 overloads tKIekZ4LOo4Oe6XEHJFLnYgizMk= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= brief text Less-than-or-equal operators returns code text true text if decoded code text lhs text is less than or equal to the decoded code text rhs returns code text true text if code text u0 <= u1 returns code text true text if code text a0 <= a1 text , otherwise code text false param text The left-hand-side decode view to compare lhs param text The right-hand-side decode view to compare rhs param text The first url to compare u0 param text The second url to compare u1 param text The first authority to compare a0 param text The second authority to compare a1 normal bZeyA134srRl+e70k55k9xdabWM= 4vZx12Tkx7fqOjRW/LuvhFPLbNQ= DnQyjGJxZiJY8aCECV80mE2qduU= rRCHC/6GEaVZrjzAeFDlvaCydi0= F1TeTah5Uxojczk8Fz++HrM66vU= identifier bool operator<= boost/url/decode_view.hpp include/boost/url/decode_view.hpp 860 5 1 function bZeyA134srRl+e70k55k9xdabWM= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= brief text Compare two decode views for less than or equal returns code text true text if decoded code text lhs text is less than or equal to the decoded code text rhs param text The left-hand-side decode view to compare lhs param text The right-hand-side decode view to compare rhs identifier bool 1 identifier S lhs 1 identifier IhE/V16b2wBX2q+s4QtlgzozWlQ= decode_view rhs normal operator<= boost/url/decode_view.hpp include/boost/url/decode_view.hpp 843 5 1 function 4vZx12Tkx7fqOjRW/LuvhFPLbNQ= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= brief text Compare two decode views for less than or equal returns code text true text if decoded code text lhs text is less than or equal to the decoded code text rhs param text The left-hand-side decode view to compare lhs param text The right-hand-side decode view to compare rhs identifier bool 1 identifier IhE/V16b2wBX2q+s4QtlgzozWlQ= decode_view lhs 1 identifier S rhs normal operator<= boost/url/decode_view.hpp include/boost/url/decode_view.hpp 826 5 1 function DnQyjGJxZiJY8aCECV80mE2qduU= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= brief text Compare two decode views for less than or equal returns code text true text if decoded code text lhs text is less than or equal to the decoded code text rhs param text The left-hand-side decode view to compare lhs param text The right-hand-side decode view to compare rhs identifier bool 1 identifier IhE/V16b2wBX2q+s4QtlgzozWlQ= decode_view lhs 1 identifier IhE/V16b2wBX2q+s4QtlgzozWlQ= decode_view rhs normal operator<= boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2616 5 1 function rRCHC/6GEaVZrjzAeFDlvaCydi0= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text The URLs are compared component by component as if they were first normalized. heading text Example 1 code url_view u0( "http://www.b.com/index.htm" ); url_view u1( "http://www.b.com/index.htm" ); assert( u0 <= u1 ); heading text Effects 1 code url a(u0); a.normalize(); url b(u1); b.normalize(); return a.buffer() <= b.buffer(); heading text Complexity 1 paragraph text Linear in code text min( u0.size(), u1.size() ) heading text Exception Safety 1 paragraph text Throws nothing heading text Specification 1 list paragraph link text 6.2.2 Syntax-Based Normalization (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-6.2.2 unordered brief text Return the result of comparing two URLs returns code text true text if code text u0 <= u1 param text The first url to compare u0 param text The second url to compare u1 reference static_url 4HBDcnMjZthTXFnhpS7z+UhDNjA= reference static_url_base dmsqdje8dXFRFgNB9wxOs9Y5nb8= reference url B4dRaSXMG3fDmuNKMW3KOeRu6kA= reference url_base aHkFCWJbYb0t+7FT+A5gCI0krpU= reference url_view wh3UbUToX9YDmRmnpcoM9EUEZo8= identifier bool 1 identifier UEVNhDEjkZMXfjN1DxbtX0n2rCg= url_view_base u0 1 identifier UEVNhDEjkZMXfjN1DxbtX0n2rCg= url_view_base u1 normal operator<= boost/url/authority_view.hpp include/boost/url/authority_view.hpp 1439 5 1 function F1TeTah5Uxojczk8Fz++HrM66vU= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= heading text Complexity 1 paragraph text Linear in code text min( a0.size(), a1.size() ) heading text Exception Safety 1 paragraph text Throws nothing brief text Return the result of comparing two authorities. The authorities are compared component by component as if they were first normalized. returns code text true text if code text a0 <= a1 text , otherwise code text false param text The first authority to compare a0 param text The second authority to compare a1 identifier bool 1 identifier d/hMlyyC3Ave6L9McUD7B4TwENA= authority_view a0 1 identifier d/hMlyyC3Ave6L9McUD7B4TwENA= authority_view a1 normal operator> boost/url/authority_view.hpp include/boost/url/authority_view.hpp 1463 5 1 overloads 9UoXN2fhMGIv9/Cwla3t/6wKV74= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= brief text Greater-than operators returns code text true text if decoded code text lhs text is greater than to the decoded code text rhs returns code text true text if code text u0 > u1 returns code text true text if code text a0 > a1 text , otherwise code text false param text The left-hand-side decode view to compare lhs param text The right-hand-side decode view to compare rhs param text The first url to compare u0 param text The second url to compare u1 param text The first authority to compare a0 param text The second authority to compare a1 normal B0rnFLRkOT6fyREi83RvdsGZIlQ= pRqLvkaFw0SG1RpbGWAKWhVi+kY= Oc4RZ743cU0XGETas6CbQ6l8OeU= ngGy21anUjaZiQQJidHT5lvOC2w= jlb8m5L+4Dp3wPZXOocje2gAGok= identifier bool operator> boost/url/decode_view.hpp include/boost/url/decode_view.hpp 927 5 1 function B0rnFLRkOT6fyREi83RvdsGZIlQ= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= brief text Compare two decode views for greater than returns code text true text if decoded code text lhs text is greater than to the decoded code text rhs param text The left-hand-side decode view to compare lhs param text The right-hand-side decode view to compare rhs identifier bool 1 identifier S lhs 1 identifier IhE/V16b2wBX2q+s4QtlgzozWlQ= decode_view rhs normal operator> boost/url/decode_view.hpp include/boost/url/decode_view.hpp 910 5 1 function pRqLvkaFw0SG1RpbGWAKWhVi+kY= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= brief text Compare two decode views for greater than returns code text true text if decoded code text lhs text is greater than to the decoded code text rhs param text The left-hand-side decode view to compare lhs param text The right-hand-side decode view to compare rhs identifier bool 1 identifier IhE/V16b2wBX2q+s4QtlgzozWlQ= decode_view lhs 1 identifier S rhs normal operator> boost/url/decode_view.hpp include/boost/url/decode_view.hpp 893 5 1 function Oc4RZ743cU0XGETas6CbQ6l8OeU= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= brief text Compare two decode views for greater than returns code text true text if decoded code text lhs text is greater than to the decoded code text rhs param text The left-hand-side decode view to compare lhs param text The right-hand-side decode view to compare rhs identifier bool 1 identifier IhE/V16b2wBX2q+s4QtlgzozWlQ= decode_view lhs 1 identifier IhE/V16b2wBX2q+s4QtlgzozWlQ= decode_view rhs normal operator> boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2660 5 1 function ngGy21anUjaZiQQJidHT5lvOC2w= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text The URLs are compared component by component as if they were first normalized. heading text Example 1 code url_view u0( "http://www.b.com/index.htm" ); url_view u1( "http://www.a.com/index.htm" ); assert( u0 > u1 ); heading text Effects 1 code url a(u0); a.normalize(); url b(u1); b.normalize(); return a.buffer() > b.buffer(); heading text Complexity 1 paragraph text Linear in code text min( u0.size(), u1.size() ) heading text Exception Safety 1 paragraph text Throws nothing heading text Specification 1 list paragraph link text 6.2.2 Syntax-Based Normalization (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-6.2.2 unordered brief text Return the result of comparing two URLs returns code text true text if code text u0 > u1 param text The first url to compare u0 param text The second url to compare u1 reference static_url 4HBDcnMjZthTXFnhpS7z+UhDNjA= reference static_url_base dmsqdje8dXFRFgNB9wxOs9Y5nb8= reference url B4dRaSXMG3fDmuNKMW3KOeRu6kA= reference url_base aHkFCWJbYb0t+7FT+A5gCI0krpU= reference url_view wh3UbUToX9YDmRmnpcoM9EUEZo8= identifier bool 1 identifier UEVNhDEjkZMXfjN1DxbtX0n2rCg= url_view_base u0 1 identifier UEVNhDEjkZMXfjN1DxbtX0n2rCg= url_view_base u1 normal operator> boost/url/authority_view.hpp include/boost/url/authority_view.hpp 1463 5 1 function jlb8m5L+4Dp3wPZXOocje2gAGok= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= heading text Complexity 1 paragraph text Linear in code text min( a0.size(), a1.size() ) heading text Exception Safety 1 paragraph text Throws nothing brief text Return the result of comparing two authorities. The authorities are compared component by component as if they were first normalized. returns code text true text if code text a0 > a1 text , otherwise code text false param text The first authority to compare a0 param text The second authority to compare a1 identifier bool 1 identifier d/hMlyyC3Ave6L9McUD7B4TwENA= authority_view a0 1 identifier d/hMlyyC3Ave6L9McUD7B4TwENA= authority_view a1 normal operator>= boost/url/authority_view.hpp include/boost/url/authority_view.hpp 1487 5 1 overloads evLaAmUXMOD+YMeWXJG9YdwR4xw= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= brief text Greater-than-or-equal operators returns code text true text if decoded code text lhs text is greater than or equal to the decoded code text rhs returns code text true text if code text u0 >= u1 returns code text true text if code text a0 >= a1 text , otherwise code text false param text The left-hand-side decode view to compare lhs param text The right-hand-side decode view to compare rhs param text The first url to compare u0 param text The second url to compare u1 param text The first authority to compare a0 param text The second authority to compare a1 normal nFUncXFoKaz6GC1HbXnibuE8ezg= njx8Q7wnnD1jPqxCgk6VjUufNlY= aAj/wyLdJMro0+uVDfExz9lDP2g= AdXFp/RvPKHF4rljfa5/5yBmyfs= hFJopnR14fIqBpDu1GGpNyp3Y5c= identifier bool operator>= boost/url/decode_view.hpp include/boost/url/decode_view.hpp 994 5 1 function nFUncXFoKaz6GC1HbXnibuE8ezg= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= brief text Compare two decode views for greater than or equal returns code text true text if decoded code text lhs text is greater than or equal to the decoded code text rhs param text The left-hand-side decode view to compare lhs param text The right-hand-side decode view to compare rhs identifier bool 1 identifier S lhs 1 identifier IhE/V16b2wBX2q+s4QtlgzozWlQ= decode_view rhs normal operator>= boost/url/decode_view.hpp include/boost/url/decode_view.hpp 977 5 1 function njx8Q7wnnD1jPqxCgk6VjUufNlY= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= brief text Compare two decode views for greater than or equal returns code text true text if decoded code text lhs text is greater than or equal to the decoded code text rhs param text The left-hand-side decode view to compare lhs param text The right-hand-side decode view to compare rhs identifier bool 1 identifier IhE/V16b2wBX2q+s4QtlgzozWlQ= decode_view lhs 1 identifier S rhs normal operator>= boost/url/decode_view.hpp include/boost/url/decode_view.hpp 960 5 1 function aAj/wyLdJMro0+uVDfExz9lDP2g= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= brief text Compare two decode views for greater than or equal returns code text true text if decoded code text lhs text is greater than or equal to the decoded code text rhs param text The left-hand-side decode view to compare lhs param text The right-hand-side decode view to compare rhs identifier bool 1 identifier IhE/V16b2wBX2q+s4QtlgzozWlQ= decode_view lhs 1 identifier IhE/V16b2wBX2q+s4QtlgzozWlQ= decode_view rhs normal operator>= boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2704 5 1 function AdXFp/RvPKHF4rljfa5/5yBmyfs= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text The URLs are compared component by component as if they were first normalized. heading text Example 1 code url_view u0( "http://www.a.com/index.htm" ); url_view u1( "http://www.a.com/index.htm" ); assert( u0 >= u1 ); heading text Effects 1 code url a(u0); a.normalize(); url b(u1); b.normalize(); return a.buffer() >= b.buffer(); heading text Complexity 1 paragraph text Linear in code text min( u0.size(), u1.size() ) heading text Exception Safety 1 paragraph text Throws nothing heading text Specification 1 list paragraph link text 6.2.2 Syntax-Based Normalization (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-6.2.2 unordered brief text Return the result of comparing two URLs returns code text true text if code text u0 >= u1 param text The first url to compare u0 param text The second url to compare u1 reference static_url 4HBDcnMjZthTXFnhpS7z+UhDNjA= reference static_url_base dmsqdje8dXFRFgNB9wxOs9Y5nb8= reference url B4dRaSXMG3fDmuNKMW3KOeRu6kA= reference url_base aHkFCWJbYb0t+7FT+A5gCI0krpU= reference url_view wh3UbUToX9YDmRmnpcoM9EUEZo8= identifier bool 1 identifier UEVNhDEjkZMXfjN1DxbtX0n2rCg= url_view_base u0 1 identifier UEVNhDEjkZMXfjN1DxbtX0n2rCg= url_view_base u1 normal operator>= boost/url/authority_view.hpp include/boost/url/authority_view.hpp 1487 5 1 function hFJopnR14fIqBpDu1GGpNyp3Y5c= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= heading text Complexity 1 paragraph text Linear in code text min( a0.size(), a1.size() ) heading text Exception Safety 1 paragraph text Throws nothing brief text Return the result of comparing two authorities. The authorities are compared component by component as if they were first normalized. returns code text true text if code text a0 >= a1 text , otherwise code text false param text The first authority to compare a0 param text The second authority to compare a1 identifier bool 1 identifier d/hMlyyC3Ave6L9McUD7B4TwENA= authority_view a0 1 identifier d/hMlyyC3Ave6L9McUD7B4TwENA= authority_view a1 normal absolute_uri_rule boost/url/rfc/absolute_uri_rule.hpp include/boost/url/rfc/absolute_uri_rule.hpp 69 1 1 variable 4SGJz+AJ+UhdwU8wP3Xh11mlvBM= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= heading text Value Type 1 code using value_type = url_view; heading text Example 1 paragraph text Rules are used with the function reference grammar::parse laQxW+BBeJINbRrZtau+U15+v7c= text . code system::result< url_view > rv = grammar::parse( "http://example.com/index.htm?id=1", absolute_uri_rule ); heading text BNF 1 code absolute-URI = scheme ":" hier-part [ "?" query ] hier-part = "//" authority path-abempty / path-absolute / path-rootless / path-empty heading text Specification 1 list paragraph link text 4.3. Absolute URI (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-4.3 unordered brief text Rule for absolute-URI see reference grammar::parse laQxW+BBeJINbRrZtau+U15+v7c= text , reference parse_absolute_uri U3CVElRbcTcbg1JzOqhBCd5RSzM= text , reference url_view wh3UbUToX9YDmRmnpcoM9EUEZo8= text . identifier ULWu8e+1y5m/ZQncGkLNDTIjCng= absolute_uri_rule_t identifier xCd2tUlylXT9zvj8ZcHXybU4P/k= implementation_defined {} 1 1 authority_rule boost/url/rfc/authority_rule.hpp include/boost/url/rfc/authority_rule.hpp 62 1 1 variable kWc6VwnEqWA0KYFMRYavAgCCB4M= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= heading text Value Type 1 code using value_type = authority_view; heading text Example 1 paragraph text Rules are used with the function reference grammar::parse laQxW+BBeJINbRrZtau+U15+v7c= text . code system::result< authority_view > rv = grammar::parse( "user:pass@example.com:8080", authority_rule ); heading text BNF 1 code authority = [ userinfo "@" ] host [ ":" port ] heading text Specification 1 list paragraph link text 3.2. Authority (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2 unordered brief text Rule for authority see reference authority_view d/hMlyyC3Ave6L9McUD7B4TwENA= text , reference grammar::parse laQxW+BBeJINbRrZtau+U15+v7c= text , reference parse_authority dl7C/yP8Suze9+hv0RfYWxZaWCY= text . identifier K+GE1hzkSGKOq3ThCLWBwd5DTuE= authority_rule_t identifier xCd2tUlylXT9zvj8ZcHXybU4P/k= implementation_defined {} 1 gen_delim_chars boost/url/rfc/gen_delim_chars.hpp include/boost/url/rfc/gen_delim_chars.hpp 44 1 1 variable M0EYo5t0pgHX2bya+60gL5gq8Mc= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= heading text Example 1 paragraph text Character sets are used with rules and the functions reference grammar::find_if tYu+dbhQn5Jt+oUv1QmBQz+Z4Mk= text and reference grammar::find_if_not o4IF1hl0/rSoqWdSZjOKE4MHFjM= text . code system::result< decode_view > rv = grammar::parse( "Program%20Files", pct_encoded_rule( gen_delim_chars ) ); heading text BNF 1 code gen-delims = ":" / "/" / "?" / "#" / "[" / "]" / "@" heading text Specification 1 list paragraph link text 2.2. Reserved Characters (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-2.2 unordered brief text The gen-delims character set see reference grammar::find_if tYu+dbhQn5Jt+oUv1QmBQz+Z4Mk= text , reference grammar::find_if_not o4IF1hl0/rSoqWdSZjOKE4MHFjM= text , reference grammar::parse laQxW+BBeJINbRrZtau+U15+v7c= text , reference pct_encoded_rule tqgOJBBmkI71v1H8Vjo+5AjUBNk= text . identifier 79IFwv0C40oPrhucou1uA6DC1RI= lut_chars identifier 1HiiaUSr2qeoadbVYr8/BZxU47k= grammar ":/?#[]@" 1 ignore_case boost/url/ignore_case.hpp include/boost/url/ignore_case.hpp 29 1 1 variable y4Fn2Zc8bAvOrHSAL6ln/eSRNjo= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text This value may be optionally passed to functions accepting a parameter of type reference ignore_case_param RATceEbebMWrhFXGkG2RDFi+7WY= text to indicate that comparisons should be case-insensitive. brief text Ignore case when comparing identifier X8bO9PzAZhZe4KoaCSz4/o1kias= ignore_case_t identifier xCd2tUlylXT9zvj8ZcHXybU4P/k= implementation_defined {} 1 1 ipv4_address_rule boost/url/rfc/ipv4_address_rule.hpp include/boost/url/rfc/ipv4_address_rule.hpp 71 1 1 variable M9SQbDZx89d7w32vLj4LMkyNHYI= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= heading text Value Type 1 code using value_type = ipv4_address; heading text Example 1 paragraph text Rules are used with the function reference grammar::parse laQxW+BBeJINbRrZtau+U15+v7c= text . code system::result< ipv4_address > rv = grammar::parse( "192.168.0.1", ipv4_address_rule ); heading text BNF 1 code IPv4address = dec-octet "." dec-octet "." dec-octet "." dec-octet dec-octet = DIGIT ; 0-9 / %x31-39 DIGIT ; 10-99 / "1" 2DIGIT ; 100-199 / "2" %x30-34 DIGIT ; 200-249 / "25" %x30-35 ; 250-255 heading text Specification 1 list paragraph link text IPv4 (Wikipedia) https://en.wikipedia.org/wiki/IPv4 paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Rule for an IP version 4 style address see reference ipv4_address /Wpp3ZZDp3kUHzbULeDoaOEhnVs= text , reference parse_ipv4_address 3H1nFll3jIwKtiUjrAoL1itMXS8= text , reference grammar::parse laQxW+BBeJINbRrZtau+U15+v7c= text . identifier oNcW0Zh+zvzi9SUKiAhcndAKBL0= ipv4_address_rule_t identifier xCd2tUlylXT9zvj8ZcHXybU4P/k= implementation_defined {} 1 ipv6_address_rule boost/url/rfc/ipv6_address_rule.hpp include/boost/url/rfc/ipv6_address_rule.hpp 79 1 1 variable HNlbMWgGFyUa8zfk9rDcguyMilg= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= heading text Value Type 1 code using value_type = ipv6_address; heading text Example 1 paragraph text Rules are used with the function reference grammar::parse laQxW+BBeJINbRrZtau+U15+v7c= text . code system::result< ipv6_address > rv = grammar::parse( "2001:0db8:85a3:0000:0000:8a2e:0370:7334", ipv6_address_rule ); heading text BNF 1 code IPv6address = 6( h16 ":" ) ls32 / "::" 5( h16 ":" ) ls32 / [ h16 ] "::" 4( h16 ":" ) ls32 / [ *1( h16 ":" ) h16 ] "::" 3( h16 ":" ) ls32 / [ *2( h16 ":" ) h16 ] "::" 2( h16 ":" ) ls32 / [ *3( h16 ":" ) h16 ] "::" h16 ":" ls32 / [ *4( h16 ":" ) h16 ] "::" ls32 / [ *5( h16 ":" ) h16 ] "::" h16 / [ *6( h16 ":" ) h16 ] "::" ls32 = ( h16 ":" h16 ) / IPv4address ; least-significant 32 bits of address h16 = 1*4HEXDIG ; 16 bits of address represented in hexadecimal heading text Specification 1 list paragraph link text IP Version 6 Addressing Architecture (rfc4291) https://datatracker.ietf.org/doc/html/rfc4291 paragraph link text 3.2.2. Host (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2 unordered brief text Rule for An IP version 6 style address see reference ipv6_address dhMSRVBIIIItY0URHSc8rwHcdTQ= text , reference parse_ipv6_address bEw/qaAlNfZy1QraETx5dipoF+I= text , reference grammar::parse laQxW+BBeJINbRrZtau+U15+v7c= text . identifier A26koPySRJKlDatdXQouZa07zD4= ipv6_address_rule_t identifier xCd2tUlylXT9zvj8ZcHXybU4P/k= implementation_defined {} 1 no_value boost/url/param.hpp include/boost/url/param.hpp 36 1 1 variable INQ2ouuVlRY3LsAsb8F4jYk7wBA= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= brief text Constant indicating no value in a param identifier 51rV2xfhRV96h9L23+q8lPiw4x8= no_value_t {} 1 origin_form_rule boost/url/rfc/origin_form_rule.hpp include/boost/url/rfc/origin_form_rule.hpp 68 1 1 variable nz+wKEzMLKgYPZA/4y/jAJmzf6I= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= paragraph text This appears in the HTTP/1 request-line grammar. heading text Value Type 1 code using value_type = url_view; heading text Example 1 paragraph text Rules are used with the function reference grammar::parse laQxW+BBeJINbRrZtau+U15+v7c= text . code system::result< url_view > rv = grammar::parse( "/index.htm?layout=mobile", origin_form_rule ); heading text BNF 1 code origin-form = absolute-path [ "?" query ] absolute-path = 1*( "/" segment ) heading text Specification 1 list paragraph link text 5.3.1. origin-form (rfc7230) https://datatracker.ietf.org/doc/html/rfc7230#section-5.3.1 unordered brief text Rule for origin-form see reference grammar::parse laQxW+BBeJINbRrZtau+U15+v7c= text , reference parse_origin_form J4f05lEg7oi89R2SkpRaYiBhCIQ= text , reference url_view wh3UbUToX9YDmRmnpcoM9EUEZo8= text . identifier A87uUMvaeqqseND6B+bppJkjKco= origin_form_rule_t identifier xCd2tUlylXT9zvj8ZcHXybU4P/k= implementation_defined {} 1 1 pchars boost/url/rfc/pchars.hpp include/boost/url/rfc/pchars.hpp 45 1 1 variable 2V+Z9ecepqbZRna6GFcGry1dzDs= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= heading text Example 1 paragraph text Character sets are used with rules and the functions reference grammar::find_if tYu+dbhQn5Jt+oUv1QmBQz+Z4Mk= text and reference grammar::find_if_not o4IF1hl0/rSoqWdSZjOKE4MHFjM= text . code system::result< decode_view > rv = grammar::parse( "Program%20Files", pchars ); heading text BNF 1 code pchar = unreserved / pct-encoded / sub-delims / ":" / "@" heading text Specification 1 list paragraph link text 3.3. Path (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 unordered brief text The path character set see reference grammar::find_if tYu+dbhQn5Jt+oUv1QmBQz+Z4Mk= text , reference grammar::find_if_not o4IF1hl0/rSoqWdSZjOKE4MHFjM= text , reference grammar::parse laQxW+BBeJINbRrZtau+U15+v7c= text , reference pct_encoded_rule tqgOJBBmkI71v1H8Vjo+5AjUBNk= text . unreserved_chars + sub_delim_chars + ':' + '@' 1 query_rule boost/url/rfc/query_rule.hpp include/boost/url/rfc/query_rule.hpp 70 1 1 variable 6a/9GskAZnBXlwr4d3UtNR0aCNQ= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= heading text Value Type 1 code using value_type = params_encoded_view; heading text Example 1 paragraph text Rules are used with the function reference grammar::parse laQxW+BBeJINbRrZtau+U15+v7c= text . code system::result< params_encoded_view > rv = grammar::parse( "format=web&id=42&compact", query_rule ); heading text BNF 1 code query = *( pchar / "/" / "?" ) query-params = [ query-param ] *( "&" query-param ) query-param = key [ "=" value ] key = *qpchar value = *( qpchar / "=" ) qpchar = unreserved / pct-encoded / "!" / "$" / "'" / "(" / ")" / "*" / "+" / "," / ";" / ":" / "@" / "/" / "?" heading text Specification 1 list paragraph link text 3.4. Query (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 unordered brief text Rule for a query string see reference grammar::parse laQxW+BBeJINbRrZtau+U15+v7c= text , reference params_encoded_view 0nSfM4mK92fIx58KtzdWGiHuq2w= text . identifier 6BnTFtZi8y58Qk6SU1LtvEpeCy0= query_rule_t identifier xCd2tUlylXT9zvj8ZcHXybU4P/k= implementation_defined {} 1 relative_ref_rule boost/url/rfc/relative_ref_rule.hpp include/boost/url/rfc/relative_ref_rule.hpp 64 1 1 variable SMHCvo8zmYWXaMRwpIb2LkyRmJE= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= heading text Value Type 1 code using value_type = url_view; heading text Example 1 paragraph text Rules are used with the function reference grammar::parse laQxW+BBeJINbRrZtau+U15+v7c= text . code system::result< url_view > rv = grammar::parse( "images/dot.gif?v=hide#a", relative_ref_rule ); heading text BNF 1 code relative-ref = relative-part [ "?" query ] [ "#" fragment ] heading text Specification 1 list paragraph link text 4.2. Relative Reference (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-4.2 unordered brief text Rule for relative-ref see reference grammar::parse laQxW+BBeJINbRrZtau+U15+v7c= text , reference parse_relative_ref QFzcl8vSLEeKOEO6w3mv1zGqX3k= text , reference url_view wh3UbUToX9YDmRmnpcoM9EUEZo8= text . identifier tojwBud9+1o/12apbTevwuH6eng= relative_ref_rule_t identifier xCd2tUlylXT9zvj8ZcHXybU4P/k= implementation_defined {} 1 reserved_chars boost/url/rfc/reserved_chars.hpp include/boost/url/rfc/reserved_chars.hpp 39 1 1 variable LHgNC6HzmNSmob+HNYbdFf3I/ss= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= heading text Example 1 paragraph text Character sets are used with rules and the functions reference grammar::find_if tYu+dbhQn5Jt+oUv1QmBQz+Z4Mk= text and reference grammar::find_if_not o4IF1hl0/rSoqWdSZjOKE4MHFjM= text . code system::result< decode_view > rv = grammar::parse( "Program%20Files", pct_encoded_rule( reserved_chars ) ); heading text Specification 1 list paragraph link text 2.3. Unreserved Characters (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-2.3 unordered brief text The reserved character set see reference grammar::find_if tYu+dbhQn5Jt+oUv1QmBQz+Z4Mk= text , reference grammar::find_if_not o4IF1hl0/rSoqWdSZjOKE4MHFjM= text , reference grammar::parse laQxW+BBeJINbRrZtau+U15+v7c= text , reference pct_encoded_rule tqgOJBBmkI71v1H8Vjo+5AjUBNk= text . ~unreserved_chars 1 sub_delim_chars boost/url/rfc/sub_delim_chars.hpp include/boost/url/rfc/sub_delim_chars.hpp 45 1 1 variable W5ZnEm5Wr2aNUSnMwlBHGfqRHgY= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= heading text Example 1 paragraph text Character sets are used with rules and the functions reference grammar::find_if tYu+dbhQn5Jt+oUv1QmBQz+Z4Mk= text and reference grammar::find_if_not o4IF1hl0/rSoqWdSZjOKE4MHFjM= text . code system::result< decode_view > = grammar::parse( "Program%20Files", pct_encoded_rule( sub_delim_chars ) ); heading text BNF 1 code sub-delims = "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" / "," / ";" / "=" heading text Specification 1 list paragraph link text 2.2. Reserved Characters (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-2.2 unordered brief text The sub-delims character set see reference grammar::find_if tYu+dbhQn5Jt+oUv1QmBQz+Z4Mk= text , reference grammar::find_if_not o4IF1hl0/rSoqWdSZjOKE4MHFjM= text , reference grammar::parse laQxW+BBeJINbRrZtau+U15+v7c= text , reference pct_encoded_rule tqgOJBBmkI71v1H8Vjo+5AjUBNk= text . identifier 79IFwv0C40oPrhucou1uA6DC1RI= lut_chars identifier 1HiiaUSr2qeoadbVYr8/BZxU47k= grammar "!$&()*+,;=\x27" 1 unreserved_chars boost/url/rfc/unreserved_chars.hpp include/boost/url/rfc/unreserved_chars.hpp 44 1 1 variable sPt+l16WQkJLiqM+m+B6d5s9eA0= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= heading text Example 1 paragraph text Character sets are used with rules and the functions reference grammar::find_if tYu+dbhQn5Jt+oUv1QmBQz+Z4Mk= text and reference grammar::find_if_not o4IF1hl0/rSoqWdSZjOKE4MHFjM= text . code system::result< decode_view > rv = grammar::parse( "Program%20Files", pct_encoded_rule( unreserved_chars ) ); heading text BNF 1 code unreserved = ALPHA / DIGIT / "-" / "." / "_" / "~" heading text Specification 1 list paragraph link text 2.3. Unreserved Characters (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-2.3 unordered brief text The unreserved character set see reference grammar::find_if tYu+dbhQn5Jt+oUv1QmBQz+Z4Mk= text , reference grammar::find_if_not o4IF1hl0/rSoqWdSZjOKE4MHFjM= text , reference grammar::parse laQxW+BBeJINbRrZtau+U15+v7c= text , reference pct_encoded_rule tqgOJBBmkI71v1H8Vjo+5AjUBNk= text . identifier 79IFwv0C40oPrhucou1uA6DC1RI= lut_chars identifier 1HiiaUSr2qeoadbVYr8/BZxU47k= grammar "ABCDEFGHIJKLMNOPQRSTUVWXYZ" "abcdefghijklmnopqrstuvwxyz" "0123456789" "-._~" 1 uri_reference_rule boost/url/rfc/uri_reference_rule.hpp include/boost/url/rfc/uri_reference_rule.hpp 67 1 1 variable S1qIdty2BzQiH3cIDwP1tc/RJzM= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= heading text Value Type 1 code using value_type = url_view; heading text Example 1 paragraph text Rules are used with the function reference grammar::parse laQxW+BBeJINbRrZtau+U15+v7c= text . code system::result< url_view > rv = grammar::parse( "ws://echo.example.com/?name=boost#demo", uri_reference_rule ); heading text BNF 1 code URI-reference = URI / relative-ref URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] relative-ref = relative-part [ "?" query ] [ "#" fragment ] heading text Specification 1 list paragraph link text 3. Syntax Components (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3 unordered brief text Rule for URI-reference see reference grammar::parse laQxW+BBeJINbRrZtau+U15+v7c= text , reference parse_uri_reference 7d2b1xVBWJPgL/+PWFdoBaZJvMA= text , reference url_view wh3UbUToX9YDmRmnpcoM9EUEZo8= text . identifier Xicirg+nwaf6LsTkCuUaRNAJdRU= uri_reference_rule_t identifier xCd2tUlylXT9zvj8ZcHXybU4P/k= implementation_defined {} 1 uri_rule boost/url/rfc/uri_rule.hpp include/boost/url/rfc/uri_rule.hpp 64 1 1 variable AL2wo0R+80Md4UIYeUHuHTClsvI= regular dnk5XPfR2OaMpCYaH3cWSxcTdyc= heading text Value Type 1 code using value_type = url_view; heading text Example 1 paragraph text Rules are used with the function reference grammar::parse laQxW+BBeJINbRrZtau+U15+v7c= text . code system::result< url_view > rv = grammar::parse( "https://www.example.com/index.htm?id=guest#s1", uri_rule ); heading text BNF 1 code URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] heading text Specification 1 list paragraph link text 3. Syntax Components (rfc3986) https://datatracker.ietf.org/doc/html/rfc3986#section-3 unordered brief text Rule for URI see reference grammar::parse laQxW+BBeJINbRrZtau+U15+v7c= text , reference parse_uri f+9kR517VGSM5ZPoS7g/RFb0g/0= text , reference url_view wh3UbUToX9YDmRmnpcoM9EUEZo8= text . identifier HtzG2IcqWtOoDM4HjT7YflVbDwI= uri_rule_t identifier xCd2tUlylXT9zvj8ZcHXybU4P/k= implementation_defined {} 1