namespace 4ZrjxJnU1LA5xSyrWMNuXTvSYKwt regular 4Mr2JeTsyczjdded6w2dFkYVQSuM 4VB1YRZ5xEZNSpqzp72yMeXnHRtn 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy otMKX5K21ws6HNQdLF1WxoZ6eaj 3q8wMY9qgurN6bxfeM1p7Frivch6 33hpLzSGuSX59WtwA9AjxEb2V9x4 L9EzVjt1tJ3urg5EuRbd8Qno1NC 22QREmHybN37zRBVoWcbcw3YBSRP 4PWS7skEnep2rjK6YtG5XLNgtz9c 8cCoHos9Ksw8a44pgsPE9B3kdyo w7yWEPLwtMpd5GnNHsV5ASwVxkX 4KjaSgopuTVfQLGVzojerLeoD327 29GwPtZpZfMaUFHNVeij8XCQFCfm 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 4VB1YRZ5xEZNSpqzp72yMeXnHRtn regular 4ZrjxJnU1LA5xSyrWMNuXTvSYKwt 2yhXyqRJb8cGER6KEEutsDnLWwWD 2Ec6WRHMWfvaQrceRQzhGdQJ2RAo 4NEdCTuie5Kv5GxXQYyH6RGmrxLn dgHcH1svHs5X3czTwE2RBXQ7tGq 2ejQGW57K8g7MFJhHAwPt5aumoLa 49AqEUzH6MSvXRjmRaQ8TgX7Zj9E 3arayeUfPESY5Fr3HEuXNuY8onj2 3KuyMbjBnZgTEj1n7927HzbnUHBt 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 2ejQGW57K8g7MFJhHAwPt5aumoLa regular 4VB1YRZ5xEZNSpqzp72yMeXnHRtn identifier 2d1fP4mznLCieoEAkcQMHzmN4sMA error_types mfaqhPxS153ZSpqTntjkRe3VH3r 2d1fP4mznLCieoEAkcQMHzmN4sMA 3xgiPUvbkGK69EKtHNfc9suQevEU 3jVzhUTY78j9Azdaoqzm3EeWXkEU gXLgKAknGYwc12RGZfBgr4HdDCT 2268wJ294zj5ry16xNemaWKRCZKm QNkXGvn4uvcuVhhsDd6QgTGgpMa 3FCL7hYN4kMytJQRw4DmkYAPaTGX 2gxMGgaDG7oA9nqZUjApPoyf9cad Jqwu89tbEUEtvWWz9bQx3m2TDPk 2fwXocwnoAG9WDGbqM3quKphV1qq UXcENkB7t9T6PDWy1z6kk8ej8kT 5dyN7z5egGMdJFpXz9WbaL549xC wxnor5Tun8FXFjfB7Jm4ghwuNS9 4Xmd9k1GBKGKQj6PYc1qdt4tMUae 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T 4DwiW6tfGAuwSbZpXpoaKSA3VizJ 2mSdVJKVJxHo9zo74jwzBLgs2Scz 21okxUDyXpX2g3uj7TzYTtM4Skgh AbvEAFQMtFaLMVMSA2NZ5D5a7nN 3JqzyR89pExMFqZFBHMskoM3dq3x 44gF3RWPKyorxySQWG1hnA4vjiJu 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe 3w4FJjjADY3EEHqUmBj5mvDKqdEB 4MtPiWDytNMbqCE6iciHidLK5Y4c DJiFqyFR7zZh4N3HNJHhiAj7JPV 3ZY5EydXePv2wNz8JPvc5skA7Bn4 2ozZGf8LNFZmRaMXAL5TZg2G1emh 3P1yc8wQhLivRSyTPUbRYh2dtWLg 24XcpKBAcyXN6FLZk8kR4zGAmKak GKjeDHooSf2HAMf239p3oFfT3i3 3sLepuFTMctJHoZrLv8tvJTFkDPS 2QU7risgZzo8F84g7LttC6dG1GsH 48MaMwY7JqeST8Mfy8WBA7wGLSzT 2egpzk38s9q8jE4fNG71Y15WvAVC 75qVNpuBHShJ8KKEUv4RCrwxEAB 2TREmHUMfZeMQz9yyw5HzqB91APN 3hrVvoVYoDkX9t3w9abTXxDqGRaW 27ryuyAvvRyzfzgketja5uQcFBcK 3uBPnjWo3AGtWCgQC8qvoJGUhjbU 2M8hT55CSziFA9Zup4mKYdwvgUiE tVuW4uzt1HMgUxPtxroTuMsNi2G ThuCYkNXzjJHhdcL2TZSz7uRwM7 F3NQkSa7n8MbRcZdK1PdHd8YmK2 4WeAoq3Y12sashfxn8vcwvrbe3Td 3vkqqomfBUowfgqyeii3TrJVgnxo 3xB3BfuNs4uV9HRTA6DGtHfJP2Wh 3p6NFmVMACBg2TKNhjDgbqESkCqF 2KWV3g149ZmZytTFz7sErpzwi7zX 2QoWAGV4WnZixaqkFZhZFWzYzizZ HqUWyeBKSK1fBrdG5vHTeybKMGZ 39Smh5do547A49AGGeWYMFmMKD3e eUt91i1T5kbaJ9ChAK4r9wB4Z4T 2ARWB82XdRYexehQmFQZjcEKzoSi 2eeZHdWXgsV3fMDoL3MrbjDNWopq 45AWvW23tadRhrV2Rr5Wwg5c83dx 2WWWLGhxBBf6EtKLCdxA28UdXFJ1 YwftbCXGz1kG5uRUguacNEwrkaP 27xn5abqwdvTfjVgEWccUE46qWjE 3aMNKrgRSuUL46UjPvkFSPkcStNk u1SFmy6a6wtXTYxrMnssMwa7K6G 2nNq8RtS22vhgfkFAo8dGh6NW87n 4KCrVrNi2iTJ15zBNtvdSNip4rmV 3YbQmLbv9k5hQejotb1EQGfGvbSp 4ZbWvyKBMwfyhwwk3YYEco8ttTeS 2Cc8cH7Z7ExrsLbjk4geBrdf5cZS 3TA5xAVGZHDj1nxZB9BputbD8861 2XRMQjtBJPK89zguipj5hUZFjVnV 22eZSjWyZJ484enpzywKvFyqeCSv EweXU6CdQNznpRpRAAX7dEk8PbR 25qqadXNgBGpEFccRzomfgrC8yBY 2HRJhYcLkr4Mm6M4RsvesRoDbXim 3WxbG8kXgRFxkzzyxQFypyYEiuQk 4RCn3DDKRk73T6wL2oYD2oBAstJR 2iM8g9kTAvadg6T8ZbSNPerCByPZ 48v2goykSGwK1v9STZJpo6jjTuxW 32VVcQFEhxqnXpaLAaf9VCsLxUkr iR6LspA69mvSF536xn6sd3cfwu8 3qSXNyNHTb9MsSXvAjVCvfvrgLhw it6B79qPoGNqdsdLCd4XteaXCL9 QK3agZDmGM1BdHqFkerviQEKvKH TXZvizo9ikqMQ3HygeHisBPEJ15 3DgP78orKFq8Q1iGscjBtBswa56h 42eTmvy8HvVVvNVPdDoa76n3UmQW 4Fq39ThcWdj4r5uCUrQeszNi4Yzf 21nqX1C987QTr3KX6K9pY8iBbWfJ cw6C7WHL2uNn5JnsspM2qAHKNbt 2H1MfGiECvLAki16SCP9AAnDgsdX 3U1VJchaHf6kHuVX7q3rr33jE4fW 23tY9bZN8SibU8Z2Hwu1KgZeLxsU 1bj9jipu5RbWBZYRqwfGNT1eJWu 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 mfaqhPxS153ZSpqTntjkRe3VH3r implementation-defined 2ejQGW57K8g7MFJhHAwPt5aumoLa n99AUCKSxVtUHYFUKsLGzHYfQ4H 3oK1iJoiVY5NcJ8vXuc3siWirK2a 4ZDF3RAGv4Z4uhkPm2urzNfGH1Xf 4Pe9L1tkaCX5RF7fFS3ZST79VPNW 2iXNbxzVCqjNzcA1m38Pbx8cks3d b7ouTZWsVer7cg6kEQ11rWoKWDv 2cG2DXLQJWyzCZDdFUpQS6VLFbjt 4NhPu7pg3WdvhMmGfiprN7jkkp2D 4JAJbdgG6HTwY9R6MD7yTqabqDs2 43QZiLt11TgZqoTfWYA4NWFTYDAp 27bdtK5gXBJwht9cCTZ7gZhA4mjZ 3jE2W9VxLYKnb9sp9p23AzeUPFvD 48vAm9v3TELjzybeQ2Vr8UeSSXT7 2fBifzZ5fJ8gve5SABaTGVasbzZH f4Th4UWVHuAghRXqWUWohEijLBB any_params_iter boost/url/detail/any_params_iter.hpp include/boost/url/detail/any_params_iter.hpp 34 1 record n99AUCKSxVtUHYFUKsLGzHYfQ4H implementation-defined mfaqhPxS153ZSpqTntjkRe3VH3r other __visibility__ struct any_segments_iter boost/url/detail/any_segments_iter.hpp include/boost/url/detail/any_segments_iter.hpp 23 1 record 3oK1iJoiVY5NcJ8vXuc3siWirK2a implementation-defined mfaqhPxS153ZSpqTntjkRe3VH3r other __visibility__ struct format_arg boost/url/detail/format_args.hpp include/boost/url/detail/format_args.hpp 101 1 record 4ZDF3RAGv4Z4uhkPm2urzNfGH1Xf implementation-defined mfaqhPxS153ZSpqTntjkRe3VH3r class named_arg boost/url/detail/format_args.hpp include/boost/url/detail/format_args.hpp 88 1 record 4Pe9L1tkaCX5RF7fFS3ZST79VPNW implementation-defined mfaqhPxS153ZSpqTntjkRe3VH3r struct optional_string boost/url/detail/optional_string.hpp include/boost/url/detail/optional_string.hpp 24 1 record 2iXNbxzVCqjNzcA1m38Pbx8cks3d implementation-defined mfaqhPxS153ZSpqTntjkRe3VH3r struct params_iter_impl boost/url/detail/params_iter_impl.hpp include/boost/url/detail/params_iter_impl.hpp 22 1 record b7ouTZWsVer7cg6kEQ11rWoKWDv implementation-defined mfaqhPxS153ZSpqTntjkRe3VH3r other __visibility__ struct named identifier 2cG2DXLQJWyzCZDdFUpQS6VLFbjt parts_base public parts_base boost/url/detail/parts_base.hpp include/boost/url/detail/parts_base.hpp 21 1 record 2cG2DXLQJWyzCZDdFUpQS6VLFbjt implementation-defined mfaqhPxS153ZSpqTntjkRe3VH3r struct 3xmfVVLosWMxPZRgUdoVwPrhCfcb 2HReBC1opFaFWU5n8L7s3DVkzQi2 boost/url/detail/parts_base.hpp include/boost/url/detail/parts_base.hpp 23 5 enum 3xmfVVLosWMxPZRgUdoVwPrhCfcb public implementation-defined 2cG2DXLQJWyzCZDdFUpQS6VLFbjt 2TCgAbXxuCHsuKaAkNbi3yDP4Z6v 24JEehL8ASgNY43pZZPQ7mqDZUBJ 3z7hGZ53veRnGqtdrUg4bpoBdrux 2CxEGXECeuwR3v1jjCU1EEuWcnnH 3W739aUasYd519bVUi8SQPjEzk8D 3yV4PcBmcwD68hiprp83VYSKHPs3 3VTrqFKHq5BivJcVCceSDM8zrzu9 Vu2WjjSCsHoL6uSxXjiNisyhrWa 2jC8ah3UXp3JsFU2ozfbsmtFBi8c id_scheme boost/url/detail/parts_base.hpp include/boost/url/detail/parts_base.hpp 25 9 enum-constant 2TCgAbXxuCHsuKaAkNbi3yDP4Z6v public implementation-defined 3xmfVVLosWMxPZRgUdoVwPrhCfcb -1 4294967295 id_user boost/url/detail/parts_base.hpp include/boost/url/detail/parts_base.hpp 26 9 enum-constant 24JEehL8ASgNY43pZZPQ7mqDZUBJ public implementation-defined 3xmfVVLosWMxPZRgUdoVwPrhCfcb id_pass boost/url/detail/parts_base.hpp include/boost/url/detail/parts_base.hpp 27 9 enum-constant 3z7hGZ53veRnGqtdrUg4bpoBdrux public implementation-defined 3xmfVVLosWMxPZRgUdoVwPrhCfcb id_host boost/url/detail/parts_base.hpp include/boost/url/detail/parts_base.hpp 28 9 enum-constant 2CxEGXECeuwR3v1jjCU1EEuWcnnH public implementation-defined 3xmfVVLosWMxPZRgUdoVwPrhCfcb id_port boost/url/detail/parts_base.hpp include/boost/url/detail/parts_base.hpp 29 9 enum-constant 3W739aUasYd519bVUi8SQPjEzk8D public implementation-defined 3xmfVVLosWMxPZRgUdoVwPrhCfcb id_path boost/url/detail/parts_base.hpp include/boost/url/detail/parts_base.hpp 30 9 enum-constant 3yV4PcBmcwD68hiprp83VYSKHPs3 public implementation-defined 3xmfVVLosWMxPZRgUdoVwPrhCfcb id_query boost/url/detail/parts_base.hpp include/boost/url/detail/parts_base.hpp 31 9 enum-constant 3VTrqFKHq5BivJcVCceSDM8zrzu9 public implementation-defined 3xmfVVLosWMxPZRgUdoVwPrhCfcb id_frag boost/url/detail/parts_base.hpp include/boost/url/detail/parts_base.hpp 32 9 enum-constant Vu2WjjSCsHoL6uSxXjiNisyhrWa public implementation-defined 3xmfVVLosWMxPZRgUdoVwPrhCfcb id_end boost/url/detail/parts_base.hpp include/boost/url/detail/parts_base.hpp 33 9 enum-constant 2jC8ah3UXp3JsFU2ozfbsmtFBi8c public implementation-defined 3xmfVVLosWMxPZRgUdoVwPrhCfcb from boost/url/detail/parts_base.hpp include/boost/url/detail/parts_base.hpp 36 5 enum 2HReBC1opFaFWU5n8L7s3DVkzQi2 public implementation-defined 2cG2DXLQJWyzCZDdFUpQS6VLFbjt named identifier char char 3ezw1Vm1kw9bcLwSzSrkG5rWe3VB 4NpbH8grJ1uRmQTu57MYrTd5mfaR 4EAZFW2HTb8jRnk2RUwh8AVLGDyk string boost/url/detail/parts_base.hpp include/boost/url/detail/parts_base.hpp 38 9 enum-constant 3ezw1Vm1kw9bcLwSzSrkG5rWe3VB public implementation-defined 2HReBC1opFaFWU5n8L7s3DVkzQi2 0 0 url boost/url/detail/parts_base.hpp include/boost/url/detail/parts_base.hpp 42 9 enum-constant 4NpbH8grJ1uRmQTu57MYrTd5mfaR public implementation-defined 2HReBC1opFaFWU5n8L7s3DVkzQi2 1 1 authority boost/url/detail/parts_base.hpp include/boost/url/detail/parts_base.hpp 45 9 enum-constant 4EAZFW2HTb8jRnk2RUwh8AVLGDyk public implementation-defined 2HReBC1opFaFWU5n8L7s3DVkzQi2 2 2 path_ref boost/url/detail/url_impl.hpp include/boost/url/detail/url_impl.hpp 127 1 record 4NhPu7pg3WdvhMmGfiprN7jkkp2D implementation-defined mfaqhPxS153ZSpqTntjkRe3VH3r other __visibility__ class pattern boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 40 1 record 4JAJbdgG6HTwY9R6MD7yTqabqDs2 implementation-defined mfaqhPxS153ZSpqTntjkRe3VH3r struct query_ref boost/url/detail/url_impl.hpp include/boost/url/detail/url_impl.hpp 174 1 record 43QZiLt11TgZqoTfWYA4NWFTYDAp implementation-defined mfaqhPxS153ZSpqTntjkRe3VH3r other __visibility__ class segments_iter_access boost/url/detail/segments_range.hpp include/boost/url/detail/segments_range.hpp 24 1 record 27bdtK5gXBJwht9cCTZ7gZhA4mjZ implementation-defined mfaqhPxS153ZSpqTntjkRe3VH3r struct segments_iter_impl boost/url/detail/segments_iter_impl.hpp include/boost/url/detail/segments_iter_impl.hpp 23 1 record 3jE2W9VxLYKnb9sp9p23AzeUPFvD implementation-defined mfaqhPxS153ZSpqTntjkRe3VH3r other __visibility__ struct url_impl boost/url/detail/url_impl.hpp include/boost/url/detail/url_impl.hpp 39 1 record 48vAm9v3TELjzybeQ2Vr8UeSSXT7 implementation-defined mfaqhPxS153ZSpqTntjkRe3VH3r other __visibility__ struct named identifier 2cG2DXLQJWyzCZDdFUpQS6VLFbjt parts_base public make_decode_view boost/url/decode_view.hpp include/boost/url/decode_view.hpp 32 1 function 2fBifzZ5fJ8gve5SABaTGVasbzZH implementation-defined mfaqhPxS153ZSpqTntjkRe3VH3r named identifier UXcENkB7t9T6PDWy1z6kk8ej8kT decode_view rvalue-reference named identifier Args args normal ref boost/url/pct_string_view.hpp include/boost/url/pct_string_view.hpp 42 1 function f4Th4UWVHuAghRXqWUWohEijLBB implementation-defined mfaqhPxS153ZSpqTntjkRe3VH3r lvalue-reference named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core lvalue-reference named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view s normal error_types boost/url/error_types.hpp include/boost/url/error_types.hpp 22 1 namespace 2d1fP4mznLCieoEAkcQMHzmN4sMA regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 3agbNqjamE6QmnztNwPQELVyeAVr zHXtfEq5ct6bQSdYPcqnJPRjvQ2 3pmEycaiwgUVazs9kf3MEjxkdScL 3MCbu5S4mnFLQBexf3onGtHtxEin 2Y3uUkjBcTcPxCho5KTPxHCr2CtX 24mcqxEPRdawwjgWqmSk2VzSatY8 3yQ2hwrBCiTF1ShDbx5gsDtiYF7h 2mZyKKMde2uwvs9yLthCo6iLaLFR errc boost/url/error_types.hpp include/boost/url/error_types.hpp 171 1 namespace-alias 3agbNqjamE6QmnztNwPQELVyeAVr regular 2d1fP4mznLCieoEAkcQMHzmN4sMA 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 dgHcH1svHs5X3czTwE2RBXQ7tGq system identifier 4VB1YRZ5xEZNSpqzp72yMeXnHRtn boost error_category boost/url/error_types.hpp include/boost/url/error_types.hpp 43 1 typedef zHXtfEq5ct6bQSdYPcqnJPRjvQ2 regular 2d1fP4mznLCieoEAkcQMHzmN4sMA 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 deprecated deprecated "Use system::error_category instead" Use system::error_category instead named identifier 3Bog57gQzZtN9258gnt7gjQVBWJn error_category identifier dgHcH1svHs5X3czTwE2RBXQ7tGq system identifier 4VB1YRZ5xEZNSpqzp72yMeXnHRtn boost error_code boost/url/error_types.hpp include/boost/url/error_types.hpp 65 1 typedef 3pmEycaiwgUVazs9kf3MEjxkdScL regular 2d1fP4mznLCieoEAkcQMHzmN4sMA 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 deprecated deprecated "Use system::error_code instead" Use system::error_code instead named identifier 4GeH1h7pxbQDvENRYw8iHw8QQPiW error_code identifier dgHcH1svHs5X3czTwE2RBXQ7tGq system identifier 4VB1YRZ5xEZNSpqzp72yMeXnHRtn boost error_condition boost/url/error_types.hpp include/boost/url/error_types.hpp 87 1 typedef 3MCbu5S4mnFLQBexf3onGtHtxEin regular 2d1fP4mznLCieoEAkcQMHzmN4sMA 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 deprecated deprecated "Use system::error_condition instead" Use system::error_condition instead named identifier 345STQq1QoB8wtYAmPDdxEsFJLQR error_condition identifier dgHcH1svHs5X3czTwE2RBXQ7tGq system identifier 4VB1YRZ5xEZNSpqzp72yMeXnHRtn boost result boost/url/error_types.hpp include/boost/url/error_types.hpp 264 1 typedef 2Y3uUkjBcTcPxCho5KTPxHCr2CtX regular 2d1fP4mznLCieoEAkcQMHzmN4sMA 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 2nNq8RtS22vhgfkFAo8dGh6NW87n 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 deprecated deprecated "Use system::result<T> instead" Use system::result<T> instead named specialization qQFMz11M2hdnkDE2M6AYnTSkQhv result identifier dgHcH1svHs5X3czTwE2RBXQ7tGq system identifier 4VB1YRZ5xEZNSpqzp72yMeXnHRtn boost type named identifier T type named identifier 4GeH1h7pxbQDvENRYw8iHw8QQPiW error_code identifier dgHcH1svHs5X3czTwE2RBXQ7tGq system system_error boost/url/error_types.hpp include/boost/url/error_types.hpp 109 1 typedef 24mcqxEPRdawwjgWqmSk2VzSatY8 regular 2d1fP4mznLCieoEAkcQMHzmN4sMA 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 deprecated deprecated "Use system::system_error instead" Use system::system_error instead named identifier 2FE2DBDSNTVcudravwAnKJ2pGr3w system_error identifier dgHcH1svHs5X3czTwE2RBXQ7tGq system identifier 4VB1YRZ5xEZNSpqzp72yMeXnHRtn boost generic_category boost/url/error_types.hpp include/boost/url/error_types.hpp 131 1 using 3yQ2hwrBCiTF1ShDbx5gsDtiYF7h regular 2d1fP4mznLCieoEAkcQMHzmN4sMA 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 dgHcH1svHs5X3czTwE2RBXQ7tGq system identifier 4VB1YRZ5xEZNSpqzp72yMeXnHRtn boost system_category boost/url/error_types.hpp include/boost/url/error_types.hpp 151 1 using 2mZyKKMde2uwvs9yLthCo6iLaLFR regular 2d1fP4mznLCieoEAkcQMHzmN4sMA 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 dgHcH1svHs5X3czTwE2RBXQ7tGq system identifier 4VB1YRZ5xEZNSpqzp72yMeXnHRtn 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 3xgiPUvbkGK69EKtHNfc9suQevEU regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 33AC7YGWwtZvBTKSxwdcQ3ffNAdV 4RGfJhXj53p44bPz6f2s7T64myLR 3466x84v8GVaJv3Ji9nER8HoySyC 9GbGGxys1Hw3rioXB6ngmTr9cQG wqrRsZTpVfkNrgN5md5LXgPtaym PFnGTC6zKj24d3tN33P14zyuZnr 3uNrm5j28Dkpd69qgbwXojiSiaac 2vYHi1zAwVu7qWE6bFo5mVwM81mF ehR6ZaA3gqV5eZf92n7xV7mYkMz 3bWqU3ksLeVFxAPBW7V92wCUvmrf 2HyRj1aBJxc9mQSrg2VP3pwFk94B 4LnTx5EKsVwNijs6E9BugA6EwaZF pGiGZp4rJemtwvxzYN1qDtgkWDy 3n98t27XcA6VWY9tzdGoTZbUDWYn 3DebHjVPfM7sPneBSfiA4ZV5iDFq 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X zRbPJc6iCoc5DHmTtrnpqHAyzG2 PiwQ5nsZHQ8sqDifHSnEiFKQM6M 4XX6oXv7fcDn7zVuuMxeb6eKAee9 3bhs31iPBqdthrGEX66tZCrKzuze 4QkGbLV39fncoj8tHDhor2KmsnGh 3VKbynmseEkdXfxpKTeafUqCZ1g8 3Kvc5n7iMUanAgmP3fyLSy6M3qSi 3M3qv3Hq6NRvW6tzwHQ6UZH44kKN 3XhMv27X469neaTG5KKaz2w1eJ1W 3H7zQeHPown6VJxU8o7M8oV2cAgJ GHYsTP5sD1CZGLeVrktLDXF45JP 273dQKXXEcenHaDX2CFEMYxvB341 xi4dY5cq9QSJCA3VRHjXdvPG6Wi 4HpDk6DDaARwYramwKg9KXqcEZ8u 2n6gXWu6UsXaXm7J8EvbhCLjTWMu 35v7twCJmdtKy88BJf2RKo7i4tri aDDm7EVotyHV35iaJF5QZr1pqhC SrZRA5AqXfGwJzbKiZSCeciZbt4 23LNUGNyBxyEyZFXTVavi4Zv5HBo 3cDeawx5aoU8fcZy8Cohmfz4UPnF 3geR1eH2FNivLakwdnyJPnpNrVS2 83PBiqs4SpXr9emD1VFbJjZ21Dy 46F3vin27VZapr3okT8ENb5eF68Q 3DSrvL2PqP2G8FHcG4TnCr6HRs22 2ssAwUNNjc8j5iGoER4xvc5QkKwQ 2DwidNJJq1FJ5gko382oRBBxC7ea 4VUoz5e4fhpRtULs6qezwRLEQev6 fm4KGz7DKn63PaBCnCYLbhX1gvW 2o6W5TBQ9LbmLFPDd9yn85hWvbwN 2dZbUeY791eW6YqfJHFUhgQV9gMc 2iMNT1B2aB6w1zvdRW3p8ePFHQso 2JAEap1NsGqkXnfHYfEFK8zyzB1s bcaTLDQstdfndoSMJP6AYgRipJw 2fjR3hjprSzgK21c2kMYTmdnqRRv 3gTcjG7wLGhhgK7izbCV8x9MWUwd 3GLRcYn4wNHf4YatGxgZeyGqA4MW BJHwVXG1yn5SJcDhAuECh5vFMQc 4BSDSuAA3FVHq1FWSJNQdrcgR3Nz KeQyLouQiB2oLgbB57w7Npq1mnR ZBLoUYbqsmpyLRqiVPJtguv12iY 2aNmCYXtDWunhuJ7qwhASTEkEdWC 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 33AC7YGWwtZvBTKSxwdcQ3ffNAdV implementation-defined 3xgiPUvbkGK69EKtHNfc9suQevEU dSL6iQpk1Eke3tfNprAQndh5zag 3BvzSDK5r2M2sbkygV7xn4Uy7okS s28LNyabXgN8YpeSFm9gY5T8Wjt 2UM4r1q8TmMPFobJVQHaMahn5axm 44tHdf4nPuUd92mQ3hiBwwBDwMjE 44JikQvwyJwAUthk6r1KRaLbBiec 2faAtWuyqyBqhmHregWgN4B4ggNZ 3S3VASL7tMycUGhmWm5eAd3UtNDj pDrYPRWtmymnQwDC2JR5i6RMZze hofXiskobMAXcsmQqNnYTTA8ZTq S7ryoAUvaZUnuofguXPTtyirJvH zZGhMjPgB1iyQmecLeB2iYmoNPi 3Y7kYi2m5mtV4e9XC8TeuuKm7y7J 3v7r5zTPsoAJRVDcP9fpFRM1uwMn 2eoezCjJ1sgpFceeyQJmxfXoa4mU L13zG67MuJ2yRik5QXpwKQftYQb 4JZ2BfHTC8Lar8AKRRzXhmGRuyZw 27LSo7ciPxehreUXsuJJMv59Hgkm Z9GfoWMyg92pKoZ4o24vPDxhX5E 4SRrKLTaMHCqxcYTVmopDykYRojC YzpvJaWAWbrGsVQUwrrVzM9SxmP CP5zh7Bc3c5QNFyZESUgrMdfMPk 3AxWeRi5wqQBciHGGT5g5H2nEG3P 3CCQpkWpPaFZB1FpmRGri3rEEHvZ 2thHPrGcmqMTPU7gfJn9G45JMskb 46Gseh2wSQ89N7fVpYSQmw7FBSGF aligned_storage_impl boost/url/grammar/detail/recycled.hpp include/boost/url/grammar/detail/recycled.hpp 20 1 record dSL6iQpk1Eke3tfNprAQndh5zag implementation-defined 33AC7YGWwtZvBTKSxwdcQ3ffNAdV struct all_chars_t boost/url/grammar/all_chars.hpp include/boost/url/grammar/all_chars.hpp 21 1 record 3BvzSDK5r2M2sbkygV7xn4Uy7okS implementation-defined 33AC7YGWwtZvBTKSxwdcQ3ffNAdV struct alnum_chars_t boost/url/grammar/alnum_chars.hpp include/boost/url/grammar/alnum_chars.hpp 20 1 record s28LNyabXgN8YpeSFm9gY5T8Wjt implementation-defined 33AC7YGWwtZvBTKSxwdcQ3ffNAdV struct alpha_chars_t boost/url/grammar/alpha_chars.hpp include/boost/url/grammar/alpha_chars.hpp 20 1 record 2UM4r1q8TmMPFobJVQHaMahn5axm implementation-defined 33AC7YGWwtZvBTKSxwdcQ3ffNAdV struct ch_delim_rule boost/url/grammar/delim_rule.hpp include/boost/url/grammar/delim_rule.hpp 26 1 record 44tHdf4nPuUd92mQ3hiBwwBDwMjE implementation-defined 33AC7YGWwtZvBTKSxwdcQ3ffNAdV struct charset_ref boost/url/grammar/charset.hpp include/boost/url/grammar/charset.hpp 207 1 record 44JikQvwyJwAUthk6r1KRaLbBiec implementation-defined 33AC7YGWwtZvBTKSxwdcQ3ffNAdV struct ci_equal boost/url/grammar/ci_string.hpp include/boost/url/grammar/ci_string.hpp 290 1 record 2faAtWuyqyBqhmHregWgN4B4ggNZ implementation-defined 33AC7YGWwtZvBTKSxwdcQ3ffNAdV struct ci_hash boost/url/grammar/ci_string.hpp include/boost/url/grammar/ci_string.hpp 253 1 record 3S3VASL7tMycUGhmWm5eAd3UtNDj implementation-defined 33AC7YGWwtZvBTKSxwdcQ3ffNAdV struct ci_less boost/url/grammar/ci_string.hpp include/boost/url/grammar/ci_string.hpp 329 1 record pDrYPRWtmymnQwDC2JR5i6RMZze implementation-defined 33AC7YGWwtZvBTKSxwdcQ3ffNAdV struct cs_delim_rule boost/url/grammar/delim_rule.hpp include/boost/url/grammar/delim_rule.hpp 90 1 record hofXiskobMAXcsmQqNnYTTA8ZTq implementation-defined 33AC7YGWwtZvBTKSxwdcQ3ffNAdV struct dec_octet_rule_t boost/url/grammar/dec_octet_rule.hpp include/boost/url/grammar/dec_octet_rule.hpp 21 1 record S7ryoAUvaZUnuofguXPTtyirJvH implementation-defined 33AC7YGWwtZvBTKSxwdcQ3ffNAdV struct digit_chars_t boost/url/grammar/digit_chars.hpp include/boost/url/grammar/digit_chars.hpp 20 1 record zZGhMjPgB1iyQmecLeB2iYmoNPi implementation-defined 33AC7YGWwtZvBTKSxwdcQ3ffNAdV struct hexdig_chars_t boost/url/grammar/hexdig_chars.hpp include/boost/url/grammar/hexdig_chars.hpp 20 1 record 3Y7kYi2m5mtV4e9XC8TeuuKm7y7J implementation-defined 33AC7YGWwtZvBTKSxwdcQ3ffNAdV struct is_charset boost/url/grammar/charset.hpp include/boost/url/grammar/charset.hpp 31 1 record 3v7r5zTPsoAJRVDcP9fpFRM1uwMn implementation-defined 33AC7YGWwtZvBTKSxwdcQ3ffNAdV struct named identifier 35Znu1makyhDbFtWQWvcmNhtWuKY false_type identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std public is_range_rule boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 50 1 record 2eoezCjJ1sgpFceeyQJmxfXoa4mU implementation-defined 33AC7YGWwtZvBTKSxwdcQ3ffNAdV struct named identifier 35Znu1makyhDbFtWQWvcmNhtWuKY false_type identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std public is_rule boost/url/grammar/type_traits.hpp include/boost/url/grammar/type_traits.hpp 23 1 record L13zG67MuJ2yRik5QXpwKQftYQb implementation-defined 33AC7YGWwtZvBTKSxwdcQ3ffNAdV struct named identifier 35Znu1makyhDbFtWQWvcmNhtWuKY false_type identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std public not_empty_rule_t boost/url/grammar/not_empty_rule.hpp include/boost/url/grammar/not_empty_rule.hpp 23 1 record 4JZ2BfHTC8Lar8AKRRzXhmGRuyZw implementation-defined 33AC7YGWwtZvBTKSxwdcQ3ffNAdV struct optional_rule_t boost/url/grammar/optional_rule.hpp include/boost/url/grammar/optional_rule.hpp 27 1 record 27LSo7ciPxehreUXsuJJMv59Hgkm implementation-defined 33AC7YGWwtZvBTKSxwdcQ3ffNAdV struct range_rule_t boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 238 5 record Z9GfoWMyg92pKoZ4o24vPDxhX5E implementation-defined 33AC7YGWwtZvBTKSxwdcQ3ffNAdV struct range_value_type boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 36 1 record 4SRrKLTaMHCqxcYTVmopDykYRojC implementation-defined 33AC7YGWwtZvBTKSxwdcQ3ffNAdV struct rule_ref boost/url/grammar/parse.hpp include/boost/url/grammar/parse.hpp 70 1 record YzpvJaWAWbrGsVQUwrrVzM9SxmP implementation-defined 33AC7YGWwtZvBTKSxwdcQ3ffNAdV struct squelch_rule_t boost/url/grammar/tuple_rule.hpp include/boost/url/grammar/tuple_rule.hpp 146 1 record CP5zh7Bc3c5QNFyZESUgrMdfMPk implementation-defined 33AC7YGWwtZvBTKSxwdcQ3ffNAdV struct named specialization 4FDb6VFoMCVN4jqwhESgbrMzuWK2 empty_value type named identifier Rule public token_rule_t boost/url/grammar/token_rule.hpp include/boost/url/grammar/token_rule.hpp 26 1 record 3AxWeRi5wqQBciHGGT5g5H2nEG3P implementation-defined 33AC7YGWwtZvBTKSxwdcQ3ffNAdV struct tuple_rule_t boost/url/grammar/tuple_rule.hpp include/boost/url/grammar/tuple_rule.hpp 29 1 record 3CCQpkWpPaFZB1FpmRGri3rEEHvZ implementation-defined 33AC7YGWwtZvBTKSxwdcQ3ffNAdV class variant_rule_t boost/url/grammar/variant_rule.hpp include/boost/url/grammar/variant_rule.hpp 25 1 record 2thHPrGcmqMTPU7gfJn9G45JMskb implementation-defined 33AC7YGWwtZvBTKSxwdcQ3ffNAdV class vchars_t boost/url/grammar/vchars.hpp include/boost/url/grammar/vchars.hpp 20 1 record 46Gseh2wSQ89N7fVpYSQmw7FBSGF implementation-defined 33AC7YGWwtZvBTKSxwdcQ3ffNAdV struct string_token boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 479 1 namespace-alias 4RGfJhXj53p44bPz6f2s7T64myLR regular 3xgiPUvbkGK69EKtHNfc9suQevEU identifier gXLgKAknGYwc12RGZfBgr4HdDCT string_token identifier 2ejQGW57K8g7MFJhHAwPt5aumoLa urls identifier 4VB1YRZ5xEZNSpqzp72yMeXnHRtn boost aligned_storage boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 43 1 typedef 3466x84v8GVaJv3Ji9nER8HoySyC regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 named specialization dSL6iQpk1Eke3tfNprAQndh5zag aligned_storage_impl identifier 33AC7YGWwtZvBTKSxwdcQ3ffNAdV implementation_defined constant implementation_defined::nearest_pow2(sizeof(T), 64) constant (alignof(::max_align_t) > alignof(T)) ? alignof(::max_align_t) : alignof(T) ci_equal boost/url/grammar/ci_string.hpp include/boost/url/grammar/ci_string.hpp 326 1 typedef 9GbGGxys1Hw3rioXB6ngmTr9cQG regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 wqrRsZTpVfkNrgN5md5LXgPtaym text , reference ci_less PFnGTC6zKj24d3tN33P14zyuZnr text . named identifier 2faAtWuyqyBqhmHregWgN4B4ggNZ ci_equal identifier 33AC7YGWwtZvBTKSxwdcQ3ffNAdV implementation_defined ci_hash boost/url/grammar/ci_string.hpp include/boost/url/grammar/ci_string.hpp 287 1 typedef wqrRsZTpVfkNrgN5md5LXgPtaym regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 9GbGGxys1Hw3rioXB6ngmTr9cQG text , reference ci_less PFnGTC6zKj24d3tN33P14zyuZnr text . named identifier 3S3VASL7tMycUGhmWm5eAd3UtNDj ci_hash identifier 33AC7YGWwtZvBTKSxwdcQ3ffNAdV implementation_defined ci_less boost/url/grammar/ci_string.hpp include/boost/url/grammar/ci_string.hpp 365 1 typedef PFnGTC6zKj24d3tN33P14zyuZnr regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 9GbGGxys1Hw3rioXB6ngmTr9cQG text , reference ci_hash wqrRsZTpVfkNrgN5md5LXgPtaym text . named identifier pDrYPRWtmymnQwDC2JR5i6RMZze ci_less identifier 33AC7YGWwtZvBTKSxwdcQ3ffNAdV implementation_defined is_charset boost/url/grammar/charset.hpp include/boost/url/grammar/charset.hpp 67 1 typedef 3uNrm5j28Dkpd69qgbwXojiSiaac regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 KeQyLouQiB2oLgbB57w7Npq1mnR text . t-param text the type to check. T named specialization 3v7r5zTPsoAJRVDcP9fpFRM1uwMn is_charset identifier 33AC7YGWwtZvBTKSxwdcQ3ffNAdV implementation_defined type named identifier T is_range_rule boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 81 1 typedef 2vYHi1zAwVu7qWE6bFo5mVwM81mF regular 3xgiPUvbkGK69EKtHNfc9suQevEU named specialization 2eoezCjJ1sgpFceeyQJmxfXoa4mU is_range_rule identifier 33AC7YGWwtZvBTKSxwdcQ3ffNAdV implementation_defined type named identifier RangeRule type named identifier type specialization 4SRrKLTaMHCqxcYTVmopDykYRojC range_value_type identifier 33AC7YGWwtZvBTKSxwdcQ3ffNAdV implementation_defined type named identifier RangeRule is_rule boost/url/grammar/type_traits.hpp include/boost/url/grammar/type_traits.hpp 62 1 typedef ehR6ZaA3gqV5eZf92n7xV7mYkMz regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 2aNmCYXtDWunhuJ7qwhASTEkEdWC see reference parse 35v7twCJmdtKy88BJf2RKo7i4tri text . named specialization L13zG67MuJ2yRik5QXpwKQftYQb is_rule identifier 33AC7YGWwtZvBTKSxwdcQ3ffNAdV implementation_defined type named identifier T 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 3bWqU3ksLeVFxAPBW7V92wCUvmrf regular 3xgiPUvbkGK69EKtHNfc9suQevEU class 2gtjXNkbJ7T6f3uK71EUbsE5Td2g 46VyknvRUjHrRsWgrePSBa8DRNSS 91sXpaGX7bsYqBo2fSMsP5krfC2 PTZehzwKzKhDy4grFKC4JMzmnuZ 1NjMcSzETbakBQje75s5B2AXJ9 4NVsk2Br5wcrRWujHvqbrWTPXtR1 value_type boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 105 5 typedef 2gtjXNkbJ7T6f3uK71EUbsE5Td2g public regular 3bWqU3ksLeVFxAPBW7V92wCUvmrf named identifier T 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 46VyknvRUjHrRsWgrePSBa8DRNSS public regular 3bWqU3ksLeVFxAPBW7V92wCUvmrf brief text Constructors constructor 4D81MBB1KfEPFkdSEZmZEMNpAgdA tvqN21K4oHQozZpQQVumNZf9txP 4Ao2XVv1xx2UrFUABLfoXqy5wqXt 48tTT43UKLdGWMg9VhMLPd9DDqLb hQiddfCiZS9V5CGC9Kmd3yGqCeY named identifier void void any_rule boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 107 5 function 4D81MBB1KfEPFkdSEZmZEMNpAgdA public regular 3bWqU3ksLeVFxAPBW7V92wCUvmrf brief text Default constructor named identifier void void constructor any_rule boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 108 5 function tvqN21K4oHQozZpQQVumNZf9txP public regular 3bWqU3ksLeVFxAPBW7V92wCUvmrf brief text Copy constructor param text The object to copy construct from other named identifier void void lvalue-reference named identifier 3bWqU3ksLeVFxAPBW7V92wCUvmrf any_rule other constructor any_rule boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 109 5 function 4Ao2XVv1xx2UrFUABLfoXqy5wqXt public regular 3bWqU3ksLeVFxAPBW7V92wCUvmrf brief text Move constructor param text The object to move construct from other named identifier void void rvalue-reference named identifier 3bWqU3ksLeVFxAPBW7V92wCUvmrf any_rule other constructor any_rule boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 114 5 function 48tTT43UKLdGWMg9VhMLPd9DDqLb public regular 3bWqU3ksLeVFxAPBW7V92wCUvmrf brief text Construct from code text R param text The object to copy construct from next named identifier void void lvalue-reference named identifier R next constructor any_rule boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 118 5 function hQiddfCiZS9V5CGC9Kmd3yGqCeY public regular 3bWqU3ksLeVFxAPBW7V92wCUvmrf named identifier void void lvalue-reference named identifier R0 first lvalue-reference named identifier R1 next constructor ~any_rule boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 112 5 function 91sXpaGX7bsYqBo2fSMsP5krfC2 public regular 3bWqU3ksLeVFxAPBW7V92wCUvmrf brief text Destructor named identifier void void destructor 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 PTZehzwKzKhDy4grFKC4JMzmnuZ public regular 3bWqU3ksLeVFxAPBW7V92wCUvmrf brief text Assignment operators normal = 3sMGFikaKgJpdsTijntrU7eHHTPa 2YM4jJLUELY1yZnFBQUQvL3NGsBE lvalue-reference named identifier 3bWqU3ksLeVFxAPBW7V92wCUvmrf any_rule operator= boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 110 5 function 3sMGFikaKgJpdsTijntrU7eHHTPa public regular 3bWqU3ksLeVFxAPBW7V92wCUvmrf brief text Copy assignment operator returns text Reference to the current object param text The object to copy assign from other lvalue-reference named identifier 3bWqU3ksLeVFxAPBW7V92wCUvmrf any_rule lvalue-reference named identifier 3bWqU3ksLeVFxAPBW7V92wCUvmrf any_rule other normal = operator= boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 111 5 function 2YM4jJLUELY1yZnFBQUQvL3NGsBE public regular 3bWqU3ksLeVFxAPBW7V92wCUvmrf brief text Move assignment operator returns text Reference to the current object param text The object to move assign from other lvalue-reference named identifier 3bWqU3ksLeVFxAPBW7V92wCUvmrf any_rule rvalue-reference named identifier 3bWqU3ksLeVFxAPBW7V92wCUvmrf any_rule other normal = first boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 123 5 function 1NjMcSzETbakBQje75s5B2AXJ9 public regular 3bWqU3ksLeVFxAPBW7V92wCUvmrf named specialization qQFMz11M2hdnkDE2M6AYnTSkQhv result identifier dgHcH1svHs5X3czTwE2RBXQ7tGq system type named identifier T lvalue-reference pointer named identifier char char it pointer named identifier char char end normal next boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 128 5 function 4NVsk2Br5wcrRWujHvqbrWTPXtR1 public regular 3bWqU3ksLeVFxAPBW7V92wCUvmrf named specialization qQFMz11M2hdnkDE2M6AYnTSkQhv result identifier dgHcH1svHs5X3czTwE2RBXQ7tGq system type named identifier T lvalue-reference pointer named identifier char char it pointer named identifier char char end normal literal_rule boost/url/grammar/literal_rule.hpp include/boost/url/grammar/literal_rule.hpp 45 1 record 2HyRj1aBJxc9mQSrg2VP3pwFk94B regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 2WEVZhduPwBDLFk8ahx6ckz25zHk 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 3Nf9THGjfFgA5PxRn23og8CckXj5 text . code system::result< core::string_view > rv = parse( "HTTP", literal_rule( "HTTP" ) ); brief text Match a string literal exactly see reference delim_rule 3M3qv3Hq6NRvW6tzwHQ6UZH44kKN text , reference parse 3Nf9THGjfFgA5PxRn23og8CckXj5 text . class 28yyF88ErHf7CM9RfZSSaauEuSw7 3iGeVTpceaJG2eWjAP2oyCuv3u4e 3Nf9THGjfFgA5PxRn23og8CckXj5 value_type boost/url/grammar/literal_rule.hpp include/boost/url/grammar/literal_rule.hpp 61 5 typedef 28yyF88ErHf7CM9RfZSSaauEuSw7 public regular 2HyRj1aBJxc9mQSrg2VP3pwFk94B named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core literal_rule boost/url/grammar/literal_rule.hpp include/boost/url/grammar/literal_rule.hpp 63 5 function 3iGeVTpceaJG2eWjAP2oyCuv3u4e public regular 2HyRj1aBJxc9mQSrg2VP3pwFk94B brief text Construct from code text char param text The value to construct from s named identifier void void pointer named identifier char char s constructor constexpr parse boost/url/grammar/literal_rule.hpp include/boost/url/grammar/literal_rule.hpp 72 5 function 3Nf9THGjfFgA5PxRn23og8CckXj5 public regular 2HyRj1aBJxc9mQSrg2VP3pwFk94B named specialization qQFMz11M2hdnkDE2M6AYnTSkQhv result identifier dgHcH1svHs5X3czTwE2RBXQ7tGq system type named identifier 28yyF88ErHf7CM9RfZSSaauEuSw7 value_type lvalue-reference pointer named identifier char char it pointer named identifier char char end normal constexpr lut_chars boost/url/grammar/lut_chars.hpp include/boost/url/grammar/lut_chars.hpp 64 1 record 4LnTx5EKsVwNijs6E9BugA6EwaZF regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 3XhMv27X469neaTG5KKaz2w1eJ1W text and reference find_if_not 3H7zQeHPown6VJxU8o7M8oV2cAgJ 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 3XhMv27X469neaTG5KKaz2w1eJ1W text , reference find_if_not 3H7zQeHPown6VJxU8o7M8oV2cAgJ text , reference parse 35v7twCJmdtKy88BJf2RKo7i4tri text , reference token_rule 83PBiqs4SpXr9emD1VFbJjZ21Dy text . class ahkvSs7d2PhmU612m3z42MDpm6G 34JyYtG5jAy6kh7byUih3Az2Pr6A 3sL6NcQwEeygAt6ZCJiJ7ELE691B 4HpDk6DDaARwYramwKg9KXqcEZ8u xi4dY5cq9QSJCA3VRHjXdvPG6Wi lut_chars boost/url/grammar/lut_chars.hpp include/boost/url/grammar/lut_chars.hpp 157 5 overloads ahkvSs7d2PhmU612m3z42MDpm6G public regular 4LnTx5EKsVwNijs6E9BugA6EwaZF 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 2hWHJkA4LLCdoU72Bu52ZheBsRW9 2d9LT2HdGtjdtw39NrZvcRp2kbn3 dp3YnPTEr6k1PRyrP2VeQ5zU7WU named identifier void void lut_chars boost/url/grammar/lut_chars.hpp include/boost/url/grammar/lut_chars.hpp 157 5 function 2hWHJkA4LLCdoU72Bu52ZheBsRW9 public regular 4LnTx5EKsVwNijs6E9BugA6EwaZF 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 named identifier void void named identifier char char ch constructor constexpr lut_chars boost/url/grammar/lut_chars.hpp include/boost/url/grammar/lut_chars.hpp 188 5 function 2d9LT2HdGtjdtw39NrZvcRp2kbn3 public regular 4LnTx5EKsVwNijs6E9BugA6EwaZF 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 named identifier void void pointer named identifier char char s constructor constexpr lut_chars boost/url/grammar/lut_chars.hpp include/boost/url/grammar/lut_chars.hpp 227 5 function dp3YnPTEr6k1PRyrP2VeQ5zU7WU public regular 4LnTx5EKsVwNijs6E9BugA6EwaZF 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 named identifier void void lvalue-reference named identifier Pred pred constructor constexpr operator() boost/url/grammar/lut_chars.hpp include/boost/url/grammar/lut_chars.hpp 257 5 overloads 34JyYtG5jAy6kh7byUih3Az2Pr6A public regular 4LnTx5EKsVwNijs6E9BugA6EwaZF 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 () 4Rr4zHfYdPJrEXeRcYY1N7xbrKHF 4Yz9DAEr8A1SArC91n81uyRbvXXQ named identifier bool bool operator() boost/url/grammar/lut_chars.hpp include/boost/url/grammar/lut_chars.hpp 266 5 function 4Rr4zHfYdPJrEXeRcYY1N7xbrKHF public regular 4LnTx5EKsVwNijs6E9BugA6EwaZF 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 named identifier bool bool named identifier char char ch normal constexpr () operator() boost/url/grammar/lut_chars.hpp include/boost/url/grammar/lut_chars.hpp 257 5 function 4Yz9DAEr8A1SArC91n81uyRbvXXQ public regular 4LnTx5EKsVwNijs6E9BugA6EwaZF 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 named identifier bool bool named identifier unsigned char unsigned char ch normal constexpr () operator~ boost/url/grammar/lut_chars.hpp include/boost/url/grammar/lut_chars.hpp 372 5 function 3sL6NcQwEeygAt6ZCJiJ7ELE691B public regular 4LnTx5EKsVwNijs6E9BugA6EwaZF 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. named identifier 4LnTx5EKsVwNijs6E9BugA6EwaZF lut_chars normal constexpr ~ range boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 205 1 record pGiGZp4rJemtwvxzYN1qDtgkWDy regular 3xgiPUvbkGK69EKtHNfc9suQevEU paragraph text Objects of this type are forward ranges returned when parsing using the reference range_rule aDDm7EVotyHV35iaJF5QZr1pqhC 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 35v7twCJmdtKy88BJf2RKo7i4tri text , reference range_rule aDDm7EVotyHV35iaJF5QZr1pqhC text . class vZaH521XVmBWuPZz5Wxv7dDGEHK 3U1S98Hb9QvBzSX5Wwe25mSngSiT kBU8J3eGGVDaqkCnGczNufsWpZY 3xxW6zRrKSUKnvv9TimY5mErCDa8 3Vrqk1wygfU2r4VEPTNpSmhZ3SQ9 TXonMFEnvYds4tLzz92CJnssbqq AoW3d8k6NUipuYb6AmmmHrhZr6q 38oTdpv1jYQPPoQwV9DY68jpAhvo 2AySrgxyaJduQqF4SFxSLtCZwnw1 vBs9YudP7hmW3HscDNf7khqsnNT 43ccqsz1zgwJkayDVz2XKHtQTSG3 kdqk6kiWKomGye4vEcWLNuPf2Y7 24Kjow62KgPMF5GsUJe49KaHwhD2 3Qv33Fp1cXgk7FbKoxe6Diw6o1Ne 3sTfveKBgFpRwpeHc5u3SryqfHD7 3m8TwabC8nL3wc7nc44c2u84LhH const_iterator boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 283 5 typedef vZaH521XVmBWuPZz5Wxv7dDGEHK public regular pGiGZp4rJemtwvxzYN1qDtgkWDy brief text A constant, forward iterator to elements of the range named identifier 38oTdpv1jYQPPoQwV9DY68jpAhvo iterator const_reference boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 263 5 typedef 3U1S98Hb9QvBzSX5Wwe25mSngSiT public regular pGiGZp4rJemtwvxzYN1qDtgkWDy brief text The type of each element of the range lvalue-reference named identifier T difference_type boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 275 5 typedef kBU8J3eGGVDaqkCnGczNufsWpZY public regular pGiGZp4rJemtwvxzYN1qDtgkWDy brief text The type used to represent signed integers named identifier EKxMGCxxySWyqBbWqvvL9j9KhWv ptrdiff_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std pointer boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 267 5 typedef 3xxW6zRrKSUKnvv9TimY5mErCDa8 public regular pGiGZp4rJemtwvxzYN1qDtgkWDy brief text Provided for compatibility, unused pointer named identifier void void reference boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 259 5 typedef 3Vrqk1wygfU2r4VEPTNpSmhZ3SQ9 public regular pGiGZp4rJemtwvxzYN1qDtgkWDy brief text The type of each element of the range lvalue-reference named identifier T size_type boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 271 5 typedef TXonMFEnvYds4tLzz92CJnssbqq public regular pGiGZp4rJemtwvxzYN1qDtgkWDy brief text The type used to represent unsigned integers named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std value_type boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 255 5 typedef AoW3d8k6NUipuYb6AmmmHrhZr6q public regular pGiGZp4rJemtwvxzYN1qDtgkWDy brief text The type of each element of the range named identifier T iterator boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 279 5 record 38oTdpv1jYQPPoQwV9DY68jpAhvo public regular pGiGZp4rJemtwvxzYN1qDtgkWDy brief text A constant, forward iterator to elements of the range class named specialization pGiGZp4rJemtwvxzYN1qDtgkWDy range type named identifier T type named identifier RangeRule pGiGZp4rJemtwvxzYN1qDtgkWDy range boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 297 5 boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 313 5 boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 328 5 overloads 2AySrgxyaJduQqF4SFxSLtCZwnw1 public regular pGiGZp4rJemtwvxzYN1qDtgkWDy brief text Constructor constructor 33XPH7BLeJ115N5L9SmXREEm4ZoM ptA8WoY8C5y5wg3NNqBQd1oQbHy 3nuuLF2MVkpxRLYTTPvPRoFSzK7i named identifier void void range boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 297 5 function 33XPH7BLeJ115N5L9SmXREEm4ZoM public regular pGiGZp4rJemtwvxzYN1qDtgkWDy paragraph text Default-constructed ranges have zero elements. heading text Exception Safety 1 paragraph text Throws nothing. brief text Constructor named identifier void void constructor range boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 328 5 function ptA8WoY8C5y5wg3NNqBQd1oQbHy public regular pGiGZp4rJemtwvxzYN1qDtgkWDy 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 named identifier void void lvalue-reference named identifier pGiGZp4rJemtwvxzYN1qDtgkWDy range other constructor range boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 313 5 function 3nuuLF2MVkpxRLYTTPvPRoFSzK7i public regular pGiGZp4rJemtwvxzYN1qDtgkWDy 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 named identifier void void rvalue-reference named identifier pGiGZp4rJemtwvxzYN1qDtgkWDy range other constructor ~range boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 287 5 function vBs9YudP7hmW3HscDNf7khqsnNT public regular pGiGZp4rJemtwvxzYN1qDtgkWDy brief text Destructor named identifier void void destructor operator= boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 345 5 boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 363 5 overloads 43ccqsz1zgwJkayDVz2XKHtQTSG3 public regular pGiGZp4rJemtwvxzYN1qDtgkWDy brief text Assignment returns code text *this normal = 2QDCctmUvq9ogc2gHt2mnXMPeivZ 2Y2ZeBDXYUeHyuXXyKRLuQADZBUD lvalue-reference named identifier pGiGZp4rJemtwvxzYN1qDtgkWDy range operator= boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 363 5 function 2QDCctmUvq9ogc2gHt2mnXMPeivZ public regular pGiGZp4rJemtwvxzYN1qDtgkWDy 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 lvalue-reference named identifier pGiGZp4rJemtwvxzYN1qDtgkWDy range lvalue-reference named identifier pGiGZp4rJemtwvxzYN1qDtgkWDy range other normal = operator= boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 345 5 function 2Y2ZeBDXYUeHyuXXyKRLuQADZBUD public regular pGiGZp4rJemtwvxzYN1qDtgkWDy 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 lvalue-reference named identifier pGiGZp4rJemtwvxzYN1qDtgkWDy range rvalue-reference named identifier pGiGZp4rJemtwvxzYN1qDtgkWDy range other normal = begin boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 370 5 function kdqk6kiWKomGye4vEcWLNuPf2Y7 public regular pGiGZp4rJemtwvxzYN1qDtgkWDy brief text Return an iterator to the beginning returns text An iterator to the first element named identifier 38oTdpv1jYQPPoQwV9DY68jpAhvo iterator normal empty boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 382 5 function 24Kjow62KgPMF5GsUJe49KaHwhD2 public regular pGiGZp4rJemtwvxzYN1qDtgkWDy brief text Return true if the range is empty returns code text true text if the range is empty named identifier bool bool normal end boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 376 5 function 3Qv33Fp1cXgk7FbKoxe6Diw6o1Ne public regular pGiGZp4rJemtwvxzYN1qDtgkWDy brief text Return an iterator to the end returns text An iterator to one past the last element named identifier 38oTdpv1jYQPPoQwV9DY68jpAhvo iterator normal size boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 392 5 function 3sTfveKBgFpRwpeHc5u3SryqfHD7 public regular pGiGZp4rJemtwvxzYN1qDtgkWDy brief text Return the number of elements in the range returns text The number of elements named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std normal string boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 402 5 function 3m8TwabC8nL3wc7nc44c2u84LhH public regular pGiGZp4rJemtwvxzYN1qDtgkWDy brief text Return the matching part of the string returns text A string view representing the range named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core normal recycled boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 71 1 record 3n98t27XcA6VWY9tzdGoTZbUDWYn regular 3xgiPUvbkGK69EKtHNfc9suQevEU paragraph text Instances of this type may be used to control where recycled instances of T come from when used with reference recycled_ptr 3DebHjVPfM7sPneBSfiA4ZV5iDFq 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 3DebHjVPfM7sPneBSfiA4ZV5iDFq text . class 2gaqC5Mk2kwT8DLujD34zxmfhgW7 353iTRnC25Y9LVDh329chs8eUWAf 3DebHjVPfM7sPneBSfiA4ZV5iDFq recycled boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 86 5 function 2gaqC5Mk2kwT8DLujD34zxmfhgW7 public regular 3n98t27XcA6VWY9tzdGoTZbUDWYn brief text Constructor named identifier void void constructor constexpr ~recycled boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 82 5 function 353iTRnC25Y9LVDh329chs8eUWAf public regular 3n98t27XcA6VWY9tzdGoTZbUDWYn paragraph text All recycled instances of T are destroyed. Undefined behavior results if there are any reference recycled_ptr 3DebHjVPfM7sPneBSfiA4ZV5iDFq text which reference this recycle bin. brief text Destructor named identifier void void destructor recycled_ptr boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 148 1 boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 89 5 record 3DebHjVPfM7sPneBSfiA4ZV5iDFq regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 2gkJVrrBNuBtrLniC2ekyyhBGpL3 2kRtvAjBvLX3exvNFXqNdb5SEB74 3UiVkoygGrD7JQnpEcEi7tjewZTf ScbPu5R8R1MoUzstouCcugiAj4v 36mFoo6UxWbGa3VdV24Y9my58Wgm 3wSDJ9rMnQQviHdiyvLxfqeGRujA 2RYzAF6xzwkFVTTP6wWHYbZD6cU9 3JjQp1jW27A6re269hNqx569VFSp 24dTaAQAtDC7NcEgZtKfAXUbV7AZ 3iGm14iaXcMe2BYvhiWmeGxMT4xU 4MMUgLDA9CBWaEDP19RwEe47x1GB named specialization 3n98t27XcA6VWY9tzdGoTZbUDWYn recycled type named identifier T 3n98t27XcA6VWY9tzdGoTZbUDWYn recycled_ptr boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 208 5 boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 242 5 boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 271 5 boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 300 5 boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 321 5 boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 341 5 overloads 2gkJVrrBNuBtrLniC2ekyyhBGpL3 public regular 3DebHjVPfM7sPneBSfiA4ZV5iDFq brief text Constructor param text The pointer to copy other param text The recycle bin to use bin see reference recycled 3n98t27XcA6VWY9tzdGoTZbUDWYn text . see reference acquire ScbPu5R8R1MoUzstouCcugiAj4v text , reference recycled 3n98t27XcA6VWY9tzdGoTZbUDWYn text , reference release 3iGm14iaXcMe2BYvhiWmeGxMT4xU text . constructor 2CedKmwHYboWMfBMT5nC5cBJALMq 3PsvJ9EvwKEm2G6JhGt6BpWYoZNv 4Pm1waQmYfpB6wPebgpXLxihJp68 2K82hqjFeNQhEvhGLqPUwSFbrY37 2wSf4HSidHt3ooXAniNHU5DQKfU1 3QRNno95LYeK6wCfA5cLRnZaSM43 named identifier void void recycled_ptr boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 271 5 function 2CedKmwHYboWMfBMT5nC5cBJALMq public regular 3DebHjVPfM7sPneBSfiA4ZV5iDFq 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 3n98t27XcA6VWY9tzdGoTZbUDWYn text . named identifier void void constructor recycled_ptr boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 321 5 function 3PsvJ9EvwKEm2G6JhGt6BpWYoZNv public regular 3DebHjVPfM7sPneBSfiA4ZV5iDFq 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 named identifier void void lvalue-reference named identifier 3DebHjVPfM7sPneBSfiA4ZV5iDFq recycled_ptr other constructor recycled_ptr boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 341 5 function 4Pm1waQmYfpB6wPebgpXLxihJp68 public regular 3DebHjVPfM7sPneBSfiA4ZV5iDFq 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 named identifier void void rvalue-reference named identifier 3DebHjVPfM7sPneBSfiA4ZV5iDFq recycled_ptr other constructor recycled_ptr boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 300 5 function 2K82hqjFeNQhEvhGLqPUwSFbrY37 public regular 3DebHjVPfM7sPneBSfiA4ZV5iDFq 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 ScbPu5R8R1MoUzstouCcugiAj4v text , reference recycled 3n98t27XcA6VWY9tzdGoTZbUDWYn text , reference release 3iGm14iaXcMe2BYvhiWmeGxMT4xU text . named identifier void void named identifier 3UruDatmFgHZgtqL9Fjv6YTVueUx nullptr_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std value constructor recycled_ptr boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 208 5 function 2wSf4HSidHt3ooXAniNHU5DQKfU1 public regular 3DebHjVPfM7sPneBSfiA4ZV5iDFq 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 3n98t27XcA6VWY9tzdGoTZbUDWYn text . named identifier void void lvalue-reference named specialization 3n98t27XcA6VWY9tzdGoTZbUDWYn recycled type named identifier T bin constructor recycled_ptr boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 242 5 function 3QRNno95LYeK6wCfA5cLRnZaSM43 public regular 3DebHjVPfM7sPneBSfiA4ZV5iDFq 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 ScbPu5R8R1MoUzstouCcugiAj4v text , reference recycled 3n98t27XcA6VWY9tzdGoTZbUDWYn text , reference release 3iGm14iaXcMe2BYvhiWmeGxMT4xU text . named identifier void void lvalue-reference named specialization 3n98t27XcA6VWY9tzdGoTZbUDWYn recycled type named identifier T bin named identifier 3UruDatmFgHZgtqL9Fjv6YTVueUx nullptr_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std constructor ~recycled_ptr boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 177 5 function 2kRtvAjBvLX3exvNFXqNdb5SEB74 public regular 3DebHjVPfM7sPneBSfiA4ZV5iDFq 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 named identifier void void destructor operator= boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 367 5 boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 395 5 overloads 3UiVkoygGrD7JQnpEcEi7tjewZTf public regular 3DebHjVPfM7sPneBSfiA4ZV5iDFq brief text Assignment returns code text *this param text The pointer to copy from other normal = 327mTvftSZKRq26r1XpaEMng5hbS 3X9UgEy3dnvoRo849PZFqXvdtKqh lvalue-reference named identifier 3DebHjVPfM7sPneBSfiA4ZV5iDFq recycled_ptr operator= boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 395 5 function 327mTvftSZKRq26r1XpaEMng5hbS public regular 3DebHjVPfM7sPneBSfiA4ZV5iDFq 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 lvalue-reference named identifier 3DebHjVPfM7sPneBSfiA4ZV5iDFq recycled_ptr lvalue-reference named identifier 3DebHjVPfM7sPneBSfiA4ZV5iDFq recycled_ptr other normal = operator= boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 367 5 function 3X9UgEy3dnvoRo849PZFqXvdtKqh public regular 3DebHjVPfM7sPneBSfiA4ZV5iDFq 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 lvalue-reference named identifier 3DebHjVPfM7sPneBSfiA4ZV5iDFq recycled_ptr rvalue-reference named identifier 3DebHjVPfM7sPneBSfiA4ZV5iDFq recycled_ptr other normal = acquire boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 499 5 function ScbPu5R8R1MoUzstouCcugiAj4v public regular 3DebHjVPfM7sPneBSfiA4ZV5iDFq 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 lvalue-reference named identifier T normal bin boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 437 5 function 36mFoo6UxWbGa3VdV24Y9my58Wgm public regular 3DebHjVPfM7sPneBSfiA4ZV5iDFq heading text Exception Safety 1 paragraph text Throws nothing. brief text Return the referenced recycle bin returns text A reference to the recycle bin lvalue-reference named specialization 3n98t27XcA6VWY9tzdGoTZbUDWYn recycled type named identifier T normal empty boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 406 5 function 3wSDJ9rMnQQviHdiyvLxfqeGRujA public regular 3DebHjVPfM7sPneBSfiA4ZV5iDFq 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 named identifier bool bool normal get boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 452 5 function 2RYzAF6xzwkFVTTP6wWHYbZD6cU9 public regular 3DebHjVPfM7sPneBSfiA4ZV5iDFq 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 pointer named identifier T normal operator* boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 480 5 function 3JjQp1jW27A6re269hNqx569VFSp public regular 3DebHjVPfM7sPneBSfiA4ZV5iDFq heading text Preconditions 1 code not this->empty() brief text Return the referenced object returns text A reference to the object lvalue-reference named identifier T normal * operator-> boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 466 5 function 24dTaAQAtDC7NcEgZtKfAXUbV7AZ public regular 3DebHjVPfM7sPneBSfiA4ZV5iDFq 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 pointer named identifier T normal -> release boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 516 5 function 3iGm14iaXcMe2BYvhiWmeGxMT4xU public regular 3DebHjVPfM7sPneBSfiA4ZV5iDFq 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 named identifier void void normal operator bool boost/url/grammar/recycled.hpp include/boost/url/grammar/recycled.hpp 424 5 function 4MMUgLDA9CBWaEDP19RwEe47x1GB public regular 3DebHjVPfM7sPneBSfiA4ZV5iDFq 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() named identifier bool bool conversion string_view_base boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 36 1 record 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 3ZY5EydXePv2wNz8JPvc5skA7Bn4 iu52vYftQmJn1PS1RcSWttFd9Un xiTt94SbvEH2kbjbMpH8WZbQAhW 2mEj2svtYXg7jX6i7oRLojMzJyfp 2bRQYvMUah4389d6W7enWHgtN3to 2egfdMDV7XURYLoer6VrajrTGWc9 3feB3yppXbbiFh3NPph59rr47dQy 2oow5byAtxv1W9Nu8nn9Pm3As1Zd 41bb3NAKvXikNUMhiiA8fbwcXJWE 419t88FFA6k47RNxBPvr5ZfdzmH7 2TEvHxNTwZk6az6p4h27DHQeFPDQ 4Vh4T7xycjcrtiiUz5m6umX2uRWH 2Yv4wXVZTSDCne1Rr76buU44biy8 3Bs82iRZxMbpBJmUXEVWRK1EoRvi MAYuqDbxMuYRh5wEJsU5FztQaFy FEWyvP5VVCNhTET4ojFmWdrNQt4 3m3wxpjnbYX7ZMjb66QcLMjYpQqt zUJYGoXHAhBavAZx8H7Zq81CN2p 2QdMhgiG7Dv6upJxA6AYimx8jzR7 3LJN4b2WcEsbN5apJXGd2qaiTvAd gc13YUZ5g64b6AHPgnJm43PwWAA 3ku9J4TN7sd9d8Ejobe1Z8eY8Tpu 3xSNSFtYpeucRYj8Lm5YNn7jLGb4 QcD8XHXPNpVQzGUJMdHAagLVDac praD3b8JGYJMoVcBhRkngVk4Bgr 36aDYSkKPWqbsj9EQnTDu5AhFL88 3CgRRJVwNs9JenuDCGpaZxYADAsQ 4F7aWUmwH44NPw6vhvocufTExL2b Nva2waUPv2F7odVi5VpPZTJXjSS 214bwQkfpzhQ2vMw6gA4M97itn2d sJwdQ3VSugDWA1BGkxWxv7Cxt2w 3U9YFTNsEghj7N1pNuoyuLoZdjGm LXiRcWmUiTXoN7uKbWYemES1zmJ RYCNCvPhXuBoLBAs5AH4ASxNpnx wGzcw5BL1efm1mk6pq6nPmoZkRS 4NADkGKvVJkngAQ6XfX2pSuPqFJg fCtPDkAHyYcmdMyXkd9i7J2vECV yR13aMBqwcRTjvDjKmrSVdorYp5 2GvVXid3fpBKQ4D7kLzCRrRdUHaY 2JpJjEsnBhnTZsbJ55h8BqSdozdK eAQNszB5neak8eCFeULLpdz1dBR 38iQFzsQfEfXUvQU4E1KU7cb3rAB 2X9fFvHm8CHy89mguA6sEudtNmQD 4EWyYXRZot7yKvPTXVF7VemKcqLa 2VYZiE2XGTu7izsSch6CFaDYCUo2 ycz1k4ebhSj7jSUnEmtFP7bwvKV 2TSxWDzCSsTHCCbfDU3TCWWXwszk 3qWcEm1E5JQvVH7xZmPSo6XNwSDQ 2ztoKkfV7H8rMnxSoUTTp4HtmeER 2ssAwUNNjc8j5iGoER4xvc5QkKwQ 2iMNT1B2aB6w1zvdRW3p8ePFHQso 2dZbUeY791eW6YqfJHFUhgQV9gMc 2o6W5TBQ9LbmLFPDd9yn85hWvbwN fm4KGz7DKn63PaBCnCYLbhX1gvW 4VUoz5e4fhpRtULs6qezwRLEQev6 2DwidNJJq1FJ5gko382oRBBxC7ea const_iterator boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 111 5 typedef iu52vYftQmJn1PS1RcSWttFd9Un public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X brief text The const iterator type pointer named identifier char char const_pointer boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 105 5 typedef xiTt94SbvEH2kbjbMpH8WZbQAhW public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X brief text The const pointer type pointer named identifier char char const_reference boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 109 5 typedef 2mEj2svtYXg7jX6i7oRLojMzJyfp public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X brief text The const reference type lvalue-reference named identifier char char const_reverse_iterator boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 115 5 typedef 2bRQYvMUah4389d6W7enWHgtN3to public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X brief text The const reverse iterator type named specialization oeEbbwRjJeyrgiT2YFUz4wpmV5r reverse_iterator identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std type named identifier iu52vYftQmJn1PS1RcSWttFd9Un const_iterator difference_type boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 122 5 typedef 2egfdMDV7XURYLoer6VrajrTGWc9 public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X brief text The difference type named identifier EKxMGCxxySWyqBbWqvvL9j9KhWv ptrdiff_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std iterator boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 113 5 typedef 3feB3yppXbbiFh3NPph59rr47dQy public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X brief text The iterator type named identifier iu52vYftQmJn1PS1RcSWttFd9Un const_iterator pointer boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 103 5 typedef 2oow5byAtxv1W9Nu8nn9Pm3As1Zd public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X brief text The pointer type pointer named identifier char char reference boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 107 5 typedef 41bb3NAKvXikNUMhiiA8fbwcXJWE public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X brief text The reference type lvalue-reference named identifier char char reverse_iterator boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 118 5 typedef 419t88FFA6k47RNxBPvr5ZfdzmH7 public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X brief text The reverse iterator type named identifier 2bRQYvMUah4389d6W7enWHgtN3to const_reverse_iterator size_type boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 120 5 typedef 2TEvHxNTwZk6az6p4h27DHQeFPDQ public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X brief text The size type named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std traits_type boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 99 5 typedef 4Vh4T7xycjcrtiiUz5m6umX2uRWH public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X brief text The character traits named specialization char_traits identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std type named identifier char char value_type boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 101 5 typedef 2Yv4wXVZTSDCne1Rr76buU44biy8 public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X brief text The value type named identifier char char at boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 331 5 function 3Bs82iRZxMbpBJmUXEVWRK1EoRvi public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2mEj2svtYXg7jX6i7oRLojMzJyfp const_reference named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos normal constexpr back boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 355 5 function MAYuqDbxMuYRh5wEJsU5FztQaFy public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X paragraph text See code text core::string_view::back brief text Return the last character returns text The last character named identifier 2mEj2svtYXg7jX6i7oRLojMzJyfp const_reference normal constexpr begin boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 177 5 function FEWyvP5VVCNhTET4ojFmWdrNQt4 public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X paragraph text See code text core::string_view::begin brief text Return an iterator to the beginning returns text An iterator to the beginning named identifier iu52vYftQmJn1PS1RcSWttFd9Un const_iterator normal constexpr cbegin boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 199 5 function 3m3wxpjnbYX7ZMjb66QcLMjYpQqt public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X paragraph text See code text core::string_view::cbegin brief text Return an iterator to the beginning returns text An iterator to the beginning named identifier iu52vYftQmJn1PS1RcSWttFd9Un const_iterator normal constexpr cend boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 210 5 function zUJYGoXHAhBavAZx8H7Zq81CN2p public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X paragraph text See code text core::string_view::cend brief text Return an iterator to the end returns text An iterator to the end named identifier iu52vYftQmJn1PS1RcSWttFd9Un const_iterator normal constexpr compare boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 413 5 overloads 2QdMhgiG7Dv6upJxA6AYimx8jzR7 public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 TkhPQ4193qtgMyQbnmTFyjkzBZV 2aAsqByw2BkZTHZhrEv2JC9ZuArr 3LbPyToLQhxmgXaqddvAsCWnwhyr 3UEqPVxZTWonSN2i7cPt4EK8y6N4 3hRC6BNUMHgwL1csdkZJStzuM2FJ 49egxgmDEe7Npx59PH8SDWBtdpWm named identifier int int compare boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 413 5 function TkhPQ4193qtgMyQbnmTFyjkzBZV public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier int int named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core str normal constexpr compare boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 459 5 function 2aAsqByw2BkZTHZhrEv2JC9ZuArr public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier int int pointer named identifier char char s normal constexpr compare boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 428 5 function 3LbPyToLQhxmgXaqddvAsCWnwhyr public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier int int named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos1 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type n1 named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core str normal constexpr compare boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 474 5 function 3UEqPVxZTWonSN2i7cPt4EK8y6N4 public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier int int named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos1 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type n1 pointer named identifier char char s normal constexpr compare boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 490 5 function 3hRC6BNUMHgwL1csdkZJStzuM2FJ public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier int int named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos1 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type n1 pointer named identifier char char s named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type n2 normal constexpr compare boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 445 5 function 49egxgmDEe7Npx59PH8SDWBtdpWm public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier int int named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos1 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type n1 named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core str named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos2 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type n2 normal constexpr contains boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 942 5 overloads 3LJN4b2WcEsbN5apJXGd2qaiTvAd public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 21BxtJf3cBK68gwPEy8W3r9sqWLt 2rCUcf4H9EkdztkRThYQVkq9Pm3K gtse3xJZKNmgTL3u5JSeDpAaPaG named identifier bool bool contains boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 954 5 function 21BxtJf3cBK68gwPEy8W3r9sqWLt public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier bool bool named identifier char char c normal constexpr contains boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 942 5 function 2rCUcf4H9EkdztkRThYQVkq9Pm3K public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier bool bool named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core sv normal constexpr contains boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 966 5 function gtse3xJZKNmgTL3u5JSeDpAaPaG public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier bool bool pointer named identifier char char s normal constexpr copy boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 384 5 function gc13YUZ5g64b6AHPgnJm43PwWAA public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pointer named identifier char char s named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type n named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos 0 normal constexpr crbegin boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 245 5 function 3ku9J4TN7sd9d8Ejobe1Z8eY8Tpu public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2bRQYvMUah4389d6W7enWHgtN3to const_reverse_iterator normal constexpr crend boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 257 5 function 3xSNSFtYpeucRYj8Lm5YNn7jLGb4 public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2bRQYvMUah4389d6W7enWHgtN3to const_reverse_iterator normal constexpr data boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 367 5 function QcD8XHXPNpVQzGUJMdHAagLVDac public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier xiTt94SbvEH2kbjbMpH8WZbQAhW const_pointer normal constexpr empty boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 304 5 function praD3b8JGYJMoVcBhRkngVk4Bgr public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier bool bool normal constexpr end boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 188 5 function 36aDYSkKPWqbsj9EQnTDu5AhFL88 public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X paragraph text See code text core::string_view::end brief text Return an iterator to the end returns text An iterator to the end named identifier iu52vYftQmJn1PS1RcSWttFd9Un const_iterator normal constexpr ends_with boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 547 5 overloads 3CgRRJVwNs9JenuDCGpaZxYADAsQ public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 2YRXJqqPm54KfxZag3rq66QPDqaS 3N2RaDeogpteHRrK4L4LXLigNK9C 3sRYWdi26VfPmzSoQsVxagyYDTu9 named identifier bool bool ends_with boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 560 5 function 2YRXJqqPm54KfxZag3rq66QPDqaS public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier bool bool named identifier char char x normal constexpr ends_with boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 547 5 function 3N2RaDeogpteHRrK4L4LXLigNK9C public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier bool bool named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core x normal constexpr ends_with boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 573 5 function 3sRYWdi26VfPmzSoQsVxagyYDTu9 public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier bool bool pointer named identifier char char x normal constexpr find boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 589 5 overloads 4F7aWUmwH44NPw6vhvocufTExL2b public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 4yb8kt3deCqDXs5YVXRxgnnyPjo 43RuGCpKgaqiQX4ZmzmjDtoSTVWP 3mSht8URmvuPrepbFLECUD9SK1yn 2eUJVta5CpXKWffHTpJZBw3xVWVk named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type find boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 603 5 function 4yb8kt3deCqDXs5YVXRxgnnyPjo public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type named identifier char char c named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos 0 normal constexpr find boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 589 5 function 43RuGCpKgaqiQX4ZmzmjDtoSTVWP public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core str named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos 0 normal constexpr find boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 632 5 function 3mSht8URmvuPrepbFLECUD9SK1yn public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pointer named identifier char char s named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos 0 normal constexpr find boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 618 5 function 2eUJVta5CpXKWffHTpJZBw3xVWVk public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pointer named identifier char char s named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type n normal constexpr find_first_not_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 825 5 overloads Nva2waUPv2F7odVi5VpPZTJXjSS public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 USp9fg3t572bTPCSe4dCxWSFMvT 4CkGLjXsrJSTXhMyWWioD939oWSZ 3i55mVTYmmdqw4eW7srmy3y84fHm 3NHxkPRZ9jPF1f3pzh5GJ8RYRY9b named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type find_first_not_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 839 5 function USp9fg3t572bTPCSe4dCxWSFMvT public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type named identifier char char c named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos 0 normal constexpr find_first_not_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 825 5 function 4CkGLjXsrJSTXhMyWWioD939oWSZ public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core str named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos 0 normal constexpr find_first_not_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 868 5 function 3i55mVTYmmdqw4eW7srmy3y84fHm public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pointer named identifier char char s named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos 0 normal constexpr find_first_not_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 854 5 function 3NHxkPRZ9jPF1f3pzh5GJ8RYRY9b public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pointer named identifier char char s named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type n normal constexpr find_first_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 707 5 overloads 214bwQkfpzhQ2vMw6gA4M97itn2d public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 25q54qiNK6RZE478TK2vV1MrVsZb 3PmCH2t4QrC5m1RsQiwAJmGWyyf6 2wWfNaGCLZXRAXGN7mtTwrBzcnoZ 3SqgCkTVYTTD4csNCR46R3XUQKCV named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type find_first_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 721 5 function 25q54qiNK6RZE478TK2vV1MrVsZb public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type named identifier char char c named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos 0 normal constexpr find_first_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 707 5 function 3PmCH2t4QrC5m1RsQiwAJmGWyyf6 public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core str named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos 0 normal constexpr find_first_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 750 5 function 2wWfNaGCLZXRAXGN7mtTwrBzcnoZ public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pointer named identifier char char s named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos 0 normal constexpr find_first_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 736 5 function 3SqgCkTVYTTD4csNCR46R3XUQKCV public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pointer named identifier char char s named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type n normal constexpr find_last_not_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 884 5 overloads sJwdQ3VSugDWA1BGkxWxv7Cxt2w public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 41YeoGAsWCsuHvJB2aLY8hMDkiMF kcriTnxockbDNC5HRP6aE1SPtmj 2QbTSEJcxznx1s2ro3dS5zTQU2Z5 Nm8xeM1V39MyCJH4fM1YEqiBv9H named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type find_last_not_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 898 5 function 41YeoGAsWCsuHvJB2aLY8hMDkiMF public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type named identifier char char c named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos core::string_view::npos normal constexpr find_last_not_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 884 5 function kcriTnxockbDNC5HRP6aE1SPtmj public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core str named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos core::string_view::npos normal constexpr find_last_not_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 927 5 function 2QbTSEJcxznx1s2ro3dS5zTQU2Z5 public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pointer named identifier char char s named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos core::string_view::npos normal constexpr find_last_not_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 913 5 function Nm8xeM1V39MyCJH4fM1YEqiBv9H public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pointer named identifier char char s named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type n normal constexpr find_last_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 766 5 overloads 3U9YFTNsEghj7N1pNuoyuLoZdjGm public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 3nUQboLhVJpLWsA1gRjRh1U17qoD 2HceG3tTfH5hd1qDNwKQYia4nRA 2zqverMTtKR1afXPSDjd12gKkQzH TGakVkEmvA7Z4qhCMrLSxfzFd1w named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type find_last_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 780 5 function 3nUQboLhVJpLWsA1gRjRh1U17qoD public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type named identifier char char c named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos core::string_view::npos normal constexpr find_last_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 766 5 function 2HceG3tTfH5hd1qDNwKQYia4nRA public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core str named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos core::string_view::npos normal constexpr find_last_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 809 5 function 2zqverMTtKR1afXPSDjd12gKkQzH public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pointer named identifier char char s named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos core::string_view::npos normal constexpr find_last_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 795 5 function TGakVkEmvA7Z4qhCMrLSxfzFd1w public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pointer named identifier char char s named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type n normal constexpr front boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 343 5 function LXiRcWmUiTXoN7uKbWYemES1zmJ public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X paragraph text See code text core::string_view::front brief text Return the first character returns text The first character named identifier 2mEj2svtYXg7jX6i7oRLojMzJyfp const_reference normal constexpr length boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 282 5 function RYCNCvPhXuBoLBAs5AH4ASxNpnx public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X paragraph text See code text core::string_view::length brief text Return the size returns text The size named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type normal constexpr max_size boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 293 5 function wGzcw5BL1efm1mk6pq6nPmoZkRS public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X paragraph text See code text core::string_view::max_size brief text Return the maximum allowed size returns text The maximum allowed size named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type normal constexpr operator[] boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 318 5 function 4NADkGKvVJkngAQ6XfX2pSuPqFJg public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2mEj2svtYXg7jX6i7oRLojMzJyfp const_reference named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos normal constexpr [] rbegin boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 221 5 function fCtPDkAHyYcmdMyXkd9i7J2vECV public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2bRQYvMUah4389d6W7enWHgtN3to const_reverse_iterator normal constexpr rend boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 233 5 function yR13aMBqwcRTjvDjKmrSVdorYp5 public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2bRQYvMUah4389d6W7enWHgtN3to const_reverse_iterator normal constexpr rfind boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 648 5 overloads 2GvVXid3fpBKQ4D7kLzCRrRdUHaY public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 4HV8wLPAYZXWzpi6cZA9nr2wcpHp 4KE8r6umXKHgEvPENarRVqtPZcjr 41MQZv4gtDnTX3TMJdkZ5sNbVmhr 3ck1jep4XReaENvi1E7kAiW7xEQy named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type rfind boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 662 5 function 4HV8wLPAYZXWzpi6cZA9nr2wcpHp public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type named identifier char char c named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos core::string_view::npos normal constexpr rfind boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 648 5 function 4KE8r6umXKHgEvPENarRVqtPZcjr public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core str named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos core::string_view::npos normal constexpr rfind boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 691 5 function 41MQZv4gtDnTX3TMJdkZ5sNbVmhr public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pointer named identifier char char s named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos core::string_view::npos normal constexpr rfind boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 677 5 function 3ck1jep4XReaENvi1E7kAiW7xEQy public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pointer named identifier char char s named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type n normal constexpr size boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 271 5 function 2JpJjEsnBhnTZsbJ55h8BqSdozdK public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X paragraph text See code text core::string_view::size brief text Return the size returns text The size named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type normal constexpr starts_with boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 506 5 overloads eAQNszB5neak8eCFeULLpdz1dBR public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 3fitxjLZ1fx7vynENKBWamRuSupz 2Yz8JhvsoydafkfYmNnUzTaCshi3 3yZitzf11DGVMdFaDNj9BhEiKUeW named identifier bool bool starts_with boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 519 5 function 3fitxjLZ1fx7vynENKBWamRuSupz public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier bool bool named identifier char char x normal constexpr starts_with boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 506 5 function 2Yz8JhvsoydafkfYmNnUzTaCshi3 public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier bool bool named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core x normal constexpr starts_with boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 532 5 function 3yZitzf11DGVMdFaDNj9BhEiKUeW public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier bool bool pointer named identifier char char x normal constexpr substr boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 398 5 function 38iQFzsQfEfXUvQU4E1KU7cb3rAB public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos 0 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type n core::string_view::npos normal constexpr operator basic_string<char> boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 160 5 function 2X9fFvHm8CHy89mguA6sEudtNmQD public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2A6bDeBwiisGpHzTYMLSbQTSaSa3 string identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std conversion operator basic_string_view<char> boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 133 5 function 4EWyYXRZot7yKvPTXVF7VemKcqLa public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X brief text Conversion returns text A string view with the same contents named identifier 3HPgS7y35hBasNYbXshp29ttUeAe string_view identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std conversion constexpr npos boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 125 5 variable 2VYZiE2XGTu7izsSch6CFaDYCUo2 public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X brief text A constant used to represent "no position" named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std core::string_view::npos static string_view_base boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 47 5 overloads ycz1k4ebhSj7jSUnEmtFP7bwvKV protected regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X brief text Constructor param text The string view s param text The character buffer data param text The number of characters size constructor TxzMJR7G1tMYYP9oBhxvpy2w1XH 4AZ5uh1EreoJJoMoS5sbgioTdTGw 3C7cTjDz64yiVuaCpnBWnbmeTZ8Y 3FVndSGNZnopfJFDFuKgKPo6L4qV named identifier void void string_view_base boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 82 5 function TxzMJR7G1tMYYP9oBhxvpy2w1XH protected regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X brief text Constructor named identifier void void constructor constexpr string_view_base boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 86 5 function 4AZ5uh1EreoJJoMoS5sbgioTdTGw protected regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X brief text Constructor param text The object to copy construct from other named identifier void void lvalue-reference named identifier 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X string_view_base other constructor constexpr string_view_base boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 47 5 function 3C7cTjDz64yiVuaCpnBWnbmeTZ8Y protected regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X brief text Constructor param text The string view s named identifier void void named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s constructor constexpr string_view_base boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 59 5 function 3FVndSGNZnopfJFDFuKgKPo6L4qV protected regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X brief text Constructor param text The character buffer data param text The number of characters size named identifier void void pointer named identifier char char data named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std size constructor constexpr operator= boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 94 5 function 2TSxWDzCSsTHCCbfDU3TCWWXwszk protected regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X brief text Assignment returns text A reference to this object param text The object to assign other lvalue-reference named identifier 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X string_view_base lvalue-reference named identifier 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X string_view_base other normal constexpr = swap boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 73 5 function 3qWcEm1E5JQvVH7xZmPSo6XNwSDQ protected regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X brief text Swap param text The object to swap with s named identifier void void lvalue-reference named identifier 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X string_view_base s normal s_ boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 41 5 variable 2ztoKkfV7H8rMnxSoUTTp4HtmeER protected regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X brief text The referenced character buffer named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core unsigned_rule boost/url/grammar/unsigned_rule.hpp include/boost/url/grammar/unsigned_rule.hpp 52 1 record zRbPJc6iCoc5DHmTtrnpqHAyzG2 regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 3Q8wiv658ax6UdCiQCHg8kZbVvRW 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 35v7twCJmdtKy88BJf2RKo7i4tri text . struct 3qS4zqD1JrVw683ba8Bz9ifVkzAv 3Q8wiv658ax6UdCiQCHg8kZbVvRW value_type boost/url/grammar/unsigned_rule.hpp include/boost/url/grammar/unsigned_rule.hpp 61 5 typedef 3qS4zqD1JrVw683ba8Bz9ifVkzAv public regular zRbPJc6iCoc5DHmTtrnpqHAyzG2 named identifier Unsigned parse boost/url/grammar/unsigned_rule.hpp include/boost/url/grammar/unsigned_rule.hpp 63 5 function 3Q8wiv658ax6UdCiQCHg8kZbVvRW public regular zRbPJc6iCoc5DHmTtrnpqHAyzG2 named specialization qQFMz11M2hdnkDE2M6AYnTSkQhv result identifier dgHcH1svHs5X3czTwE2RBXQ7tGq system type named identifier 3qS4zqD1JrVw683ba8Bz9ifVkzAv value_type lvalue-reference pointer named identifier char char it pointer named identifier char char end normal constexpr condition boost/url/grammar/error.hpp include/boost/url/grammar/error.hpp 114 1 enum PiwQ5nsZHQ8sqDifHSnEiFKQM6M regular 3xgiPUvbkGK69EKtHNfc9suQevEU brief text Error conditions for errors received from rules see reference error 4XX6oXv7fcDn7zVuuMxeb6eKAee9 text , reference parse 35v7twCJmdtKy88BJf2RKo7i4tri text . named identifier int int 2L3ytj15Ks7azd38ixYunfpNazc7 fatal boost/url/grammar/error.hpp include/boost/url/grammar/error.hpp 121 5 enum-constant 2L3ytj15Ks7azd38ixYunfpNazc7 regular PiwQ5nsZHQ8sqDifHSnEiFKQM6M paragraph text This indicates that parsing cannot continue. brief text A fatal error in syntax was encountered. 1 1 error boost/url/grammar/error.hpp include/boost/url/grammar/error.hpp 26 1 enum 4XX6oXv7fcDn7zVuuMxeb6eKAee9 regular 3xgiPUvbkGK69EKtHNfc9suQevEU brief text Error codes returned when using rules see reference condition PiwQ5nsZHQ8sqDifHSnEiFKQM6M text , reference parse 35v7twCJmdtKy88BJf2RKo7i4tri text . named identifier int int 2WEVZhduPwBDLFk8ahx6ckz25zHk 2VgKimeUjWqwmAqoyraCM4ynzo28 44EqpubAvqoEZU6zQzmc3vKs2LpS 2WYNpqkA1fEz1VCuVf1KMJdo9Ay7 2gV41DNqJar7ywaikvx3RQTpWpzV 3KjxEnMSARyhA4Ef7zUuX2KdQfEo xNvr7LZU7yTH1BK87vH2S7ByrAq need_more boost/url/grammar/error.hpp include/boost/url/grammar/error.hpp 48 5 enum-constant 2WEVZhduPwBDLFk8ahx6ckz25zHk regular 4XX6oXv7fcDn7zVuuMxeb6eKAee9 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 1 mismatch boost/url/grammar/error.hpp include/boost/url/grammar/error.hpp 58 5 enum-constant 2VgKimeUjWqwmAqoyraCM4ynzo28 regular 4XX6oXv7fcDn7zVuuMxeb6eKAee9 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 enum-constant 44EqpubAvqoEZU6zQzmc3vKs2LpS regular 4XX6oXv7fcDn7zVuuMxeb6eKAee9 paragraph text This indicates that the input was consumed when parsing a reference range pGiGZp4rJemtwvxzYN1qDtgkWDy text . The reference range_rule aDDm7EVotyHV35iaJF5QZr1pqhC 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 enum-constant 2WYNpqkA1fEz1VCuVf1KMJdo9Ay7 regular 4XX6oXv7fcDn7zVuuMxeb6eKAee9 brief text Leftover input remaining after match. invalid boost/url/grammar/error.hpp include/boost/url/grammar/error.hpp 94 5 enum-constant 2gV41DNqJar7ywaikvx3RQTpWpzV regular 4XX6oXv7fcDn7zVuuMxeb6eKAee9 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 enum-constant 3KjxEnMSARyhA4Ef7zUuX2KdQfEo regular 4XX6oXv7fcDn7zVuuMxeb6eKAee9 brief text An integer overflowed during parsing. syntax boost/url/grammar/error.hpp include/boost/url/grammar/error.hpp 103 5 enum-constant xNvr7LZU7yTH1BK87vH2S7ByrAq regular 4XX6oXv7fcDn7zVuuMxeb6eKAee9 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 function 3bhs31iPBqdthrGEX66tZCrKzuze regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 3VKbynmseEkdXfxpKTeafUqCZ1g8 text , reference ci_is_less 3Kvc5n7iMUanAgmP3fyLSy6M3qSi text . named identifier int int named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s0 named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s1 normal ci_digest boost/url/grammar/ci_string.hpp include/boost/url/grammar/ci_string.hpp 140 1 function 4QkGbLV39fncoj8tHDhor2KmsnGh regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal ci_is_equal boost/url/grammar/ci_string.hpp include/boost/url/grammar/ci_string.hpp 164 1 overloads 3VKbynmseEkdXfxpKTeafUqCZ1g8 regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 3bhs31iPBqdthrGEX66tZCrKzuze text , reference ci_is_less 3Kvc5n7iMUanAgmP3fyLSy6M3qSi text . normal 3aZaadY8Mzbexm1Qf8vxXVTNCFwG 2USdUqcaYo23tiPnGqygsM5dUKin auto auto ci_is_equal boost/url/grammar/ci_string.hpp include/boost/url/grammar/ci_string.hpp 204 1 function 3aZaadY8Mzbexm1Qf8vxXVTNCFwG regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 3bhs31iPBqdthrGEX66tZCrKzuze text , reference ci_is_less 3Kvc5n7iMUanAgmP3fyLSy6M3qSi text . named identifier bool bool named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s0 named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s1 normal ci_is_equal boost/url/grammar/ci_string.hpp include/boost/url/grammar/ci_string.hpp 164 1 function 2USdUqcaYo23tiPnGqygsM5dUKin regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 3bhs31iPBqdthrGEX66tZCrKzuze text , reference ci_is_less 3Kvc5n7iMUanAgmP3fyLSy6M3qSi text . named ! std::is_convertible< String0, core::string_view>::value || ! std::is_convertible< String1, core::string_view>::value identifier bool bool lvalue-reference named identifier String0 s0 lvalue-reference named identifier String1 s1 normal ! std::is_convertible< String0, core::string_view>::value || ! std::is_convertible< String1, core::string_view>::value ci_is_less boost/url/grammar/ci_string.hpp include/boost/url/grammar/ci_string.hpp 239 1 function 3Kvc5n7iMUanAgmP3fyLSy6M3qSi regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 3bhs31iPBqdthrGEX66tZCrKzuze text , reference ci_is_equal 3VKbynmseEkdXfxpKTeafUqCZ1g8 text . named identifier bool bool named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s0 named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s1 normal delim_rule boost/url/grammar/delim_rule.hpp include/boost/url/grammar/delim_rule.hpp 80 1 overloads 3M3qv3Hq6NRvW6tzwHQ6UZH44kKN regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 35v7twCJmdtKy88BJf2RKo7i4tri text , reference squelch 23LNUGNyBxyEyZFXTVavi4Zv5HBo text . see reference alpha_chars 2fjR3hjprSzgK21c2kMYTmdnqRRv text , reference parse 35v7twCJmdtKy88BJf2RKo7i4tri text , reference squelch 23LNUGNyBxyEyZFXTVavi4Zv5HBo text . normal eAqrzPg9DK8QnL54GMCbbwT8fYA 3A2E17vf1bqRjDh4zR5tec6hzQkU auto auto delim_rule boost/url/grammar/delim_rule.hpp include/boost/url/grammar/delim_rule.hpp 80 1 function eAqrzPg9DK8QnL54GMCbbwT8fYA regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 23LNUGNyBxyEyZFXTVavi4Zv5HBo 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 2WEVZhduPwBDLFk8ahx6ckz25zHk 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 35v7twCJmdtKy88BJf2RKo7i4tri 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 35v7twCJmdtKy88BJf2RKo7i4tri text , reference squelch 23LNUGNyBxyEyZFXTVavi4Zv5HBo text . named identifier 44tHdf4nPuUd92mQ3hiBwwBDwMjE ch_delim_rule identifier 33AC7YGWwtZvBTKSxwdcQ3ffNAdV implementation_defined named identifier char char ch normal constexpr delim_rule boost/url/grammar/delim_rule.hpp include/boost/url/grammar/delim_rule.hpp 158 1 function 3A2E17vf1bqRjDh4zR5tec6hzQkU regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 23LNUGNyBxyEyZFXTVavi4Zv5HBo 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 2WEVZhduPwBDLFk8ahx6ckz25zHk 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 35v7twCJmdtKy88BJf2RKo7i4tri 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 2fjR3hjprSzgK21c2kMYTmdnqRRv text , reference parse 35v7twCJmdtKy88BJf2RKo7i4tri text , reference squelch 23LNUGNyBxyEyZFXTVavi4Zv5HBo text . named ! std::is_convertible< CS, char>::value specialization hofXiskobMAXcsmQqNnYTTA8ZTq cs_delim_rule identifier 33AC7YGWwtZvBTKSxwdcQ3ffNAdV implementation_defined type named identifier CS lvalue-reference named identifier CS cs normal ! std::is_convertible< CS, char>::value constexpr find_if boost/url/grammar/charset.hpp include/boost/url/grammar/charset.hpp 145 1 function 3XhMv27X469neaTG5KKaz2w1eJ1W regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 3H7zQeHPown6VJxU8o7M8oV2cAgJ text . pointer named identifier char char pointer named identifier char char first pointer named identifier char char last lvalue-reference named identifier CS cs normal constexpr find_if_not boost/url/grammar/charset.hpp include/boost/url/grammar/charset.hpp 184 1 function 3H7zQeHPown6VJxU8o7M8oV2cAgJ regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 3H7zQeHPown6VJxU8o7M8oV2cAgJ text . pointer named identifier char char pointer named identifier char char first pointer named identifier char char last lvalue-reference named identifier CS cs normal constexpr hexdig_value boost/url/grammar/hexdig_chars.hpp include/boost/url/grammar/hexdig_chars.hpp 117 1 function GHYsTP5sD1CZGLeVrktLDXF45JP regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 named identifier signed char signed char named identifier char char ch normal not_empty_rule boost/url/grammar/not_empty_rule.hpp include/boost/url/grammar/not_empty_rule.hpp 74 1 function 273dQKXXEcenHaDX2CFEMYxvB341 regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 35v7twCJmdtKy88BJf2RKo7i4tri 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 35v7twCJmdtKy88BJf2RKo7i4tri text , reference pct_encoded_rule 3YbQmLbv9k5hQejotb1EQGfGvbSp text , reference unreserved_chars 3U1VJchaHf6kHuVX7q3rr33jE4fW text . named specialization 4JZ2BfHTC8Lar8AKRRzXhmGRuyZw not_empty_rule_t identifier 33AC7YGWwtZvBTKSxwdcQ3ffNAdV implementation_defined type named identifier R lvalue-reference named identifier R r normal constexpr operator+ boost/url/grammar/lut_chars.hpp include/boost/url/grammar/lut_chars.hpp 300 5 function xi4dY5cq9QSJCA3VRHjXdvPG6Wi public regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 named identifier 4LnTx5EKsVwNijs6E9BugA6EwaZF lut_chars lvalue-reference named identifier 4LnTx5EKsVwNijs6E9BugA6EwaZF lut_chars cs0 lvalue-reference named identifier 4LnTx5EKsVwNijs6E9BugA6EwaZF lut_chars cs1 normal constexpr + operator- boost/url/grammar/lut_chars.hpp include/boost/url/grammar/lut_chars.hpp 337 5 function 4HpDk6DDaARwYramwKg9KXqcEZ8u public regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 named identifier 4LnTx5EKsVwNijs6E9BugA6EwaZF lut_chars lvalue-reference named identifier 4LnTx5EKsVwNijs6E9BugA6EwaZF lut_chars cs0 lvalue-reference named identifier 4LnTx5EKsVwNijs6E9BugA6EwaZF lut_chars cs1 normal constexpr - optional_rule boost/url/grammar/optional_rule.hpp include/boost/url/grammar/optional_rule.hpp 87 1 function 2n6gXWu6UsXaXm7J8EvbhCLjTWMu regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 35v7twCJmdtKy88BJf2RKo7i4tri 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 2fjR3hjprSzgK21c2kMYTmdnqRRv text , reference parse 35v7twCJmdtKy88BJf2RKo7i4tri text , reference optional 3FCL7hYN4kMytJQRw4DmkYAPaTGX text , reference token_rule 83PBiqs4SpXr9emD1VFbJjZ21Dy text . named specialization 27LSo7ciPxehreUXsuJJMv59Hgkm optional_rule_t identifier 33AC7YGWwtZvBTKSxwdcQ3ffNAdV implementation_defined type named identifier R lvalue-reference named identifier R r normal constexpr parse boost/url/grammar/parse.hpp include/boost/url/grammar/parse.hpp 38 1 boost/url/grammar/parse.hpp include/boost/url/grammar/parse.hpp 60 1 overloads 35v7twCJmdtKy88BJf2RKo7i4tri regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 eQrykHx8zB1Cmm6DshJQFxGnZXh 2S9hYE7Byko1cmR1MQvoeUs8DaLE named specialization qQFMz11M2hdnkDE2M6AYnTSkQhv result identifier dgHcH1svHs5X3czTwE2RBXQ7tGq system type named identifier value_type identifier R parse boost/url/grammar/parse.hpp include/boost/url/grammar/parse.hpp 60 1 function eQrykHx8zB1Cmm6DshJQFxGnZXh regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 named specialization qQFMz11M2hdnkDE2M6AYnTSkQhv result identifier dgHcH1svHs5X3czTwE2RBXQ7tGq system type named identifier value_type identifier R named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s lvalue-reference named identifier R r normal constexpr parse boost/url/grammar/parse.hpp include/boost/url/grammar/parse.hpp 38 1 function 2S9hYE7Byko1cmR1MQvoeUs8DaLE regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 named specialization qQFMz11M2hdnkDE2M6AYnTSkQhv result identifier dgHcH1svHs5X3czTwE2RBXQ7tGq system type named identifier value_type identifier R lvalue-reference pointer named identifier char char it pointer named identifier char char end lvalue-reference named identifier R r normal constexpr range_rule boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 517 1 overloads aDDm7EVotyHV35iaJF5QZr1pqhC regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 2fjR3hjprSzgK21c2kMYTmdnqRRv text , reference delim_rule 3M3qv3Hq6NRvW6tzwHQ6UZH44kKN text , reference error::end_of_range 44EqpubAvqoEZU6zQzmc3vKs2LpS text , reference parse 35v7twCJmdtKy88BJf2RKo7i4tri text , reference range pGiGZp4rJemtwvxzYN1qDtgkWDy text , reference tuple_rule 46F3vin27VZapr3okT8ENb5eF68Q text , reference squelch 23LNUGNyBxyEyZFXTVavi4Zv5HBo text . normal 1gnvKeb4uiPyawm5aYgrkbZiGj7 35ELrHCGKveFYTAEiJduxqVEPKA7 auto auto range_rule boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 517 1 function 1gnvKeb4uiPyawm5aYgrkbZiGj7 regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 44EqpubAvqoEZU6zQzmc3vKs2LpS 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 35v7twCJmdtKy88BJf2RKo7i4tri 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 2fjR3hjprSzgK21c2kMYTmdnqRRv text , reference delim_rule 3M3qv3Hq6NRvW6tzwHQ6UZH44kKN text , reference error::end_of_range 44EqpubAvqoEZU6zQzmc3vKs2LpS text , reference parse 35v7twCJmdtKy88BJf2RKo7i4tri text , reference range pGiGZp4rJemtwvxzYN1qDtgkWDy text , reference tuple_rule 46F3vin27VZapr3okT8ENb5eF68Q text , reference squelch 23LNUGNyBxyEyZFXTVavi4Zv5HBo text . named specialization Z9GfoWMyg92pKoZ4o24vPDxhX5E range_rule_t identifier 33AC7YGWwtZvBTKSxwdcQ3ffNAdV implementation_defined type named identifier R lvalue-reference named identifier R next named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std N 0 named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std M std::size_t(-1) normal constexpr range_rule boost/url/grammar/range_rule.hpp include/boost/url/grammar/range_rule.hpp 648 1 function 35ELrHCGKveFYTAEiJduxqVEPKA7 regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 44EqpubAvqoEZU6zQzmc3vKs2LpS 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 35v7twCJmdtKy88BJf2RKo7i4tri 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 2fjR3hjprSzgK21c2kMYTmdnqRRv text , reference delim_rule 3M3qv3Hq6NRvW6tzwHQ6UZH44kKN text , reference error::end_of_range 44EqpubAvqoEZU6zQzmc3vKs2LpS text , reference parse 35v7twCJmdtKy88BJf2RKo7i4tri text , reference range pGiGZp4rJemtwvxzYN1qDtgkWDy text , reference tuple_rule 46F3vin27VZapr3okT8ENb5eF68Q text , reference squelch 23LNUGNyBxyEyZFXTVavi4Zv5HBo text . named ! std::is_integral<R2>::value specialization Z9GfoWMyg92pKoZ4o24vPDxhX5E range_rule_t identifier 33AC7YGWwtZvBTKSxwdcQ3ffNAdV implementation_defined type named identifier R1 type named identifier R2 lvalue-reference named identifier R1 first lvalue-reference named identifier R2 next named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std N 0 named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std M std::size_t(-1) normal ! std::is_integral<R2>::value constexpr ref boost/url/grammar/charset.hpp include/boost/url/grammar/charset.hpp 260 1 overloads SrZRA5AqXfGwJzbKiZSCeciZbt4 regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 oDyJikAJE4jQQ6ytx6BeWbFu77w 3t3MFVKbgAf2AGHDyUYUb9H49pyw auto auto ref boost/url/grammar/charset.hpp include/boost/url/grammar/charset.hpp 260 1 function oDyJikAJE4jQQ6ytx6BeWbFu77w regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 named is_charset<CS>::value && ! std::is_same<CS, implementation_defined::charset_ref<CS> >::value specialization 44JikQvwyJwAUthk6r1KRaLbBiec charset_ref identifier 33AC7YGWwtZvBTKSxwdcQ3ffNAdV implementation_defined type named identifier CS lvalue-reference named identifier CS cs normal is_charset<CS>::value && ! std::is_same<CS, implementation_defined::charset_ref<CS> >::value constexpr ref boost/url/grammar/parse.hpp include/boost/url/grammar/parse.hpp 106 1 function 3t3MFVKbgAf2AGHDyUYUb9H49pyw regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 named is_rule<R>::value && ! std::is_same<R, implementation_defined::rule_ref<R> >::value specialization YzpvJaWAWbrGsVQUwrrVzM9SxmP rule_ref identifier 33AC7YGWwtZvBTKSxwdcQ3ffNAdV implementation_defined type named identifier R lvalue-reference named identifier R r normal is_rule<R>::value && ! std::is_same<R, implementation_defined::rule_ref<R> >::value constexpr squelch boost/url/grammar/tuple_rule.hpp include/boost/url/grammar/tuple_rule.hpp 224 1 function 23LNUGNyBxyEyZFXTVavi4Zv5HBo regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 3M3qv3Hq6NRvW6tzwHQ6UZH44kKN text , reference digit_chars 3GLRcYn4wNHf4YatGxgZeyGqA4MW text , reference parse 35v7twCJmdtKy88BJf2RKo7i4tri text , reference tuple_rule 46F3vin27VZapr3okT8ENb5eF68Q text , reference token_rule 83PBiqs4SpXr9emD1VFbJjZ21Dy text , reference decode_view UXcENkB7t9T6PDWy1z6kk8ej8kT text , reference pct_encoded_rule 3YbQmLbv9k5hQejotb1EQGfGvbSp text , reference unreserved_chars 3U1VJchaHf6kHuVX7q3rr33jE4fW text . named specialization CP5zh7Bc3c5QNFyZESUgrMdfMPk squelch_rule_t identifier 33AC7YGWwtZvBTKSxwdcQ3ffNAdV implementation_defined type named identifier R lvalue-reference named identifier R r normal constexpr to_lower boost/url/grammar/ci_string.hpp include/boost/url/grammar/ci_string.hpp 53 1 function 3cDeawx5aoU8fcZy8Cohmfz4UPnF regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 3geR1eH2FNivLakwdnyJPnpNrVS2 text . named identifier char char named identifier char char c normal constexpr to_upper boost/url/grammar/ci_string.hpp include/boost/url/grammar/ci_string.hpp 83 1 function 3geR1eH2FNivLakwdnyJPnpNrVS2 regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 3cDeawx5aoU8fcZy8Cohmfz4UPnF text . named identifier char char named identifier char char c normal constexpr token_rule boost/url/grammar/token_rule.hpp include/boost/url/grammar/token_rule.hpp 93 1 overloads 83PBiqs4SpXr9emD1VFbJjZ21Dy regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 2fjR3hjprSzgK21c2kMYTmdnqRRv text , reference parse 35v7twCJmdtKy88BJf2RKo7i4tri text . normal R5BGdKmDcJeoThnzSEND1RMziGP 2uDqwFNketJHB3CkqeAsogWsMGHg auto auto token_rule boost/url/grammar/token_rule.hpp include/boost/url/grammar/token_rule.hpp 134 1 function R5BGdKmDcJeoThnzSEND1RMziGP regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 2WEVZhduPwBDLFk8ahx6ckz25zHk 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 35v7twCJmdtKy88BJf2RKo7i4tri 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 2fjR3hjprSzgK21c2kMYTmdnqRRv text , reference parse 35v7twCJmdtKy88BJf2RKo7i4tri text . named std::is_default_constructible<CharSet>::value specialization 3AxWeRi5wqQBciHGGT5g5H2nEG3P token_rule_t identifier 33AC7YGWwtZvBTKSxwdcQ3ffNAdV implementation_defined type named identifier CharSet normal std::is_default_constructible<CharSet>::value constexpr token_rule boost/url/grammar/token_rule.hpp include/boost/url/grammar/token_rule.hpp 93 1 function 2uDqwFNketJHB3CkqeAsogWsMGHg regular 3xgiPUvbkGK69EKtHNfc9suQevEU paragraph text If there is no more input, the error code reference error::need_more 2WEVZhduPwBDLFk8ahx6ckz25zHk 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 35v7twCJmdtKy88BJf2RKo7i4tri 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 2fjR3hjprSzgK21c2kMYTmdnqRRv text , reference parse 35v7twCJmdtKy88BJf2RKo7i4tri text . named specialization 3AxWeRi5wqQBciHGGT5g5H2nEG3P token_rule_t identifier 33AC7YGWwtZvBTKSxwdcQ3ffNAdV implementation_defined type named identifier CS lvalue-reference named identifier CS cs normal constexpr tuple_rule boost/url/grammar/tuple_rule.hpp include/boost/url/grammar/tuple_rule.hpp 126 1 function 46F3vin27VZapr3okT8ENb5eF68Q regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 35v7twCJmdtKy88BJf2RKo7i4tri 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 3gTcjG7wLGhhgK7izbCV8x9MWUwd text , reference delim_rule 3M3qv3Hq6NRvW6tzwHQ6UZH44kKN text , reference parse 35v7twCJmdtKy88BJf2RKo7i4tri text , reference squelch 23LNUGNyBxyEyZFXTVavi4Zv5HBo text . named specialization 3CCQpkWpPaFZB1FpmRGri3rEEHvZ tuple_rule_t identifier 33AC7YGWwtZvBTKSxwdcQ3ffNAdV implementation_defined type named identifier R0 type named identifier Rn lvalue-reference named identifier R0 r0 lvalue-reference named identifier Rn rn normal constexpr variant_rule boost/url/grammar/variant_rule.hpp include/boost/url/grammar/variant_rule.hpp 107 1 function 3DSrvL2PqP2G8FHcG4TnCr6HRs22 regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 35v7twCJmdtKy88BJf2RKo7i4tri 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 48v2goykSGwK1v9STZJpo6jjTuxW text , reference authority_rule 32VVcQFEhxqnXpaLAaf9VCsLxUkr text , reference delim_rule 3M3qv3Hq6NRvW6tzwHQ6UZH44kKN text , reference parse 35v7twCJmdtKy88BJf2RKo7i4tri text , reference origin_form_rule 3DgP78orKFq8Q1iGscjBtBswa56h text , reference url_view 3hrVvoVYoDkX9t3w9abTXxDqGRaW text . named specialization 2thHPrGcmqMTPU7gfJn9G45JMskb variant_rule_t identifier 33AC7YGWwtZvBTKSxwdcQ3ffNAdV implementation_defined type named identifier R0 type named identifier Rn lvalue-reference named identifier R0 r0 lvalue-reference named identifier Rn rn normal constexpr operator<< boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 1112 5 boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 1124 1 function 2ssAwUNNjc8j5iGoER4xvc5QkKwQ public regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 lvalue-reference named identifier 2HrCakn2VFWrwzuwmx1m5Dq5CgYg ostream identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std lvalue-reference named identifier 2HrCakn2VFWrwzuwmx1m5Dq5CgYg ostream identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std os lvalue-reference named identifier 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X string_view_base s normal << operator== boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 999 5 function 2DwidNJJq1FJ5gko382oRBBxC7ea public regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 named is_match<S0, S1>::value identifier bool bool lvalue-reference named identifier S0 s0 lvalue-reference named identifier S1 s1 normal is_match<S0, S1>::value constexpr == operator!= boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 1018 5 function 4VUoz5e4fhpRtULs6qezwRLEQev6 public regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 named is_match<S0, S1>::value identifier bool bool lvalue-reference named identifier S0 s0 lvalue-reference named identifier S1 s1 normal is_match<S0, S1>::value constexpr != operator< boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 1037 5 function fm4KGz7DKn63PaBCnCYLbhX1gvW public regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 named is_match<S0, S1>::value identifier bool bool lvalue-reference named identifier S0 s0 lvalue-reference named identifier S1 s1 normal is_match<S0, S1>::value constexpr < operator<= boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 1056 5 function 2o6W5TBQ9LbmLFPDd9yn85hWvbwN public regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 named is_match<S0, S1>::value identifier bool bool lvalue-reference named identifier S0 s0 lvalue-reference named identifier S1 s1 normal is_match<S0, S1>::value constexpr <= operator> boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 1075 5 function 2dZbUeY791eW6YqfJHFUhgQV9gMc public regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 named is_match<S0, S1>::value identifier bool bool lvalue-reference named identifier S0 s0 lvalue-reference named identifier S1 s1 normal is_match<S0, S1>::value constexpr > operator>= boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 1094 5 function 2iMNT1B2aB6w1zvdRW3p8ePFHQso public regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 named is_match<S0, S1>::value identifier bool bool lvalue-reference named identifier S0 s0 lvalue-reference named identifier S1 s1 normal is_match<S0, S1>::value constexpr >= all_chars boost/url/grammar/all_chars.hpp include/boost/url/grammar/all_chars.hpp 75 1 variable 2JAEap1NsGqkXnfHYfEFK8zyzB1s regular 3xgiPUvbkGK69EKtHNfc9suQevEU heading text Example 1 paragraph text Character sets are used with rules and the functions reference find_if 3XhMv27X469neaTG5KKaz2w1eJ1W text and reference find_if_not 3H7zQeHPown6VJxU8o7M8oV2cAgJ 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 3XhMv27X469neaTG5KKaz2w1eJ1W text , reference find_if_not 3H7zQeHPown6VJxU8o7M8oV2cAgJ text , reference parse 35v7twCJmdtKy88BJf2RKo7i4tri text , reference token_rule 83PBiqs4SpXr9emD1VFbJjZ21Dy text . named identifier 3BvzSDK5r2M2sbkygV7xn4Uy7okS all_chars_t identifier 33AC7YGWwtZvBTKSxwdcQ3ffNAdV implementation_defined all_chars{} alnum_chars boost/url/grammar/alnum_chars.hpp include/boost/url/grammar/alnum_chars.hpp 84 1 variable bcaTLDQstdfndoSMJP6AYgRipJw regular 3xgiPUvbkGK69EKtHNfc9suQevEU heading text Example 1 paragraph text Character sets are used with rules and the functions reference find_if 3XhMv27X469neaTG5KKaz2w1eJ1W text and reference find_if_not 3H7zQeHPown6VJxU8o7M8oV2cAgJ 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 3XhMv27X469neaTG5KKaz2w1eJ1W text , reference find_if_not 3H7zQeHPown6VJxU8o7M8oV2cAgJ text , reference parse 35v7twCJmdtKy88BJf2RKo7i4tri text , reference token_rule 83PBiqs4SpXr9emD1VFbJjZ21Dy text . named identifier s28LNyabXgN8YpeSFm9gY5T8Wjt alnum_chars_t identifier 33AC7YGWwtZvBTKSxwdcQ3ffNAdV implementation_defined {} alpha_chars boost/url/grammar/alpha_chars.hpp include/boost/url/grammar/alpha_chars.hpp 81 1 variable 2fjR3hjprSzgK21c2kMYTmdnqRRv regular 3xgiPUvbkGK69EKtHNfc9suQevEU heading text Example 1 paragraph text Character sets are used with rules and the functions reference find_if 3XhMv27X469neaTG5KKaz2w1eJ1W text and reference find_if_not 3H7zQeHPown6VJxU8o7M8oV2cAgJ 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 3XhMv27X469neaTG5KKaz2w1eJ1W text , reference find_if_not 3H7zQeHPown6VJxU8o7M8oV2cAgJ text , reference parse 35v7twCJmdtKy88BJf2RKo7i4tri text , reference token_rule 83PBiqs4SpXr9emD1VFbJjZ21Dy text . named identifier 2UM4r1q8TmMPFobJVQHaMahn5axm alpha_chars_t identifier 33AC7YGWwtZvBTKSxwdcQ3ffNAdV implementation_defined alpha_chars{} dec_octet_rule boost/url/grammar/dec_octet_rule.hpp include/boost/url/grammar/dec_octet_rule.hpp 68 1 variable 3gTcjG7wLGhhgK7izbCV8x9MWUwd regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 35v7twCJmdtKy88BJf2RKo7i4tri 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 35v7twCJmdtKy88BJf2RKo7i4tri text . named identifier S7ryoAUvaZUnuofguXPTtyirJvH dec_octet_rule_t identifier 33AC7YGWwtZvBTKSxwdcQ3ffNAdV implementation_defined {} digit_chars boost/url/grammar/digit_chars.hpp include/boost/url/grammar/digit_chars.hpp 76 1 variable 3GLRcYn4wNHf4YatGxgZeyGqA4MW regular 3xgiPUvbkGK69EKtHNfc9suQevEU heading text Example 1 paragraph text Character sets are used with rules and the functions reference find_if 3XhMv27X469neaTG5KKaz2w1eJ1W text and reference find_if_not 3H7zQeHPown6VJxU8o7M8oV2cAgJ 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 3XhMv27X469neaTG5KKaz2w1eJ1W text , reference find_if_not 3H7zQeHPown6VJxU8o7M8oV2cAgJ text , reference parse 35v7twCJmdtKy88BJf2RKo7i4tri text , reference token_rule 83PBiqs4SpXr9emD1VFbJjZ21Dy text . named identifier zZGhMjPgB1iyQmecLeB2iYmoNPi digit_chars_t identifier 33AC7YGWwtZvBTKSxwdcQ3ffNAdV implementation_defined {} hexdig_chars boost/url/grammar/hexdig_chars.hpp include/boost/url/grammar/hexdig_chars.hpp 97 1 variable BJHwVXG1yn5SJcDhAuECh5vFMQc regular 3xgiPUvbkGK69EKtHNfc9suQevEU heading text Example 1 paragraph text Character sets are used with rules and the functions reference find_if 3XhMv27X469neaTG5KKaz2w1eJ1W text and reference find_if_not 3H7zQeHPown6VJxU8o7M8oV2cAgJ 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 3XhMv27X469neaTG5KKaz2w1eJ1W text , reference find_if_not 3H7zQeHPown6VJxU8o7M8oV2cAgJ text , reference hexdig_value GHYsTP5sD1CZGLeVrktLDXF45JP text , reference parse 35v7twCJmdtKy88BJf2RKo7i4tri text , reference token_rule 83PBiqs4SpXr9emD1VFbJjZ21Dy text . named identifier 3Y7kYi2m5mtV4e9XC8TeuuKm7y7J hexdig_chars_t identifier 33AC7YGWwtZvBTKSxwdcQ3ffNAdV implementation_defined {} vchars boost/url/grammar/vchars.hpp include/boost/url/grammar/vchars.hpp 76 1 variable 4BSDSuAA3FVHq1FWSJNQdrcgR3Nz regular 3xgiPUvbkGK69EKtHNfc9suQevEU heading text Example 1 paragraph text Character sets are used with rules and the functions reference find_if 3XhMv27X469neaTG5KKaz2w1eJ1W text and reference find_if_not 3H7zQeHPown6VJxU8o7M8oV2cAgJ 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 3XhMv27X469neaTG5KKaz2w1eJ1W text , reference find_if_not 3H7zQeHPown6VJxU8o7M8oV2cAgJ text , reference parse 35v7twCJmdtKy88BJf2RKo7i4tri text , reference token_rule 83PBiqs4SpXr9emD1VFbJjZ21Dy text . named identifier 46Gseh2wSQ89N7fVpYSQmw7FBSGF vchars_t identifier 33AC7YGWwtZvBTKSxwdcQ3ffNAdV implementation_defined {} CharSet boost/url/grammar/charset.hpp include/boost/url/grammar/charset.hpp 115 1 concept KeQyLouQiB2oLgbB57w7Npq1mnR regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 bcaTLDQstdfndoSMJP6AYgRipJw paragraph reference alpha_chars 2fjR3hjprSzgK21c2kMYTmdnqRRv paragraph reference digit_chars 3GLRcYn4wNHf4YatGxgZeyGqA4MW paragraph reference hexdig_chars BJHwVXG1yn5SJcDhAuECh5vFMQc paragraph reference lut_chars 4LnTx5EKsVwNijs6E9BugA6EwaZF unordered brief text Concept for a CharSet see reference is_charset 3uNrm5j28Dkpd69qgbwXojiSiaac text , reference find_if 3XhMv27X469neaTG5KKaz2w1eJ1W text , reference find_if_not 3H7zQeHPown6VJxU8o7M8oV2cAgJ 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 ZBLoUYbqsmpyLRqiVPJtguv12iY regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 concept 2aNmCYXtDWunhuJ7qwhASTEkEdWC regular 3xgiPUvbkGK69EKtHNfc9suQevEU 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 35v7twCJmdtKy88BJf2RKo7i4tri 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 3gTcjG7wLGhhgK7izbCV8x9MWUwd paragraph reference delim_rule 3M3qv3Hq6NRvW6tzwHQ6UZH44kKN paragraph reference not_empty_rule 273dQKXXEcenHaDX2CFEMYxvB341 paragraph reference optional_rule 2n6gXWu6UsXaXm7J8EvbhCLjTWMu paragraph reference range_rule aDDm7EVotyHV35iaJF5QZr1pqhC paragraph reference token_rule 83PBiqs4SpXr9emD1VFbJjZ21Dy paragraph reference tuple_rule 46F3vin27VZapr3okT8ENb5eF68Q paragraph reference unsigned_rule zRbPJc6iCoc5DHmTtrnpqHAyzG2 paragraph reference variant_rule 3DSrvL2PqP2G8FHcG4TnCr6HRs22 unordered brief text Concept for a grammar Rule see reference parse 35v7twCJmdtKy88BJf2RKo7i4tri text , reference is_rule ehR6ZaA3gqV5eZf92n7xV7mYkMz 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 3jVzhUTY78j9Azdaoqzm3EeWXkEU implementation-defined 2ejQGW57K8g7MFJhHAwPt5aumoLa 28DZBeCCfnFAp6BDdvTvfydAa9cs cTXppJW6xt15m8djAPDdgb4DDYU 2LPgbGCfKKnahA45gG6zVjG9WUcA 3ExxwPTESczMzTf2489HBSWA6zEG 3mrY4amrXsM7dFmSAbFhqjKG4YM 45Uw1N3BcEHkXLQpcFvhe9pSM9K 8HhHaa6h2JiNhZ9E4zU7uYNKgjN 4EYgSxFF8chLwEJtNc7Ufxbe6yKa 3YViMX5KP1ZZd5Jp7dKx9J4RG8C7 2K5avjP9r9DGYDgSW2ZNECviGYR2 RwQNqC8gZnDgSLJ1xxVX2bdnvfj absolute_uri_rule_t boost/url/rfc/absolute_uri_rule.hpp include/boost/url/rfc/absolute_uri_rule.hpp 23 1 record 28DZBeCCfnFAp6BDdvTvfydAa9cs implementation-defined 3jVzhUTY78j9Azdaoqzm3EeWXkEU struct authority_rule_t boost/url/rfc/authority_rule.hpp include/boost/url/rfc/authority_rule.hpp 21 1 record cTXppJW6xt15m8djAPDdgb4DDYU implementation-defined 3jVzhUTY78j9Azdaoqzm3EeWXkEU struct ignore_case_t boost/url/ignore_case.hpp include/boost/url/ignore_case.hpp 19 1 record 2LPgbGCfKKnahA45gG6zVjG9WUcA implementation-defined 3jVzhUTY78j9Azdaoqzm3EeWXkEU struct ipv4_address_rule_t boost/url/rfc/ipv4_address_rule.hpp include/boost/url/rfc/ipv4_address_rule.hpp 21 1 record 3ExxwPTESczMzTf2489HBSWA6zEG implementation-defined 3jVzhUTY78j9Azdaoqzm3EeWXkEU struct ipv6_address_rule_t boost/url/rfc/ipv6_address_rule.hpp include/boost/url/rfc/ipv6_address_rule.hpp 21 1 record 3mrY4amrXsM7dFmSAbFhqjKG4YM implementation-defined 3jVzhUTY78j9Azdaoqzm3EeWXkEU struct origin_form_rule_t boost/url/rfc/origin_form_rule.hpp include/boost/url/rfc/origin_form_rule.hpp 23 1 record 45Uw1N3BcEHkXLQpcFvhe9pSM9K implementation-defined 3jVzhUTY78j9Azdaoqzm3EeWXkEU struct pct_encoded_rule_t boost/url/rfc/pct_encoded_rule.hpp include/boost/url/rfc/pct_encoded_rule.hpp 22 1 record 8HhHaa6h2JiNhZ9E4zU7uYNKgjN implementation-defined 3jVzhUTY78j9Azdaoqzm3EeWXkEU struct query_rule_t boost/url/rfc/query_rule.hpp include/boost/url/rfc/query_rule.hpp 22 1 record 4EYgSxFF8chLwEJtNc7Ufxbe6yKa implementation-defined 3jVzhUTY78j9Azdaoqzm3EeWXkEU struct relative_ref_rule_t boost/url/rfc/relative_ref_rule.hpp include/boost/url/rfc/relative_ref_rule.hpp 23 1 record 3YViMX5KP1ZZd5Jp7dKx9J4RG8C7 implementation-defined 3jVzhUTY78j9Azdaoqzm3EeWXkEU struct uri_reference_rule_t boost/url/rfc/uri_reference_rule.hpp include/boost/url/rfc/uri_reference_rule.hpp 23 1 record 2K5avjP9r9DGYDgSW2ZNECviGYR2 implementation-defined 3jVzhUTY78j9Azdaoqzm3EeWXkEU struct uri_rule_t boost/url/rfc/uri_rule.hpp include/boost/url/rfc/uri_rule.hpp 23 1 record RwQNqC8gZnDgSLJ1xxVX2bdnvfj implementation-defined 3jVzhUTY78j9Azdaoqzm3EeWXkEU struct string_token boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 21 1 namespace gXLgKAknGYwc12RGZfBgr4HdDCT regular 2ejQGW57K8g7MFJhHAwPt5aumoLa qQpkegZWLvhBTwZqCvDCRVcgjAJ 3Y7Xbae72RLVbDwrvG28bjSrqPRA 4UumWzLNRv3vgTVdDkz5PVqdSsSL 4XGUrdBsWAgVsJYv12cLYxsQzwnb 4HPdckNJWYP6EwzTSRQwp4XCam4o XRgErtvdgogvfQn13sEAR6jd1uT 7UQR5tGyoz8hnqbre8ugcpWoK4T 2jrLuAf8SropaW5iWJ5viezX4GJB 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 qQpkegZWLvhBTwZqCvDCRVcgjAJ implementation-defined gXLgKAknGYwc12RGZfBgr4HdDCT 3NcX3C2TB37p4RTE8stCdunyw7Bw 3LEMm8DJGzbwQfSP2CHysVLK35R4 2uHkBTH3hbisFab4VCxbw2Ev6VDi 3e11kkmrjyCuYn6WvfoCyeDfyn7r 3CA8GCrteoFX8mpTn7Dr2qJUbpDm append_to_t boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 282 1 record 3NcX3C2TB37p4RTE8stCdunyw7Bw implementation-defined qQpkegZWLvhBTwZqCvDCRVcgjAJ struct named identifier 4XGUrdBsWAgVsJYv12cLYxsQzwnb arg public assign_to_t boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 348 1 record 3LEMm8DJGzbwQfSP2CHysVLK35R4 implementation-defined qQpkegZWLvhBTwZqCvDCRVcgjAJ struct named identifier 4XGUrdBsWAgVsJYv12cLYxsQzwnb arg public is_token boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 97 1 record 2uHkBTH3hbisFab4VCxbw2Ev6VDi implementation-defined qQpkegZWLvhBTwZqCvDCRVcgjAJ struct named identifier 35Znu1makyhDbFtWQWvcmNhtWuKY false_type identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std public preserve_size_t boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 411 1 record 3e11kkmrjyCuYn6WvfoCyeDfyn7r implementation-defined qQpkegZWLvhBTwZqCvDCRVcgjAJ struct named identifier 4XGUrdBsWAgVsJYv12cLYxsQzwnb arg public return_string boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 245 1 record 3CA8GCrteoFX8mpTn7Dr2qJUbpDm implementation-defined qQpkegZWLvhBTwZqCvDCRVcgjAJ struct named identifier 4XGUrdBsWAgVsJYv12cLYxsQzwnb arg public is_token boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 130 1 typedef 3Y7Xbae72RLVbDwrvG28bjSrqPRA regular gXLgKAknGYwc12RGZfBgr4HdDCT paragraph text This trait returns code text true text if code text T text is a valid reference StringToken 2jrLuAf8SropaW5iWJ5viezX4GJB 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 named specialization 2uHkBTH3hbisFab4VCxbw2Ev6VDi is_token identifier qQpkegZWLvhBTwZqCvDCRVcgjAJ implementation_defined type named identifier T return_string boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 277 1 typedef 4UumWzLNRv3vgTVdDkz5PVqdSsSL regular gXLgKAknGYwc12RGZfBgr4HdDCT paragraph text This reference StringToken 2jrLuAf8SropaW5iWJ5viezX4GJB 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 27ryuyAvvRyzfzgketja5uQcFBcK text that return decoded strings. brief text A string token for returning a plain string named identifier 3CA8GCrteoFX8mpTn7Dr2qJUbpDm return_string identifier qQpkegZWLvhBTwZqCvDCRVcgjAJ implementation_defined arg boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 51 1 record 4XGUrdBsWAgVsJYv12cLYxsQzwnb regular gXLgKAknGYwc12RGZfBgr4HdDCT 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 2jrLuAf8SropaW5iWJ5viezX4GJB text should be derived from this class. As the author of an algorithm using a reference StringToken 2jrLuAf8SropaW5iWJ5viezX4GJB 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 2TAEEwvqwB8tkzNZbqsbeJgxaWiY 3rmEUw2UU3LtyAqB1HZ4jH9nsKua 2p5wNmuByBLFCnDjJwvq1KAnjMxw 3kCTxz7dzHBDHdZS1772Gimez6e2 arg boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 79 5 overloads 2TAEEwvqwB8tkzNZbqsbeJgxaWiY public regular 4XGUrdBsWAgVsJYv12cLYxsQzwnb brief text Constructors constructor G5CoEkt27Hpout34KS9U5PnCgX7 28nnn7aSDUTmaSQNdB65g9dBtqUq 3tfnfVQAqKCq135CR6zfMVBTiEt5 named identifier void void arg boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 79 5 function G5CoEkt27Hpout34KS9U5PnCgX7 public regular 4XGUrdBsWAgVsJYv12cLYxsQzwnb brief text Default constructor named identifier void void constructor constexpr arg boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 85 5 function 28nnn7aSDUTmaSQNdB65g9dBtqUq public regular 4XGUrdBsWAgVsJYv12cLYxsQzwnb brief text Deleted copy constructor param text The object to copy construct from other named identifier void void lvalue-reference named identifier 4XGUrdBsWAgVsJYv12cLYxsQzwnb arg other constructor arg boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 82 5 function 3tfnfVQAqKCq135CR6zfMVBTiEt5 public regular 4XGUrdBsWAgVsJYv12cLYxsQzwnb brief text Default move constructor param text The object to move construct from other named identifier void void rvalue-reference named identifier 4XGUrdBsWAgVsJYv12cLYxsQzwnb arg other constructor constexpr ~arg boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 76 5 function 3rmEUw2UU3LtyAqB1HZ4jH9nsKua public regular 4XGUrdBsWAgVsJYv12cLYxsQzwnb brief text Virtual destructor named identifier void void destructor constexpr operator= boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 88 5 overloads 2p5wNmuByBLFCnDjJwvq1KAnjMxw public regular 4XGUrdBsWAgVsJYv12cLYxsQzwnb brief text Assignment operators normal = JKPuudXXeW1tSragpJ1mhmGYzdf 4PTjz2dg6asxiwgq8sLLoLkPZm75 lvalue-reference named identifier 4XGUrdBsWAgVsJYv12cLYxsQzwnb arg operator= boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 91 5 function JKPuudXXeW1tSragpJ1mhmGYzdf public regular 4XGUrdBsWAgVsJYv12cLYxsQzwnb brief text Deleted copy assignment returns text Reference to the current object param text The object to copy assign from other lvalue-reference named identifier 4XGUrdBsWAgVsJYv12cLYxsQzwnb arg lvalue-reference named identifier 4XGUrdBsWAgVsJYv12cLYxsQzwnb arg other normal = operator= boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 88 5 function 4PTjz2dg6asxiwgq8sLLoLkPZm75 public regular 4XGUrdBsWAgVsJYv12cLYxsQzwnb brief text Deleted move assignment returns text Reference to the current object param text The object to move assign from other lvalue-reference named identifier 4XGUrdBsWAgVsJYv12cLYxsQzwnb arg rvalue-reference named identifier 4XGUrdBsWAgVsJYv12cLYxsQzwnb arg other normal = prepare boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 73 5 function 3kCTxz7dzHBDHdZS1772Gimez6e2 public regular 4XGUrdBsWAgVsJYv12cLYxsQzwnb 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 pointer named identifier char char named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std n normal append_to boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 332 1 function 4HPdckNJWYP6EwzTSRQwp4XCam4o regular gXLgKAknGYwc12RGZfBgr4HdDCT paragraph text This function creates a reference StringToken 2jrLuAf8SropaW5iWJ5viezX4GJB 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 named specialization 3NcX3C2TB37p4RTE8stCdunyw7Bw append_to_t identifier qQpkegZWLvhBTwZqCvDCRVcgjAJ implementation_defined type named identifier Alloc lvalue-reference named specialization 32aFbDLVPXjqHqix8E8umRSkx2JM basic_string identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std type named identifier char char type named specialization char_traits identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std type named identifier char char type named identifier Alloc s normal assign_to boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 395 1 function XRgErtvdgogvfQn13sEAR6jd1uT regular gXLgKAknGYwc12RGZfBgr4HdDCT paragraph text This function creates a reference StringToken 2jrLuAf8SropaW5iWJ5viezX4GJB 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 named specialization 3LEMm8DJGzbwQfSP2CHysVLK35R4 assign_to_t identifier qQpkegZWLvhBTwZqCvDCRVcgjAJ implementation_defined type named identifier Alloc lvalue-reference named specialization 32aFbDLVPXjqHqix8E8umRSkx2JM basic_string identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std type named identifier char char type named specialization char_traits identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std type named identifier char char type named identifier Alloc s normal preserve_size boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 464 1 function 7UQR5tGyoz8hnqbre8ugcpWoK4T regular gXLgKAknGYwc12RGZfBgr4HdDCT paragraph text This function creates a reference StringToken 2jrLuAf8SropaW5iWJ5viezX4GJB 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 named specialization 3e11kkmrjyCuYn6WvfoCyeDfyn7r preserve_size_t identifier qQpkegZWLvhBTwZqCvDCRVcgjAJ implementation_defined type named identifier Alloc lvalue-reference named specialization 32aFbDLVPXjqHqix8E8umRSkx2JM basic_string identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std type named identifier char char type named specialization char_traits identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std type named identifier char char type named identifier Alloc s normal StringToken boost/url/grammar/string_token.hpp include/boost/url/grammar/string_token.hpp 231 1 concept 2jrLuAf8SropaW5iWJ5viezX4GJB regular gXLgKAknGYwc12RGZfBgr4HdDCT 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 4XGUrdBsWAgVsJYv12cLYxsQzwnb 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 4UumWzLNRv3vgTVdDkz5PVqdSsSL paragraph reference assign_to XRgErtvdgogvfQn13sEAR6jd1uT paragraph reference preserve_size 7UQR5tGyoz8hnqbre8ugcpWoK4T 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 typedef 2268wJ294zj5ry16xNemaWKRCZKm see-below 2ejQGW57K8g7MFJhHAwPt5aumoLa paragraph text This class represents a temporary reference to a formatting argument used by the reference format 2QoWAGV4WnZixaqkFZhZFWzYzizZ text function. paragraph text A reference format 2QoWAGV4WnZixaqkFZhZFWzYzizZ text argument should always be created by passing the argument to be formatted directly to the reference format 2QoWAGV4WnZixaqkFZhZFWzYzizZ text function. paragraph text Any type that can be formatted into a URL with the reference format 2QoWAGV4WnZixaqkFZhZFWzYzizZ 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 QNkXGvn4uvcuVhhsDd6QgTGgpMa text . brief text A temporary reference to a formatting argument see reference format 2QoWAGV4WnZixaqkFZhZFWzYzizZ text , reference format_to HqUWyeBKSK1fBrdG5vHTeybKMGZ text , reference arg ThuCYkNXzjJHhdcL2TZSz7uRwM7 text . named identifier 4ZDF3RAGv4Z4uhkPm2urzNfGH1Xf format_arg identifier mfaqhPxS153ZSpqTntjkRe3VH3r detail named_arg boost/url/format.hpp include/boost/url/format.hpp 47 1 typedef QNkXGvn4uvcuVhhsDd6QgTGgpMa see-below 2ejQGW57K8g7MFJhHAwPt5aumoLa paragraph text This class represents a temporary reference to a named formatting argument used by the reference format 2QoWAGV4WnZixaqkFZhZFWzYzizZ text function. paragraph text Named arguments should always be created with the reference arg ThuCYkNXzjJHhdcL2TZSz7uRwM7 text function. paragraph text Any type that can be formatted into a URL with the reference format 2QoWAGV4WnZixaqkFZhZFWzYzizZ text function can also be used in a named argument. All named arguments are convertible to reference format_arg 2268wJ294zj5ry16xNemaWKRCZKm text and can be used in the reference format 2QoWAGV4WnZixaqkFZhZFWzYzizZ text function. brief text A temporary reference to a named formatting argument see reference arg ThuCYkNXzjJHhdcL2TZSz7uRwM7 text , reference format 2QoWAGV4WnZixaqkFZhZFWzYzizZ text , reference format_to HqUWyeBKSK1fBrdG5vHTeybKMGZ text , reference format_arg 2268wJ294zj5ry16xNemaWKRCZKm text . named specialization 4Pe9L1tkaCX5RF7fFS3ZST79VPNW named_arg identifier mfaqhPxS153ZSpqTntjkRe3VH3r detail type named identifier T optional boost/url/optional.hpp include/boost/url/optional.hpp 38 1 typedef 3FCL7hYN4kMytJQRw4DmkYAPaTGX regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 deprecated deprecated "Use boost::optional<T> instead" Use boost::optional<T> instead named specialization 3KuyMbjBnZgTEj1n7927HzbnUHBt optional identifier 4VB1YRZ5xEZNSpqzp72yMeXnHRtn boost type named identifier T string_view boost/url/string_view.hpp include/boost/url/string_view.hpp 45 1 typedef 2gxMGgaDG7oA9nqZUjApPoyf9cad regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 deprecated deprecated "Use core::string_view instead" Use core::string_view instead named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core identifier 4VB1YRZ5xEZNSpqzp72yMeXnHRtn boost variant boost/url/variant.hpp include/boost/url/variant.hpp 37 1 typedef Jqwu89tbEUEtvWWz9bQx3m2TDPk regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 deprecated deprecated "Use variant2::variant instead" Use variant2::variant instead named specialization vzXsJzBoeUkY6Fcq5vsv2kwzk11 variant identifier 49AqEUzH6MSvXRjmRaQ8TgX7Zj9E variant2 identifier 4VB1YRZ5xEZNSpqzp72yMeXnHRtn boost type named identifier Ts authority_view boost/url/authority_view.hpp include/boost/url/authority_view.hpp 92 1 boost/url/detail/url_impl.hpp include/boost/url/detail/url_impl.hpp 27 1 record 2fwXocwnoAG9WDGbqM3quKphV1qq regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 2eeZHdWXgsV3fMDoL3MrbjDNWopq text returns a code text boost::system::result text containing either a valid reference authority_view 2BDr4MqUnBL4wTtVgSWYbeJbNuLz 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 2eeZHdWXgsV3fMDoL3MrbjDNWopq text . reference parse_authority 2eeZHdWXgsV3fMDoL3MrbjDNWopq other __visibility__ class 2BDr4MqUnBL4wTtVgSWYbeJbNuLz 32Qd9WVkpPPjzxvpj6SC8PJjtusw 3ajQFPF3cgA6t1nkCYWZbEXbgscB tCegydLoADKgWgYC7R7eE8mYi4T 2vJYMwVyxtwzjWJ3cAxnjLzLKnKt 3kfzoBo4qguqoNk2HPQ9YNg26XrW iW72PekAiwDtokChHw1b8wNaWCu 2RDaGsa5Ya8KkYxgXUisFJUhXjRE dL1WvAERo9zPHU6q1HxYEa6143q 4Bw2xDcgKPg8DiuAwAo1zhqF3wtp 2tnC8xMQy5ouYBpFKFMkoi84zXoi 4HSS2XGh5ereC2sjNEoN1BX19ojH 2FsySsShEWXHJKjwD5aNWJPnfX6m 38DKeGB8R39txiNzue659tXNLk2r 33FUNTShjJB5FCn9BKv8mLc9cFS9 UxKifvLd4vQ16dw3mPtfb3DF1o1 3bFTKxdNmSFH2F3ncBsAn5WYL8g3 3xtgyqAayn49XQJF7Ck5jMdZdXWE oDpbq1GN5w2M5Njj1LjFauaDUZe 32SxKEXgV17Q2kZf4jUVS4LWd2By 3k1myVLT4Y5Eyp66E4RDzTupBZ78 2r4o7y8z2bBUP12ripczYSekqCZd M1X1kRUecEy5uqSKPC4f6QDQSuq VRXJ5SQteHZ4tDbvqt7pmu1W5GX xfnNhqLuf3PvVbACejetgSFvL6r 343EohQ8nNhXAcqS4uH4CdhtXgGq UvMCoNbRVhH4SKrKru4uf6fYpKL vkFaXP3CcS8FJSimRYdmYGcP3s3 33zbJpFyn7PYNXKr7ibaTjEroonG Gw7BsDwShjH5FZpBX1GwP48yF7m 2ycfkKeMS44DJ2ZC1UdQ6pPkUCuz 4MVcqMSg5d6D9Lde1AiG299rzdft 4HEN1ajFF2C24FYgGLXT2dgqH48z 2qvRTQyEphNFQZSvMzCwe757weAA 2z1vSrMfNsaXSpXNN7S4sKgdsAwS KrTct9qjuEP7hibe7nz1KZyF7Dv 3M1WdaS44GQP8N9STNo8SUrQes9H mW4oaqgPMtffuauFEkbWRJyy8C4 33dbp77PAPLZseM4KaAT4LooxSC9 named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base 2TREmHUMfZeMQz9yyw5HzqB91APN named identifier 27ryuyAvvRyzfzgketja5uQcFBcK url_view_base 27ryuyAvvRyzfzgketja5uQcFBcK authority_view boost/url/authority_view.hpp include/boost/url/authority_view.hpp 145 5 boost/url/authority_view.hpp include/boost/url/authority_view.hpp 188 5 overloads 2BDr4MqUnBL4wTtVgSWYbeJbNuLz public regular 2fwXocwnoAG9WDGbqM3quKphV1qq brief text Constructors param text The string to parse s see reference parse_authority 2eeZHdWXgsV3fMDoL3MrbjDNWopq text . constructor 4KPPyHWEPTYsRCXwCWbSYQUQJHgU vRe6riNXGYUgca48aJNHgD1jefy hRouhJvAZwsy5chKk5HfTYvgEox named identifier void void authority_view boost/url/authority_view.hpp include/boost/url/authority_view.hpp 145 5 function 4KPPyHWEPTYsRCXwCWbSYQUQJHgU public regular 2fwXocwnoAG9WDGbqM3quKphV1qq 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 named identifier void void constructor constexpr authority_view boost/url/authority_view.hpp include/boost/url/authority_view.hpp 194 5 function vRe6riNXGYUgca48aJNHgD1jefy public regular 2fwXocwnoAG9WDGbqM3quKphV1qq brief text Constructor param text The object to copy construct from other named identifier void void lvalue-reference named identifier 2fwXocwnoAG9WDGbqM3quKphV1qq authority_view other constructor constexpr authority_view boost/url/authority_view.hpp include/boost/url/authority_view.hpp 188 5 function hRouhJvAZwsy5chKk5HfTYvgEox public regular 2fwXocwnoAG9WDGbqM3quKphV1qq 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 2eeZHdWXgsV3fMDoL3MrbjDNWopq text . named identifier void void named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s constructor constexpr ~authority_view boost/url/authority_view.hpp include/boost/url/authority_view.hpp 123 5 function 32Qd9WVkpPPjzxvpj6SC8PJjtusw public regular 2fwXocwnoAG9WDGbqM3quKphV1qq brief text Destructor named identifier void void destructor constexpr operator= boost/url/authority_view.hpp include/boost/url/authority_view.hpp 209 5 function 3ajQFPF3cgA6t1nkCYWZbEXbgscB public regular 2fwXocwnoAG9WDGbqM3quKphV1qq 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 lvalue-reference named identifier 2fwXocwnoAG9WDGbqM3quKphV1qq authority_view lvalue-reference named identifier 2fwXocwnoAG9WDGbqM3quKphV1qq authority_view other normal constexpr = buffer boost/url/authority_view.hpp include/boost/url/authority_view.hpp 303 5 function tCegydLoADKgWgYC7R7eE8mYi4T public regular 2fwXocwnoAG9WDGbqM3quKphV1qq 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 named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core normal compare boost/url/authority_view.hpp include/boost/url/authority_view.hpp 1349 5 function 2vJYMwVyxtwzjWJ3cAxnjLzLKnKt public regular 2fwXocwnoAG9WDGbqM3quKphV1qq 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 named identifier int int lvalue-reference named identifier 2fwXocwnoAG9WDGbqM3quKphV1qq authority_view other normal data boost/url/authority_view.hpp include/boost/url/authority_view.hpp 273 5 function 3kfzoBo4qguqoNk2HPQ9YNg26XrW public regular 2fwXocwnoAG9WDGbqM3quKphV1qq 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 pointer named identifier char char normal empty boost/url/authority_view.hpp include/boost/url/authority_view.hpp 256 5 function iW72PekAiwDtokChHw1b8wNaWCu public regular 2fwXocwnoAG9WDGbqM3quKphV1qq 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 named identifier bool bool normal encoded_host boost/url/authority_view.hpp include/boost/url/authority_view.hpp 824 5 function 2RDaGsa5Ya8KkYxgXUisFJUhXjRE public regular 2fwXocwnoAG9WDGbqM3quKphV1qq 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 named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal constexpr encoded_host_address boost/url/authority_view.hpp include/boost/url/authority_view.hpp 944 5 function dL1WvAERo9zPHU6q1HxYEa6143q public regular 2fwXocwnoAG9WDGbqM3quKphV1qq paragraph text The value returned by this function depends on the type of host returned from the function reference host_type VRXJ5SQteHZ4tDbvqt7pmu1W5GX text . list paragraph text If the type is reference host_type::ipv4 4B5yLFvhkpef7XX8ryKTaBWz8d6D text , then the IPv4 address string is returned. paragraph text If the type is reference host_type::ipv6 2y7UTsNbko8TLegXS5EpSa1goNog text , then the IPv6 address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::ipvfuture 25qx7TTMyctoe4LxqgMPXccSpy5Q text , then the IPvFuture address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::name QfoSUW8M1SPUL5EFVKwAUabTKCa 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 wGjRbosZ4DQY7xCpjwAZqPVHiim 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 named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal constexpr encoded_host_and_port boost/url/authority_view.hpp include/boost/url/authority_view.hpp 1321 5 function 4Bw2xDcgKPg8DiuAwAo1zhqF3wtp public regular 2fwXocwnoAG9WDGbqM3quKphV1qq 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 UxKifvLd4vQ16dw3mPtfb3DF1o1 text , reference port 343EohQ8nNhXAcqS4uH4CdhtXgGq text , reference port_number UvMCoNbRVhH4SKrKru4uf6fYpKL text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal constexpr encoded_host_name boost/url/authority_view.hpp include/boost/url/authority_view.hpp 1159 5 function 2tnC8xMQy5ouYBpFKFMkoi84zXoi public regular 2fwXocwnoAG9WDGbqM3quKphV1qq paragraph text If the host type is reference host_type::name QfoSUW8M1SPUL5EFVKwAUabTKCa 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 named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal constexpr encoded_password boost/url/authority_view.hpp include/boost/url/authority_view.hpp 700 5 function 4HSS2XGh5ereC2sjNEoN1BX19ojH public regular 2fwXocwnoAG9WDGbqM3quKphV1qq 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 33FUNTShjJB5FCn9BKv8mLc9cFS9 text , reference has_userinfo 3bFTKxdNmSFH2F3ncBsAn5WYL8g3 text , reference encoded_user 2FsySsShEWXHJKjwD5aNWJPnfX6m text , reference encoded_userinfo 38DKeGB8R39txiNzue659tXNLk2r text , reference password xfnNhqLuf3PvVbACejetgSFvL6r text , reference user 33zbJpFyn7PYNXKr7ibaTjEroonG text , reference userinfo Gw7BsDwShjH5FZpBX1GwP48yF7m text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal constexpr encoded_user boost/url/authority_view.hpp include/boost/url/authority_view.hpp 558 5 function 2FsySsShEWXHJKjwD5aNWJPnfX6m public regular 2fwXocwnoAG9WDGbqM3quKphV1qq 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 33FUNTShjJB5FCn9BKv8mLc9cFS9 text , reference has_userinfo 3bFTKxdNmSFH2F3ncBsAn5WYL8g3 text , reference encoded_password 4HSS2XGh5ereC2sjNEoN1BX19ojH text , reference encoded_userinfo 38DKeGB8R39txiNzue659tXNLk2r text , reference password xfnNhqLuf3PvVbACejetgSFvL6r text , reference user 33zbJpFyn7PYNXKr7ibaTjEroonG text , reference userinfo Gw7BsDwShjH5FZpBX1GwP48yF7m text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal constexpr encoded_userinfo boost/url/authority_view.hpp include/boost/url/authority_view.hpp 454 5 function 38DKeGB8R39txiNzue659tXNLk2r public regular 2fwXocwnoAG9WDGbqM3quKphV1qq 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 33FUNTShjJB5FCn9BKv8mLc9cFS9 text , reference has_userinfo 3bFTKxdNmSFH2F3ncBsAn5WYL8g3 text , reference encoded_password 4HSS2XGh5ereC2sjNEoN1BX19ojH text , reference encoded_user 2FsySsShEWXHJKjwD5aNWJPnfX6m text , reference password xfnNhqLuf3PvVbACejetgSFvL6r text , reference user 33zbJpFyn7PYNXKr7ibaTjEroonG text , reference userinfo Gw7BsDwShjH5FZpBX1GwP48yF7m text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal constexpr has_password boost/url/authority_view.hpp include/boost/url/authority_view.hpp 602 5 function 33FUNTShjJB5FCn9BKv8mLc9cFS9 public regular 2fwXocwnoAG9WDGbqM3quKphV1qq 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 3bFTKxdNmSFH2F3ncBsAn5WYL8g3 text , reference encoded_password 4HSS2XGh5ereC2sjNEoN1BX19ojH text , reference encoded_user 2FsySsShEWXHJKjwD5aNWJPnfX6m text , reference encoded_userinfo 38DKeGB8R39txiNzue659tXNLk2r text , reference password xfnNhqLuf3PvVbACejetgSFvL6r text , reference user 33zbJpFyn7PYNXKr7ibaTjEroonG text , reference userinfo Gw7BsDwShjH5FZpBX1GwP48yF7m text . named identifier bool bool normal constexpr has_port boost/url/authority_view.hpp include/boost/url/authority_view.hpp 1203 5 function UxKifvLd4vQ16dw3mPtfb3DF1o1 public regular 2fwXocwnoAG9WDGbqM3quKphV1qq 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 4Bw2xDcgKPg8DiuAwAo1zhqF3wtp text , reference port 343EohQ8nNhXAcqS4uH4CdhtXgGq text , reference port_number UvMCoNbRVhH4SKrKru4uf6fYpKL text . named identifier bool bool normal constexpr has_userinfo boost/url/authority_view.hpp include/boost/url/authority_view.hpp 354 5 function 3bFTKxdNmSFH2F3ncBsAn5WYL8g3 public regular 2fwXocwnoAG9WDGbqM3quKphV1qq 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 33FUNTShjJB5FCn9BKv8mLc9cFS9 text , reference encoded_password 4HSS2XGh5ereC2sjNEoN1BX19ojH text , reference encoded_user 2FsySsShEWXHJKjwD5aNWJPnfX6m text , reference encoded_userinfo 38DKeGB8R39txiNzue659tXNLk2r text , reference password xfnNhqLuf3PvVbACejetgSFvL6r text , reference user 33zbJpFyn7PYNXKr7ibaTjEroonG text , reference userinfo Gw7BsDwShjH5FZpBX1GwP48yF7m text . named identifier bool bool normal constexpr host boost/url/authority_view.hpp include/boost/url/authority_view.hpp 779 5 function 3xtgyqAayn49XQJF7Ck5jMdZdXWE public regular 2fwXocwnoAG9WDGbqM3quKphV1qq 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 named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token normal host_address boost/url/authority_view.hpp include/boost/url/authority_view.hpp 880 5 function oDpbq1GN5w2M5Njj1LjFauaDUZe public regular 2fwXocwnoAG9WDGbqM3quKphV1qq paragraph text The value returned by this function depends on the type of host returned from the function reference host_type VRXJ5SQteHZ4tDbvqt7pmu1W5GX text . list paragraph text If the type is reference host_type::ipv4 4B5yLFvhkpef7XX8ryKTaBWz8d6D text , then the IPv4 address string is returned. paragraph text If the type is reference host_type::ipv6 2y7UTsNbko8TLegXS5EpSa1goNog text , then the IPv6 address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::ipvfuture 25qx7TTMyctoe4LxqgMPXccSpy5Q text , then the IPvFuture address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::name QfoSUW8M1SPUL5EFVKwAUabTKCa 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 wGjRbosZ4DQY7xCpjwAZqPVHiim 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 named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token normal host_ipv4_address boost/url/authority_view.hpp include/boost/url/authority_view.hpp 986 5 function 32SxKEXgV17Q2kZf4jUVS4LWd2By public regular 2fwXocwnoAG9WDGbqM3quKphV1qq paragraph text If the host type is reference host_type::ipv4 4B5yLFvhkpef7XX8ryKTaBWz8d6D text , this function returns the address as a value of type reference ipv4_address 4Xmd9k1GBKGKQj6PYc1qdt4tMUae 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 named identifier 4Xmd9k1GBKGKQj6PYc1qdt4tMUae ipv4_address normal constexpr host_ipv6_address boost/url/authority_view.hpp include/boost/url/authority_view.hpp 1036 5 function 3k1myVLT4Y5Eyp66E4RDzTupBZ78 public regular 2fwXocwnoAG9WDGbqM3quKphV1qq paragraph text If the host type is reference host_type::ipv6 2y7UTsNbko8TLegXS5EpSa1goNog text , this function returns the address as a value of type reference ipv6_address 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T 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 named identifier 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T ipv6_address normal constexpr host_ipvfuture boost/url/authority_view.hpp include/boost/url/authority_view.hpp 1071 5 function 2r4o7y8z2bBUP12ripczYSekqCZd public regular 2fwXocwnoAG9WDGbqM3quKphV1qq paragraph text If the host type is reference host_type::ipvfuture 25qx7TTMyctoe4LxqgMPXccSpy5Q 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 named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core normal constexpr host_name boost/url/authority_view.hpp include/boost/url/authority_view.hpp 1112 5 function M1X1kRUecEy5uqSKPC4f6QDQSuq public regular 2fwXocwnoAG9WDGbqM3quKphV1qq paragraph text If the host type is reference host_type::name QfoSUW8M1SPUL5EFVKwAUabTKCa 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 named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token normal host_type boost/url/authority_view.hpp include/boost/url/authority_view.hpp 738 5 function VRXJ5SQteHZ4tDbvqt7pmu1W5GX public regular 2fwXocwnoAG9WDGbqM3quKphV1qq paragraph text This function returns one of the following constants representing the type of host present. list paragraph reference host_type::ipv4 4B5yLFvhkpef7XX8ryKTaBWz8d6D paragraph reference host_type::ipv6 2y7UTsNbko8TLegXS5EpSa1goNog paragraph reference host_type::ipvfuture 25qx7TTMyctoe4LxqgMPXccSpy5Q paragraph reference host_type::name QfoSUW8M1SPUL5EFVKwAUabTKCa 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 named identifier 2M8hT55CSziFA9Zup4mKYdwvgUiE host_type identifier 2ejQGW57K8g7MFJhHAwPt5aumoLa urls normal password boost/url/authority_view.hpp include/boost/url/authority_view.hpp 650 5 function xfnNhqLuf3PvVbACejetgSFvL6r public regular 2fwXocwnoAG9WDGbqM3quKphV1qq 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 33FUNTShjJB5FCn9BKv8mLc9cFS9 text , reference has_userinfo 3bFTKxdNmSFH2F3ncBsAn5WYL8g3 text , reference encoded_password 4HSS2XGh5ereC2sjNEoN1BX19ojH text , reference encoded_user 2FsySsShEWXHJKjwD5aNWJPnfX6m text , reference encoded_userinfo 38DKeGB8R39txiNzue659tXNLk2r text , reference user 33zbJpFyn7PYNXKr7ibaTjEroonG text , reference userinfo Gw7BsDwShjH5FZpBX1GwP48yF7m text . named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token normal port boost/url/authority_view.hpp include/boost/url/authority_view.hpp 1241 5 function 343EohQ8nNhXAcqS4uH4CdhtXgGq public regular 2fwXocwnoAG9WDGbqM3quKphV1qq 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 4Bw2xDcgKPg8DiuAwAo1zhqF3wtp text , reference has_port UxKifvLd4vQ16dw3mPtfb3DF1o1 text , reference port_number UvMCoNbRVhH4SKrKru4uf6fYpKL text . named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core normal constexpr port_number boost/url/authority_view.hpp include/boost/url/authority_view.hpp 1279 5 function UvMCoNbRVhH4SKrKru4uf6fYpKL public regular 2fwXocwnoAG9WDGbqM3quKphV1qq 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 4Bw2xDcgKPg8DiuAwAo1zhqF3wtp text , reference has_port UxKifvLd4vQ16dw3mPtfb3DF1o1 text , reference port 343EohQ8nNhXAcqS4uH4CdhtXgGq text . named identifier w7yWEPLwtMpd5GnNHsV5ASwVxkX uint16_t normal constexpr size boost/url/authority_view.hpp include/boost/url/authority_view.hpp 235 5 function vkFaXP3CcS8FJSimRYdmYGcP3s3 public regular 2fwXocwnoAG9WDGbqM3quKphV1qq 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 named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std normal user boost/url/authority_view.hpp include/boost/url/authority_view.hpp 504 5 function 33zbJpFyn7PYNXKr7ibaTjEroonG public regular 2fwXocwnoAG9WDGbqM3quKphV1qq 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 33FUNTShjJB5FCn9BKv8mLc9cFS9 text , reference has_userinfo 3bFTKxdNmSFH2F3ncBsAn5WYL8g3 text , reference encoded_password 4HSS2XGh5ereC2sjNEoN1BX19ojH text , reference encoded_user 2FsySsShEWXHJKjwD5aNWJPnfX6m text , reference encoded_userinfo 38DKeGB8R39txiNzue659tXNLk2r text , reference password xfnNhqLuf3PvVbACejetgSFvL6r text , reference userinfo Gw7BsDwShjH5FZpBX1GwP48yF7m text . named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token normal userinfo boost/url/authority_view.hpp include/boost/url/authority_view.hpp 401 5 function Gw7BsDwShjH5FZpBX1GwP48yF7m public regular 2fwXocwnoAG9WDGbqM3quKphV1qq 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 33FUNTShjJB5FCn9BKv8mLc9cFS9 text , reference has_userinfo 3bFTKxdNmSFH2F3ncBsAn5WYL8g3 text , reference encoded_password 4HSS2XGh5ereC2sjNEoN1BX19ojH text , reference encoded_user 2FsySsShEWXHJKjwD5aNWJPnfX6m text , reference encoded_userinfo 38DKeGB8R39txiNzue659tXNLk2r text , reference password xfnNhqLuf3PvVbACejetgSFvL6r text , reference user 33zbJpFyn7PYNXKr7ibaTjEroonG text . named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token normal decode_view boost/url/decode_view.hpp include/boost/url/decode_view.hpp 70 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 UXcENkB7t9T6PDWy1z6kk8ej8kT regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 4UWVAaZmgK9W8E5uF6QWCEszxFES 2ezCwSaUe3X8ycmaLnDtx36T8D3t TpRd4z7xC4baXpqZ1c5G1vFbxV5 dDAQf8zEXYDnKkyipYtgMx8Tacq 2F92aKbDai27cB28aV1ikaptrM78 qU5rsYKnQ4bDq9j9VGmvTSJC2iP xRtC4Thw6Kdf6e2LWTuKcYLstgb 2pSM8usvFY4y4UgQJv1JhBn5tPTz 3febeSYNGGukkKhVtoj4H1S4nH4f 2uiBJELXLYLUbrHFxGUEpUmZ1wVC 3wVu1JiV57SnerVmJHC377gRrtgK ugpZk9wx1D1H7FiJ6fNQfhvdwVH 4ATMzQfc7dEtEjnNpaDAscBbKYMs 2qZaYLBToTnqCYNuFjoSjBLA6fSJ 2sWAbGGLmTdZa5GxxLEhc36BwBsp CFs1oKDCFQZzLXUwcNbQPCmgbsJ 3VqHMMhJoptzAgU7av93y2C7mvSi 2hZAnBtPPbFtHN7Gd9ceFfXX4uhP 3yCzQ1QTEVapKs4fGrUgfEYbvmjH AQF8dnmX4KceRsGHfBy2ZZAMU21 3Ko5wR5voZvurfQkjvfrdFe8LdxK 27ZeBwBBf3hc6pcdWrxW9adFzBL2 z7TnBa9S5KdEUq8kHpMvpci8qco 3BKiKXz24757315qSDWs5sC96oYK 3CrvrwFxEeAquQA9rVv6mwxG9W1s 2T4jKJco3hzVpTuxyYhP5wUxSGes 6tmzXudNnQwDhTyhcBfTEA8KCMZ 3JQn9uwJsMU3oTGagkPoFXwuBKMf oi6dJJ1yraHpxNJWjD3hoadotrG 2XZBfyvXdaob531WGj8yhbYDkzmG 4APsbBP2DhCNQjH12Tn46E6sr6R9 CgQ8dpCCveSUdsSA7HGTkyc4bfS oLoRXUbcXcariYoA6KQAwyL6FVk zniu77oNHTZyKKJY6jvcymun57i 292XgpMBwSR1rEb5p6AXNu4Kgpoz 3drLUq3sbeAJXfMPokq9WVQXMyLw 2Ly6x2BtsMf6bzrVCPEDrHUsbJVU 2pQCaj8jtjk5KUeUkYgwoVvaeZXU djvNtSboH7Njf6eBMYgoGWTtPJH 31PQG59s9GnXskXKYY6hCbYuwBB2 32NzB82hdxbUmnZMhHJ182sYaeUi const_iterator boost/url/decode_view.hpp include/boost/url/decode_view.hpp 128 5 typedef 4UWVAaZmgK9W8E5uF6QWCEszxFES public regular UXcENkB7t9T6PDWy1z6kk8ej8kT 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 named identifier xRtC4Thw6Kdf6e2LWTuKcYLstgb iterator const_reference boost/url/decode_view.hpp include/boost/url/decode_view.hpp 107 5 typedef 2ezCwSaUe3X8ycmaLnDtx36T8D3t public regular UXcENkB7t9T6PDWy1z6kk8ej8kT brief text The reference type reference named identifier char char difference_type boost/url/decode_view.hpp include/boost/url/decode_view.hpp 115 5 typedef TpRd4z7xC4baXpqZ1c5G1vFbxV5 public regular UXcENkB7t9T6PDWy1z6kk8ej8kT brief text The signed integer type named identifier EKxMGCxxySWyqBbWqvvL9j9KhWv ptrdiff_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std reference boost/url/decode_view.hpp include/boost/url/decode_view.hpp 104 5 typedef dDAQf8zEXYDnKkyipYtgMx8Tacq public regular UXcENkB7t9T6PDWy1z6kk8ej8kT brief text The reference type named identifier char char size_type boost/url/decode_view.hpp include/boost/url/decode_view.hpp 111 5 typedef 2F92aKbDai27cB28aV1ikaptrM78 public regular UXcENkB7t9T6PDWy1z6kk8ej8kT brief text The unsigned integer type named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std value_type boost/url/decode_view.hpp include/boost/url/decode_view.hpp 100 5 typedef qU5rsYKnQ4bDq9j9VGmvTSJC2iP public regular UXcENkB7t9T6PDWy1z6kk8ej8kT brief text The value type named identifier char char iterator boost/url/decode_view.hpp include/boost/url/decode_view.hpp 125 5 record xRtC4Thw6Kdf6e2LWTuKcYLstgb public see-below UXcENkB7t9T6PDWy1z6kk8ej8kT 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 named identifier UXcENkB7t9T6PDWy1z6kk8ej8kT decode_view UXcENkB7t9T6PDWy1z6kk8ej8kT decode_view boost/url/decode_view.hpp include/boost/url/decode_view.hpp 157 5 overloads 2pSM8usvFY4y4UgQJv1JhBn5tPTz public regular UXcENkB7t9T6PDWy1z6kk8ej8kT 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 2fyeHbheNErEokxYyn4Rm8B1TRPt jVFfJP88Y5m7an87CtmyM55jibB named identifier void void decode_view boost/url/decode_view.hpp include/boost/url/decode_view.hpp 157 5 function 2fyeHbheNErEokxYyn4Rm8B1TRPt public regular UXcENkB7t9T6PDWy1z6kk8ej8kT 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 named identifier void void constructor constexpr decode_view boost/url/decode_view.hpp include/boost/url/decode_view.hpp 195 5 function jVFfJP88Y5m7an87CtmyM55jibB public regular UXcENkB7t9T6PDWy1z6kk8ej8kT 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 3ZY5EydXePv2wNz8JPvc5skA7Bn4 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 named identifier void void named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view s named identifier 5dyN7z5egGMdJFpXz9WbaL549xC encoding_opts opt {} constructor constexpr back boost/url/decode_view.hpp include/boost/url/decode_view.hpp 339 5 function 3febeSYNGGukkKhVtoj4H1S4nH4f public regular UXcENkB7t9T6PDWy1z6kk8ej8kT 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 named identifier dDAQf8zEXYDnKkyipYtgMx8Tacq reference normal begin boost/url/decode_view.hpp include/boost/url/decode_view.hpp 275 5 function 2uiBJELXLYLUbrHFxGUEpUmZ1wVC public regular UXcENkB7t9T6PDWy1z6kk8ej8kT 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 named identifier xRtC4Thw6Kdf6e2LWTuKcYLstgb iterator normal compare boost/url/decode_view.hpp include/boost/url/decode_view.hpp 533 5 boost/url/decode_view.hpp include/boost/url/decode_view.hpp 554 5 overloads 3wVu1JiV57SnerVmJHC377gRrtgK public regular UXcENkB7t9T6PDWy1z6kk8ej8kT 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 HKUwcR35yWGmdjuMuSdrf8vaULh ajPvVbGykgQS6MS5Ctwfg3agGbx named identifier int int compare boost/url/decode_view.hpp include/boost/url/decode_view.hpp 554 5 function HKUwcR35yWGmdjuMuSdrf8vaULh public regular UXcENkB7t9T6PDWy1z6kk8ej8kT 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 named identifier int int named identifier UXcENkB7t9T6PDWy1z6kk8ej8kT decode_view other normal constexpr compare boost/url/decode_view.hpp include/boost/url/decode_view.hpp 533 5 function ajPvVbGykgQS6MS5Ctwfg3agGbx public regular UXcENkB7t9T6PDWy1z6kk8ej8kT 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 named identifier int int named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core other normal constexpr empty boost/url/decode_view.hpp include/boost/url/decode_view.hpp 228 5 function ugpZk9wx1D1H7FiJ6fNQfhvdwVH public regular UXcENkB7t9T6PDWy1z6kk8ej8kT 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 named identifier bool bool normal end boost/url/decode_view.hpp include/boost/url/decode_view.hpp 293 5 function 4ATMzQfc7dEtEjnNpaDAscBbKYMs public regular UXcENkB7t9T6PDWy1z6kk8ej8kT 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 named identifier xRtC4Thw6Kdf6e2LWTuKcYLstgb iterator normal ends_with boost/url/decode_view.hpp include/boost/url/decode_view.hpp 379 5 boost/url/decode_view.hpp include/boost/url/decode_view.hpp 419 5 overloads 2qZaYLBToTnqCYNuFjoSjBLA6fSJ public regular UXcENkB7t9T6PDWy1z6kk8ej8kT 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 3wKB5AeMNN88o7wWgLRh4L6Fk9um 21Niufy4yg1UHi7K7VRdfPCcwwfN named identifier bool bool ends_with boost/url/decode_view.hpp include/boost/url/decode_view.hpp 419 5 function 3wKB5AeMNN88o7wWgLRh4L6Fk9um public regular UXcENkB7t9T6PDWy1z6kk8ej8kT 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 named identifier bool bool named identifier char char ch normal ends_with boost/url/decode_view.hpp include/boost/url/decode_view.hpp 379 5 function 21Niufy4yg1UHi7K7VRdfPCcwwfN public regular UXcENkB7t9T6PDWy1z6kk8ej8kT 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 named identifier bool bool named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal find boost/url/decode_view.hpp include/boost/url/decode_view.hpp 434 5 function 2sWAbGGLmTdZa5GxxLEhc36BwBsp public regular UXcENkB7t9T6PDWy1z6kk8ej8kT 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 named identifier 4UWVAaZmgK9W8E5uF6QWCEszxFES const_iterator named identifier char char ch normal front boost/url/decode_view.hpp include/boost/url/decode_view.hpp 316 5 function CFs1oKDCFQZzLXUwcNbQPCmgbsJ public regular UXcENkB7t9T6PDWy1z6kk8ej8kT 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 named identifier dDAQf8zEXYDnKkyipYtgMx8Tacq reference normal options boost/url/decode_view.hpp include/boost/url/decode_view.hpp 502 5 function 3VqHMMhJoptzAgU7av93y2C7mvSi public regular UXcENkB7t9T6PDWy1z6kk8ej8kT brief text Return the decoding options returns text The decoding options used by this view named identifier 5dyN7z5egGMdJFpXz9WbaL549xC encoding_opts normal remove_prefix boost/url/decode_view.hpp include/boost/url/decode_view.hpp 472 5 function 2hZAnBtPPbFtHN7Gd9ceFfXX4uhP public regular UXcENkB7t9T6PDWy1z6kk8ej8kT 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 named identifier void void named identifier 2F92aKbDai27cB28aV1ikaptrM78 size_type n normal remove_suffix boost/url/decode_view.hpp include/boost/url/decode_view.hpp 495 5 function 3yCzQ1QTEVapKs4fGrUgfEYbvmjH public regular UXcENkB7t9T6PDWy1z6kk8ej8kT 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 named identifier void void named identifier 2F92aKbDai27cB28aV1ikaptrM78 size_type n normal rfind boost/url/decode_view.hpp include/boost/url/decode_view.hpp 449 5 function AQF8dnmX4KceRsGHfBy2ZZAMU21 public regular UXcENkB7t9T6PDWy1z6kk8ej8kT 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 named identifier 4UWVAaZmgK9W8E5uF6QWCEszxFES const_iterator named identifier char char ch normal size boost/url/decode_view.hpp include/boost/url/decode_view.hpp 254 5 function 3Ko5wR5voZvurfQkjvfrdFe8LdxK public regular UXcENkB7t9T6PDWy1z6kk8ej8kT 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 named identifier 2F92aKbDai27cB28aV1ikaptrM78 size_type normal starts_with boost/url/decode_view.hpp include/boost/url/decode_view.hpp 359 5 boost/url/decode_view.hpp include/boost/url/decode_view.hpp 399 5 overloads 27ZeBwBBf3hc6pcdWrxW9adFzBL2 public regular UXcENkB7t9T6PDWy1z6kk8ej8kT 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 3WjYFdmzqJmk5NNqZ6rhhV3ST2q2 LLDttGBxV72viKtPPDENGHDh7fc named identifier bool bool starts_with boost/url/decode_view.hpp include/boost/url/decode_view.hpp 399 5 function 3WjYFdmzqJmk5NNqZ6rhhV3ST2q2 public regular UXcENkB7t9T6PDWy1z6kk8ej8kT 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 named identifier bool bool named identifier char char ch normal starts_with boost/url/decode_view.hpp include/boost/url/decode_view.hpp 359 5 function LLDttGBxV72viKtPPDENGHDh7fc public regular UXcENkB7t9T6PDWy1z6kk8ej8kT 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 named identifier bool bool named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal encoding_opts boost/url/encoding_opts.hpp include/boost/url/encoding_opts.hpp 31 1 record 5dyN7z5egGMdJFpXz9WbaL549xC regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 3xB3BfuNs4uV9HRTA6DGtHfJP2Wh text , reference encoded_size 2KWV3g149ZmZytTFz7sErpzwi7zX text , reference pct_string_view 3ZY5EydXePv2wNz8JPvc5skA7Bn4 text . struct 42dn6NwvSVW6CCjJVxY4v57MkPVx 2HAg2SbnF3k5Qgh3GkpjojvGJaMH 2e3srymwsEVUxWAEEzepDsyMK759 3L8i2T27V3wPummgdmEkuXwAs4aU encoding_opts boost/url/encoding_opts.hpp include/boost/url/encoding_opts.hpp 117 5 function 42dn6NwvSVW6CCjJVxY4v57MkPVx public regular 5dyN7z5egGMdJFpXz9WbaL549xC 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 named identifier void void named identifier bool bool space_as_plus false named identifier bool bool lower_case false named identifier bool bool disallow_null false constructor constexpr disallow_null boost/url/encoding_opts.hpp include/boost/url/encoding_opts.hpp 109 5 variable 2HAg2SbnF3k5Qgh3GkpjojvGJaMH public regular 5dyN7z5egGMdJFpXz9WbaL549xC 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 named identifier bool bool false lower_case boost/url/encoding_opts.hpp include/boost/url/encoding_opts.hpp 98 5 variable 2e3srymwsEVUxWAEEzepDsyMK759 public regular 5dyN7z5egGMdJFpXz9WbaL549xC 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 named identifier bool bool false space_as_plus boost/url/encoding_opts.hpp include/boost/url/encoding_opts.hpp 89 5 variable 3L8i2T27V3wPummgdmEkuXwAs4aU public regular 5dyN7z5egGMdJFpXz9WbaL549xC 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 3xB3BfuNs4uV9HRTA6DGtHfJP2Wh text and reference encoded_size 2KWV3g149ZmZytTFz7sErpzwi7zX 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 named identifier bool bool false ignore_case_param boost/url/ignore_case.hpp include/boost/url/ignore_case.hpp 43 1 record wxnor5Tun8FXFjfB7Jm4ghwuNS9 regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw text is passed. brief text An optional parameter to determine case-sensitivity see reference params_ref 4MtPiWDytNMbqCE6iciHidLK5Y4c class 3Re1kKzGCwRM1VJgFXA7a9Ugmx6F 35nSZMJ3eP3HsB2rXy4tYap33cn9 34gEBbi9v9VeqijDrSfdv6yQZ7N8 ignore_case_param boost/url/ignore_case.hpp include/boost/url/ignore_case.hpp 68 5 overloads 3Re1kKzGCwRM1VJgFXA7a9Ugmx6F public regular wxnor5Tun8FXFjfB7Jm4ghwuNS9 brief text Constructor constructor otQowuUCARWonKE9viaw1Bbbp4M 4A967wcpRktToGXjv1Zus9jDFH6 named identifier void void ignore_case_param boost/url/ignore_case.hpp include/boost/url/ignore_case.hpp 68 5 function otQowuUCARWonKE9viaw1Bbbp4M public regular wxnor5Tun8FXFjfB7Jm4ghwuNS9 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 named identifier void void constructor constexpr ignore_case_param boost/url/ignore_case.hpp include/boost/url/ignore_case.hpp 89 5 function 4A967wcpRktToGXjv1Zus9jDFH6 public regular wxnor5Tun8FXFjfB7Jm4ghwuNS9 paragraph text Construction from reference ignore_case 3qSXNyNHTb9MsSXvAjVCvfvrgLhw text indicates that comparisons should be case-insensitive. paragraph text The first parameter to this function should be the variable reference ignore_case 3qSXNyNHTb9MsSXvAjVCvfvrgLhw text . heading text Example 1 paragraph text When reference ignore_case 3qSXNyNHTb9MsSXvAjVCvfvrgLhw 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 named identifier void void named identifier 2LPgbGCfKKnahA45gG6zVjG9WUcA ignore_case_t identifier 3jVzhUTY78j9Azdaoqzm3EeWXkEU implementation_defined value constructor constexpr operator bool boost/url/ignore_case.hpp include/boost/url/ignore_case.hpp 106 5 function 35nSZMJ3eP3HsB2rXy4tYap33cn9 public regular wxnor5Tun8FXFjfB7Jm4ghwuNS9 paragraph text Values of type code text ignore_case_param text evaluate to true when constructed with the constant reference ignore_case 3qSXNyNHTb9MsSXvAjVCvfvrgLhw 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 named identifier bool bool conversion ipv4_address boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 53 1 boost/url/ipv6_address.hpp include/boost/url/ipv6_address.hpp 26 1 record 4Xmd9k1GBKGKQj6PYc1qdt4tMUae regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 45AWvW23tadRhrV2Rr5Wwg5c83dx text , reference ipv6_address 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T text . reference parse_ipv4_address 45AWvW23tadRhrV2Rr5Wwg5c83dx class c16W8RhYMsT7usZkk4FrBQ2BQYe 2pMSZev5QtM2PyPm1ykyTGjhizSC 9G9wv1Nad2S4Li79LfyLnCaG3eD 46JJQ6LBkx9QwCQaswsmsau96ZDS 3o3p98yR4S7Fwcp2EK65EgjwcEQq ydPF27tAZm9iASXft6JgvvhcWZv 3fsLtF5at5fTVmkTMTBSSi4jgJhg cnqTLfHW4qkvocyW6tQZdinTcuo 2r1kf6kqgHipibhVGcaWL2BnyRoa 2wFMbactxmEPxCQY4M5wdMvrCAv6 3TXEKqvy9qN9xXSVXEtNi76Q8Ueo unkE2yvC2jaWsoN9AbGEPZrBkVc 3tWCAJim36RiEMwDwcNrSbaCHyX5 44N51vJ31PRt53b6dAajz9Vu5rqR 3GPKAJEXbvX8pmgSxUGCUGpBnNgE named identifier 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T ipv6_address 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T 7fHrzgAgHgHmyXWP7b6SuvBQUXw eRFRDqqybWetB8bXwFU4a1ePZ6y 4NyHbGPF8j37AC3t4BfnHymNjQeG bytes_type boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 71 5 typedef c16W8RhYMsT7usZkk4FrBQ2BQYe public regular 4Xmd9k1GBKGKQj6PYc1qdt4tMUae brief text The type used to represent an address as an array of bytes named specialization 2gaoUWQMA6h1PziKLih7RLioVE3c array identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std type named identifier unsigned char unsigned char constant 4 uint_type boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 66 5 typedef 2pMSZev5QtM2PyPm1ykyTGjhizSC public regular 4Xmd9k1GBKGKQj6PYc1qdt4tMUae brief text The type used to represent an address as an unsigned integer named identifier 4KjaSgopuTVfQLGVzojerLeoD327 uint_least32_t ipv4_address boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 76 5 boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 106 5 boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 119 5 boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 148 5 overloads 9G9wv1Nad2S4Li79LfyLnCaG3eD public regular 4Xmd9k1GBKGKQj6PYc1qdt4tMUae 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 45AWvW23tadRhrV2Rr5Wwg5c83dx text . constructor 3pX1RMCPb1o3gnCGYTvRMxtfzdhq 42z5LwYQE6fYjzxNCgK68CseCqVB 2zCXxCsQpGJKY17PXfTJjKsN1bPM 2T8gjMNLzu82jETVJPVYw2mbwMs9 4SLVuKgkktwwruYopatf4wwVtneN named identifier void void ipv4_address boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 76 5 function 3pX1RMCPb1o3gnCGYTvRMxtfzdhq public regular 4Xmd9k1GBKGKQj6PYc1qdt4tMUae brief text Constructor. named identifier void void constructor constexpr ipv4_address boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 80 5 function 42z5LwYQE6fYjzxNCgK68CseCqVB public regular 4Xmd9k1GBKGKQj6PYc1qdt4tMUae brief text Constructor. param text The object to copy construct from other named identifier void void lvalue-reference named identifier 4Xmd9k1GBKGKQj6PYc1qdt4tMUae ipv4_address other constructor constexpr ipv4_address boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 148 5 function 2zCXxCsQpGJKY17PXfTJjKsN1bPM public regular 4Xmd9k1GBKGKQj6PYc1qdt4tMUae 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 45AWvW23tadRhrV2Rr5Wwg5c83dx 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 45AWvW23tadRhrV2Rr5Wwg5c83dx text . named identifier void void named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s constructor ipv4_address boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 106 5 function 2T8gjMNLzu82jETVJPVYw2mbwMs9 public regular 4Xmd9k1GBKGKQj6PYc1qdt4tMUae 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 named identifier void void named identifier 2pMSZev5QtM2PyPm1ykyTGjhizSC uint_type u constructor ipv4_address boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 119 5 function 4SLVuKgkktwwruYopatf4wwVtneN public regular 4Xmd9k1GBKGKQj6PYc1qdt4tMUae 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 named identifier void void lvalue-reference named identifier c16W8RhYMsT7usZkk4FrBQ2BQYe bytes_type bytes constructor operator= boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 88 5 function 46JJQ6LBkx9QwCQaswsmsau96ZDS public regular 4Xmd9k1GBKGKQj6PYc1qdt4tMUae brief text Copy Assignment. returns text A reference to this object. param text The object to copy. other lvalue-reference named identifier 4Xmd9k1GBKGKQj6PYc1qdt4tMUae ipv4_address lvalue-reference named identifier 4Xmd9k1GBKGKQj6PYc1qdt4tMUae ipv4_address other normal constexpr = is_loopback boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 233 5 function 3o3p98yR4S7Fwcp2EK65EgjwcEQq public regular 4Xmd9k1GBKGKQj6PYc1qdt4tMUae brief text Return true if the address is a loopback address returns code text true text if the address is a loopback address named identifier bool bool normal is_multicast boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 249 5 function ydPF27tAZm9iASXft6JgvvhcWZv public regular 4Xmd9k1GBKGKQj6PYc1qdt4tMUae brief text Return true if the address is a multicast address returns code text true text if the address is a multicast address named identifier bool bool normal is_unspecified boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 241 5 function 3fsLtF5at5fTVmkTMTBSSi4jgJhg public regular 4Xmd9k1GBKGKQj6PYc1qdt4tMUae brief text Return true if the address is unspecified returns code text true text if the address is unspecified named identifier bool bool normal to_buffer boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 223 5 function cnqTLfHW4qkvocyW6tQZdinTcuo public regular 4Xmd9k1GBKGKQj6PYc1qdt4tMUae 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 named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core pointer named identifier char char dest named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std dest_size normal to_bytes boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 157 5 function 2r1kf6kqgHipibhVGcaWL2BnyRoa public regular 4Xmd9k1GBKGKQj6PYc1qdt4tMUae brief text Return the address as bytes, in network byte order. returns text The address as an array of bytes. named identifier c16W8RhYMsT7usZkk4FrBQ2BQYe bytes_type normal to_string boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 201 5 function 2wFMbactxmEPxCQY4M5wdMvrCAv6 public regular 4Xmd9k1GBKGKQj6PYc1qdt4tMUae 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 named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal to_uint boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 165 5 function 3TXEKqvy9qN9xXSVXEtNi76Q8Ueo public regular 4Xmd9k1GBKGKQj6PYc1qdt4tMUae brief text Return the address as an unsigned integer. returns text The address as an unsigned integer. named identifier 2pMSZev5QtM2PyPm1ykyTGjhizSC uint_type normal any boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 287 5 function unkE2yvC2jaWsoN9AbGEPZrBkVc public regular 4Xmd9k1GBKGKQj6PYc1qdt4tMUae brief text Return an address object that represents any address returns text The any address. named identifier 4Xmd9k1GBKGKQj6PYc1qdt4tMUae ipv4_address normal static broadcast boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 309 5 function 3tWCAJim36RiEMwDwcNrSbaCHyX5 public regular 4Xmd9k1GBKGKQj6PYc1qdt4tMUae brief text Return an address object that represents the broadcast address returns text The broadcast address. named identifier 4Xmd9k1GBKGKQj6PYc1qdt4tMUae ipv4_address normal static loopback boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 298 5 function 44N51vJ31PRt53b6dAajz9Vu5rqR public regular 4Xmd9k1GBKGKQj6PYc1qdt4tMUae brief text Return an address object that represents the loopback address returns text The loopback address. named identifier 4Xmd9k1GBKGKQj6PYc1qdt4tMUae ipv4_address normal static max_str_len boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 60 5 variable 3GPKAJEXbvX8pmgSxUGCUGpBnNgE public regular 4Xmd9k1GBKGKQj6PYc1qdt4tMUae paragraph text The longest ipv4 address string is "255.255.255.255". brief text The number of characters in the longest possible IPv4 string. named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std 15 static ipv6_address boost/url/ipv6_address.hpp include/boost/url/ipv6_address.hpp 62 1 record 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 4Xmd9k1GBKGKQj6PYc1qdt4tMUae text , reference parse_ipv6_address 2WWWLGhxBBf6EtKLCdxA28UdXFJ1 text . reference parse_ipv6_address 2WWWLGhxBBf6EtKLCdxA28UdXFJ1 class 458bT9QXAxeZP58zaGQVDos3F3dr 352T3QKPTHSCw5c6Hiw6ttGeeAnv 3A2fVfqScJB6W47sNXQran6VweTT 44sRWZFvsHTpvb5ctsvy7KBTsZ9j 3Fv1No6Sejb8sBAefWLwCiBp7V6H a5qPSRRP5sxgvpSusRjWyPY9grj 2whLeVsmgfAHQcPABnL7C43dYCnM UnyY3TtnwZDNFYokxT9J3SdWCgN 448Utk2m3nzPiDsi3RsKtmDRjYG8 3wmNeLJmqqM67yeRmnXxati9g6wg 4SJNFrz3qdjy6CJecV3oCTsJTBYJ 4JdwWRKpmjaS2ZsTQuJX2jtWm1Xf 2bjS6o9i6nbUN3sfz9rczg3ppD9S 3pHfqEkh6BV6WQE5cfAvyMHyjE19 28wRhwwjVNvgRpTz9dPK9QFEFEdB qsKtXZMCdwtUEZ1HgrXpjoJZvY 2beF2UXb4tELnBeQCioogEDXvNDQ 4XXMaqfgz9sYsAYkpbRLMs12phav bytes_type boost/url/ipv6_address.hpp include/boost/url/ipv6_address.hpp 87 5 typedef 458bT9QXAxeZP58zaGQVDos3F3dr public regular 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T paragraph text Octets are stored in network byte order. brief text The type used to represent an address as an array of bytes. named specialization 2gaoUWQMA6h1PziKLih7RLioVE3c array identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std type named identifier unsigned char unsigned char constant 16 ipv6_address boost/url/ipv6_address.hpp include/boost/url/ipv6_address.hpp 101 5 boost/url/ipv6_address.hpp include/boost/url/ipv6_address.hpp 144 5 boost/url/ipv6_address.hpp include/boost/url/ipv6_address.hpp 173 5 overloads 352T3QKPTHSCw5c6Hiw6ttGeeAnv public regular 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T 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 3Fv1No6Sejb8sBAefWLwCiBp7V6H see reference parse_ipv6_address 2WWWLGhxBBf6EtKLCdxA28UdXFJ1 text . constructor 21oH68RaGSR9B37Fk768hHj9fs98 2Usb6oAChC98N6ztqeW2zthhJf11 3PypQbUDodrAcGGr39t6a8TReFm 3QW2qJYs89yqzi5d8XKw7bWFjUsm 2y9LYfYjMSDns7YABnyADoJ2jtuf named identifier void void ipv6_address boost/url/ipv6_address.hpp include/boost/url/ipv6_address.hpp 101 5 function 21oH68RaGSR9B37Fk768hHj9fs98 public regular 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T 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 3Fv1No6Sejb8sBAefWLwCiBp7V6H named identifier void void constructor constexpr ipv6_address boost/url/ipv6_address.hpp include/boost/url/ipv6_address.hpp 105 5 function 2Usb6oAChC98N6ztqeW2zthhJf11 public regular 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T brief text Constructor. param text The object to copy construct from other named identifier void void lvalue-reference named identifier 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T ipv6_address other constructor constexpr ipv6_address boost/url/ipv6_address.hpp include/boost/url/ipv6_address.hpp 173 5 function 3PypQbUDodrAcGGr39t6a8TReFm public regular 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T 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 2WWWLGhxBBf6EtKLCdxA28UdXFJ1 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 2WWWLGhxBBf6EtKLCdxA28UdXFJ1 text . named identifier void void named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s constructor ipv6_address boost/url/ipv6_address.hpp include/boost/url/ipv6_address.hpp 124 5 function 3QW2qJYs89yqzi5d8XKw7bWFjUsm public regular 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T 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 named identifier void void lvalue-reference named identifier 458bT9QXAxeZP58zaGQVDos3F3dr bytes_type bytes constructor constexpr ipv6_address boost/url/ipv6_address.hpp include/boost/url/ipv6_address.hpp 144 5 function 2y9LYfYjMSDns7YABnyADoJ2jtuf public regular 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T 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 named identifier void void lvalue-reference named identifier 4Xmd9k1GBKGKQj6PYc1qdt4tMUae ipv4_address addr constructor operator= boost/url/ipv6_address.hpp include/boost/url/ipv6_address.hpp 112 5 function 3A2fVfqScJB6W47sNXQran6VweTT public regular 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T brief text Copy Assignment returns code text *this param text The object to copy assign from other lvalue-reference named identifier 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T ipv6_address lvalue-reference named identifier 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T ipv6_address other normal constexpr = is_loopback boost/url/ipv6_address.hpp include/boost/url/ipv6_address.hpp 284 5 function 44sRWZFvsHTpvb5ctsvy7KBTsZ9j public regular 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T 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 named identifier bool bool normal is_unspecified boost/url/ipv6_address.hpp include/boost/url/ipv6_address.hpp 268 5 function 3Fv1No6Sejb8sBAefWLwCiBp7V6H public regular 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T 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 named identifier bool bool normal is_v4_mapped boost/url/ipv6_address.hpp include/boost/url/ipv6_address.hpp 299 5 function a5qPSRRP5sxgvpSusRjWyPY9grj public regular 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T 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 named identifier bool bool normal to_buffer boost/url/ipv6_address.hpp include/boost/url/ipv6_address.hpp 250 5 function 2whLeVsmgfAHQcPABnL7C43dYCnM public regular 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T 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 named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core pointer named identifier char char dest named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std dest_size normal to_bytes boost/url/ipv6_address.hpp include/boost/url/ipv6_address.hpp 180 5 function UnyY3TtnwZDNFYokxT9J3SdWCgN public regular 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T brief text Return the address as bytes, in network byte order returns text The address as an array of bytes. named identifier 458bT9QXAxeZP58zaGQVDos3F3dr bytes_type normal to_string boost/url/ipv6_address.hpp include/boost/url/ipv6_address.hpp 227 5 function 448Utk2m3nzPiDsi3RsKtmDRjYG8 public regular 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T 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 named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token normal loopback boost/url/ipv6_address.hpp include/boost/url/ipv6_address.hpp 345 5 function 3wmNeLJmqqM67yeRmnXxati9g6wg public regular 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T 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. named identifier 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T ipv6_address normal static max_str_len boost/url/ipv6_address.hpp include/boost/url/ipv6_address.hpp 79 5 variable 4SJNFrz3qdjy6CJecV3oCTsJTBYJ public regular 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T 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 2whLeVsmgfAHQcPABnL7C43dYCnM text . named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std 49 static no_value_t boost/url/param.hpp include/boost/url/param.hpp 30 1 boost/url/detail/optional_string.hpp include/boost/url/detail/optional_string.hpp 20 1 record 4DwiW6tfGAuwSbZpXpoaKSA3VizJ see-below 2ejQGW57K8g7MFJhHAwPt5aumoLa brief text The type of reference no_value TXZvizo9ikqMQ3HygeHisBPEJ15 struct param boost/url/param.hpp include/boost/url/param.hpp 75 1 record 2mSdVJKVJxHo9zo74jwzBLgs2Scz regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 3AmGdZ6mPwkT4subsk4Kz17mNzsv 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 AbvEAFQMtFaLMVMSA2NZ5D5a7nN text , reference param_pct_view 21okxUDyXpX2g3uj7TzYTtM4Skgh text . struct ymuh8EctC7k3hVpywCFk62Tjfwz 3VKdp13dzoHnTUY52pjji15sXVFA PyKagm5tMpu2rMV4EysVhnURKpm 3AmGdZ6mPwkT4subsk4Kz17mNzsv 3va1X1CnBjor348tPGoaeWGQ1yH5 dgVhNRJDcTKK2T5K7opjoiZnQd3 377HrFsdVyv1ZtgZheaLW1BAcW4K param boost/url/param.hpp include/boost/url/param.hpp 124 5 overloads ymuh8EctC7k3hVpywCFk62Tjfwz public regular 2mSdVJKVJxHo9zo74jwzBLgs2Scz 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 4DwiW6tfGAuwSbZpXpoaKSA3VizJ text , or code text optional<core::string_view> text . OptionalString constructor 3AeDazvyyWBrzmebJ5Ans1gNUr4p 47tGxkvihKE9VHbkhjFKpuB5W2tQ 2gQrj5yXs1arCwUcuYGLYrfeFBKF 3bvGCv9seDe7pzBQdq7LX5QKrAXs 3G8KNi1T8Ca46Lgyk4hG3qnYRkfu named identifier void void param boost/url/param.hpp include/boost/url/param.hpp 124 5 function 3AeDazvyyWBrzmebJ5Ans1gNUr4p public regular 2mSdVJKVJxHo9zo74jwzBLgs2Scz 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 named identifier void void constructor constexpr param boost/url/param.hpp include/boost/url/param.hpp 174 5 function 47tGxkvihKE9VHbkhjFKpuB5W2tQ public regular 2mSdVJKVJxHo9zo74jwzBLgs2Scz 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 named identifier void void lvalue-reference named identifier 2mSdVJKVJxHo9zo74jwzBLgs2Scz param other constructor constexpr param boost/url/param.hpp include/boost/url/param.hpp 142 5 function 2gQrj5yXs1arCwUcuYGLYrfeFBKF public regular 2mSdVJKVJxHo9zo74jwzBLgs2Scz 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 named identifier void void rvalue-reference named identifier 2mSdVJKVJxHo9zo74jwzBLgs2Scz param other constructor param boost/url/param.hpp include/boost/url/param.hpp 283 5 function 3bvGCv9seDe7pzBQdq7LX5QKrAXs public regular 2mSdVJKVJxHo9zo74jwzBLgs2Scz 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 4DwiW6tfGAuwSbZpXpoaKSA3VizJ text , or code text optional<core::string_view> text . OptionalString named identifier void void named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core key lvalue-reference named identifier OptionalString value constructor param boost/url/param.hpp include/boost/url/param.hpp 356 5 function 3G8KNi1T8Ca46Lgyk4hG3qnYRkfu public regular 2mSdVJKVJxHo9zo74jwzBLgs2Scz 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 named identifier void void named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core key named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core value named identifier bool bool has_value constructor operator= boost/url/param.hpp include/boost/url/param.hpp 194 5 boost/url/param.hpp include/boost/url/param.hpp 310 5 boost/url/param.hpp include/boost/url/param.hpp 332 5 overloads 3VKdp13dzoHnTUY52pjji15sXVFA public regular 2mSdVJKVJxHo9zo74jwzBLgs2Scz brief text Assignment returns text A reference to this object. param text The object to assign from. other normal = 3sQoMumt9jpkdw32e9chgw4Mdy6r 3WPmdqqHdwUwhP7cde13iEjuA8Ws jJiVZFnxxRjypznNeHSGCgVEaxf 3qDzAhXiqTaCNpgHrmK9zjNZ4x1W lvalue-reference named identifier 2mSdVJKVJxHo9zo74jwzBLgs2Scz param operator= boost/url/param.hpp include/boost/url/param.hpp 229 5 function 3sQoMumt9jpkdw32e9chgw4Mdy6r public regular 2mSdVJKVJxHo9zo74jwzBLgs2Scz 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 lvalue-reference named identifier 2mSdVJKVJxHo9zo74jwzBLgs2Scz param lvalue-reference named identifier 2mSdVJKVJxHo9zo74jwzBLgs2Scz param other normal constexpr = operator= boost/url/param.hpp include/boost/url/param.hpp 194 5 function 3WPmdqqHdwUwhP7cde13iEjuA8Ws public regular 2mSdVJKVJxHo9zo74jwzBLgs2Scz 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 lvalue-reference named identifier 2mSdVJKVJxHo9zo74jwzBLgs2Scz param rvalue-reference named identifier 2mSdVJKVJxHo9zo74jwzBLgs2Scz param other normal = operator= boost/url/param.hpp include/boost/url/param.hpp 997 1 boost/url/param.hpp include/boost/url/param.hpp 332 5 function jJiVZFnxxRjypznNeHSGCgVEaxf public regular 2mSdVJKVJxHo9zo74jwzBLgs2Scz 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 lvalue-reference named identifier 2mSdVJKVJxHo9zo74jwzBLgs2Scz param lvalue-reference named identifier 21okxUDyXpX2g3uj7TzYTtM4Skgh param_pct_view other normal = operator= boost/url/param.hpp include/boost/url/param.hpp 973 1 boost/url/param.hpp include/boost/url/param.hpp 310 5 function 3qDzAhXiqTaCNpgHrmK9zjNZ4x1W public regular 2mSdVJKVJxHo9zo74jwzBLgs2Scz 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 lvalue-reference named identifier 2mSdVJKVJxHo9zo74jwzBLgs2Scz param lvalue-reference named identifier AbvEAFQMtFaLMVMSA2NZ5D5a7nN param_view other normal = operator-> boost/url/param.hpp include/boost/url/param.hpp 344 5 function PyKagm5tMpu2rMV4EysVhnURKpm public regular 2mSdVJKVJxHo9zo74jwzBLgs2Scz 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. pointer named identifier 2mSdVJKVJxHo9zo74jwzBLgs2Scz param normal -> has_value boost/url/param.hpp include/boost/url/param.hpp 101 5 variable 3AmGdZ6mPwkT4subsk4Kz17mNzsv public regular 2mSdVJKVJxHo9zo74jwzBLgs2Scz 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 named identifier bool bool false key boost/url/param.hpp include/boost/url/param.hpp 85 5 variable 3va1X1CnBjor348tPGoaeWGQ1yH5 public regular 2mSdVJKVJxHo9zo74jwzBLgs2Scz 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 named identifier 2A6bDeBwiisGpHzTYMLSbQTSaSa3 string identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std value boost/url/param.hpp include/boost/url/param.hpp 93 5 variable dgVhNRJDcTKK2T5K7opjoiZnQd3 public regular 2mSdVJKVJxHo9zo74jwzBLgs2Scz paragraph text The presence of a value is indicated by reference has_value 3AmGdZ6mPwkT4subsk4Kz17mNzsv text equal to true. An empty value is distinct from no value. brief text The value named identifier 2A6bDeBwiisGpHzTYMLSbQTSaSa3 string identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std param_pct_view boost/url/param.hpp include/boost/url/param.hpp 695 1 boost/url/param.hpp include/boost/url/param.hpp 24 1 record 21okxUDyXpX2g3uj7TzYTtM4Skgh regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 3RunahQFN3jqdR7g1UFVHu9d5iot 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 2mSdVJKVJxHo9zo74jwzBLgs2Scz text , reference param_view AbvEAFQMtFaLMVMSA2NZ5D5a7nN text . struct 45xMvzK8xmVLrtgPL9Cwyjmj8j6h 8wCpJHyByXSCYrccecDQXeecMR9 2HbeGGTVywEzM3VNo943Z8CZC6N 3krT92tMF3kwGzytVBGZK7kfKXKt 3RunahQFN3jqdR7g1UFVHu9d5iot 3GjRNrsNQc3aDPNmChRrJmBYXwiP 2uxGGasHDVHhvU8KFbWjQG9YpSMb 2qEndzw8sfkfQZ9hqF19GD3grjM4 param_pct_view boost/url/param.hpp include/boost/url/param.hpp 746 5 overloads 45xMvzK8xmVLrtgPL9Cwyjmj8j6h public regular 21okxUDyXpX2g3uj7TzYTtM4Skgh 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 CTjGxFu2cRrVh2WnkH3tc9Pe6P7 n1ucsxQ1XiTn3CXgEzY23c4nkmV 4EmY9xyKyyFF3Y238g96NotPgeNq 2JYSvWv4dQraRTQ8fvy6YhZniYKX VBu5ju22ErEn1VySmhyPPMoFqtA named identifier void void param_pct_view boost/url/param.hpp include/boost/url/param.hpp 746 5 function CTjGxFu2cRrVh2WnkH3tc9Pe6P7 public regular 21okxUDyXpX2g3uj7TzYTtM4Skgh 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 named identifier void void constructor constexpr param_pct_view boost/url/param.hpp include/boost/url/param.hpp 876 5 function n1ucsxQ1XiTn3CXgEzY23c4nkmV public regular 21okxUDyXpX2g3uj7TzYTtM4Skgh 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 named identifier void void lvalue-reference named identifier AbvEAFQMtFaLMVMSA2NZ5D5a7nN param_view p constructor param_pct_view boost/url/param.hpp include/boost/url/param.hpp 783 5 function 4EmY9xyKyyFF3Y238g96NotPgeNq public regular 21okxUDyXpX2g3uj7TzYTtM4Skgh 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 named identifier void void named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view key named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view value constructor param_pct_view boost/url/param.hpp include/boost/url/param.hpp 835 5 function 2JYSvWv4dQraRTQ8fvy6YhZniYKX public regular 21okxUDyXpX2g3uj7TzYTtM4Skgh 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 named identifier void void named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view key lvalue-reference named identifier OptionalString value constructor param_pct_view boost/url/param.hpp include/boost/url/param.hpp 950 5 function VBu5ju22ErEn1VySmhyPPMoFqtA public regular 21okxUDyXpX2g3uj7TzYTtM4Skgh brief text Aggregate construction param text The key key param text The value value param text True if a value is present has_value named identifier void void named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view key named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view value named identifier bool bool has_value constructor operator-> boost/url/param.hpp include/boost/url/param.hpp 938 5 function 8wCpJHyByXSCYrccecDQXeecMR9 public regular 21okxUDyXpX2g3uj7TzYTtM4Skgh 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 pointer named identifier 21okxUDyXpX2g3uj7TzYTtM4Skgh param_pct_view normal -> operator param boost/url/param.hpp include/boost/url/param.hpp 902 5 function 2HbeGGTVywEzM3VNo943Z8CZC6N public regular 21okxUDyXpX2g3uj7TzYTtM4Skgh 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 named identifier 2mSdVJKVJxHo9zo74jwzBLgs2Scz param conversion operator param_view boost/url/param.hpp include/boost/url/param.hpp 923 5 function 3krT92tMF3kwGzytVBGZK7kfKXKt public regular 21okxUDyXpX2g3uj7TzYTtM4Skgh 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 named identifier AbvEAFQMtFaLMVMSA2NZ5D5a7nN param_view conversion has_value boost/url/param.hpp include/boost/url/param.hpp 721 5 variable 3RunahQFN3jqdR7g1UFVHu9d5iot public regular 21okxUDyXpX2g3uj7TzYTtM4Skgh 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 named identifier bool bool false key boost/url/param.hpp include/boost/url/param.hpp 705 5 variable 3GjRNrsNQc3aDPNmChRrJmBYXwiP public regular 21okxUDyXpX2g3uj7TzYTtM4Skgh 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 named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view value boost/url/param.hpp include/boost/url/param.hpp 713 5 variable 2uxGGasHDVHhvU8KFbWjQG9YpSMb public regular 21okxUDyXpX2g3uj7TzYTtM4Skgh paragraph text The presence of a value is indicated by reference has_value 3RunahQFN3jqdR7g1UFVHu9d5iot text equal to true. An empty value is distinct from no value. brief text The value named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view param_view boost/url/param.hpp include/boost/url/param.hpp 427 1 boost/url/param.hpp include/boost/url/param.hpp 25 1 record AbvEAFQMtFaLMVMSA2NZ5D5a7nN regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 4DNsP2fP9ihm3H1oQNLPdHd8uQRC 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 2mSdVJKVJxHo9zo74jwzBLgs2Scz text , reference param_pct_view 21okxUDyXpX2g3uj7TzYTtM4Skgh text . struct 4FBST55kFUyRtEKsqSjouaE6uKaH 23jD46e1y2HyVDaCGkkaUhNo6Ckp 2zzfCo5sEMaCMEt3A9VQpPpHL2B1 4DNsP2fP9ihm3H1oQNLPdHd8uQRC 3wYZsAdpf71iVWhpXZFaZLuerAKv 2y3p49FywPBt7ppyNhaJs8znPmxS oPixhR4SB7qaDuGt6ZgPnJURWi9 param_view boost/url/param.hpp include/boost/url/param.hpp 478 5 overloads 4FBST55kFUyRtEKsqSjouaE6uKaH public regular AbvEAFQMtFaLMVMSA2NZ5D5a7nN 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 4DwiW6tfGAuwSbZpXpoaKSA3VizJ text , or code text optional<core::string_view> text . OptionalString constructor 2i8MjWYVqokjG1szRohPB5jerwXs 2m1ZKFPho3ueiDJmhGpnqDu5L2rj MH4z7hJtuid4pwQ5mX3hDVbP5Tt jwb6TiyB6Mpaz2vDoqBsyvUQGmm named identifier void void param_view boost/url/param.hpp include/boost/url/param.hpp 478 5 function 2i8MjWYVqokjG1szRohPB5jerwXs public regular AbvEAFQMtFaLMVMSA2NZ5D5a7nN 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 named identifier void void constructor constexpr param_view boost/url/param.hpp include/boost/url/param.hpp 555 5 function 2m1ZKFPho3ueiDJmhGpnqDu5L2rj public regular AbvEAFQMtFaLMVMSA2NZ5D5a7nN 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 named identifier void void lvalue-reference named identifier 2mSdVJKVJxHo9zo74jwzBLgs2Scz param other constructor param_view boost/url/param.hpp include/boost/url/param.hpp 517 5 function MH4z7hJtuid4pwQ5mX3hDVbP5Tt public regular AbvEAFQMtFaLMVMSA2NZ5D5a7nN 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 4DwiW6tfGAuwSbZpXpoaKSA3VizJ text , or code text optional<core::string_view> text . OptionalString named identifier void void named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core key lvalue-reference named identifier OptionalString value constructor param_view boost/url/param.hpp include/boost/url/param.hpp 619 5 function jwb6TiyB6Mpaz2vDoqBsyvUQGmm public regular AbvEAFQMtFaLMVMSA2NZ5D5a7nN 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 named identifier void void named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core key named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core value named identifier bool bool has_value constructor operator-> boost/url/param.hpp include/boost/url/param.hpp 595 5 function 23jD46e1y2HyVDaCGkkaUhNo6Ckp public regular AbvEAFQMtFaLMVMSA2NZ5D5a7nN 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. pointer named identifier AbvEAFQMtFaLMVMSA2NZ5D5a7nN param_view normal -> operator param boost/url/param.hpp include/boost/url/param.hpp 580 5 function 2zzfCo5sEMaCMEt3A9VQpPpHL2B1 public regular AbvEAFQMtFaLMVMSA2NZ5D5a7nN 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. named identifier 2mSdVJKVJxHo9zo74jwzBLgs2Scz param conversion has_value boost/url/param.hpp include/boost/url/param.hpp 453 5 variable 4DNsP2fP9ihm3H1oQNLPdHd8uQRC public regular AbvEAFQMtFaLMVMSA2NZ5D5a7nN 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 named identifier bool bool false key boost/url/param.hpp include/boost/url/param.hpp 437 5 variable 3wYZsAdpf71iVWhpXZFaZLuerAKv public regular AbvEAFQMtFaLMVMSA2NZ5D5a7nN 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 named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core value boost/url/param.hpp include/boost/url/param.hpp 445 5 variable 2y3p49FywPBt7ppyNhaJs8znPmxS public regular AbvEAFQMtFaLMVMSA2NZ5D5a7nN paragraph text The presence of a value is indicated by reference has_value 4DNsP2fP9ihm3H1oQNLPdHd8uQRC text equal to true. An empty value is distinct from no value. brief text The value named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core params_base boost/url/params_base.hpp include/boost/url/params_base.hpp 42 1 record 3JqzyR89pExMFqZFBHMskoM3dq3x regular 2ejQGW57K8g7MFJhHAwPt5aumoLa paragraph text This base centralizes the read-only, percent-decoded query parameter algorithms (iteration, lookup, counting) that are shared by reference params_view DJiFqyFR7zZh4N3HNJHhiAj7JPV text and reference params_ref 4MtPiWDytNMbqCE6iciHidLK5Y4c 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 4MtPiWDytNMbqCE6iciHidLK5Y4c paragraph reference params_view DJiFqyFR7zZh4N3HNJHhiAj7JPV paragraph reference params_encoded_ref 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe paragraph reference params_encoded_view 3w4FJjjADY3EEHqUmBj5mvDKqdEB unordered brief text Decoded query parameter helper base other __visibility__ class 4MtPiWDytNMbqCE6iciHidLK5Y4c DJiFqyFR7zZh4N3HNJHhiAj7JPV 49BBGFSd4SwAURZeuhCEaXediDdJ 4Xx9vtbkyrMRFcX6dhA9EuNpA3hu 49oR6EqtkFRr1Bymk1w9Wz9yWMU6 4MJtyAXahb7x3kuqnzTyFU8wPji6 2ZncUdqXP51Rm1SVMvHxcE2G3h2m 4Z4sBT8FxThQJcHVk3coS2ZWnmTU 399FQ6KddUL8ZnrPLHJUSZf1JvgB 3RbyBkqnvV8MJE9umvacbDCDfXmJ 2bbRcPd3jX9CTnvkFxyySAzaF4kU 4VMZSzQLL4cKY2HBoL5TdKXCfAtf 22CityYzMdoqGjqEahCAgKi4GQxB 2BjCAZiyHaKPriQ6mfRsjEksN6sK kEewuBi8Kzmh3TFtMfP7sjLTQ6m 4YX5so5aQEEJZd3tjTDpYj1qTiph 23uLeb7cygRQRPeonrUfhp87YPgi N5MpsfkLUThQwuAT2reGDy86cPj 3cu9cFBD5WP4ojAFLBpo7112FDaY W7WP55a9DuMT6FQHq6d3TMDZTEN 3kT4Mt1tF5AXKwWBhGVFNJmNz9D3 3sbZtAHJ4o3m1Ukkb1iLCSaUVsV5 25vsjo3U5fvRiasQg22pSejNbrrt 4TDDk2aFkQFX9nEFbPTeMDqwp9mV 4WfLVeNCYrGayGm2TEXzthcTwHGi 43bFGRJrekBRAiBff4mptrvkVNkg named identifier DJiFqyFR7zZh4N3HNJHhiAj7JPV params_view DJiFqyFR7zZh4N3HNJHhiAj7JPV named identifier 4MtPiWDytNMbqCE6iciHidLK5Y4c params_ref 4MtPiWDytNMbqCE6iciHidLK5Y4c named identifier 27ryuyAvvRyzfzgketja5uQcFBcK url_view_base 27ryuyAvvRyzfzgketja5uQcFBcK const_iterator boost/url/params_base.hpp include/boost/url/params_base.hpp 94 5 typedef 49BBGFSd4SwAURZeuhCEaXediDdJ public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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 named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator const_reference boost/url/params_base.hpp include/boost/url/params_base.hpp 123 5 typedef 4Xx9vtbkyrMRFcX6dhA9EuNpA3hu public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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 AbvEAFQMtFaLMVMSA2NZ5D5a7nN text . named identifier 2mSdVJKVJxHo9zo74jwzBLgs2Scz param difference_type boost/url/params_base.hpp include/boost/url/params_base.hpp 131 5 typedef 49oR6EqtkFRr1Bymk1w9Wz9yWMU6 public regular 3JqzyR89pExMFqZFBHMskoM3dq3x brief text A signed integer type used to represent differences. named identifier EKxMGCxxySWyqBbWqvvL9j9KhWv ptrdiff_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std reference boost/url/params_base.hpp include/boost/url/params_base.hpp 120 5 typedef 4MJtyAXahb7x3kuqnzTyFU8wPji6 public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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 AbvEAFQMtFaLMVMSA2NZ5D5a7nN text . named identifier 2mSdVJKVJxHo9zo74jwzBLgs2Scz param size_type boost/url/params_base.hpp include/boost/url/params_base.hpp 127 5 typedef 2ZncUdqXP51Rm1SVMvHxcE2G3h2m public regular 3JqzyR89pExMFqZFBHMskoM3dq3x brief text An unsigned integer type to represent sizes. named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std value_type boost/url/params_base.hpp include/boost/url/params_base.hpp 110 5 typedef 4Z4sBT8FxThQJcHVk3coS2ZWnmTU public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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 2mSdVJKVJxHo9zo74jwzBLgs2Scz text . named identifier 2mSdVJKVJxHo9zo74jwzBLgs2Scz param 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 record 399FQ6KddUL8ZnrPLHJUSZf1JvgB public see-below 3JqzyR89pExMFqZFBHMskoM3dq3x 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 other __visibility__ class named identifier 4MtPiWDytNMbqCE6iciHidLK5Y4c params_ref 4MtPiWDytNMbqCE6iciHidLK5Y4c named identifier 3JqzyR89pExMFqZFBHMskoM3dq3x params_base 3JqzyR89pExMFqZFBHMskoM3dq3x begin boost/url/params_base.hpp include/boost/url/params_base.hpp 227 5 function 3RbyBkqnvV8MJE9umvacbDCDfXmJ public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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. named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator normal buffer boost/url/params_base.hpp include/boost/url/params_base.hpp 178 5 function 2bbRcPd3jX9CTnvkFxyySAzaF4kU public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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. named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal contains boost/url/params_base.hpp include/boost/url/params_base.hpp 275 5 function 4VMZSzQLL4cKY2HBoL5TdKXCfAtf public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw text is passed here, the comparison is case-insensitive. ic named identifier bool bool named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core key named identifier wxnor5Tun8FXFjfB7Jm4ghwuNS9 ignore_case_param ic {} normal count boost/url/params_base.hpp include/boost/url/params_base.hpp 311 5 function 22CityYzMdoqGjqEahCAgKi4GQxB public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw text is passed here, the comparison is case-insensitive. ic named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core key named identifier wxnor5Tun8FXFjfB7Jm4ghwuNS9 ignore_case_param ic {} normal empty boost/url/params_base.hpp include/boost/url/params_base.hpp 196 5 function 2BjCAZiyHaKPriQ6mfRsjEksN6sK public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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. named identifier bool bool normal end boost/url/params_base.hpp include/boost/url/params_base.hpp 240 5 function kEewuBi8Kzmh3TFtMfP7sjLTQ6m public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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. named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator normal find boost/url/params_base.hpp include/boost/url/params_base.hpp 395 5 boost/url/params_base.hpp include/boost/url/params_base.hpp 440 5 overloads 4YX5so5aQEEJZd3tjTDpYj1qTiph public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw 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 38kjLuKfKDsmR9uPZmR6KNCgpHnA wubrUDNmf4xbT2BGw857MB7xkZG named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator find boost/url/params_base.hpp include/boost/url/params_base.hpp 395 5 function 38kjLuKfKDsmR9uPZmR6KNCgpHnA public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw text is passed here, the comparison is case-insensitive. ic named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core key named identifier wxnor5Tun8FXFjfB7Jm4ghwuNS9 ignore_case_param ic {} normal find boost/url/params_base.hpp include/boost/url/params_base.hpp 440 5 function wubrUDNmf4xbT2BGw857MB7xkZG public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw text is passed here, the comparison is case-insensitive. ic named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator from named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core key named identifier wxnor5Tun8FXFjfB7Jm4ghwuNS9 ignore_case_param ic {} normal find_last boost/url/params_base.hpp include/boost/url/params_base.hpp 481 5 boost/url/params_base.hpp include/boost/url/params_base.hpp 527 5 overloads 23uLeb7cygRQRPeonrUfhp87YPgi public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw 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 27RGcRUEoQPCWUEANTx9RwTXGMAP 4473YZ5UmH9eUXSJ4YKAY3g2cAwE named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator find_last boost/url/params_base.hpp include/boost/url/params_base.hpp 481 5 function 27RGcRUEoQPCWUEANTx9RwTXGMAP public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw text is passed here, the comparison is case-insensitive. ic named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core key named identifier wxnor5Tun8FXFjfB7Jm4ghwuNS9 ignore_case_param ic {} normal find_last boost/url/params_base.hpp include/boost/url/params_base.hpp 527 5 function 4473YZ5UmH9eUXSJ4YKAY3g2cAwE public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw text is passed here, the comparison is case-insensitive. ic named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator before named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core key named identifier wxnor5Tun8FXFjfB7Jm4ghwuNS9 ignore_case_param ic {} normal get_or boost/url/params_base.hpp include/boost/url/params_base.hpp 349 5 function N5MpsfkLUThQwuAT2reGDy86cPj public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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 named identifier 2A6bDeBwiisGpHzTYMLSbQTSaSa3 string identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core key named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core value {} named identifier wxnor5Tun8FXFjfB7Jm4ghwuNS9 ignore_case_param ic {} normal size boost/url/params_base.hpp include/boost/url/params_base.hpp 214 5 function 3cu9cFBD5WP4ojAFLBpo7112FDaY public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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. named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std normal max_size boost/url/params_base.hpp include/boost/url/params_base.hpp 150 5 function W7WP55a9DuMT6FQHq6d3TMDZTEN public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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. named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std normal constexpr static params_encoded_base boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 40 1 record 44gF3RWPKyorxySQWG1hnA4vjiJu regular 2ejQGW57K8g7MFJhHAwPt5aumoLa paragraph text This base implements the shared percent-encoded query parameter view functionality used by reference params_encoded_view 3w4FJjjADY3EEHqUmBj5mvDKqdEB text and reference params_encoded_ref 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe 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 4MtPiWDytNMbqCE6iciHidLK5Y4c paragraph reference params_view DJiFqyFR7zZh4N3HNJHhiAj7JPV paragraph reference params_encoded_ref 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe paragraph reference params_encoded_view 3w4FJjjADY3EEHqUmBj5mvDKqdEB unordered brief text Percent-encoded query helper base other __visibility__ class 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe 3w4FJjjADY3EEHqUmBj5mvDKqdEB 2HpwbN2Szmp7KmTXbr3WvdCcKamE 2e1iTfsy3DEfUvuUccByuvDgvYVG XjmufrUAdwmHHsQs1jCx2FMvqdB 5Hcm6PkiWu4tTBwZeTufpMc4emL NWpzhp9xYqvFfKXRv569qoL2yWZ 25kKvgfbbcUd7Vaqga2eNJKXPfez 2S6RhMxvYJmeqASdwaN8wwa9iuA9 SLwkxq8g9ycJamQM4FQtfuFHza3 3JgWegRAPzHrqrfYQZq8whXJ7ryX 3puX2KWDVRSuaDrkHS9FA1rDj7CH 2dxfgVqQ32ZhhabhjV4wQsBoNDei HC88sscX42gEVrNoDP2qQUpxD2i gkh9K7LePYBv65iZiX72tVij5Zq 3seczRZW2fo5K3zpqhnf47QcCnXN 3UGhcTQNLYub6jjrbEpZ9j8mrgLm 3mxJb39gK3RuZRj1C8nWzyx5GcKi 3r958hBNBGtYPsdmG8BJk5DazYaJ 2NFEJMjGbepeKdG4frbqQLkvEGFD 2ztM2aSu39BAzNqwNeAnL4a8Ls4Z uFJ2uErKe9Cf9mUYr8b19A3QB2i RssXFeovpeTYy5xuzjS292YwFJ7 3VvaNW6Po263Se8gi8gwDS9MkasR 3XeC9aQK9n1yCidZ8hPT8FTHDvpB named identifier 3w4FJjjADY3EEHqUmBj5mvDKqdEB params_encoded_view 3w4FJjjADY3EEHqUmBj5mvDKqdEB named identifier 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe params_encoded_ref 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe named identifier 27ryuyAvvRyzfzgketja5uQcFBcK url_view_base 27ryuyAvvRyzfzgketja5uQcFBcK const_iterator boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 82 5 typedef 2HpwbN2Szmp7KmTXbr3WvdCcKamE public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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 named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator const_reference boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 111 5 typedef 2e1iTfsy3DEfUvuUccByuvDgvYVG public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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 AbvEAFQMtFaLMVMSA2NZ5D5a7nN text . named identifier 21okxUDyXpX2g3uj7TzYTtM4Skgh param_pct_view difference_type boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 119 5 typedef XjmufrUAdwmHHsQs1jCx2FMvqdB public regular 44gF3RWPKyorxySQWG1hnA4vjiJu brief text A signed integer type used to represent differences. named identifier EKxMGCxxySWyqBbWqvvL9j9KhWv ptrdiff_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std reference boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 108 5 typedef 5Hcm6PkiWu4tTBwZeTufpMc4emL public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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 AbvEAFQMtFaLMVMSA2NZ5D5a7nN text . named identifier 21okxUDyXpX2g3uj7TzYTtM4Skgh param_pct_view size_type boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 115 5 typedef NWpzhp9xYqvFfKXRv569qoL2yWZ public regular 44gF3RWPKyorxySQWG1hnA4vjiJu brief text An unsigned integer type to represent sizes. named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std value_type boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 98 5 typedef 25kKvgfbbcUd7Vaqga2eNJKXPfez public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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 2mSdVJKVJxHo9zo74jwzBLgs2Scz text . named identifier 2mSdVJKVJxHo9zo74jwzBLgs2Scz param iterator boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 79 5 record 2S6RhMxvYJmeqASdwaN8wwa9iuA9 public see-below 44gF3RWPKyorxySQWG1hnA4vjiJu 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 4VLNtjVPizL2BSJyy3wj95h8PqTs 46BQAdxnkiLRk4tua9zvjBVNBxhG named identifier 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe params_encoded_ref 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe named identifier 44gF3RWPKyorxySQWG1hnA4vjiJu params_encoded_base 44gF3RWPKyorxySQWG1hnA4vjiJu begin boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 228 5 function SLwkxq8g9ycJamQM4FQtfuFHza3 public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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. named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator normal buffer boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 179 5 function 3JgWegRAPzHrqrfYQZq8whXJ7ryX public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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. named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal contains boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 280 5 function 3puX2KWDVRSuaDrkHS9FA1rDj7CH public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw text is passed here, the comparison is case-insensitive. ic throws code text key text contains an invalid percent-encoding. reference system_error named identifier bool bool named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view key named identifier wxnor5Tun8FXFjfB7Jm4ghwuNS9 ignore_case_param ic {} normal count boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 319 5 function 2dxfgVqQ32ZhhabhjV4wQsBoNDei public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw text is passed here, the comparison is case-insensitive. ic throws code text key text contains an invalid percent-encoding. reference system_error named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view key named identifier wxnor5Tun8FXFjfB7Jm4ghwuNS9 ignore_case_param ic {} normal empty boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 197 5 function HC88sscX42gEVrNoDP2qQUpxD2i public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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. named identifier bool bool normal end boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 241 5 function gkh9K7LePYBv65iZiX72tVij5Zq public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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. named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator normal find boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 411 5 boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 463 5 overloads 3seczRZW2fo5K3zpqhnf47QcCnXN public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw 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 p6gY4sPVXn2wpvCrYWjec1so69f 67c5UraTs4Vzkua1nxoUtVtcttJ named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator find boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 411 5 function p6gY4sPVXn2wpvCrYWjec1so69f public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw text is passed here, the comparison is case-insensitive. ic throws code text key text contains an invalid percent-encoding. reference system_error named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view key named identifier wxnor5Tun8FXFjfB7Jm4ghwuNS9 ignore_case_param ic {} normal find boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 463 5 function 67c5UraTs4Vzkua1nxoUtVtcttJ public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw text is passed here, the comparison is case-insensitive. ic throws code text key text contains an invalid percent-encoding. reference system_error named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator from named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view key named identifier wxnor5Tun8FXFjfB7Jm4ghwuNS9 ignore_case_param ic {} normal find_last boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 511 5 boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 558 5 overloads 3UGhcTQNLYub6jjrbEpZ9j8mrgLm public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw 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 2JSEk1fCWgUDz7dBvT5BsreEmwRc 3uUzT7mq4oc3oZHHHjpCG5Q2ZpYF named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator find_last boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 511 5 function 2JSEk1fCWgUDz7dBvT5BsreEmwRc public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw text is passed here, the comparison is case-insensitive. ic throws code text key text contains an invalid percent-encoding. reference system_error named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view key named identifier wxnor5Tun8FXFjfB7Jm4ghwuNS9 ignore_case_param ic {} normal find_last boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 558 5 function 3uUzT7mq4oc3oZHHHjpCG5Q2ZpYF public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw text is passed here, the comparison is case-insensitive. ic named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator before named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view key named identifier wxnor5Tun8FXFjfB7Jm4ghwuNS9 ignore_case_param ic {} normal get_or boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 358 5 function 3mxJb39gK3RuZRj1C8nWzyx5GcKi public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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 named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view key named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view value {} named identifier wxnor5Tun8FXFjfB7Jm4ghwuNS9 ignore_case_param ic {} normal size boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 215 5 function 3r958hBNBGtYPsdmG8BJk5DazYaJ public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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. named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std normal max_size boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 138 5 function 2NFEJMjGbepeKdG4frbqQLkvEGFD public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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. named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std normal constexpr static params_encoded_ref boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 77 1 record 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe regular 2ejQGW57K8g7MFJhHAwPt5aumoLa paragraph text This container exposes the percent-encoded query parameters of a reference url_base 2TREmHUMfZeMQz9yyw5HzqB91APN 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 21okxUDyXpX2g3uj7TzYTtM4Skgh 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 35z5LXdtBCKR5kRCUhFEcop2CDhK text : Only code text end() text . paragraph reference assign 2DNgWeTVjLjGZjCyYRKBBwvGnjp4 text , reference clear 347FsZbCs67ztnaCSDwBKEYae6Wk text , code text operator= text : All params. paragraph reference erase k8x742wMakffcMWXLz4YbwretVv text : Erased params and all params after (including code text end() text ). paragraph reference insert 48o9PcHNcfC1YJMaMyQ8KngAsg8U text : All params at or after the insertion point (including code text end() text ). paragraph reference replace P6hRJfPmQfSp5d4znFicjRwqQVP text , reference set 2YBRDx9ZuBMC7wEruFe6Ey5sGeJc 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 44gF3RWPKyorxySQWG1hnA4vjiJu text (for example reference contains 3puX2KWDVRSuaDrkHS9FA1rDj7CH text , reference find 3seczRZW2fo5K3zpqhnf47QcCnXN text , and reference get_or 3mxJb39gK3RuZRj1C8nWzyx5GcKi text ) behaves like the corresponding function on reference params_encoded_view 3w4FJjjADY3EEHqUmBj5mvDKqdEB text it inspects the current encoded query and does not perform any modifications. brief text Mutable encoded query parameter proxy other __visibility__ class named identifier 44gF3RWPKyorxySQWG1hnA4vjiJu params_encoded_base public 2HpwbN2Szmp7KmTXbr3WvdCcKamE 2e1iTfsy3DEfUvuUccByuvDgvYVG XjmufrUAdwmHHsQs1jCx2FMvqdB 5Hcm6PkiWu4tTBwZeTufpMc4emL NWpzhp9xYqvFfKXRv569qoL2yWZ 25kKvgfbbcUd7Vaqga2eNJKXPfez DG5QUYmUk6zg2MjLxVMvAz5KHgZ MxrdnxguK1NK9SrxzaSuHD4VH85 HdaxBbptAysJfzGVzzoAZfPmR6R 35z5LXdtBCKR5kRCUhFEcop2CDhK 2DNgWeTVjLjGZjCyYRKBBwvGnjp4 SLwkxq8g9ycJamQM4FQtfuFHza3 3JgWegRAPzHrqrfYQZq8whXJ7ryX 347FsZbCs67ztnaCSDwBKEYae6Wk 3puX2KWDVRSuaDrkHS9FA1rDj7CH 2dxfgVqQ32ZhhabhjV4wQsBoNDei HC88sscX42gEVrNoDP2qQUpxD2i gkh9K7LePYBv65iZiX72tVij5Zq k8x742wMakffcMWXLz4YbwretVv 3seczRZW2fo5K3zpqhnf47QcCnXN 3UGhcTQNLYub6jjrbEpZ9j8mrgLm 3mxJb39gK3RuZRj1C8nWzyx5GcKi 48o9PcHNcfC1YJMaMyQ8KngAsg8U P6hRJfPmQfSp5d4znFicjRwqQVP 2YBRDx9ZuBMC7wEruFe6Ey5sGeJc 3r958hBNBGtYPsdmG8BJk5DazYaJ 48BwAfUhRJ5jjCEncyi4FPGG9iNM yKZtCdsr9M3ukSavsqrasmC9iZd 485ib7fede4CwAtf3xRyxoJjosZo 2NFEJMjGbepeKdG4frbqQLkvEGFD 2BpYNB1fwQb6TNPBX3NQd4CrMA3p auqQiSCpQyF3Gfkfx6CHERp43rM 3LojScUksmSxwjZ5p5xZqupXgsyi 2UL7GwCi2KyUGY56nz3k3se87msi named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base 2TREmHUMfZeMQz9yyw5HzqB91APN const_iterator boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 82 5 typedef 2HpwbN2Szmp7KmTXbr3WvdCcKamE public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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 named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator const_reference boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 111 5 typedef 2e1iTfsy3DEfUvuUccByuvDgvYVG public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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 AbvEAFQMtFaLMVMSA2NZ5D5a7nN text . named identifier 21okxUDyXpX2g3uj7TzYTtM4Skgh param_pct_view difference_type boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 119 5 typedef XjmufrUAdwmHHsQs1jCx2FMvqdB public regular 44gF3RWPKyorxySQWG1hnA4vjiJu brief text A signed integer type used to represent differences. named identifier EKxMGCxxySWyqBbWqvvL9j9KhWv ptrdiff_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std reference boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 108 5 typedef 5Hcm6PkiWu4tTBwZeTufpMc4emL public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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 AbvEAFQMtFaLMVMSA2NZ5D5a7nN text . named identifier 21okxUDyXpX2g3uj7TzYTtM4Skgh param_pct_view size_type boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 115 5 typedef NWpzhp9xYqvFfKXRv569qoL2yWZ public regular 44gF3RWPKyorxySQWG1hnA4vjiJu brief text An unsigned integer type to represent sizes. named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std value_type boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 98 5 typedef 25kKvgfbbcUd7Vaqga2eNJKXPfez public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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 2mSdVJKVJxHo9zo74jwzBLgs2Scz text . named identifier 2mSdVJKVJxHo9zo74jwzBLgs2Scz param iterator boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 79 5 record DG5QUYmUk6zg2MjLxVMvAz5KHgZ public see-below 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe 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 4VLNtjVPizL2BSJyy3wj95h8PqTs 46BQAdxnkiLRk4tua9zvjBVNBxhG named identifier 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe params_encoded_ref 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe named identifier 44gF3RWPKyorxySQWG1hnA4vjiJu params_encoded_base 44gF3RWPKyorxySQWG1hnA4vjiJu params_encoded_ref boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 116 5 function MxrdnxguK1NK9SrxzaSuHD4VH85 public regular 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe 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 named identifier void void lvalue-reference named identifier 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe params_encoded_ref other constructor constexpr operator= boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 147 5 boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 185 5 overloads HdaxBbptAysJfzGVzzoAZfPmR6R public regular 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe 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 = ar1wzRfYBFLXjbh9fin5xDV645Q s3AWcFDAQnSFEXAh3axSqJZHMFf lvalue-reference named identifier 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe params_encoded_ref operator= boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 147 5 function ar1wzRfYBFLXjbh9fin5xDV645Q public regular 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe 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 lvalue-reference named identifier 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe params_encoded_ref lvalue-reference named identifier 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe params_encoded_ref other normal = operator= boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 185 5 function s3AWcFDAQnSFEXAh3axSqJZHMFf public regular 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe 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 lvalue-reference named identifier 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe params_encoded_ref named specialization 474HF6bGJmJntnocv1iPAYL2crja initializer_list identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std type named identifier 21okxUDyXpX2g3uj7TzYTtM4Skgh param_pct_view init normal = append boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 372 5 boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 406 5 boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 446 5 overloads 35z5LXdtBCKR5kRCUhFEcop2CDhK public regular 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe 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 4FJUmScjtTR7QGVika28FzUe2Fhq 2aXcHbgtvxsf1zAbnUPRZQzbaaU1 2wB8yHh5rf4DC3wK4rqrmofzqG6b named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator append boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 406 5 function 4FJUmScjtTR7QGVika28FzUe2Fhq public regular 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe 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 named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator named specialization 474HF6bGJmJntnocv1iPAYL2crja initializer_list identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std type named identifier 21okxUDyXpX2g3uj7TzYTtM4Skgh param_pct_view init normal append boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 372 5 function 2aXcHbgtvxsf1zAbnUPRZQzbaaU1 public regular 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe 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 named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator lvalue-reference named identifier 21okxUDyXpX2g3uj7TzYTtM4Skgh param_pct_view p normal append boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 446 5 function 2wB8yHh5rf4DC3wK4rqrmofzqG6b public regular 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe 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 named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator named identifier FwdIt first named identifier FwdIt last normal assign boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 299 5 boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 337 5 overloads 2DNgWeTVjLjGZjCyYRKBBwvGnjp4 public regular 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe 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 BDno28XruhfQjL4qaQsXVSGFAG8 2ad6Uh33TJCN4VqqDekFJgQZ4rMh named identifier void void assign boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 299 5 function BDno28XruhfQjL4qaQsXVSGFAG8 public regular 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe 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 named identifier void void named specialization 474HF6bGJmJntnocv1iPAYL2crja initializer_list identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std type named identifier 21okxUDyXpX2g3uj7TzYTtM4Skgh param_pct_view init normal assign boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 337 5 function 2ad6Uh33TJCN4VqqDekFJgQZ4rMh public regular 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe 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 named identifier void void named identifier FwdIt first named identifier FwdIt last normal begin boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 228 5 function SLwkxq8g9ycJamQM4FQtfuFHza3 public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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. named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator normal buffer boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 179 5 function 3JgWegRAPzHrqrfYQZq8whXJ7ryX public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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. named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal clear boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 260 5 function 347FsZbCs67ztnaCSDwBKEYae6Wk public regular 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe 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 named identifier void void normal contains boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 280 5 function 3puX2KWDVRSuaDrkHS9FA1rDj7CH public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw text is passed here, the comparison is case-insensitive. ic throws code text key text contains an invalid percent-encoding. reference system_error named identifier bool bool named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view key named identifier wxnor5Tun8FXFjfB7Jm4ghwuNS9 ignore_case_param ic {} normal count boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 319 5 function 2dxfgVqQ32ZhhabhjV4wQsBoNDei public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw text is passed here, the comparison is case-insensitive. ic throws code text key text contains an invalid percent-encoding. reference system_error named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view key named identifier wxnor5Tun8FXFjfB7Jm4ghwuNS9 ignore_case_param ic {} normal empty boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 197 5 function HC88sscX42gEVrNoDP2qQUpxD2i public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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. named identifier bool bool normal end boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 241 5 function gkh9K7LePYBv65iZiX72tVij5Zq public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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. named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator normal erase boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 609 5 boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 634 5 boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 670 5 overloads k8x742wMakffcMWXLz4YbwretVv public regular 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw text is passed here, the comparison is case-insensitive. ic throws code text key text contains an invalid percent-encoding. reference system_error normal 2vaFwnJ2Dz4ofHWz149mwAsgoEPB 3WbuEps78pXMYZLhde46n4cGXqZZ 1k17zEsf26YudAVx8wCxarGyMGM auto auto erase boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 609 5 function 2vaFwnJ2Dz4ofHWz149mwAsgoEPB public regular 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe 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 named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator pos normal erase boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 634 5 function 3WbuEps78pXMYZLhde46n4cGXqZZ public regular 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe 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 named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator first named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator last normal erase boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 670 5 function 1k17zEsf26YudAVx8wCxarGyMGM public regular 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw text is passed here, the comparison is case-insensitive. ic throws code text key text contains an invalid percent-encoding. reference system_error named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view key named identifier wxnor5Tun8FXFjfB7Jm4ghwuNS9 ignore_case_param ic {} normal find boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 411 5 boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 463 5 overloads 3seczRZW2fo5K3zpqhnf47QcCnXN public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw 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 p6gY4sPVXn2wpvCrYWjec1so69f 67c5UraTs4Vzkua1nxoUtVtcttJ named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator find boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 411 5 function p6gY4sPVXn2wpvCrYWjec1so69f public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw text is passed here, the comparison is case-insensitive. ic throws code text key text contains an invalid percent-encoding. reference system_error named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view key named identifier wxnor5Tun8FXFjfB7Jm4ghwuNS9 ignore_case_param ic {} normal find boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 463 5 function 67c5UraTs4Vzkua1nxoUtVtcttJ public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw text is passed here, the comparison is case-insensitive. ic throws code text key text contains an invalid percent-encoding. reference system_error named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator from named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view key named identifier wxnor5Tun8FXFjfB7Jm4ghwuNS9 ignore_case_param ic {} normal find_last boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 511 5 boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 558 5 overloads 3UGhcTQNLYub6jjrbEpZ9j8mrgLm public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw 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 2JSEk1fCWgUDz7dBvT5BsreEmwRc 3uUzT7mq4oc3oZHHHjpCG5Q2ZpYF named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator find_last boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 511 5 function 2JSEk1fCWgUDz7dBvT5BsreEmwRc public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw text is passed here, the comparison is case-insensitive. ic throws code text key text contains an invalid percent-encoding. reference system_error named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view key named identifier wxnor5Tun8FXFjfB7Jm4ghwuNS9 ignore_case_param ic {} normal find_last boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 558 5 function 3uUzT7mq4oc3oZHHHjpCG5Q2ZpYF public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw text is passed here, the comparison is case-insensitive. ic named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator before named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view key named identifier wxnor5Tun8FXFjfB7Jm4ghwuNS9 ignore_case_param ic {} normal get_or boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 358 5 function 3mxJb39gK3RuZRj1C8nWzyx5GcKi public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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 named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view key named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view value {} named identifier wxnor5Tun8FXFjfB7Jm4ghwuNS9 ignore_case_param ic {} normal insert boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 482 5 boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 523 5 boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 571 5 overloads 48o9PcHNcfC1YJMaMyQ8KngAsg8U public regular 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe 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 3X5bPkNhUHTSgRPiVGdLxpR6xEv6 sn3DGAX55jDL1HG7GACB3Ar5Qos 29ZyyDxtBGRJM2YnDJfWew4qE7gu named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator insert boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 523 5 function 3X5bPkNhUHTSgRPiVGdLxpR6xEv6 public regular 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe 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 named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator before named specialization 474HF6bGJmJntnocv1iPAYL2crja initializer_list identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std type named identifier 21okxUDyXpX2g3uj7TzYTtM4Skgh param_pct_view init normal insert boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 482 5 function sn3DGAX55jDL1HG7GACB3Ar5Qos public regular 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe 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 named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator before lvalue-reference named identifier 21okxUDyXpX2g3uj7TzYTtM4Skgh param_pct_view p normal insert boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 571 5 function 29ZyyDxtBGRJM2YnDJfWew4qE7gu public regular 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe 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 named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator before named identifier FwdIt first named identifier FwdIt last normal replace boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 718 5 boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 758 5 boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 806 5 overloads P6hRJfPmQfSp5d4znFicjRwqQVP public regular 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe 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 4NzB96Lf7ZbHyD9oKgEF2q4oL76B 2sXj5v6SMRdwrqVne6kH8G2PCEU7 2ZMdr6zWRjquEqYaxYsvvDztxGXy named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator replace boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 718 5 function 4NzB96Lf7ZbHyD9oKgEF2q4oL76B public regular 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe 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 named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator pos lvalue-reference named identifier 21okxUDyXpX2g3uj7TzYTtM4Skgh param_pct_view p normal replace boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 758 5 function 2sXj5v6SMRdwrqVne6kH8G2PCEU7 public regular 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe 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 named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator from named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator to named specialization 474HF6bGJmJntnocv1iPAYL2crja initializer_list identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std type named identifier 21okxUDyXpX2g3uj7TzYTtM4Skgh param_pct_view init normal replace boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 806 5 function 2ZMdr6zWRjquEqYaxYsvvDztxGXy public regular 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe 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 named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator from named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator to named identifier FwdIt first named identifier FwdIt last normal set boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 893 5 boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 965 5 overloads 2YBRDx9ZuBMC7wEruFe6Ey5sGeJc public regular 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw text is passed here, the comparison is case-insensitive. ic throws code text value text contains an invalid percent-encoding. reference system_error normal 42wkh2ZfFAWyjDry8vHZmVeXQLMn 2jM4wCJNe8NiZFuNTTPC6urqfPWR named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator set boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 893 5 function 42wkh2ZfFAWyjDry8vHZmVeXQLMn public regular 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe 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 named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator pos named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view value normal set boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 965 5 function 2jM4wCJNe8NiZFuNTTPC6urqfPWR public regular 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw 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 named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view key named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view value named identifier wxnor5Tun8FXFjfB7Jm4ghwuNS9 ignore_case_param ic {} normal size boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 215 5 function 3r958hBNBGtYPsdmG8BJk5DazYaJ public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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. named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std normal unset boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 846 5 function 48BwAfUhRJ5jjCEncyi4FPGG9iNM public regular 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe 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 named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator pos normal url boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 227 5 function yKZtCdsr9M3ukSavsqrasmC9iZd public regular 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe 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. lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base normal operator params_encoded_view boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 199 5 function 485ib7fede4CwAtf3xRyxoJjosZo public regular 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe 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. named identifier 3w4FJjjADY3EEHqUmBj5mvDKqdEB params_encoded_view conversion max_size boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 138 5 function 2NFEJMjGbepeKdG4frbqQLkvEGFD public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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. named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std normal constexpr static params_encoded_view boost/url/params_encoded_view.hpp include/boost/url/params_encoded_view.hpp 52 1 boost/url/params_encoded_ref.hpp include/boost/url/params_encoded_ref.hpp 24 1 record 3w4FJjjADY3EEHqUmBj5mvDKqdEB regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 21okxUDyXpX2g3uj7TzYTtM4Skgh 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 other __visibility__ class named identifier 44gF3RWPKyorxySQWG1hnA4vjiJu params_encoded_base public 2HpwbN2Szmp7KmTXbr3WvdCcKamE 2e1iTfsy3DEfUvuUccByuvDgvYVG XjmufrUAdwmHHsQs1jCx2FMvqdB 5Hcm6PkiWu4tTBwZeTufpMc4emL NWpzhp9xYqvFfKXRv569qoL2yWZ 25kKvgfbbcUd7Vaqga2eNJKXPfez 4Qt9QMMXCdD2mg41Z4gjLP85XXCT 3eToTvShNNYFnq3FDbLiwtRUkQ2U 3dVR4mie6zbGfk9WcTey96co337X SLwkxq8g9ycJamQM4FQtfuFHza3 3JgWegRAPzHrqrfYQZq8whXJ7ryX 3puX2KWDVRSuaDrkHS9FA1rDj7CH 2dxfgVqQ32ZhhabhjV4wQsBoNDei HC88sscX42gEVrNoDP2qQUpxD2i gkh9K7LePYBv65iZiX72tVij5Zq 3seczRZW2fo5K3zpqhnf47QcCnXN 3UGhcTQNLYub6jjrbEpZ9j8mrgLm 3mxJb39gK3RuZRj1C8nWzyx5GcKi 3r958hBNBGtYPsdmG8BJk5DazYaJ r2HADHB1Ww1ASwR4SxUu3StbqUT 2NFEJMjGbepeKdG4frbqQLkvEGFD 456oDujxLSQARGp1mqtq95RQeV5w 3aMNKrgRSuUL46UjPvkFSPkcStNk named identifier 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe params_encoded_ref 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe named identifier DJiFqyFR7zZh4N3HNJHhiAj7JPV params_view DJiFqyFR7zZh4N3HNJHhiAj7JPV named identifier 27ryuyAvvRyzfzgketja5uQcFBcK url_view_base 27ryuyAvvRyzfzgketja5uQcFBcK const_iterator boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 82 5 typedef 2HpwbN2Szmp7KmTXbr3WvdCcKamE public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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 named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator const_reference boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 111 5 typedef 2e1iTfsy3DEfUvuUccByuvDgvYVG public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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 AbvEAFQMtFaLMVMSA2NZ5D5a7nN text . named identifier 21okxUDyXpX2g3uj7TzYTtM4Skgh param_pct_view difference_type boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 119 5 typedef XjmufrUAdwmHHsQs1jCx2FMvqdB public regular 44gF3RWPKyorxySQWG1hnA4vjiJu brief text A signed integer type used to represent differences. named identifier EKxMGCxxySWyqBbWqvvL9j9KhWv ptrdiff_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std reference boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 108 5 typedef 5Hcm6PkiWu4tTBwZeTufpMc4emL public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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 AbvEAFQMtFaLMVMSA2NZ5D5a7nN text . named identifier 21okxUDyXpX2g3uj7TzYTtM4Skgh param_pct_view size_type boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 115 5 typedef NWpzhp9xYqvFfKXRv569qoL2yWZ public regular 44gF3RWPKyorxySQWG1hnA4vjiJu brief text An unsigned integer type to represent sizes. named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std value_type boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 98 5 typedef 25kKvgfbbcUd7Vaqga2eNJKXPfez public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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 2mSdVJKVJxHo9zo74jwzBLgs2Scz text . named identifier 2mSdVJKVJxHo9zo74jwzBLgs2Scz param iterator boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 79 5 record 4Qt9QMMXCdD2mg41Z4gjLP85XXCT public see-below 3w4FJjjADY3EEHqUmBj5mvDKqdEB 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 4VLNtjVPizL2BSJyy3wj95h8PqTs 46BQAdxnkiLRk4tua9zvjBVNBxhG named identifier 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe params_encoded_ref 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe named identifier 44gF3RWPKyorxySQWG1hnA4vjiJu params_encoded_base 44gF3RWPKyorxySQWG1hnA4vjiJu params_encoded_view boost/url/params_encoded_view.hpp include/boost/url/params_encoded_view.hpp 85 5 boost/url/params_encoded_view.hpp include/boost/url/params_encoded_view.hpp 165 5 overloads 3eToTvShNNYFnq3FDbLiwtRUkQ2U public regular 3w4FJjjADY3EEHqUmBj5mvDKqdEB 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 e6d3zRjMayX8jR9s4yZxjg8SJRR 2WFxCqC8vnVMkRhaRuY3FhczDPsw 3qHtPBwRVRqNpSwKNRU5gmHDjMpQ named identifier void void params_encoded_view boost/url/params_encoded_view.hpp include/boost/url/params_encoded_view.hpp 85 5 function e6d3zRjMayX8jR9s4yZxjg8SJRR public regular 3w4FJjjADY3EEHqUmBj5mvDKqdEB 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 named identifier void void constructor constexpr params_encoded_view boost/url/params_encoded_view.hpp include/boost/url/params_encoded_view.hpp 110 5 function 2WFxCqC8vnVMkRhaRuY3FhczDPsw public regular 3w4FJjjADY3EEHqUmBj5mvDKqdEB 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 named identifier void void lvalue-reference named identifier 3w4FJjjADY3EEHqUmBj5mvDKqdEB params_encoded_view other constructor constexpr params_encoded_view boost/url/params_encoded_view.hpp include/boost/url/params_encoded_view.hpp 165 5 function 3qHtPBwRVRqNpSwKNRU5gmHDjMpQ public regular 3w4FJjjADY3EEHqUmBj5mvDKqdEB 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 named identifier void void named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s constructor operator= boost/url/params_encoded_view.hpp include/boost/url/params_encoded_view.hpp 193 5 function 3dVR4mie6zbGfk9WcTey96co337X public regular 3w4FJjjADY3EEHqUmBj5mvDKqdEB 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 lvalue-reference named identifier 3w4FJjjADY3EEHqUmBj5mvDKqdEB params_encoded_view lvalue-reference named identifier 3w4FJjjADY3EEHqUmBj5mvDKqdEB params_encoded_view other normal constexpr = begin boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 228 5 function SLwkxq8g9ycJamQM4FQtfuFHza3 public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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. named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator normal buffer boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 179 5 function 3JgWegRAPzHrqrfYQZq8whXJ7ryX public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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. named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal contains boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 280 5 function 3puX2KWDVRSuaDrkHS9FA1rDj7CH public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw text is passed here, the comparison is case-insensitive. ic throws code text key text contains an invalid percent-encoding. reference system_error named identifier bool bool named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view key named identifier wxnor5Tun8FXFjfB7Jm4ghwuNS9 ignore_case_param ic {} normal count boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 319 5 function 2dxfgVqQ32ZhhabhjV4wQsBoNDei public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw text is passed here, the comparison is case-insensitive. ic throws code text key text contains an invalid percent-encoding. reference system_error named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view key named identifier wxnor5Tun8FXFjfB7Jm4ghwuNS9 ignore_case_param ic {} normal empty boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 197 5 function HC88sscX42gEVrNoDP2qQUpxD2i public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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. named identifier bool bool normal end boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 241 5 function gkh9K7LePYBv65iZiX72tVij5Zq public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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. named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator normal find boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 411 5 boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 463 5 overloads 3seczRZW2fo5K3zpqhnf47QcCnXN public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw 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 p6gY4sPVXn2wpvCrYWjec1so69f 67c5UraTs4Vzkua1nxoUtVtcttJ named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator find boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 411 5 function p6gY4sPVXn2wpvCrYWjec1so69f public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw text is passed here, the comparison is case-insensitive. ic throws code text key text contains an invalid percent-encoding. reference system_error named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view key named identifier wxnor5Tun8FXFjfB7Jm4ghwuNS9 ignore_case_param ic {} normal find boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 463 5 function 67c5UraTs4Vzkua1nxoUtVtcttJ public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw text is passed here, the comparison is case-insensitive. ic throws code text key text contains an invalid percent-encoding. reference system_error named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator from named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view key named identifier wxnor5Tun8FXFjfB7Jm4ghwuNS9 ignore_case_param ic {} normal find_last boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 511 5 boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 558 5 overloads 3UGhcTQNLYub6jjrbEpZ9j8mrgLm public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw 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 2JSEk1fCWgUDz7dBvT5BsreEmwRc 3uUzT7mq4oc3oZHHHjpCG5Q2ZpYF named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator find_last boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 511 5 function 2JSEk1fCWgUDz7dBvT5BsreEmwRc public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw text is passed here, the comparison is case-insensitive. ic throws code text key text contains an invalid percent-encoding. reference system_error named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view key named identifier wxnor5Tun8FXFjfB7Jm4ghwuNS9 ignore_case_param ic {} normal find_last boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 558 5 function 3uUzT7mq4oc3oZHHHjpCG5Q2ZpYF public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw text is passed here, the comparison is case-insensitive. ic named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator named identifier 2S6RhMxvYJmeqASdwaN8wwa9iuA9 iterator before named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view key named identifier wxnor5Tun8FXFjfB7Jm4ghwuNS9 ignore_case_param ic {} normal get_or boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 358 5 function 3mxJb39gK3RuZRj1C8nWzyx5GcKi public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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 named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view key named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view value {} named identifier wxnor5Tun8FXFjfB7Jm4ghwuNS9 ignore_case_param ic {} normal size boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 215 5 function 3r958hBNBGtYPsdmG8BJk5DazYaJ public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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. named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std normal operator params_view boost/url/params_encoded_view.hpp include/boost/url/params_encoded_view.hpp 228 5 function r2HADHB1Ww1ASwR4SxUu3StbqUT public regular 3w4FJjjADY3EEHqUmBj5mvDKqdEB 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. named identifier DJiFqyFR7zZh4N3HNJHhiAj7JPV params_view conversion max_size boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 138 5 function 2NFEJMjGbepeKdG4frbqQLkvEGFD public regular 44gF3RWPKyorxySQWG1hnA4vjiJu 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. named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std normal constexpr static params_ref boost/url/params_ref.hpp include/boost/url/params_ref.hpp 86 1 record 4MtPiWDytNMbqCE6iciHidLK5Y4c regular 2ejQGW57K8g7MFJhHAwPt5aumoLa paragraph text This container presents the decoded query parameters of a reference url_base 2TREmHUMfZeMQz9yyw5HzqB91APN 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 AdsaYx95aKG7MoCK4N7Sr4p2Lhs text : Only code text end() text . paragraph reference assign 29zV1f9jXW65yBaoNjos1j7bK1kC text , reference clear 4XtsSmRq6SJyfX3R8jiXLB9rickQ text , code text operator= text : All elements. paragraph reference erase 4VrmUEmMfhLE2cXdjc2DR97mscTT text : Erased elements and all elements after (including code text end() text ). paragraph reference insert 47QYjmhVd243a98j6KhXuGabCp17 text : All elements at or after the insertion point (including code text end() text ). paragraph reference replace 36Bxc5VrfWHXcA8RfVvPRCjyqaBZ text , reference set 4Vw9uoKMswhNjvgKmfDWh5qGJNNr 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 3JqzyR89pExMFqZFBHMskoM3dq3x text (such as reference contains 4VMZSzQLL4cKY2HBoL5TdKXCfAtf text , reference find 4YX5so5aQEEJZd3tjTDpYj1qTiph text , and reference get_or N5MpsfkLUThQwuAT2reGDy86cPj text ) operate in the same way as they do on reference params_view DJiFqyFR7zZh4N3HNJHhiAj7JPV text they perform their lookup against the current contents of the referenced URL without modifying it. brief text Mutable decoded query parameter proxy other __visibility__ class named identifier 3JqzyR89pExMFqZFBHMskoM3dq3x params_base public 49BBGFSd4SwAURZeuhCEaXediDdJ 4Xx9vtbkyrMRFcX6dhA9EuNpA3hu 49oR6EqtkFRr1Bymk1w9Wz9yWMU6 4MJtyAXahb7x3kuqnzTyFU8wPji6 2ZncUdqXP51Rm1SVMvHxcE2G3h2m 4Z4sBT8FxThQJcHVk3coS2ZWnmTU 2Pf757BnXHqtFdDL9r9Arp9Ykb9t 4HGY3mFXseAwik7txNyFv43nH4Qv 3fnxnHF5hT5ixYJbjsRwFK5Kh1uZ AdsaYx95aKG7MoCK4N7Sr4p2Lhs 29zV1f9jXW65yBaoNjos1j7bK1kC 3RbyBkqnvV8MJE9umvacbDCDfXmJ 2bbRcPd3jX9CTnvkFxyySAzaF4kU 4XtsSmRq6SJyfX3R8jiXLB9rickQ 4VMZSzQLL4cKY2HBoL5TdKXCfAtf 22CityYzMdoqGjqEahCAgKi4GQxB 2BjCAZiyHaKPriQ6mfRsjEksN6sK kEewuBi8Kzmh3TFtMfP7sjLTQ6m 4VrmUEmMfhLE2cXdjc2DR97mscTT 4YX5so5aQEEJZd3tjTDpYj1qTiph 23uLeb7cygRQRPeonrUfhp87YPgi N5MpsfkLUThQwuAT2reGDy86cPj 47QYjmhVd243a98j6KhXuGabCp17 36Bxc5VrfWHXcA8RfVvPRCjyqaBZ 4Vw9uoKMswhNjvgKmfDWh5qGJNNr 3cu9cFBD5WP4ojAFLBpo7112FDaY 2zcijxKxW7QPxyGqg7mJThLU3yDy 4Adfpj3Tm9GbDEsHDmChQRFwRfFi nBhem7FoKm8zGZnn3Phqme6aRek W7WP55a9DuMT6FQHq6d3TMDZTEN 4YzHRJeP9FQ5MG7Zy8WnhFnKeaR9 2dfeVqUwG6tkL9e5H4ef3Awb1rnC j6FuWohKxjtFf4pqaBjo5iRqX9F 3tZhytJSx45FSHFBmnS698yWBR1X named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base 2TREmHUMfZeMQz9yyw5HzqB91APN const_iterator boost/url/params_base.hpp include/boost/url/params_base.hpp 94 5 typedef 49BBGFSd4SwAURZeuhCEaXediDdJ public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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 named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator const_reference boost/url/params_base.hpp include/boost/url/params_base.hpp 123 5 typedef 4Xx9vtbkyrMRFcX6dhA9EuNpA3hu public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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 AbvEAFQMtFaLMVMSA2NZ5D5a7nN text . named identifier 2mSdVJKVJxHo9zo74jwzBLgs2Scz param difference_type boost/url/params_base.hpp include/boost/url/params_base.hpp 131 5 typedef 49oR6EqtkFRr1Bymk1w9Wz9yWMU6 public regular 3JqzyR89pExMFqZFBHMskoM3dq3x brief text A signed integer type used to represent differences. named identifier EKxMGCxxySWyqBbWqvvL9j9KhWv ptrdiff_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std reference boost/url/params_base.hpp include/boost/url/params_base.hpp 120 5 typedef 4MJtyAXahb7x3kuqnzTyFU8wPji6 public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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 AbvEAFQMtFaLMVMSA2NZ5D5a7nN text . named identifier 2mSdVJKVJxHo9zo74jwzBLgs2Scz param size_type boost/url/params_base.hpp include/boost/url/params_base.hpp 127 5 typedef 2ZncUdqXP51Rm1SVMvHxcE2G3h2m public regular 3JqzyR89pExMFqZFBHMskoM3dq3x brief text An unsigned integer type to represent sizes. named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std value_type boost/url/params_base.hpp include/boost/url/params_base.hpp 110 5 typedef 4Z4sBT8FxThQJcHVk3coS2ZWnmTU public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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 2mSdVJKVJxHo9zo74jwzBLgs2Scz text . named identifier 2mSdVJKVJxHo9zo74jwzBLgs2Scz param 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 record 2Pf757BnXHqtFdDL9r9Arp9Ykb9t public see-below 4MtPiWDytNMbqCE6iciHidLK5Y4c 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 other __visibility__ class named identifier 4MtPiWDytNMbqCE6iciHidLK5Y4c params_ref 4MtPiWDytNMbqCE6iciHidLK5Y4c named identifier 3JqzyR89pExMFqZFBHMskoM3dq3x params_base 3JqzyR89pExMFqZFBHMskoM3dq3x params_ref boost/url/params_ref.hpp include/boost/url/params_ref.hpp 126 5 boost/url/params_ref.hpp include/boost/url/params_ref.hpp 159 5 overloads 4HGY3mFXseAwik7txNyFv43nH4Qv public regular 4MtPiWDytNMbqCE6iciHidLK5Y4c 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 3TRRBPm77ym8k8jtTnE7dwChs5Hf 3BgwQh8mMvF32RBqL6kRDHWMg3jE named identifier void void params_ref boost/url/params_ref.hpp include/boost/url/params_ref.hpp 126 5 function 3TRRBPm77ym8k8jtTnE7dwChs5Hf public regular 4MtPiWDytNMbqCE6iciHidLK5Y4c 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 named identifier void void lvalue-reference named identifier 4MtPiWDytNMbqCE6iciHidLK5Y4c params_ref other constructor constexpr params_ref boost/url/params_ref.hpp include/boost/url/params_ref.hpp 159 5 function 3BgwQh8mMvF32RBqL6kRDHWMg3jE public regular 4MtPiWDytNMbqCE6iciHidLK5Y4c paragraph text After construction, both views will reference the same url but this instance will use the specified reference encoding_opts 5dyN7z5egGMdJFpXz9WbaL549xC 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 named identifier void void lvalue-reference named identifier 4MtPiWDytNMbqCE6iciHidLK5Y4c params_ref other named identifier 5dyN7z5egGMdJFpXz9WbaL549xC encoding_opts opt constructor operator= boost/url/params_ref.hpp include/boost/url/params_ref.hpp 191 5 boost/url/params_ref.hpp include/boost/url/params_ref.hpp 222 5 overloads 3fnxnHF5hT5ixYJbjsRwFK5Kh1uZ public regular 4MtPiWDytNMbqCE6iciHidLK5Y4c brief text Assignment returns code text *this param text The params to assign. other param text The list of params to assign. init normal = 3qcmWp77QEH6zjjxc72dmbEq66UE ifxv1V1rUDptfsHJuWHx8MwPJVe lvalue-reference named identifier 4MtPiWDytNMbqCE6iciHidLK5Y4c params_ref operator= boost/url/params_ref.hpp include/boost/url/params_ref.hpp 191 5 function 3qcmWp77QEH6zjjxc72dmbEq66UE public regular 4MtPiWDytNMbqCE6iciHidLK5Y4c 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 lvalue-reference named identifier 4MtPiWDytNMbqCE6iciHidLK5Y4c params_ref lvalue-reference named identifier 4MtPiWDytNMbqCE6iciHidLK5Y4c params_ref other normal = operator= boost/url/params_ref.hpp include/boost/url/params_ref.hpp 222 5 function ifxv1V1rUDptfsHJuWHx8MwPJVe public regular 4MtPiWDytNMbqCE6iciHidLK5Y4c 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 lvalue-reference named identifier 4MtPiWDytNMbqCE6iciHidLK5Y4c params_ref named specialization 474HF6bGJmJntnocv1iPAYL2crja initializer_list identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std type named identifier AbvEAFQMtFaLMVMSA2NZ5D5a7nN param_view init normal = append boost/url/params_ref.hpp include/boost/url/params_ref.hpp 392 5 boost/url/params_ref.hpp include/boost/url/params_ref.hpp 422 5 boost/url/params_ref.hpp include/boost/url/params_ref.hpp 456 5 overloads AdsaYx95aKG7MoCK4N7Sr4p2Lhs public regular 4MtPiWDytNMbqCE6iciHidLK5Y4c 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 2kzeydgTGFM6VeSuTaK1qHL9xgxC 4Rf41KFVryDtEL5NEQHh3bzCQVFC 3pe6kucZRZNXX5QvkS9pqxZyyZgn named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator append boost/url/params_ref.hpp include/boost/url/params_ref.hpp 422 5 function 2kzeydgTGFM6VeSuTaK1qHL9xgxC public regular 4MtPiWDytNMbqCE6iciHidLK5Y4c 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 named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator named specialization 474HF6bGJmJntnocv1iPAYL2crja initializer_list identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std type named identifier AbvEAFQMtFaLMVMSA2NZ5D5a7nN param_view init normal append boost/url/params_ref.hpp include/boost/url/params_ref.hpp 392 5 function 4Rf41KFVryDtEL5NEQHh3bzCQVFC public regular 4MtPiWDytNMbqCE6iciHidLK5Y4c 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 named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator lvalue-reference named identifier AbvEAFQMtFaLMVMSA2NZ5D5a7nN param_view p normal append boost/url/params_ref.hpp include/boost/url/params_ref.hpp 456 5 function 3pe6kucZRZNXX5QvkS9pqxZyyZgn public regular 4MtPiWDytNMbqCE6iciHidLK5Y4c 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 named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator named identifier FwdIt first named identifier FwdIt last normal assign boost/url/params_ref.hpp include/boost/url/params_ref.hpp 327 5 boost/url/params_ref.hpp include/boost/url/params_ref.hpp 361 5 overloads 29zV1f9jXW65yBaoNjos1j7bK1kC public regular 4MtPiWDytNMbqCE6iciHidLK5Y4c 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 38R9kTLpRBuRr4Eri7T2pWqHfGh3 eztKjVYWNFk3K6UtCCBk8J8WeFk named identifier void void assign boost/url/params_ref.hpp include/boost/url/params_ref.hpp 327 5 function 38R9kTLpRBuRr4Eri7T2pWqHfGh3 public regular 4MtPiWDytNMbqCE6iciHidLK5Y4c 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 named identifier void void named specialization 474HF6bGJmJntnocv1iPAYL2crja initializer_list identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std type named identifier AbvEAFQMtFaLMVMSA2NZ5D5a7nN param_view init normal assign boost/url/params_ref.hpp include/boost/url/params_ref.hpp 361 5 function eztKjVYWNFk3K6UtCCBk8J8WeFk public regular 4MtPiWDytNMbqCE6iciHidLK5Y4c 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 named identifier void void named identifier FwdIt first named identifier FwdIt last normal begin boost/url/params_base.hpp include/boost/url/params_base.hpp 227 5 function 3RbyBkqnvV8MJE9umvacbDCDfXmJ public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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. named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator normal buffer boost/url/params_base.hpp include/boost/url/params_base.hpp 178 5 function 2bbRcPd3jX9CTnvkFxyySAzaF4kU public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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. named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal clear boost/url/params_ref.hpp include/boost/url/params_ref.hpp 292 5 function 4XtsSmRq6SJyfX3R8jiXLB9rickQ public regular 4MtPiWDytNMbqCE6iciHidLK5Y4c 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 named identifier void void normal contains boost/url/params_base.hpp include/boost/url/params_base.hpp 275 5 function 4VMZSzQLL4cKY2HBoL5TdKXCfAtf public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw text is passed here, the comparison is case-insensitive. ic named identifier bool bool named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core key named identifier wxnor5Tun8FXFjfB7Jm4ghwuNS9 ignore_case_param ic {} normal count boost/url/params_base.hpp include/boost/url/params_base.hpp 311 5 function 22CityYzMdoqGjqEahCAgKi4GQxB public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw text is passed here, the comparison is case-insensitive. ic named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core key named identifier wxnor5Tun8FXFjfB7Jm4ghwuNS9 ignore_case_param ic {} normal empty boost/url/params_base.hpp include/boost/url/params_base.hpp 196 5 function 2BjCAZiyHaKPriQ6mfRsjEksN6sK public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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. named identifier bool bool normal end boost/url/params_base.hpp include/boost/url/params_base.hpp 240 5 function kEewuBi8Kzmh3TFtMfP7sjLTQ6m public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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. named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator normal erase boost/url/params_ref.hpp include/boost/url/params_ref.hpp 606 5 boost/url/params_ref.hpp include/boost/url/params_ref.hpp 628 5 boost/url/params_ref.hpp include/boost/url/params_ref.hpp 661 5 overloads 4VrmUEmMfhLE2cXdjc2DR97mscTT public regular 4MtPiWDytNMbqCE6iciHidLK5Y4c 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw text is passed here, the comparison is case-insensitive. ic normal 2G4fQtK6xkWg7ZppviXq6uYNspPt 4Usj83Gh4r2Do2ukgeiimUQ8iy4o 6xgUKXxGedFpp7mjhunM9k4mNS5 auto auto erase boost/url/params_ref.hpp include/boost/url/params_ref.hpp 606 5 function 2G4fQtK6xkWg7ZppviXq6uYNspPt public regular 4MtPiWDytNMbqCE6iciHidLK5Y4c 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 named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator pos normal erase boost/url/params_ref.hpp include/boost/url/params_ref.hpp 628 5 function 4Usj83Gh4r2Do2ukgeiimUQ8iy4o public regular 4MtPiWDytNMbqCE6iciHidLK5Y4c 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 named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator first named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator last normal erase boost/url/params_ref.hpp include/boost/url/params_ref.hpp 661 5 function 6xgUKXxGedFpp7mjhunM9k4mNS5 public regular 4MtPiWDytNMbqCE6iciHidLK5Y4c 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw text is passed here, the comparison is case-insensitive. ic named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core key named identifier wxnor5Tun8FXFjfB7Jm4ghwuNS9 ignore_case_param ic {} normal find boost/url/params_base.hpp include/boost/url/params_base.hpp 395 5 boost/url/params_base.hpp include/boost/url/params_base.hpp 440 5 overloads 4YX5so5aQEEJZd3tjTDpYj1qTiph public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw 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 38kjLuKfKDsmR9uPZmR6KNCgpHnA wubrUDNmf4xbT2BGw857MB7xkZG named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator find boost/url/params_base.hpp include/boost/url/params_base.hpp 395 5 function 38kjLuKfKDsmR9uPZmR6KNCgpHnA public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw text is passed here, the comparison is case-insensitive. ic named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core key named identifier wxnor5Tun8FXFjfB7Jm4ghwuNS9 ignore_case_param ic {} normal find boost/url/params_base.hpp include/boost/url/params_base.hpp 440 5 function wubrUDNmf4xbT2BGw857MB7xkZG public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw text is passed here, the comparison is case-insensitive. ic named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator from named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core key named identifier wxnor5Tun8FXFjfB7Jm4ghwuNS9 ignore_case_param ic {} normal find_last boost/url/params_base.hpp include/boost/url/params_base.hpp 481 5 boost/url/params_base.hpp include/boost/url/params_base.hpp 527 5 overloads 23uLeb7cygRQRPeonrUfhp87YPgi public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw 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 27RGcRUEoQPCWUEANTx9RwTXGMAP 4473YZ5UmH9eUXSJ4YKAY3g2cAwE named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator find_last boost/url/params_base.hpp include/boost/url/params_base.hpp 481 5 function 27RGcRUEoQPCWUEANTx9RwTXGMAP public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw text is passed here, the comparison is case-insensitive. ic named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core key named identifier wxnor5Tun8FXFjfB7Jm4ghwuNS9 ignore_case_param ic {} normal find_last boost/url/params_base.hpp include/boost/url/params_base.hpp 527 5 function 4473YZ5UmH9eUXSJ4YKAY3g2cAwE public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw text is passed here, the comparison is case-insensitive. ic named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator before named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core key named identifier wxnor5Tun8FXFjfB7Jm4ghwuNS9 ignore_case_param ic {} normal get_or boost/url/params_base.hpp include/boost/url/params_base.hpp 349 5 function N5MpsfkLUThQwuAT2reGDy86cPj public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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 named identifier 2A6bDeBwiisGpHzTYMLSbQTSaSa3 string identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core key named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core value {} named identifier wxnor5Tun8FXFjfB7Jm4ghwuNS9 ignore_case_param ic {} normal insert boost/url/params_ref.hpp include/boost/url/params_ref.hpp 488 5 boost/url/params_ref.hpp include/boost/url/params_ref.hpp 525 5 boost/url/params_ref.hpp include/boost/url/params_ref.hpp 568 5 overloads 47QYjmhVd243a98j6KhXuGabCp17 public regular 4MtPiWDytNMbqCE6iciHidLK5Y4c 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 TidqtE4YzVqepooScvNbAzu8i9P 2vtxfpCxddmHM3vu6nu58zYJhFur 2ETJ36SWmWBuN6MBNmQZueNUPLXD named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator insert boost/url/params_ref.hpp include/boost/url/params_ref.hpp 525 5 function TidqtE4YzVqepooScvNbAzu8i9P public regular 4MtPiWDytNMbqCE6iciHidLK5Y4c 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 named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator before named specialization 474HF6bGJmJntnocv1iPAYL2crja initializer_list identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std type named identifier AbvEAFQMtFaLMVMSA2NZ5D5a7nN param_view init normal insert boost/url/params_ref.hpp include/boost/url/params_ref.hpp 488 5 function 2vtxfpCxddmHM3vu6nu58zYJhFur public regular 4MtPiWDytNMbqCE6iciHidLK5Y4c 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 named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator before lvalue-reference named identifier AbvEAFQMtFaLMVMSA2NZ5D5a7nN param_view p normal insert boost/url/params_ref.hpp include/boost/url/params_ref.hpp 568 5 function 2ETJ36SWmWBuN6MBNmQZueNUPLXD public regular 4MtPiWDytNMbqCE6iciHidLK5Y4c 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 named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator before named identifier FwdIt first named identifier FwdIt last normal replace boost/url/params_ref.hpp include/boost/url/params_ref.hpp 700 5 boost/url/params_ref.hpp include/boost/url/params_ref.hpp 736 5 boost/url/params_ref.hpp include/boost/url/params_ref.hpp 779 5 overloads 36Bxc5VrfWHXcA8RfVvPRCjyqaBZ public regular 4MtPiWDytNMbqCE6iciHidLK5Y4c 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 45WNjMTRH43w6sA9qeh8QbGb2RFc 3WKJ9KUUdECGGzAxoetCriRWirQ9 ERYrmN4ApUPEbHxSYL1QB7g7GYa named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator replace boost/url/params_ref.hpp include/boost/url/params_ref.hpp 700 5 function 45WNjMTRH43w6sA9qeh8QbGb2RFc public regular 4MtPiWDytNMbqCE6iciHidLK5Y4c 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 named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator pos lvalue-reference named identifier AbvEAFQMtFaLMVMSA2NZ5D5a7nN param_view p normal replace boost/url/params_ref.hpp include/boost/url/params_ref.hpp 736 5 function 3WKJ9KUUdECGGzAxoetCriRWirQ9 public regular 4MtPiWDytNMbqCE6iciHidLK5Y4c 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 named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator from named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator to named specialization 474HF6bGJmJntnocv1iPAYL2crja initializer_list identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std type named identifier AbvEAFQMtFaLMVMSA2NZ5D5a7nN param_view init normal replace boost/url/params_ref.hpp include/boost/url/params_ref.hpp 779 5 function ERYrmN4ApUPEbHxSYL1QB7g7GYa public regular 4MtPiWDytNMbqCE6iciHidLK5Y4c 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 named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator from named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator to named identifier FwdIt first named identifier FwdIt last normal set boost/url/params_ref.hpp include/boost/url/params_ref.hpp 857 5 boost/url/params_ref.hpp include/boost/url/params_ref.hpp 919 5 overloads 4Vw9uoKMswhNjvgKmfDWh5qGJNNr public regular 4MtPiWDytNMbqCE6iciHidLK5Y4c 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw text is passed here, the comparison is case-insensitive. ic normal 37weZq3epfcdehWw6CAqcx8Qmr7T EG4SGMEqhdyAFNpFmiGzfUJm91p named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator set boost/url/params_ref.hpp include/boost/url/params_ref.hpp 857 5 function 37weZq3epfcdehWw6CAqcx8Qmr7T public regular 4MtPiWDytNMbqCE6iciHidLK5Y4c 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 named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator pos named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core value normal set boost/url/params_ref.hpp include/boost/url/params_ref.hpp 919 5 function EG4SGMEqhdyAFNpFmiGzfUJm91p public regular 4MtPiWDytNMbqCE6iciHidLK5Y4c 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw text is passed here, the comparison is case-insensitive. ic named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core key named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core value named identifier wxnor5Tun8FXFjfB7Jm4ghwuNS9 ignore_case_param ic {} normal size boost/url/params_base.hpp include/boost/url/params_base.hpp 214 5 function 3cu9cFBD5WP4ojAFLBpo7112FDaY public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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. named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std normal unset boost/url/params_ref.hpp include/boost/url/params_ref.hpp 819 5 function 2zcijxKxW7QPxyGqg7mJThLU3yDy public regular 4MtPiWDytNMbqCE6iciHidLK5Y4c 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 named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator pos normal url boost/url/params_ref.hpp include/boost/url/params_ref.hpp 259 5 function 4Adfpj3Tm9GbDEsHDmChQRFwRfFi public regular 4MtPiWDytNMbqCE6iciHidLK5Y4c 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. lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base normal operator params_view boost/url/params_ref.hpp include/boost/url/params_ref.hpp 231 5 function nBhem7FoKm8zGZnn3Phqme6aRek public regular 4MtPiWDytNMbqCE6iciHidLK5Y4c brief text Conversion returns text A view of the query parameters. named identifier DJiFqyFR7zZh4N3HNJHhiAj7JPV params_view conversion max_size boost/url/params_base.hpp include/boost/url/params_base.hpp 150 5 function W7WP55a9DuMT6FQHq6d3TMDZTEN public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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. named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std normal constexpr static params_view boost/url/params_view.hpp include/boost/url/params_view.hpp 43 1 boost/url/params_ref.hpp include/boost/url/params_ref.hpp 25 1 record DJiFqyFR7zZh4N3HNJHhiAj7JPV regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 other __visibility__ class named identifier 3JqzyR89pExMFqZFBHMskoM3dq3x params_base public 49BBGFSd4SwAURZeuhCEaXediDdJ 4Xx9vtbkyrMRFcX6dhA9EuNpA3hu 49oR6EqtkFRr1Bymk1w9Wz9yWMU6 4MJtyAXahb7x3kuqnzTyFU8wPji6 2ZncUdqXP51Rm1SVMvHxcE2G3h2m 4Z4sBT8FxThQJcHVk3coS2ZWnmTU 3oTHdL6t3btXiKHXYW3XMLhdvCqQ 2Wpc22YAD6efVMHoXW9GPNRXPLoV 2xGXwYp6mNYyHMVXFVfpuNa4enRP 3RbyBkqnvV8MJE9umvacbDCDfXmJ 2bbRcPd3jX9CTnvkFxyySAzaF4kU 4VMZSzQLL4cKY2HBoL5TdKXCfAtf 22CityYzMdoqGjqEahCAgKi4GQxB 2BjCAZiyHaKPriQ6mfRsjEksN6sK kEewuBi8Kzmh3TFtMfP7sjLTQ6m 4YX5so5aQEEJZd3tjTDpYj1qTiph 23uLeb7cygRQRPeonrUfhp87YPgi N5MpsfkLUThQwuAT2reGDy86cPj 3cu9cFBD5WP4ojAFLBpo7112FDaY W7WP55a9DuMT6FQHq6d3TMDZTEN 3LBvpy1qNY7K14cuPUkGzN2k87Ua named identifier 4MtPiWDytNMbqCE6iciHidLK5Y4c params_ref 4MtPiWDytNMbqCE6iciHidLK5Y4c named identifier 3w4FJjjADY3EEHqUmBj5mvDKqdEB params_encoded_view 3w4FJjjADY3EEHqUmBj5mvDKqdEB named identifier 27ryuyAvvRyzfzgketja5uQcFBcK url_view_base 27ryuyAvvRyzfzgketja5uQcFBcK const_iterator boost/url/params_base.hpp include/boost/url/params_base.hpp 94 5 typedef 49BBGFSd4SwAURZeuhCEaXediDdJ public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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 named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator const_reference boost/url/params_base.hpp include/boost/url/params_base.hpp 123 5 typedef 4Xx9vtbkyrMRFcX6dhA9EuNpA3hu public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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 AbvEAFQMtFaLMVMSA2NZ5D5a7nN text . named identifier 2mSdVJKVJxHo9zo74jwzBLgs2Scz param difference_type boost/url/params_base.hpp include/boost/url/params_base.hpp 131 5 typedef 49oR6EqtkFRr1Bymk1w9Wz9yWMU6 public regular 3JqzyR89pExMFqZFBHMskoM3dq3x brief text A signed integer type used to represent differences. named identifier EKxMGCxxySWyqBbWqvvL9j9KhWv ptrdiff_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std reference boost/url/params_base.hpp include/boost/url/params_base.hpp 120 5 typedef 4MJtyAXahb7x3kuqnzTyFU8wPji6 public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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 AbvEAFQMtFaLMVMSA2NZ5D5a7nN text . named identifier 2mSdVJKVJxHo9zo74jwzBLgs2Scz param size_type boost/url/params_base.hpp include/boost/url/params_base.hpp 127 5 typedef 2ZncUdqXP51Rm1SVMvHxcE2G3h2m public regular 3JqzyR89pExMFqZFBHMskoM3dq3x brief text An unsigned integer type to represent sizes. named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std value_type boost/url/params_base.hpp include/boost/url/params_base.hpp 110 5 typedef 4Z4sBT8FxThQJcHVk3coS2ZWnmTU public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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 2mSdVJKVJxHo9zo74jwzBLgs2Scz text . named identifier 2mSdVJKVJxHo9zo74jwzBLgs2Scz param 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 record 3oTHdL6t3btXiKHXYW3XMLhdvCqQ public see-below DJiFqyFR7zZh4N3HNJHhiAj7JPV 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 other __visibility__ class named identifier 4MtPiWDytNMbqCE6iciHidLK5Y4c params_ref 4MtPiWDytNMbqCE6iciHidLK5Y4c named identifier 3JqzyR89pExMFqZFBHMskoM3dq3x params_base 3JqzyR89pExMFqZFBHMskoM3dq3x params_view boost/url/params_view.hpp include/boost/url/params_view.hpp 76 5 boost/url/params_view.hpp include/boost/url/params_view.hpp 131 5 boost/url/params_view.hpp include/boost/url/params_view.hpp 186 5 boost/url/params_view.hpp include/boost/url/params_view.hpp 252 5 overloads 2Wpc22YAD6efVMHoXW9GPNRXPLoV public regular DJiFqyFR7zZh4N3HNJHhiAj7JPV 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 412Zy6tqmcjofUzsConz7tiCYTYD 32m84NzntvWjFhCsNswRLYxSGTbX 3A7ccoHbmc5egjQNEHZbUo62Myts ui6qbdN9WSSEbmYjct6xCvQFsKy RGLcfStmkLPZmHCYsvG4GK2Fo4J named identifier void void params_view boost/url/params_view.hpp include/boost/url/params_view.hpp 76 5 function 412Zy6tqmcjofUzsConz7tiCYTYD public regular DJiFqyFR7zZh4N3HNJHhiAj7JPV 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 named identifier void void constructor params_view boost/url/params_view.hpp include/boost/url/params_view.hpp 101 5 function 32m84NzntvWjFhCsNswRLYxSGTbX public regular DJiFqyFR7zZh4N3HNJHhiAj7JPV 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 named identifier void void lvalue-reference named identifier DJiFqyFR7zZh4N3HNJHhiAj7JPV params_view other constructor constexpr params_view boost/url/params_view.hpp include/boost/url/params_view.hpp 186 5 function 3A7ccoHbmc5egjQNEHZbUo62Myts public regular DJiFqyFR7zZh4N3HNJHhiAj7JPV 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 named identifier void void named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s constructor params_view boost/url/params_view.hpp include/boost/url/params_view.hpp 252 5 function ui6qbdN9WSSEbmYjct6xCvQFsKy public regular DJiFqyFR7zZh4N3HNJHhiAj7JPV 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 5dyN7z5egGMdJFpXz9WbaL549xC 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 named identifier void void named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s named identifier 5dyN7z5egGMdJFpXz9WbaL549xC encoding_opts opt constructor params_view boost/url/params_view.hpp include/boost/url/params_view.hpp 131 5 function RGLcfStmkLPZmHCYsvG4GK2Fo4J public regular DJiFqyFR7zZh4N3HNJHhiAj7JPV paragraph text After construction both views will reference the same character buffer but this instance will use the specified reference encoding_opts 5dyN7z5egGMdJFpXz9WbaL549xC 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 named identifier void void lvalue-reference named identifier DJiFqyFR7zZh4N3HNJHhiAj7JPV params_view other named identifier 5dyN7z5egGMdJFpXz9WbaL549xC encoding_opts opt constructor operator= boost/url/params_view.hpp include/boost/url/params_view.hpp 280 5 function 2xGXwYp6mNYyHMVXFVfpuNa4enRP public regular DJiFqyFR7zZh4N3HNJHhiAj7JPV 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 lvalue-reference named identifier DJiFqyFR7zZh4N3HNJHhiAj7JPV params_view lvalue-reference named identifier DJiFqyFR7zZh4N3HNJHhiAj7JPV params_view other normal = begin boost/url/params_base.hpp include/boost/url/params_base.hpp 227 5 function 3RbyBkqnvV8MJE9umvacbDCDfXmJ public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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. named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator normal buffer boost/url/params_base.hpp include/boost/url/params_base.hpp 178 5 function 2bbRcPd3jX9CTnvkFxyySAzaF4kU public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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. named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal contains boost/url/params_base.hpp include/boost/url/params_base.hpp 275 5 function 4VMZSzQLL4cKY2HBoL5TdKXCfAtf public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw text is passed here, the comparison is case-insensitive. ic named identifier bool bool named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core key named identifier wxnor5Tun8FXFjfB7Jm4ghwuNS9 ignore_case_param ic {} normal count boost/url/params_base.hpp include/boost/url/params_base.hpp 311 5 function 22CityYzMdoqGjqEahCAgKi4GQxB public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw text is passed here, the comparison is case-insensitive. ic named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core key named identifier wxnor5Tun8FXFjfB7Jm4ghwuNS9 ignore_case_param ic {} normal empty boost/url/params_base.hpp include/boost/url/params_base.hpp 196 5 function 2BjCAZiyHaKPriQ6mfRsjEksN6sK public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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. named identifier bool bool normal end boost/url/params_base.hpp include/boost/url/params_base.hpp 240 5 function kEewuBi8Kzmh3TFtMfP7sjLTQ6m public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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. named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator normal find boost/url/params_base.hpp include/boost/url/params_base.hpp 395 5 boost/url/params_base.hpp include/boost/url/params_base.hpp 440 5 overloads 4YX5so5aQEEJZd3tjTDpYj1qTiph public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw 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 38kjLuKfKDsmR9uPZmR6KNCgpHnA wubrUDNmf4xbT2BGw857MB7xkZG named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator find boost/url/params_base.hpp include/boost/url/params_base.hpp 395 5 function 38kjLuKfKDsmR9uPZmR6KNCgpHnA public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw text is passed here, the comparison is case-insensitive. ic named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core key named identifier wxnor5Tun8FXFjfB7Jm4ghwuNS9 ignore_case_param ic {} normal find boost/url/params_base.hpp include/boost/url/params_base.hpp 440 5 function wubrUDNmf4xbT2BGw857MB7xkZG public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw text is passed here, the comparison is case-insensitive. ic named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator from named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core key named identifier wxnor5Tun8FXFjfB7Jm4ghwuNS9 ignore_case_param ic {} normal find_last boost/url/params_base.hpp include/boost/url/params_base.hpp 481 5 boost/url/params_base.hpp include/boost/url/params_base.hpp 527 5 overloads 23uLeb7cygRQRPeonrUfhp87YPgi public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw 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 27RGcRUEoQPCWUEANTx9RwTXGMAP 4473YZ5UmH9eUXSJ4YKAY3g2cAwE named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator find_last boost/url/params_base.hpp include/boost/url/params_base.hpp 481 5 function 27RGcRUEoQPCWUEANTx9RwTXGMAP public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw text is passed here, the comparison is case-insensitive. ic named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core key named identifier wxnor5Tun8FXFjfB7Jm4ghwuNS9 ignore_case_param ic {} normal find_last boost/url/params_base.hpp include/boost/url/params_base.hpp 527 5 function 4473YZ5UmH9eUXSJ4YKAY3g2cAwE public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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 3qSXNyNHTb9MsSXvAjVCvfvrgLhw text is passed here, the comparison is case-insensitive. ic named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator named identifier 399FQ6KddUL8ZnrPLHJUSZf1JvgB iterator before named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core key named identifier wxnor5Tun8FXFjfB7Jm4ghwuNS9 ignore_case_param ic {} normal get_or boost/url/params_base.hpp include/boost/url/params_base.hpp 349 5 function N5MpsfkLUThQwuAT2reGDy86cPj public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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 named identifier 2A6bDeBwiisGpHzTYMLSbQTSaSa3 string identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core key named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core value {} named identifier wxnor5Tun8FXFjfB7Jm4ghwuNS9 ignore_case_param ic {} normal size boost/url/params_base.hpp include/boost/url/params_base.hpp 214 5 function 3cu9cFBD5WP4ojAFLBpo7112FDaY public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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. named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std normal max_size boost/url/params_base.hpp include/boost/url/params_base.hpp 150 5 function W7WP55a9DuMT6FQHq6d3TMDZTEN public regular 3JqzyR89pExMFqZFBHMskoM3dq3x 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. named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std normal constexpr static pct_string_view boost/url/pct_string_view.hpp include/boost/url/pct_string_view.hpp 61 1 boost/url/pct_string_view.hpp include/boost/url/pct_string_view.hpp 33 1 record 3ZY5EydXePv2wNz8JPvc5skA7Bn4 regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 named identifier 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X string_view_base identifier 3xgiPUvbkGK69EKtHNfc9suQevEU grammar public iu52vYftQmJn1PS1RcSWttFd9Un xiTt94SbvEH2kbjbMpH8WZbQAhW 2mEj2svtYXg7jX6i7oRLojMzJyfp 2bRQYvMUah4389d6W7enWHgtN3to 2egfdMDV7XURYLoer6VrajrTGWc9 3feB3yppXbbiFh3NPph59rr47dQy 2oow5byAtxv1W9Nu8nn9Pm3As1Zd 41bb3NAKvXikNUMhiiA8fbwcXJWE 419t88FFA6k47RNxBPvr5ZfdzmH7 2TEvHxNTwZk6az6p4h27DHQeFPDQ 4Vh4T7xycjcrtiiUz5m6umX2uRWH 2Yv4wXVZTSDCne1Rr76buU44biy8 Mnz5qnBKpt2ymWoNCD2kPHTJbiJ 2eDkrxcFMFxgkhXvo8m74QMY9i6R 3Bs82iRZxMbpBJmUXEVWRK1EoRvi MAYuqDbxMuYRh5wEJsU5FztQaFy FEWyvP5VVCNhTET4ojFmWdrNQt4 3m3wxpjnbYX7ZMjb66QcLMjYpQqt zUJYGoXHAhBavAZx8H7Zq81CN2p 2QdMhgiG7Dv6upJxA6AYimx8jzR7 3LJN4b2WcEsbN5apJXGd2qaiTvAd gc13YUZ5g64b6AHPgnJm43PwWAA 3ku9J4TN7sd9d8Ejobe1Z8eY8Tpu 3xSNSFtYpeucRYj8Lm5YNn7jLGb4 QcD8XHXPNpVQzGUJMdHAagLVDac QZo8joeLrA5C6aB7d2ANQLUCTbu Wk9yDfbc9KRKvJXkvsKiNKKdaih praD3b8JGYJMoVcBhRkngVk4Bgr 36aDYSkKPWqbsj9EQnTDu5AhFL88 3CgRRJVwNs9JenuDCGpaZxYADAsQ 4F7aWUmwH44NPw6vhvocufTExL2b Nva2waUPv2F7odVi5VpPZTJXjSS 214bwQkfpzhQ2vMw6gA4M97itn2d sJwdQ3VSugDWA1BGkxWxv7Cxt2w 3U9YFTNsEghj7N1pNuoyuLoZdjGm LXiRcWmUiTXoN7uKbWYemES1zmJ RYCNCvPhXuBoLBAs5AH4ASxNpnx wGzcw5BL1efm1mk6pq6nPmoZkRS wwtEYBe9yCR9Ss5FFC7nFQb54ex u994LufNDUVooZFojPvjugESqiY 4NADkGKvVJkngAQ6XfX2pSuPqFJg fCtPDkAHyYcmdMyXkd9i7J2vECV yR13aMBqwcRTjvDjKmrSVdorYp5 2GvVXid3fpBKQ4D7kLzCRrRdUHaY 2JpJjEsnBhnTZsbJ55h8BqSdozdK eAQNszB5neak8eCFeULLpdz1dBR 38iQFzsQfEfXUvQU4E1KU7cb3rAB 3Tg7o3sU2Pekf5y5qseivSjJEjPS 2X9fFvHm8CHy89mguA6sEudtNmQD 4EWyYXRZot7yKvPTXVF7VemKcqLa 2VYZiE2XGTu7izsSch6CFaDYCUo2 2TSxWDzCSsTHCCbfDU3TCWWXwszk 3qWcEm1E5JQvVH7xZmPSo6XNwSDQ 2ztoKkfV7H8rMnxSoUTTp4HtmeER 39Smh5do547A49AGGeWYMFmMKD3e const_iterator boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 111 5 typedef iu52vYftQmJn1PS1RcSWttFd9Un public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X brief text The const iterator type pointer named identifier char char const_pointer boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 105 5 typedef xiTt94SbvEH2kbjbMpH8WZbQAhW public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X brief text The const pointer type pointer named identifier char char const_reference boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 109 5 typedef 2mEj2svtYXg7jX6i7oRLojMzJyfp public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X brief text The const reference type lvalue-reference named identifier char char const_reverse_iterator boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 115 5 typedef 2bRQYvMUah4389d6W7enWHgtN3to public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X brief text The const reverse iterator type named specialization oeEbbwRjJeyrgiT2YFUz4wpmV5r reverse_iterator identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std type named identifier iu52vYftQmJn1PS1RcSWttFd9Un const_iterator difference_type boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 122 5 typedef 2egfdMDV7XURYLoer6VrajrTGWc9 public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X brief text The difference type named identifier EKxMGCxxySWyqBbWqvvL9j9KhWv ptrdiff_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std iterator boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 113 5 typedef 3feB3yppXbbiFh3NPph59rr47dQy public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X brief text The iterator type named identifier iu52vYftQmJn1PS1RcSWttFd9Un const_iterator pointer boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 103 5 typedef 2oow5byAtxv1W9Nu8nn9Pm3As1Zd public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X brief text The pointer type pointer named identifier char char reference boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 107 5 typedef 41bb3NAKvXikNUMhiiA8fbwcXJWE public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X brief text The reference type lvalue-reference named identifier char char reverse_iterator boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 118 5 typedef 419t88FFA6k47RNxBPvr5ZfdzmH7 public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X brief text The reverse iterator type named identifier 2bRQYvMUah4389d6W7enWHgtN3to const_reverse_iterator size_type boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 120 5 typedef 2TEvHxNTwZk6az6p4h27DHQeFPDQ public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X brief text The size type named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std traits_type boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 99 5 typedef 4Vh4T7xycjcrtiiUz5m6umX2uRWH public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X brief text The character traits named specialization char_traits identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std type named identifier char char value_type boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 101 5 typedef 2Yv4wXVZTSDCne1Rr76buU44biy8 public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X brief text The value type named identifier char char pct_string_view boost/url/pct_string_view.hpp include/boost/url/pct_string_view.hpp 107 5 boost/url/pct_string_view.hpp include/boost/url/pct_string_view.hpp 234 5 overloads Mnz5qnBKpt2ymWoNCD2kPHTJbiJ public regular 3ZY5EydXePv2wNz8JPvc5skA7Bn4 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 7B2LXXMuTdFjAkh9gnVHvw5BzEN 2iJ7xGkrABmXjYw9KLc3g4igcPjS 4XZYvYuH74btUy2yHEEEtdJxvQDZ 3xp4VCbb2TQ6zenprRKxTQUwhEKa 3muKXDFEVmMSRXDn3iULqs4oxPdn 2RpQH1U5WEsEnGgRnghhp2FAD4BN named identifier void void pct_string_view boost/url/pct_string_view.hpp include/boost/url/pct_string_view.hpp 107 5 function 7B2LXXMuTdFjAkh9gnVHvw5BzEN public regular 3ZY5EydXePv2wNz8JPvc5skA7Bn4 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 named identifier void void constructor constexpr pct_string_view boost/url/pct_string_view.hpp include/boost/url/pct_string_view.hpp 129 5 function 2iJ7xGkrABmXjYw9KLc3g4igcPjS public regular 3ZY5EydXePv2wNz8JPvc5skA7Bn4 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 named identifier void void lvalue-reference named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view other constructor constexpr pct_string_view boost/url/pct_string_view.hpp include/boost/url/pct_string_view.hpp 177 5 function 4XZYvYuH74btUy2yHEEEtdJxvQDZ public regular 3ZY5EydXePv2wNz8JPvc5skA7Bn4 brief text Constructor (deleted) param text The object to construct from value named identifier void void named identifier 3UruDatmFgHZgtqL9Fjv6YTVueUx nullptr_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std value constructor pct_string_view boost/url/pct_string_view.hpp include/boost/url/pct_string_view.hpp 234 5 function 3xp4VCbb2TQ6zenprRKxTQUwhEKa public regular 3ZY5EydXePv2wNz8JPvc5skA7Bn4 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 named identifier void void named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s constructor pct_string_view boost/url/pct_string_view.hpp include/boost/url/pct_string_view.hpp 157 5 function 3muKXDFEVmMSRXDn3iULqs4oxPdn public regular 3ZY5EydXePv2wNz8JPvc5skA7Bn4 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 named identifier void void lvalue-reference named identifier String s constructor constexpr pct_string_view boost/url/pct_string_view.hpp include/boost/url/pct_string_view.hpp 203 5 function 2RpQH1U5WEsEnGgRnghhp2FAD4BN public regular 3ZY5EydXePv2wNz8JPvc5skA7Bn4 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 named identifier void void pointer named identifier char char s named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std len constructor operator= boost/url/pct_string_view.hpp include/boost/url/pct_string_view.hpp 257 5 function 2eDkrxcFMFxgkhXvo8m74QMY9i6R public regular 3ZY5EydXePv2wNz8JPvc5skA7Bn4 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 lvalue-reference named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view lvalue-reference named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view other normal constexpr = at boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 331 5 function 3Bs82iRZxMbpBJmUXEVWRK1EoRvi public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2mEj2svtYXg7jX6i7oRLojMzJyfp const_reference named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos normal constexpr back boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 355 5 function MAYuqDbxMuYRh5wEJsU5FztQaFy public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X paragraph text See code text core::string_view::back brief text Return the last character returns text The last character named identifier 2mEj2svtYXg7jX6i7oRLojMzJyfp const_reference normal constexpr begin boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 177 5 function FEWyvP5VVCNhTET4ojFmWdrNQt4 public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X paragraph text See code text core::string_view::begin brief text Return an iterator to the beginning returns text An iterator to the beginning named identifier iu52vYftQmJn1PS1RcSWttFd9Un const_iterator normal constexpr cbegin boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 199 5 function 3m3wxpjnbYX7ZMjb66QcLMjYpQqt public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X paragraph text See code text core::string_view::cbegin brief text Return an iterator to the beginning returns text An iterator to the beginning named identifier iu52vYftQmJn1PS1RcSWttFd9Un const_iterator normal constexpr cend boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 210 5 function zUJYGoXHAhBavAZx8H7Zq81CN2p public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X paragraph text See code text core::string_view::cend brief text Return an iterator to the end returns text An iterator to the end named identifier iu52vYftQmJn1PS1RcSWttFd9Un const_iterator normal constexpr compare boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 413 5 overloads 2QdMhgiG7Dv6upJxA6AYimx8jzR7 public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 TkhPQ4193qtgMyQbnmTFyjkzBZV 2aAsqByw2BkZTHZhrEv2JC9ZuArr 3LbPyToLQhxmgXaqddvAsCWnwhyr 3UEqPVxZTWonSN2i7cPt4EK8y6N4 3hRC6BNUMHgwL1csdkZJStzuM2FJ 49egxgmDEe7Npx59PH8SDWBtdpWm named identifier int int compare boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 413 5 function TkhPQ4193qtgMyQbnmTFyjkzBZV public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier int int named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core str normal constexpr compare boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 459 5 function 2aAsqByw2BkZTHZhrEv2JC9ZuArr public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier int int pointer named identifier char char s normal constexpr compare boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 428 5 function 3LbPyToLQhxmgXaqddvAsCWnwhyr public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier int int named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos1 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type n1 named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core str normal constexpr compare boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 474 5 function 3UEqPVxZTWonSN2i7cPt4EK8y6N4 public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier int int named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos1 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type n1 pointer named identifier char char s normal constexpr compare boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 490 5 function 3hRC6BNUMHgwL1csdkZJStzuM2FJ public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier int int named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos1 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type n1 pointer named identifier char char s named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type n2 normal constexpr compare boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 445 5 function 49egxgmDEe7Npx59PH8SDWBtdpWm public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier int int named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos1 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type n1 named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core str named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos2 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type n2 normal constexpr contains boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 942 5 overloads 3LJN4b2WcEsbN5apJXGd2qaiTvAd public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 21BxtJf3cBK68gwPEy8W3r9sqWLt 2rCUcf4H9EkdztkRThYQVkq9Pm3K gtse3xJZKNmgTL3u5JSeDpAaPaG named identifier bool bool contains boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 954 5 function 21BxtJf3cBK68gwPEy8W3r9sqWLt public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier bool bool named identifier char char c normal constexpr contains boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 942 5 function 2rCUcf4H9EkdztkRThYQVkq9Pm3K public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier bool bool named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core sv normal constexpr contains boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 966 5 function gtse3xJZKNmgTL3u5JSeDpAaPaG public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier bool bool pointer named identifier char char s normal constexpr copy boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 384 5 function gc13YUZ5g64b6AHPgnJm43PwWAA public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pointer named identifier char char s named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type n named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos 0 normal constexpr crbegin boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 245 5 function 3ku9J4TN7sd9d8Ejobe1Z8eY8Tpu public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2bRQYvMUah4389d6W7enWHgtN3to const_reverse_iterator normal constexpr crend boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 257 5 function 3xSNSFtYpeucRYj8Lm5YNn7jLGb4 public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2bRQYvMUah4389d6W7enWHgtN3to const_reverse_iterator normal constexpr data boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 367 5 function QcD8XHXPNpVQzGUJMdHAagLVDac public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier xiTt94SbvEH2kbjbMpH8WZbQAhW const_pointer normal constexpr decode boost/url/pct_string_view.hpp include/boost/url/pct_string_view.hpp 345 5 function QZo8joeLrA5C6aB7d2ANQLUCTbu public regular 3ZY5EydXePv2wNz8JPvc5skA7Bn4 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 5dyN7z5egGMdJFpXz9WbaL549xC text , reference string_token::return_string 4UumWzLNRv3vgTVdDkz5PVqdSsSL text . named identifier result_type identifier StringToken named identifier 5dyN7z5egGMdJFpXz9WbaL549xC encoding_opts opt {} rvalue-reference named identifier StringToken token normal decoded_size boost/url/pct_string_view.hpp include/boost/url/pct_string_view.hpp 283 5 function Wk9yDfbc9KRKvJXkvsKiNKKdaih public regular 3ZY5EydXePv2wNz8JPvc5skA7Bn4 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. named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std normal constexpr empty boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 304 5 function praD3b8JGYJMoVcBhRkngVk4Bgr public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier bool bool normal constexpr end boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 188 5 function 36aDYSkKPWqbsj9EQnTDu5AhFL88 public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X paragraph text See code text core::string_view::end brief text Return an iterator to the end returns text An iterator to the end named identifier iu52vYftQmJn1PS1RcSWttFd9Un const_iterator normal constexpr ends_with boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 547 5 overloads 3CgRRJVwNs9JenuDCGpaZxYADAsQ public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 2YRXJqqPm54KfxZag3rq66QPDqaS 3N2RaDeogpteHRrK4L4LXLigNK9C 3sRYWdi26VfPmzSoQsVxagyYDTu9 named identifier bool bool ends_with boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 560 5 function 2YRXJqqPm54KfxZag3rq66QPDqaS public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier bool bool named identifier char char x normal constexpr ends_with boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 547 5 function 3N2RaDeogpteHRrK4L4LXLigNK9C public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier bool bool named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core x normal constexpr ends_with boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 573 5 function 3sRYWdi26VfPmzSoQsVxagyYDTu9 public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier bool bool pointer named identifier char char x normal constexpr find boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 589 5 overloads 4F7aWUmwH44NPw6vhvocufTExL2b public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 4yb8kt3deCqDXs5YVXRxgnnyPjo 43RuGCpKgaqiQX4ZmzmjDtoSTVWP 3mSht8URmvuPrepbFLECUD9SK1yn 2eUJVta5CpXKWffHTpJZBw3xVWVk named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type find boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 603 5 function 4yb8kt3deCqDXs5YVXRxgnnyPjo public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type named identifier char char c named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos 0 normal constexpr find boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 589 5 function 43RuGCpKgaqiQX4ZmzmjDtoSTVWP public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core str named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos 0 normal constexpr find boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 632 5 function 3mSht8URmvuPrepbFLECUD9SK1yn public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pointer named identifier char char s named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos 0 normal constexpr find boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 618 5 function 2eUJVta5CpXKWffHTpJZBw3xVWVk public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pointer named identifier char char s named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type n normal constexpr find_first_not_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 825 5 overloads Nva2waUPv2F7odVi5VpPZTJXjSS public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 USp9fg3t572bTPCSe4dCxWSFMvT 4CkGLjXsrJSTXhMyWWioD939oWSZ 3i55mVTYmmdqw4eW7srmy3y84fHm 3NHxkPRZ9jPF1f3pzh5GJ8RYRY9b named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type find_first_not_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 839 5 function USp9fg3t572bTPCSe4dCxWSFMvT public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type named identifier char char c named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos 0 normal constexpr find_first_not_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 825 5 function 4CkGLjXsrJSTXhMyWWioD939oWSZ public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core str named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos 0 normal constexpr find_first_not_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 868 5 function 3i55mVTYmmdqw4eW7srmy3y84fHm public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pointer named identifier char char s named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos 0 normal constexpr find_first_not_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 854 5 function 3NHxkPRZ9jPF1f3pzh5GJ8RYRY9b public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pointer named identifier char char s named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type n normal constexpr find_first_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 707 5 overloads 214bwQkfpzhQ2vMw6gA4M97itn2d public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 25q54qiNK6RZE478TK2vV1MrVsZb 3PmCH2t4QrC5m1RsQiwAJmGWyyf6 2wWfNaGCLZXRAXGN7mtTwrBzcnoZ 3SqgCkTVYTTD4csNCR46R3XUQKCV named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type find_first_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 721 5 function 25q54qiNK6RZE478TK2vV1MrVsZb public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type named identifier char char c named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos 0 normal constexpr find_first_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 707 5 function 3PmCH2t4QrC5m1RsQiwAJmGWyyf6 public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core str named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos 0 normal constexpr find_first_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 750 5 function 2wWfNaGCLZXRAXGN7mtTwrBzcnoZ public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pointer named identifier char char s named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos 0 normal constexpr find_first_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 736 5 function 3SqgCkTVYTTD4csNCR46R3XUQKCV public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pointer named identifier char char s named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type n normal constexpr find_last_not_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 884 5 overloads sJwdQ3VSugDWA1BGkxWxv7Cxt2w public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 41YeoGAsWCsuHvJB2aLY8hMDkiMF kcriTnxockbDNC5HRP6aE1SPtmj 2QbTSEJcxznx1s2ro3dS5zTQU2Z5 Nm8xeM1V39MyCJH4fM1YEqiBv9H named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type find_last_not_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 898 5 function 41YeoGAsWCsuHvJB2aLY8hMDkiMF public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type named identifier char char c named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos core::string_view::npos normal constexpr find_last_not_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 884 5 function kcriTnxockbDNC5HRP6aE1SPtmj public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core str named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos core::string_view::npos normal constexpr find_last_not_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 927 5 function 2QbTSEJcxznx1s2ro3dS5zTQU2Z5 public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pointer named identifier char char s named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos core::string_view::npos normal constexpr find_last_not_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 913 5 function Nm8xeM1V39MyCJH4fM1YEqiBv9H public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pointer named identifier char char s named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type n normal constexpr find_last_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 766 5 overloads 3U9YFTNsEghj7N1pNuoyuLoZdjGm public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 3nUQboLhVJpLWsA1gRjRh1U17qoD 2HceG3tTfH5hd1qDNwKQYia4nRA 2zqverMTtKR1afXPSDjd12gKkQzH TGakVkEmvA7Z4qhCMrLSxfzFd1w named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type find_last_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 780 5 function 3nUQboLhVJpLWsA1gRjRh1U17qoD public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type named identifier char char c named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos core::string_view::npos normal constexpr find_last_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 766 5 function 2HceG3tTfH5hd1qDNwKQYia4nRA public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core str named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos core::string_view::npos normal constexpr find_last_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 809 5 function 2zqverMTtKR1afXPSDjd12gKkQzH public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pointer named identifier char char s named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos core::string_view::npos normal constexpr find_last_of boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 795 5 function TGakVkEmvA7Z4qhCMrLSxfzFd1w public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pointer named identifier char char s named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type n normal constexpr front boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 343 5 function LXiRcWmUiTXoN7uKbWYemES1zmJ public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X paragraph text See code text core::string_view::front brief text Return the first character returns text The first character named identifier 2mEj2svtYXg7jX6i7oRLojMzJyfp const_reference normal constexpr length boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 282 5 function RYCNCvPhXuBoLBAs5AH4ASxNpnx public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X paragraph text See code text core::string_view::length brief text Return the size returns text The size named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type normal constexpr max_size boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 293 5 function wGzcw5BL1efm1mk6pq6nPmoZkRS public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X paragraph text See code text core::string_view::max_size brief text Return the maximum allowed size returns text The maximum allowed size named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type normal constexpr 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 function wwtEYBe9yCR9Ss5FFC7nFQb54ex public regular 3ZY5EydXePv2wNz8JPvc5skA7Bn4 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 UXcENkB7t9T6PDWy1z6kk8ej8kT text . named identifier UXcENkB7t9T6PDWy1z6kk8ej8kT decode_view normal * operator-> boost/url/pct_string_view.hpp include/boost/url/pct_string_view.hpp 370 5 function u994LufNDUVooZFojPvjugESqiY public regular 3ZY5EydXePv2wNz8JPvc5skA7Bn4 brief text Arrow support returns text A pointer to this object. pointer named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal -> operator[] boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 318 5 function 4NADkGKvVJkngAQ6XfX2pSuPqFJg public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2mEj2svtYXg7jX6i7oRLojMzJyfp const_reference named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos normal constexpr [] rbegin boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 221 5 function fCtPDkAHyYcmdMyXkd9i7J2vECV public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2bRQYvMUah4389d6W7enWHgtN3to const_reverse_iterator normal constexpr rend boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 233 5 function yR13aMBqwcRTjvDjKmrSVdorYp5 public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2bRQYvMUah4389d6W7enWHgtN3to const_reverse_iterator normal constexpr rfind boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 648 5 overloads 2GvVXid3fpBKQ4D7kLzCRrRdUHaY public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 4HV8wLPAYZXWzpi6cZA9nr2wcpHp 4KE8r6umXKHgEvPENarRVqtPZcjr 41MQZv4gtDnTX3TMJdkZ5sNbVmhr 3ck1jep4XReaENvi1E7kAiW7xEQy named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type rfind boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 662 5 function 4HV8wLPAYZXWzpi6cZA9nr2wcpHp public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type named identifier char char c named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos core::string_view::npos normal constexpr rfind boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 648 5 function 4KE8r6umXKHgEvPENarRVqtPZcjr public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core str named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos core::string_view::npos normal constexpr rfind boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 691 5 function 41MQZv4gtDnTX3TMJdkZ5sNbVmhr public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pointer named identifier char char s named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos core::string_view::npos normal constexpr rfind boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 677 5 function 3ck1jep4XReaENvi1E7kAiW7xEQy public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pointer named identifier char char s named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type n normal constexpr size boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 271 5 function 2JpJjEsnBhnTZsbJ55h8BqSdozdK public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X paragraph text See code text core::string_view::size brief text Return the size returns text The size named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type normal constexpr starts_with boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 506 5 overloads eAQNszB5neak8eCFeULLpdz1dBR public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 3fitxjLZ1fx7vynENKBWamRuSupz 2Yz8JhvsoydafkfYmNnUzTaCshi3 3yZitzf11DGVMdFaDNj9BhEiKUeW named identifier bool bool starts_with boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 519 5 function 3fitxjLZ1fx7vynENKBWamRuSupz public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier bool bool named identifier char char x normal constexpr starts_with boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 506 5 function 2Yz8JhvsoydafkfYmNnUzTaCshi3 public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier bool bool named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core x normal constexpr starts_with boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 532 5 function 3yZitzf11DGVMdFaDNj9BhEiKUeW public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier bool bool pointer named identifier char char x normal constexpr substr boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 398 5 function 38iQFzsQfEfXUvQU4E1KU7cb3rAB public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type pos 0 named identifier 2TEvHxNTwZk6az6p4h27DHQeFPDQ size_type n core::string_view::npos normal constexpr swap boost/url/pct_string_view.hpp include/boost/url/pct_string_view.hpp 384 31 function 3Tg7o3sU2Pekf5y5qseivSjJEjPS public regular 3ZY5EydXePv2wNz8JPvc5skA7Bn4 brief text Swap param text The object to swap with s named identifier void void lvalue-reference named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view s normal operator basic_string<char> boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 160 5 function 2X9fFvHm8CHy89mguA6sEudtNmQD public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X 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 named identifier 2A6bDeBwiisGpHzTYMLSbQTSaSa3 string identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std conversion operator basic_string_view<char> boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 133 5 function 4EWyYXRZot7yKvPTXVF7VemKcqLa public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X brief text Conversion returns text A string view with the same contents named identifier 3HPgS7y35hBasNYbXshp29ttUeAe string_view identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std conversion constexpr npos boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 125 5 variable 2VYZiE2XGTu7izsSch6CFaDYCUo2 public regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X brief text A constant used to represent "no position" named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std core::string_view::npos static operator= boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 94 5 function 2TSxWDzCSsTHCCbfDU3TCWWXwszk protected regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X brief text Assignment returns text A reference to this object param text The object to assign other lvalue-reference named identifier 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X string_view_base lvalue-reference named identifier 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X string_view_base other normal constexpr = swap boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 73 5 function 3qWcEm1E5JQvVH7xZmPSo6XNwSDQ protected regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X brief text Swap param text The object to swap with s named identifier void void lvalue-reference named identifier 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X string_view_base s normal s_ boost/url/grammar/string_view_base.hpp include/boost/url/grammar/string_view_base.hpp 41 5 variable 2ztoKkfV7H8rMnxSoUTTp4HtmeER protected regular 2PHD3Y9MrUNUHDSsQ6WtQy5fiM9X brief text The referenced character buffer named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core segments_base boost/url/segments_base.hpp include/boost/url/segments_base.hpp 38 1 record 2ozZGf8LNFZmRaMXAL5TZg2G1emh regular 2ejQGW57K8g7MFJhHAwPt5aumoLa paragraph text Provides the shared decoded path-segment algorithms (iteration, lookup, comparison) used by reference segments_view 2QU7risgZzo8F84g7LttC6dG1GsH text and reference segments_ref 3sLepuFTMctJHoZrLv8tvJTFkDPS text . This base cannot be instantiated directly; instead, use one of the concrete containers below. heading text Containers 1 list paragraph reference segments_ref 3sLepuFTMctJHoZrLv8tvJTFkDPS paragraph reference segments_view 2QU7risgZzo8F84g7LttC6dG1GsH paragraph reference segments_encoded_ref 24XcpKBAcyXN6FLZk8kR4zGAmKak paragraph reference segments_encoded_view GKjeDHooSf2HAMf239p3oFfT3i3 unordered brief text Decoded path segment helper base other __visibility__ class 3sLepuFTMctJHoZrLv8tvJTFkDPS 2QU7risgZzo8F84g7LttC6dG1GsH 3wMHKqNF6d1YX7HEaegmKEXUx1jb VJqeBKHH52hkGqTQ2jJjqQCCAsx 2Q9XnteURWK8gFL8nH2H5tJJBYuA 3p9u5WQ1eRWbDt68F38n8Kpc7Tpf 3PQA5Uiny61SBNLpxRXMFUjHLZET 44brnuMYBwZWzJ16SaCs7ZGgqdFw 3fYKK3ZjraBrPr17gDowH5ka89WM 22utcNVxLypt7iaAVikdi2jEyC8k xQVmR56rEMQRfrRe54uq8J811ob 3fnojGuABPuXRX9fTa2ENXmXFoKs 65eXJr2ZVtrq4HHWS7jmjLV1vCk 3EN1k29zTsCwHHKyi7P75aSr6X9o FEc64aNwXUX5tpSuTGscsH4MLqi PMjHw8XHi2vVH1LumgeaRouzqB4 3nfksnuZPrVHzGyTh2rA3wkq7Z6r 49XMCMWmytdEkqgT8ztZ7EwH9DS6 3ZhK49ZqA8rC7VeSMeSkzGtgy9Hx 4KB6a3GKsLv9v3981bodByeB4sXr 2yq34jhNeKZfnnxPkm1CSdf89tAm named identifier 2QU7risgZzo8F84g7LttC6dG1GsH segments_view 2QU7risgZzo8F84g7LttC6dG1GsH named identifier 3sLepuFTMctJHoZrLv8tvJTFkDPS segments_ref 3sLepuFTMctJHoZrLv8tvJTFkDPS named identifier 27ryuyAvvRyzfzgketja5uQcFBcK url_view_base 27ryuyAvvRyzfzgketja5uQcFBcK const_iterator boost/url/segments_base.hpp include/boost/url/segments_base.hpp 77 5 typedef 3wMHKqNF6d1YX7HEaegmKEXUx1jb public regular 2ozZGf8LNFZmRaMXAL5TZg2G1emh 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 named identifier 3fYKK3ZjraBrPr17gDowH5ka89WM iterator const_reference boost/url/segments_base.hpp include/boost/url/segments_base.hpp 100 5 typedef VJqeBKHH52hkGqTQ2jJjqQCCAsx public regular 2ozZGf8LNFZmRaMXAL5TZg2G1emh paragraph text This is the type of value returned when iterators of the view are dereferenced. brief text The reference type reference named identifier 2A6bDeBwiisGpHzTYMLSbQTSaSa3 string identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std difference_type boost/url/segments_base.hpp include/boost/url/segments_base.hpp 108 5 typedef 2Q9XnteURWK8gFL8nH2H5tJJBYuA public regular 2ozZGf8LNFZmRaMXAL5TZg2G1emh brief text A signed integer type used to represent differences. named identifier EKxMGCxxySWyqBbWqvvL9j9KhWv ptrdiff_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std reference boost/url/segments_base.hpp include/boost/url/segments_base.hpp 97 5 typedef 3p9u5WQ1eRWbDt68F38n8Kpc7Tpf public regular 2ozZGf8LNFZmRaMXAL5TZg2G1emh paragraph text This is the type of value returned when iterators of the view are dereferenced. brief text The reference type named identifier 2A6bDeBwiisGpHzTYMLSbQTSaSa3 string identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std size_type boost/url/segments_base.hpp include/boost/url/segments_base.hpp 104 5 typedef 3PQA5Uiny61SBNLpxRXMFUjHLZET public regular 2ozZGf8LNFZmRaMXAL5TZg2G1emh brief text An unsigned integer type used to represent size. named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std value_type boost/url/segments_base.hpp include/boost/url/segments_base.hpp 90 5 typedef 44brnuMYBwZWzJ16SaCs7ZGgqdFw public regular 2ozZGf8LNFZmRaMXAL5TZg2G1emh 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 named identifier 2A6bDeBwiisGpHzTYMLSbQTSaSa3 string identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std 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 record 3fYKK3ZjraBrPr17gDowH5ka89WM public see-below 2ozZGf8LNFZmRaMXAL5TZg2G1emh 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 named identifier 3sLepuFTMctJHoZrLv8tvJTFkDPS segments_ref 3sLepuFTMctJHoZrLv8tvJTFkDPS named identifier 2ozZGf8LNFZmRaMXAL5TZg2G1emh segments_base 2ozZGf8LNFZmRaMXAL5TZg2G1emh back boost/url/segments_base.hpp include/boost/url/segments_base.hpp 279 5 function 22utcNVxLypt7iaAVikdi2jEyC8k public regular 2ozZGf8LNFZmRaMXAL5TZg2G1emh 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. named identifier 2A6bDeBwiisGpHzTYMLSbQTSaSa3 string identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std normal begin boost/url/segments_base.hpp include/boost/url/segments_base.hpp 293 5 function xQVmR56rEMQRfrRe54uq8J811ob public regular 2ozZGf8LNFZmRaMXAL5TZg2G1emh 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. named identifier 3fYKK3ZjraBrPr17gDowH5ka89WM iterator normal buffer boost/url/segments_base.hpp include/boost/url/segments_base.hpp 155 5 function 3fnojGuABPuXRX9fTa2ENXmXFoKs public regular 2ozZGf8LNFZmRaMXAL5TZg2G1emh 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. named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal empty boost/url/segments_base.hpp include/boost/url/segments_base.hpp 194 5 function 65eXJr2ZVtrq4HHWS7jmjLV1vCk public regular 2ozZGf8LNFZmRaMXAL5TZg2G1emh 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 . named identifier bool bool normal end boost/url/segments_base.hpp include/boost/url/segments_base.hpp 306 5 function 3EN1k29zTsCwHHKyi7P75aSr6X9o public regular 2ozZGf8LNFZmRaMXAL5TZg2G1emh 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. named identifier 3fYKK3ZjraBrPr17gDowH5ka89WM iterator normal front boost/url/segments_base.hpp include/boost/url/segments_base.hpp 246 5 function FEc64aNwXUX5tpSuTGscsH4MLqi public regular 2ozZGf8LNFZmRaMXAL5TZg2G1emh 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. named identifier 2A6bDeBwiisGpHzTYMLSbQTSaSa3 string identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std normal is_absolute boost/url/segments_base.hpp include/boost/url/segments_base.hpp 176 5 function PMjHw8XHi2vVH1LumgeaRouzqB4 public regular 2ozZGf8LNFZmRaMXAL5TZg2G1emh 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 . named identifier bool bool normal size boost/url/segments_base.hpp include/boost/url/segments_base.hpp 212 5 function 3nfksnuZPrVHzGyTh2rA3wkq7Z6r public regular 2ozZGf8LNFZmRaMXAL5TZg2G1emh 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. named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std normal max_size boost/url/segments_base.hpp include/boost/url/segments_base.hpp 127 5 function 49XMCMWmytdEkqgT8ztZ7EwH9DS6 public regular 2ozZGf8LNFZmRaMXAL5TZg2G1emh 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. named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std normal constexpr static segments_encoded_base boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 37 1 record 3P1yc8wQhLivRSyTPUbRYh2dtWLg regular 2ejQGW57K8g7MFJhHAwPt5aumoLa paragraph text Implements the shared encoded-segment algorithms reused by reference segments_encoded_view GKjeDHooSf2HAMf239p3oFfT3i3 text and reference segments_encoded_ref 24XcpKBAcyXN6FLZk8kR4zGAmKak 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 3sLepuFTMctJHoZrLv8tvJTFkDPS paragraph reference segments_view 2QU7risgZzo8F84g7LttC6dG1GsH paragraph reference segments_encoded_ref 24XcpKBAcyXN6FLZk8kR4zGAmKak paragraph reference segments_encoded_view GKjeDHooSf2HAMf239p3oFfT3i3 unordered brief text Percent-encoded path segment helper base other __visibility__ class 24XcpKBAcyXN6FLZk8kR4zGAmKak GKjeDHooSf2HAMf239p3oFfT3i3 6demN3A6frQxCPcuxXRfp3eHA8J 4KLGY7xD5mJkk7z16RshtkGEjutD 3AUqzF441TqDmyc5Dy88PmXY1Avu 4BfkFxFGNFfFfhUnMXe9JdjPLJyZ vgKTDoiDaiPsSjZw6bsQE9r9UiC 282GaAV487J59XKa2YsZAzQLFAi 2qcxFfAmLeEBzgd4uWm7J7K8dZWF 2szTuMjMgM7yHBjYmZXySm5C4jQt 43nBxjPFkQK4n8cxc4xdxNNU43GW 4Lj8kGwjcm8TgFfiN8jy6juj8tR5 Lm7zr8AAGMbux1omg5gViFvc1k7 JNJBBcu5jFftFLVp3Rj4pg66YiK 2WNQyjZ2aqZhXBj5pppBfC2KQhrD 3MYXxb5b2qJks9fgNKeZ2PiKK6Bw 4j3Ut3UFtEAXEow3Puxhyyq1WKU 2bB8EadXpAyGWqW6iKYMtCmLpAKo 3U2A5o9dTNfZWgu9kyxLRAygiYFz 3JiEruUf92nm8Fsyg6S36eXcWnUf 4JUFxN1qYmTcCWgugfa61QbRVppH named identifier GKjeDHooSf2HAMf239p3oFfT3i3 segments_encoded_view GKjeDHooSf2HAMf239p3oFfT3i3 named identifier 24XcpKBAcyXN6FLZk8kR4zGAmKak segments_encoded_ref 24XcpKBAcyXN6FLZk8kR4zGAmKak named identifier 27ryuyAvvRyzfzgketja5uQcFBcK url_view_base 27ryuyAvvRyzfzgketja5uQcFBcK const_iterator boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 79 5 typedef 6demN3A6frQxCPcuxXRfp3eHA8J public regular 3P1yc8wQhLivRSyTPUbRYh2dtWLg 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 named identifier 2qcxFfAmLeEBzgd4uWm7J7K8dZWF iterator const_reference boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 102 5 typedef 4KLGY7xD5mJkk7z16RshtkGEjutD public regular 3P1yc8wQhLivRSyTPUbRYh2dtWLg paragraph text This is the type of value returned when iterators of the view are dereferenced. brief text The reference type reference named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view difference_type boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 110 5 typedef 3AUqzF441TqDmyc5Dy88PmXY1Avu public regular 3P1yc8wQhLivRSyTPUbRYh2dtWLg brief text A signed integer type used to represent differences. named identifier EKxMGCxxySWyqBbWqvvL9j9KhWv ptrdiff_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std reference boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 99 5 typedef 4BfkFxFGNFfFfhUnMXe9JdjPLJyZ public regular 3P1yc8wQhLivRSyTPUbRYh2dtWLg paragraph text This is the type of value returned when iterators of the view are dereferenced. brief text The reference type named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view size_type boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 106 5 typedef vgKTDoiDaiPsSjZw6bsQE9r9UiC public regular 3P1yc8wQhLivRSyTPUbRYh2dtWLg brief text An unsigned integer type used to represent size. named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std value_type boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 92 5 typedef 282GaAV487J59XKa2YsZAzQLFAi public regular 3P1yc8wQhLivRSyTPUbRYh2dtWLg 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 named identifier 2A6bDeBwiisGpHzTYMLSbQTSaSa3 string identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std 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 record 2qcxFfAmLeEBzgd4uWm7J7K8dZWF public see-below 3P1yc8wQhLivRSyTPUbRYh2dtWLg 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 named identifier 24XcpKBAcyXN6FLZk8kR4zGAmKak segments_encoded_ref 24XcpKBAcyXN6FLZk8kR4zGAmKak named identifier 3P1yc8wQhLivRSyTPUbRYh2dtWLg segments_encoded_base 3P1yc8wQhLivRSyTPUbRYh2dtWLg named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base 2TREmHUMfZeMQz9yyw5HzqB91APN back boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 287 5 function 2szTuMjMgM7yHBjYmZXySm5C4jQt public regular 3P1yc8wQhLivRSyTPUbRYh2dtWLg 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. named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal begin boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 301 5 function 43nBxjPFkQK4n8cxc4xdxNNU43GW public regular 3P1yc8wQhLivRSyTPUbRYh2dtWLg 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. named identifier 2qcxFfAmLeEBzgd4uWm7J7K8dZWF iterator normal buffer boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 157 5 function 4Lj8kGwjcm8TgFfiN8jy6juj8tR5 public regular 3P1yc8wQhLivRSyTPUbRYh2dtWLg 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. named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal empty boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 196 5 function Lm7zr8AAGMbux1omg5gViFvc1k7 public regular 3P1yc8wQhLivRSyTPUbRYh2dtWLg 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 . named identifier bool bool normal end boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 314 5 function JNJBBcu5jFftFLVp3Rj4pg66YiK public regular 3P1yc8wQhLivRSyTPUbRYh2dtWLg 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. named identifier 2qcxFfAmLeEBzgd4uWm7J7K8dZWF iterator normal front boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 248 5 function 2WNQyjZ2aqZhXBj5pppBfC2KQhrD public regular 3P1yc8wQhLivRSyTPUbRYh2dtWLg 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. named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal is_absolute boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 178 5 function 3MYXxb5b2qJks9fgNKeZ2PiKK6Bw public regular 3P1yc8wQhLivRSyTPUbRYh2dtWLg 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 . named identifier bool bool normal size boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 214 5 function 4j3Ut3UFtEAXEow3Puxhyyq1WKU public regular 3P1yc8wQhLivRSyTPUbRYh2dtWLg 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. named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std normal max_size boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 129 5 function 2bB8EadXpAyGWqW6iKYMtCmLpAKo public regular 3P1yc8wQhLivRSyTPUbRYh2dtWLg 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. named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std normal constexpr static segments_encoded_ref boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 79 1 record 24XcpKBAcyXN6FLZk8kR4zGAmKak regular 2ejQGW57K8g7MFJhHAwPt5aumoLa paragraph text Exposes the percent-encoded segments of a reference url_base 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3ZY5EydXePv2wNz8JPvc5skA7Bn4 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 34b9Kw2uRtFwe4f7FncxuZzbjV1k text : Only code text end() text . paragraph reference assign 4zkp69T3exLj2HSMwfzd54S47M1 text , reference clear Zr5AShBxnZVGX7DB3sQxZYtpRkt text , reference operator= 3J7zsELmJpFt9pcAb58zcMHsuwEq text : All elements. paragraph reference erase FTFpcbnUiQRnwx4PzR3TjcEqoWC text : Erased elements and all elements after (including code text end() text ). paragraph reference insert 71ngn5Rpbi22Gxpd7iRnt4k36Dg text : All elements at or after the insertion point (including code text end() text ). paragraph reference replace 3xFTTFPJVpKieDFT7upjV9s2YjBz 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 GKjeDHooSf2HAMf239p3oFfT3i3 text , reference segments_view 2QU7risgZzo8F84g7LttC6dG1GsH text , reference segments_ref 3sLepuFTMctJHoZrLv8tvJTFkDPS text . other __visibility__ class named identifier 3P1yc8wQhLivRSyTPUbRYh2dtWLg segments_encoded_base public 6demN3A6frQxCPcuxXRfp3eHA8J 4KLGY7xD5mJkk7z16RshtkGEjutD 3AUqzF441TqDmyc5Dy88PmXY1Avu 4BfkFxFGNFfFfhUnMXe9JdjPLJyZ vgKTDoiDaiPsSjZw6bsQE9r9UiC 282GaAV487J59XKa2YsZAzQLFAi 39qVB8c4aiUyWd65Xcda3a2P8KK4 3J1YCQAmiQ8YS56yDctTqFa1t9Pd 3J7zsELmJpFt9pcAb58zcMHsuwEq 4zkp69T3exLj2HSMwfzd54S47M1 2szTuMjMgM7yHBjYmZXySm5C4jQt 43nBxjPFkQK4n8cxc4xdxNNU43GW 4Lj8kGwjcm8TgFfiN8jy6juj8tR5 Zr5AShBxnZVGX7DB3sQxZYtpRkt Lm7zr8AAGMbux1omg5gViFvc1k7 JNJBBcu5jFftFLVp3Rj4pg66YiK FTFpcbnUiQRnwx4PzR3TjcEqoWC 2WNQyjZ2aqZhXBj5pppBfC2KQhrD 71ngn5Rpbi22Gxpd7iRnt4k36Dg 3MYXxb5b2qJks9fgNKeZ2PiKK6Bw XzuPnAKpU5M7gBQgnu9daUvFPDG 34b9Kw2uRtFwe4f7FncxuZzbjV1k 3xFTTFPJVpKieDFT7upjV9s2YjBz 4j3Ut3UFtEAXEow3Puxhyyq1WKU 391SWoLcHb1dGLDD7RvRh6KU31dn 3iX3UQvFidYDgVCc3pxKjVBmWQAm 2bB8EadXpAyGWqW6iKYMtCmLpAKo 4GEeEE43ym1eVWiZJ7gaccaCWFFS ZTP7QcoRHfyv5kYYC6cjJg1ixeT 2WaVp7RXiycXc72harihyo3cB7iw named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base 2TREmHUMfZeMQz9yyw5HzqB91APN const_iterator boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 79 5 typedef 6demN3A6frQxCPcuxXRfp3eHA8J public regular 3P1yc8wQhLivRSyTPUbRYh2dtWLg 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 named identifier 2qcxFfAmLeEBzgd4uWm7J7K8dZWF iterator const_reference boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 102 5 typedef 4KLGY7xD5mJkk7z16RshtkGEjutD public regular 3P1yc8wQhLivRSyTPUbRYh2dtWLg paragraph text This is the type of value returned when iterators of the view are dereferenced. brief text The reference type reference named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view difference_type boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 110 5 typedef 3AUqzF441TqDmyc5Dy88PmXY1Avu public regular 3P1yc8wQhLivRSyTPUbRYh2dtWLg brief text A signed integer type used to represent differences. named identifier EKxMGCxxySWyqBbWqvvL9j9KhWv ptrdiff_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std reference boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 99 5 typedef 4BfkFxFGNFfFfhUnMXe9JdjPLJyZ public regular 3P1yc8wQhLivRSyTPUbRYh2dtWLg paragraph text This is the type of value returned when iterators of the view are dereferenced. brief text The reference type named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view size_type boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 106 5 typedef vgKTDoiDaiPsSjZw6bsQE9r9UiC public regular 3P1yc8wQhLivRSyTPUbRYh2dtWLg brief text An unsigned integer type used to represent size. named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std value_type boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 92 5 typedef 282GaAV487J59XKa2YsZAzQLFAi public regular 3P1yc8wQhLivRSyTPUbRYh2dtWLg 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 named identifier 2A6bDeBwiisGpHzTYMLSbQTSaSa3 string identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std 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 record 39qVB8c4aiUyWd65Xcda3a2P8KK4 public see-below 24XcpKBAcyXN6FLZk8kR4zGAmKak 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 named identifier 24XcpKBAcyXN6FLZk8kR4zGAmKak segments_encoded_ref 24XcpKBAcyXN6FLZk8kR4zGAmKak named identifier 3P1yc8wQhLivRSyTPUbRYh2dtWLg segments_encoded_base 3P1yc8wQhLivRSyTPUbRYh2dtWLg named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base 2TREmHUMfZeMQz9yyw5HzqB91APN segments_encoded_ref boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 118 5 function 3J1YCQAmiQ8YS56yDctTqFa1t9Pd public regular 24XcpKBAcyXN6FLZk8kR4zGAmKak 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 named identifier void void lvalue-reference named identifier 24XcpKBAcyXN6FLZk8kR4zGAmKak segments_encoded_ref other constructor constexpr operator= boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 150 5 boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 154 5 boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 201 5 overloads 3J7zsELmJpFt9pcAb58zcMHsuwEq public regular 24XcpKBAcyXN6FLZk8kR4zGAmKak 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 = d9juJ9fAS8RcviGb7WrKdTU8Mn8 2ua6gDNRCcWNmPS3yfs9udhGSfzV eTUbj6wqx1sTTP3SP7uSoBJr6Y3 lvalue-reference named identifier 24XcpKBAcyXN6FLZk8kR4zGAmKak segments_encoded_ref operator= boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 150 5 function d9juJ9fAS8RcviGb7WrKdTU8Mn8 public regular 24XcpKBAcyXN6FLZk8kR4zGAmKak 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 lvalue-reference named identifier 24XcpKBAcyXN6FLZk8kR4zGAmKak segments_encoded_ref lvalue-reference named identifier 24XcpKBAcyXN6FLZk8kR4zGAmKak segments_encoded_ref other normal = operator= boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 201 5 function 2ua6gDNRCcWNmPS3yfs9udhGSfzV public regular 24XcpKBAcyXN6FLZk8kR4zGAmKak 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 lvalue-reference named identifier 24XcpKBAcyXN6FLZk8kR4zGAmKak segments_encoded_ref named specialization 474HF6bGJmJntnocv1iPAYL2crja initializer_list identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std type named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view init normal = operator= boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 154 5 function eTUbj6wqx1sTTP3SP7uSoBJr6Y3 public regular 24XcpKBAcyXN6FLZk8kR4zGAmKak 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 lvalue-reference named identifier 24XcpKBAcyXN6FLZk8kR4zGAmKak segments_encoded_ref lvalue-reference named identifier GKjeDHooSf2HAMf239p3oFfT3i3 segments_encoded_view other normal = assign boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 312 5 boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 352 5 overloads 4zkp69T3exLj2HSMwfzd54S47M1 public regular 24XcpKBAcyXN6FLZk8kR4zGAmKak 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 48qC84r96wC8ALEdJ5BwxBBJgFLH 3TMuQTYXkmE4E6Bo2FpZpVZSCPcb named identifier void void assign boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 312 5 function 48qC84r96wC8ALEdJ5BwxBBJgFLH public regular 24XcpKBAcyXN6FLZk8kR4zGAmKak 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 named identifier void void named specialization 474HF6bGJmJntnocv1iPAYL2crja initializer_list identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std type named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view init normal assign boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 352 5 function 3TMuQTYXkmE4E6Bo2FpZpVZSCPcb public regular 24XcpKBAcyXN6FLZk8kR4zGAmKak 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 named identifier void void named identifier FwdIt first named identifier FwdIt last normal back boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 287 5 function 2szTuMjMgM7yHBjYmZXySm5C4jQt public regular 3P1yc8wQhLivRSyTPUbRYh2dtWLg 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. named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal begin boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 301 5 function 43nBxjPFkQK4n8cxc4xdxNNU43GW public regular 3P1yc8wQhLivRSyTPUbRYh2dtWLg 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. named identifier 2qcxFfAmLeEBzgd4uWm7J7K8dZWF iterator normal buffer boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 157 5 function 4Lj8kGwjcm8TgFfiN8jy6juj8tR5 public regular 3P1yc8wQhLivRSyTPUbRYh2dtWLg 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. named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal clear boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 271 5 function Zr5AShBxnZVGX7DB3sQxZYtpRkt public regular 24XcpKBAcyXN6FLZk8kR4zGAmKak 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 named identifier void void normal empty boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 196 5 function Lm7zr8AAGMbux1omg5gViFvc1k7 public regular 3P1yc8wQhLivRSyTPUbRYh2dtWLg 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 . named identifier bool bool normal end boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 314 5 function JNJBBcu5jFftFLVp3Rj4pg66YiK public regular 3P1yc8wQhLivRSyTPUbRYh2dtWLg 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. named identifier 2qcxFfAmLeEBzgd4uWm7J7K8dZWF iterator normal erase boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 521 5 boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 544 5 overloads FTFpcbnUiQRnwx4PzR3TjcEqoWC public regular 24XcpKBAcyXN6FLZk8kR4zGAmKak 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 6TsH7dyr1NQjLaUCsvqyyjqpQac 9gz323oth4iAiypsp3srf1cCcgS named identifier 2qcxFfAmLeEBzgd4uWm7J7K8dZWF iterator erase boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 521 5 function 6TsH7dyr1NQjLaUCsvqyyjqpQac public regular 24XcpKBAcyXN6FLZk8kR4zGAmKak 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 named identifier 2qcxFfAmLeEBzgd4uWm7J7K8dZWF iterator named identifier 2qcxFfAmLeEBzgd4uWm7J7K8dZWF iterator pos normal erase boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 544 5 function 9gz323oth4iAiypsp3srf1cCcgS public regular 24XcpKBAcyXN6FLZk8kR4zGAmKak 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 named identifier 2qcxFfAmLeEBzgd4uWm7J7K8dZWF iterator named identifier 2qcxFfAmLeEBzgd4uWm7J7K8dZWF iterator first named identifier 2qcxFfAmLeEBzgd4uWm7J7K8dZWF iterator last normal front boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 248 5 function 2WNQyjZ2aqZhXBj5pppBfC2KQhrD public regular 3P1yc8wQhLivRSyTPUbRYh2dtWLg 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. named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal insert boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 390 5 boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 442 5 boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 493 5 overloads 71ngn5Rpbi22Gxpd7iRnt4k36Dg public regular 24XcpKBAcyXN6FLZk8kR4zGAmKak 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 26JmeGue4pQfpHxtDevxSQsnUNcA 43mCCdhLELgcY72mP1oFFH51X6KU 2f71EPMB9YmP6inxYi4Z6JMxqRb8 named identifier 2qcxFfAmLeEBzgd4uWm7J7K8dZWF iterator insert boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 390 5 function 26JmeGue4pQfpHxtDevxSQsnUNcA public regular 24XcpKBAcyXN6FLZk8kR4zGAmKak 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 named identifier 2qcxFfAmLeEBzgd4uWm7J7K8dZWF iterator named identifier 2qcxFfAmLeEBzgd4uWm7J7K8dZWF iterator before named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view s normal insert boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 442 5 function 43mCCdhLELgcY72mP1oFFH51X6KU public regular 24XcpKBAcyXN6FLZk8kR4zGAmKak 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 named identifier 2qcxFfAmLeEBzgd4uWm7J7K8dZWF iterator named identifier 2qcxFfAmLeEBzgd4uWm7J7K8dZWF iterator before named specialization 474HF6bGJmJntnocv1iPAYL2crja initializer_list identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std type named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view init normal insert boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 493 5 function 2f71EPMB9YmP6inxYi4Z6JMxqRb8 public regular 24XcpKBAcyXN6FLZk8kR4zGAmKak 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 named identifier 2qcxFfAmLeEBzgd4uWm7J7K8dZWF iterator named identifier 2qcxFfAmLeEBzgd4uWm7J7K8dZWF iterator before named identifier FwdIt first named identifier FwdIt last normal is_absolute boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 178 5 function 3MYXxb5b2qJks9fgNKeZ2PiKK6Bw public regular 3P1yc8wQhLivRSyTPUbRYh2dtWLg 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 . named identifier bool bool normal pop_back boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 758 5 function XzuPnAKpU5M7gBQgnu9daUvFPDG public regular 24XcpKBAcyXN6FLZk8kR4zGAmKak 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 named identifier void void normal push_back boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 737 5 function 34b9Kw2uRtFwe4f7FncxuZzbjV1k public regular 24XcpKBAcyXN6FLZk8kR4zGAmKak 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 named identifier void void named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view s normal replace boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 576 5 boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 611 5 boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 656 5 boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 701 5 overloads 3xFTTFPJVpKieDFT7upjV9s2YjBz public regular 24XcpKBAcyXN6FLZk8kR4zGAmKak 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 2aR6mb5quV5in3LwP1aT6izCxfsS 2MJ1JfryJBhnVnrf7Zy5DKSw2mqe 2wxbFQAaqxwU5iYqkzTbmTDYMNtD 4U21FYBh1MoUhDaGPvJ2sP8VgDrr named identifier 2qcxFfAmLeEBzgd4uWm7J7K8dZWF iterator replace boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 576 5 function 2aR6mb5quV5in3LwP1aT6izCxfsS public regular 24XcpKBAcyXN6FLZk8kR4zGAmKak 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 named identifier 2qcxFfAmLeEBzgd4uWm7J7K8dZWF iterator named identifier 2qcxFfAmLeEBzgd4uWm7J7K8dZWF iterator pos named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view s normal replace boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 611 5 function 2MJ1JfryJBhnVnrf7Zy5DKSw2mqe public regular 24XcpKBAcyXN6FLZk8kR4zGAmKak 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 named identifier 2qcxFfAmLeEBzgd4uWm7J7K8dZWF iterator named identifier 2qcxFfAmLeEBzgd4uWm7J7K8dZWF iterator from named identifier 2qcxFfAmLeEBzgd4uWm7J7K8dZWF iterator to named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view s normal replace boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 656 5 function 2wxbFQAaqxwU5iYqkzTbmTDYMNtD public regular 24XcpKBAcyXN6FLZk8kR4zGAmKak 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 named identifier 2qcxFfAmLeEBzgd4uWm7J7K8dZWF iterator named identifier 2qcxFfAmLeEBzgd4uWm7J7K8dZWF iterator from named identifier 2qcxFfAmLeEBzgd4uWm7J7K8dZWF iterator to named specialization 474HF6bGJmJntnocv1iPAYL2crja initializer_list identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std type named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view init normal replace boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 701 5 function 4U21FYBh1MoUhDaGPvJ2sP8VgDrr public regular 24XcpKBAcyXN6FLZk8kR4zGAmKak 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 named identifier 2qcxFfAmLeEBzgd4uWm7J7K8dZWF iterator named identifier 2qcxFfAmLeEBzgd4uWm7J7K8dZWF iterator from named identifier 2qcxFfAmLeEBzgd4uWm7J7K8dZWF iterator to named identifier FwdIt first named identifier FwdIt last normal size boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 214 5 function 4j3Ut3UFtEAXEow3Puxhyyq1WKU public regular 3P1yc8wQhLivRSyTPUbRYh2dtWLg 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. named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std normal url boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 238 5 function 391SWoLcHb1dGLDD7RvRh6KU31dn public regular 24XcpKBAcyXN6FLZk8kR4zGAmKak 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. lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base normal operator segments_encoded_view boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 212 5 function 3iX3UQvFidYDgVCc3pxKjVBmWQAm public regular 24XcpKBAcyXN6FLZk8kR4zGAmKak brief text Conversion returns text A view of the segments. see reference segments_encoded_view GKjeDHooSf2HAMf239p3oFfT3i3 text . named identifier GKjeDHooSf2HAMf239p3oFfT3i3 segments_encoded_view conversion max_size boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 129 5 function 2bB8EadXpAyGWqW6iKYMtCmLpAKo public regular 3P1yc8wQhLivRSyTPUbRYh2dtWLg 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. named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std normal constexpr static segments_encoded_view boost/url/segments_encoded_view.hpp include/boost/url/segments_encoded_view.hpp 55 1 boost/url/segments_encoded_ref.hpp include/boost/url/segments_encoded_ref.hpp 24 1 record GKjeDHooSf2HAMf239p3oFfT3i3 regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 2QU7risgZzo8F84g7LttC6dG1GsH text , reference segments_encoded_ref 24XcpKBAcyXN6FLZk8kR4zGAmKak text , reference segments_ref 3sLepuFTMctJHoZrLv8tvJTFkDPS text . other __visibility__ class named identifier 3P1yc8wQhLivRSyTPUbRYh2dtWLg segments_encoded_base public 6demN3A6frQxCPcuxXRfp3eHA8J 4KLGY7xD5mJkk7z16RshtkGEjutD 3AUqzF441TqDmyc5Dy88PmXY1Avu 4BfkFxFGNFfFfhUnMXe9JdjPLJyZ vgKTDoiDaiPsSjZw6bsQE9r9UiC 282GaAV487J59XKa2YsZAzQLFAi Ud6oAsshujzRLoqZ9EUUNdyiRES 3Um2xnKbGmkXz7qy7XdcAP8dWkEy 4P23FxB8b63VTuK1NVQTUoS5q1Yg 2szTuMjMgM7yHBjYmZXySm5C4jQt 43nBxjPFkQK4n8cxc4xdxNNU43GW 4Lj8kGwjcm8TgFfiN8jy6juj8tR5 Lm7zr8AAGMbux1omg5gViFvc1k7 JNJBBcu5jFftFLVp3Rj4pg66YiK 2WNQyjZ2aqZhXBj5pppBfC2KQhrD 3MYXxb5b2qJks9fgNKeZ2PiKK6Bw 4j3Ut3UFtEAXEow3Puxhyyq1WKU KF5xTd5rj8Hqg8LTfVMagpgckrE 2bB8EadXpAyGWqW6iKYMtCmLpAKo 4KLp7mG7nLTqL3ZQvFUVBbisnaHq 27xn5abqwdvTfjVgEWccUE46qWjE named identifier 24XcpKBAcyXN6FLZk8kR4zGAmKak segments_encoded_ref 24XcpKBAcyXN6FLZk8kR4zGAmKak named identifier 27ryuyAvvRyzfzgketja5uQcFBcK url_view_base 27ryuyAvvRyzfzgketja5uQcFBcK const_iterator boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 79 5 typedef 6demN3A6frQxCPcuxXRfp3eHA8J public regular 3P1yc8wQhLivRSyTPUbRYh2dtWLg 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 named identifier 2qcxFfAmLeEBzgd4uWm7J7K8dZWF iterator const_reference boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 102 5 typedef 4KLGY7xD5mJkk7z16RshtkGEjutD public regular 3P1yc8wQhLivRSyTPUbRYh2dtWLg paragraph text This is the type of value returned when iterators of the view are dereferenced. brief text The reference type reference named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view difference_type boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 110 5 typedef 3AUqzF441TqDmyc5Dy88PmXY1Avu public regular 3P1yc8wQhLivRSyTPUbRYh2dtWLg brief text A signed integer type used to represent differences. named identifier EKxMGCxxySWyqBbWqvvL9j9KhWv ptrdiff_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std reference boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 99 5 typedef 4BfkFxFGNFfFfhUnMXe9JdjPLJyZ public regular 3P1yc8wQhLivRSyTPUbRYh2dtWLg paragraph text This is the type of value returned when iterators of the view are dereferenced. brief text The reference type named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view size_type boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 106 5 typedef vgKTDoiDaiPsSjZw6bsQE9r9UiC public regular 3P1yc8wQhLivRSyTPUbRYh2dtWLg brief text An unsigned integer type used to represent size. named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std value_type boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 92 5 typedef 282GaAV487J59XKa2YsZAzQLFAi public regular 3P1yc8wQhLivRSyTPUbRYh2dtWLg 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 named identifier 2A6bDeBwiisGpHzTYMLSbQTSaSa3 string identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std 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 record Ud6oAsshujzRLoqZ9EUUNdyiRES public see-below GKjeDHooSf2HAMf239p3oFfT3i3 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 named identifier 24XcpKBAcyXN6FLZk8kR4zGAmKak segments_encoded_ref 24XcpKBAcyXN6FLZk8kR4zGAmKak named identifier 3P1yc8wQhLivRSyTPUbRYh2dtWLg segments_encoded_base 3P1yc8wQhLivRSyTPUbRYh2dtWLg named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base 2TREmHUMfZeMQz9yyw5HzqB91APN segments_encoded_view boost/url/segments_encoded_view.hpp include/boost/url/segments_encoded_view.hpp 109 5 boost/url/segments_encoded_view.hpp include/boost/url/segments_encoded_view.hpp 86 5 boost/url/segments_encoded_view.hpp include/boost/url/segments_encoded_view.hpp 160 5 boost/url/segments_encoded_view.hpp include/boost/url/segments_encoded_view.hpp 229 5 overloads 3Um2xnKbGmkXz7qy7XdcAP8dWkEy public regular GKjeDHooSf2HAMf239p3oFfT3i3 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 3gEr8RaVfvAxEr7qz7MLjbzdPmRc 3Yn5u3uYhhdFrhYawKenQzg2XS1F eGAU9iYmUbvL6HvTVPvMvmt2Dis 48BJxwJvopDLbEajrm6SiyvTF9bt named identifier void void segments_encoded_view boost/url/segments_encoded_view.hpp include/boost/url/segments_encoded_view.hpp 86 5 function 3gEr8RaVfvAxEr7qz7MLjbzdPmRc public regular GKjeDHooSf2HAMf239p3oFfT3i3 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 named identifier void void constructor segments_encoded_view boost/url/segments_encoded_view.hpp include/boost/url/segments_encoded_view.hpp 109 5 function 3Yn5u3uYhhdFrhYawKenQzg2XS1F public regular GKjeDHooSf2HAMf239p3oFfT3i3 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 named identifier void void lvalue-reference named identifier GKjeDHooSf2HAMf239p3oFfT3i3 segments_encoded_view other constructor constexpr segments_encoded_view boost/url/segments_encoded_view.hpp include/boost/url/segments_encoded_view.hpp 160 5 function eGAU9iYmUbvL6HvTVPvMvmt2Dis public regular GKjeDHooSf2HAMf239p3oFfT3i3 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 named identifier void void named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s constructor segments_encoded_view boost/url/segments_encoded_view.hpp include/boost/url/segments_encoded_view.hpp 229 5 function 48BJxwJvopDLbEajrm6SiyvTF9bt public regular GKjeDHooSf2HAMf239p3oFfT3i3 paragraph text This function creates a new reference segments_encoded_view 3Um2xnKbGmkXz7qy7XdcAP8dWkEy 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 3Um2xnKbGmkXz7qy7XdcAP8dWkEy 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 named identifier void void named identifier 2qcxFfAmLeEBzgd4uWm7J7K8dZWF iterator first named identifier 2qcxFfAmLeEBzgd4uWm7J7K8dZWF iterator last constructor operator= boost/url/segments_encoded_view.hpp include/boost/url/segments_encoded_view.hpp 258 5 function 4P23FxB8b63VTuK1NVQTUoS5q1Yg public regular GKjeDHooSf2HAMf239p3oFfT3i3 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 lvalue-reference named identifier GKjeDHooSf2HAMf239p3oFfT3i3 segments_encoded_view lvalue-reference named identifier GKjeDHooSf2HAMf239p3oFfT3i3 segments_encoded_view other normal = back boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 287 5 function 2szTuMjMgM7yHBjYmZXySm5C4jQt public regular 3P1yc8wQhLivRSyTPUbRYh2dtWLg 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. named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal begin boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 301 5 function 43nBxjPFkQK4n8cxc4xdxNNU43GW public regular 3P1yc8wQhLivRSyTPUbRYh2dtWLg 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. named identifier 2qcxFfAmLeEBzgd4uWm7J7K8dZWF iterator normal buffer boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 157 5 function 4Lj8kGwjcm8TgFfiN8jy6juj8tR5 public regular 3P1yc8wQhLivRSyTPUbRYh2dtWLg 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. named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal empty boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 196 5 function Lm7zr8AAGMbux1omg5gViFvc1k7 public regular 3P1yc8wQhLivRSyTPUbRYh2dtWLg 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 . named identifier bool bool normal end boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 314 5 function JNJBBcu5jFftFLVp3Rj4pg66YiK public regular 3P1yc8wQhLivRSyTPUbRYh2dtWLg 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. named identifier 2qcxFfAmLeEBzgd4uWm7J7K8dZWF iterator normal front boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 248 5 function 2WNQyjZ2aqZhXBj5pppBfC2KQhrD public regular 3P1yc8wQhLivRSyTPUbRYh2dtWLg 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. named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal is_absolute boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 178 5 function 3MYXxb5b2qJks9fgNKeZ2PiKK6Bw public regular 3P1yc8wQhLivRSyTPUbRYh2dtWLg 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 . named identifier bool bool normal size boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 214 5 function 4j3Ut3UFtEAXEow3Puxhyyq1WKU public regular 3P1yc8wQhLivRSyTPUbRYh2dtWLg 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. named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std normal operator segments_view boost/url/segments_encoded_view.hpp include/boost/url/segments_encoded_view.hpp 293 5 function KF5xTd5rj8Hqg8LTfVMagpgckrE public regular GKjeDHooSf2HAMf239p3oFfT3i3 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. named identifier 2QU7risgZzo8F84g7LttC6dG1GsH segments_view conversion max_size boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 129 5 function 2bB8EadXpAyGWqW6iKYMtCmLpAKo public regular 3P1yc8wQhLivRSyTPUbRYh2dtWLg 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. named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std normal constexpr static segments_ref boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 77 1 record 3sLepuFTMctJHoZrLv8tvJTFkDPS regular 2ejQGW57K8g7MFJhHAwPt5aumoLa paragraph text Presents the decoded path segments of a reference url_base 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3LeoF4uaTTUq2HNYnmxbfMfLc8at text : Only code text end() text . paragraph reference assign 3pULWfNcNN1nZD7DhtKCembQ5KNw text , reference clear 27VMV5dAAR5DHhvaazowsXweYZQX text , reference operator= 3KFFo4ySZE8Ntc1oWMVfqEf3rau7 text : All elements. paragraph reference erase 4Ca56M2EGoHcZeM4NWR6DVLpiK9f text : Erased elements and all elements after (including code text end() text ). paragraph reference insert 3H69WnvH3s5doWogNggzpNetZAHG text : All elements at or after the insertion point (including code text end() text ). paragraph reference replace 3yw5pU7TMsS366VGGhn1A9LrTjJA 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 24XcpKBAcyXN6FLZk8kR4zGAmKak text , reference segments_encoded_view GKjeDHooSf2HAMf239p3oFfT3i3 text , reference segments_view 2QU7risgZzo8F84g7LttC6dG1GsH text . other __visibility__ class named identifier 2ozZGf8LNFZmRaMXAL5TZg2G1emh segments_base public 3wMHKqNF6d1YX7HEaegmKEXUx1jb VJqeBKHH52hkGqTQ2jJjqQCCAsx 2Q9XnteURWK8gFL8nH2H5tJJBYuA 3p9u5WQ1eRWbDt68F38n8Kpc7Tpf 3PQA5Uiny61SBNLpxRXMFUjHLZET 44brnuMYBwZWzJ16SaCs7ZGgqdFw di6z1E2pzejre7KRa7ZPLkKX2D4 3DXiA7EZdtJkM8F7NJuT7afkbSyF 3KFFo4ySZE8Ntc1oWMVfqEf3rau7 3pULWfNcNN1nZD7DhtKCembQ5KNw 22utcNVxLypt7iaAVikdi2jEyC8k xQVmR56rEMQRfrRe54uq8J811ob 3fnojGuABPuXRX9fTa2ENXmXFoKs 27VMV5dAAR5DHhvaazowsXweYZQX 65eXJr2ZVtrq4HHWS7jmjLV1vCk 3EN1k29zTsCwHHKyi7P75aSr6X9o 4Ca56M2EGoHcZeM4NWR6DVLpiK9f FEc64aNwXUX5tpSuTGscsH4MLqi 3H69WnvH3s5doWogNggzpNetZAHG PMjHw8XHi2vVH1LumgeaRouzqB4 4UkYZvgVyhK6ZyRWW9LLfzCh5M7g 3LeoF4uaTTUq2HNYnmxbfMfLc8at 3yw5pU7TMsS366VGGhn1A9LrTjJA 3nfksnuZPrVHzGyTh2rA3wkq7Z6r 3ZdENJsJiPwowxD6iz3SFGko8kMr 2NNT2h7ABDXPG3SK6RppfZGzjwh5 49XMCMWmytdEkqgT8ztZ7EwH9DS6 3ma5AuM7XKLtq8QSoJsHeEdqAwYY wRN6e4uLhVcmQ66zd6YWPxqwEkm iddw7hwZsGdPfdmvB2o77mMZEKF named identifier 24XcpKBAcyXN6FLZk8kR4zGAmKak segments_encoded_ref 24XcpKBAcyXN6FLZk8kR4zGAmKak named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base 2TREmHUMfZeMQz9yyw5HzqB91APN const_iterator boost/url/segments_base.hpp include/boost/url/segments_base.hpp 77 5 typedef 3wMHKqNF6d1YX7HEaegmKEXUx1jb public regular 2ozZGf8LNFZmRaMXAL5TZg2G1emh 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 named identifier 3fYKK3ZjraBrPr17gDowH5ka89WM iterator const_reference boost/url/segments_base.hpp include/boost/url/segments_base.hpp 100 5 typedef VJqeBKHH52hkGqTQ2jJjqQCCAsx public regular 2ozZGf8LNFZmRaMXAL5TZg2G1emh paragraph text This is the type of value returned when iterators of the view are dereferenced. brief text The reference type reference named identifier 2A6bDeBwiisGpHzTYMLSbQTSaSa3 string identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std difference_type boost/url/segments_base.hpp include/boost/url/segments_base.hpp 108 5 typedef 2Q9XnteURWK8gFL8nH2H5tJJBYuA public regular 2ozZGf8LNFZmRaMXAL5TZg2G1emh brief text A signed integer type used to represent differences. named identifier EKxMGCxxySWyqBbWqvvL9j9KhWv ptrdiff_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std reference boost/url/segments_base.hpp include/boost/url/segments_base.hpp 97 5 typedef 3p9u5WQ1eRWbDt68F38n8Kpc7Tpf public regular 2ozZGf8LNFZmRaMXAL5TZg2G1emh paragraph text This is the type of value returned when iterators of the view are dereferenced. brief text The reference type named identifier 2A6bDeBwiisGpHzTYMLSbQTSaSa3 string identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std size_type boost/url/segments_base.hpp include/boost/url/segments_base.hpp 104 5 typedef 3PQA5Uiny61SBNLpxRXMFUjHLZET public regular 2ozZGf8LNFZmRaMXAL5TZg2G1emh brief text An unsigned integer type used to represent size. named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std value_type boost/url/segments_base.hpp include/boost/url/segments_base.hpp 90 5 typedef 44brnuMYBwZWzJ16SaCs7ZGgqdFw public regular 2ozZGf8LNFZmRaMXAL5TZg2G1emh 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 named identifier 2A6bDeBwiisGpHzTYMLSbQTSaSa3 string identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std 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 record di6z1E2pzejre7KRa7ZPLkKX2D4 public see-below 3sLepuFTMctJHoZrLv8tvJTFkDPS 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 named identifier 3sLepuFTMctJHoZrLv8tvJTFkDPS segments_ref 3sLepuFTMctJHoZrLv8tvJTFkDPS named identifier 2ozZGf8LNFZmRaMXAL5TZg2G1emh segments_base 2ozZGf8LNFZmRaMXAL5TZg2G1emh segments_ref boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 116 5 function 3DXiA7EZdtJkM8F7NJuT7afkbSyF public regular 3sLepuFTMctJHoZrLv8tvJTFkDPS 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 named identifier void void lvalue-reference named identifier 3sLepuFTMctJHoZrLv8tvJTFkDPS segments_ref other constructor constexpr operator= boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 148 5 boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 152 5 boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 194 5 overloads 3KFFo4ySZE8Ntc1oWMVfqEf3rau7 public regular 3sLepuFTMctJHoZrLv8tvJTFkDPS 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 = 3y4sSLu7D4Ub6eN5x7sybXGm9z5y 4VUVtQNf3zNMZLJ89bj9imVp8pAA 2w1vw3rc7gYGdMVutBarYji3Yd9w lvalue-reference named identifier 3sLepuFTMctJHoZrLv8tvJTFkDPS segments_ref operator= boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 148 5 function 3y4sSLu7D4Ub6eN5x7sybXGm9z5y public regular 3sLepuFTMctJHoZrLv8tvJTFkDPS 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 lvalue-reference named identifier 3sLepuFTMctJHoZrLv8tvJTFkDPS segments_ref lvalue-reference named identifier 3sLepuFTMctJHoZrLv8tvJTFkDPS segments_ref other normal = operator= boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 194 5 function 4VUVtQNf3zNMZLJ89bj9imVp8pAA public regular 3sLepuFTMctJHoZrLv8tvJTFkDPS 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 lvalue-reference named identifier 3sLepuFTMctJHoZrLv8tvJTFkDPS segments_ref named specialization 474HF6bGJmJntnocv1iPAYL2crja initializer_list identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std type named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core init normal = operator= boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 152 5 function 2w1vw3rc7gYGdMVutBarYji3Yd9w public regular 3sLepuFTMctJHoZrLv8tvJTFkDPS 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 lvalue-reference named identifier 3sLepuFTMctJHoZrLv8tvJTFkDPS segments_ref lvalue-reference named identifier 2QU7risgZzo8F84g7LttC6dG1GsH segments_view other normal = assign boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 300 5 boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 335 5 overloads 3pULWfNcNN1nZD7DhtKCembQ5KNw public regular 3sLepuFTMctJHoZrLv8tvJTFkDPS 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 2z5mYo8hHmSxuETuRA8tdFHmVcna 3zEcyZz9Y2KtHQGXDMUCz2kTrR2i named identifier void void assign boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 300 5 function 2z5mYo8hHmSxuETuRA8tdFHmVcna public regular 3sLepuFTMctJHoZrLv8tvJTFkDPS 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 named identifier void void named specialization 474HF6bGJmJntnocv1iPAYL2crja initializer_list identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std type named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core init normal assign boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 335 5 function 3zEcyZz9Y2KtHQGXDMUCz2kTrR2i public regular 3sLepuFTMctJHoZrLv8tvJTFkDPS 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 named identifier void void named identifier FwdIt first named identifier FwdIt last normal back boost/url/segments_base.hpp include/boost/url/segments_base.hpp 279 5 function 22utcNVxLypt7iaAVikdi2jEyC8k public regular 2ozZGf8LNFZmRaMXAL5TZg2G1emh 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. named identifier 2A6bDeBwiisGpHzTYMLSbQTSaSa3 string identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std normal begin boost/url/segments_base.hpp include/boost/url/segments_base.hpp 293 5 function xQVmR56rEMQRfrRe54uq8J811ob public regular 2ozZGf8LNFZmRaMXAL5TZg2G1emh 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. named identifier 3fYKK3ZjraBrPr17gDowH5ka89WM iterator normal buffer boost/url/segments_base.hpp include/boost/url/segments_base.hpp 155 5 function 3fnojGuABPuXRX9fTa2ENXmXFoKs public regular 2ozZGf8LNFZmRaMXAL5TZg2G1emh 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. named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal clear boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 264 5 function 27VMV5dAAR5DHhvaazowsXweYZQX public regular 3sLepuFTMctJHoZrLv8tvJTFkDPS 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 named identifier void void normal empty boost/url/segments_base.hpp include/boost/url/segments_base.hpp 194 5 function 65eXJr2ZVtrq4HHWS7jmjLV1vCk public regular 2ozZGf8LNFZmRaMXAL5TZg2G1emh 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 . named identifier bool bool normal end boost/url/segments_base.hpp include/boost/url/segments_base.hpp 306 5 function 3EN1k29zTsCwHHKyi7P75aSr6X9o public regular 2ozZGf8LNFZmRaMXAL5TZg2G1emh 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. named identifier 3fYKK3ZjraBrPr17gDowH5ka89WM iterator normal erase boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 488 5 boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 512 5 overloads 4Ca56M2EGoHcZeM4NWR6DVLpiK9f public regular 3sLepuFTMctJHoZrLv8tvJTFkDPS 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 3SYxJbbDH5Qh7SkJYEizZjKzRbrZ 3SghtBbou6zEG6zfFQGM7ZgSLHZC named identifier 3fYKK3ZjraBrPr17gDowH5ka89WM iterator erase boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 488 5 function 3SYxJbbDH5Qh7SkJYEizZjKzRbrZ public regular 3sLepuFTMctJHoZrLv8tvJTFkDPS 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 named identifier 3fYKK3ZjraBrPr17gDowH5ka89WM iterator named identifier 3fYKK3ZjraBrPr17gDowH5ka89WM iterator pos normal erase boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 512 5 function 3SghtBbou6zEG6zfFQGM7ZgSLHZC public regular 3sLepuFTMctJHoZrLv8tvJTFkDPS 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 named identifier 3fYKK3ZjraBrPr17gDowH5ka89WM iterator named identifier 3fYKK3ZjraBrPr17gDowH5ka89WM iterator first named identifier 3fYKK3ZjraBrPr17gDowH5ka89WM iterator last normal front boost/url/segments_base.hpp include/boost/url/segments_base.hpp 246 5 function FEc64aNwXUX5tpSuTGscsH4MLqi public regular 2ozZGf8LNFZmRaMXAL5TZg2G1emh 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. named identifier 2A6bDeBwiisGpHzTYMLSbQTSaSa3 string identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std normal insert boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 368 5 boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 415 5 boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 460 5 overloads 3H69WnvH3s5doWogNggzpNetZAHG public regular 3sLepuFTMctJHoZrLv8tvJTFkDPS 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 27vExAEk3tMJwjmu64fojQvrhNe3 3BMhm2gRvHgg5ABy5pFPt9KpcBqk 2ennkXcNQrpdJ4AEoqtpG7TkReBo named identifier 3fYKK3ZjraBrPr17gDowH5ka89WM iterator insert boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 368 5 function 27vExAEk3tMJwjmu64fojQvrhNe3 public regular 3sLepuFTMctJHoZrLv8tvJTFkDPS 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 named identifier 3fYKK3ZjraBrPr17gDowH5ka89WM iterator named identifier 3fYKK3ZjraBrPr17gDowH5ka89WM iterator before named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal insert boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 415 5 function 3BMhm2gRvHgg5ABy5pFPt9KpcBqk public regular 3sLepuFTMctJHoZrLv8tvJTFkDPS 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 named identifier 3fYKK3ZjraBrPr17gDowH5ka89WM iterator named identifier 3fYKK3ZjraBrPr17gDowH5ka89WM iterator before named specialization 474HF6bGJmJntnocv1iPAYL2crja initializer_list identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std type named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core init normal insert boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 460 5 function 2ennkXcNQrpdJ4AEoqtpG7TkReBo public regular 3sLepuFTMctJHoZrLv8tvJTFkDPS 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 named identifier 3fYKK3ZjraBrPr17gDowH5ka89WM iterator named identifier 3fYKK3ZjraBrPr17gDowH5ka89WM iterator before named identifier FwdIt first named identifier FwdIt last normal is_absolute boost/url/segments_base.hpp include/boost/url/segments_base.hpp 176 5 function PMjHw8XHi2vVH1LumgeaRouzqB4 public regular 2ozZGf8LNFZmRaMXAL5TZg2G1emh 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 . named identifier bool bool normal pop_back boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 703 5 function 4UkYZvgVyhK6ZyRWW9LLfzCh5M7g public regular 3sLepuFTMctJHoZrLv8tvJTFkDPS 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 named identifier void void normal push_back boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 682 5 function 3LeoF4uaTTUq2HNYnmxbfMfLc8at public regular 3sLepuFTMctJHoZrLv8tvJTFkDPS 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 named identifier void void named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal replace boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 543 5 boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 573 5 boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 613 5 boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 653 5 overloads 3yw5pU7TMsS366VGGhn1A9LrTjJA public regular 3sLepuFTMctJHoZrLv8tvJTFkDPS 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 2JoQhZtwN2eWFNzQ8RnFWZ9UFRJj 23umvJsK3yaTegrfdHySt2WtMxNo TMkVYnEaACfFrJZ5fBfxBAm2uot 2ibNrPFFA2K54anUPzvuuWcfh5dU named identifier 3fYKK3ZjraBrPr17gDowH5ka89WM iterator replace boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 543 5 function 2JoQhZtwN2eWFNzQ8RnFWZ9UFRJj public regular 3sLepuFTMctJHoZrLv8tvJTFkDPS 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 named identifier 3fYKK3ZjraBrPr17gDowH5ka89WM iterator named identifier 3fYKK3ZjraBrPr17gDowH5ka89WM iterator pos named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal replace boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 573 5 function 23umvJsK3yaTegrfdHySt2WtMxNo public regular 3sLepuFTMctJHoZrLv8tvJTFkDPS 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 named identifier 3fYKK3ZjraBrPr17gDowH5ka89WM iterator named identifier 3fYKK3ZjraBrPr17gDowH5ka89WM iterator from named identifier 3fYKK3ZjraBrPr17gDowH5ka89WM iterator to named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal replace boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 613 5 function TMkVYnEaACfFrJZ5fBfxBAm2uot public regular 3sLepuFTMctJHoZrLv8tvJTFkDPS 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 named identifier 3fYKK3ZjraBrPr17gDowH5ka89WM iterator named identifier 3fYKK3ZjraBrPr17gDowH5ka89WM iterator from named identifier 3fYKK3ZjraBrPr17gDowH5ka89WM iterator to named specialization 474HF6bGJmJntnocv1iPAYL2crja initializer_list identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std type named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core init normal replace boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 653 5 function 2ibNrPFFA2K54anUPzvuuWcfh5dU public regular 3sLepuFTMctJHoZrLv8tvJTFkDPS 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 named identifier 3fYKK3ZjraBrPr17gDowH5ka89WM iterator named identifier 3fYKK3ZjraBrPr17gDowH5ka89WM iterator from named identifier 3fYKK3ZjraBrPr17gDowH5ka89WM iterator to named identifier FwdIt first named identifier FwdIt last normal size boost/url/segments_base.hpp include/boost/url/segments_base.hpp 212 5 function 3nfksnuZPrVHzGyTh2rA3wkq7Z6r public regular 2ozZGf8LNFZmRaMXAL5TZg2G1emh 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. named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std normal url boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 231 5 function 3ZdENJsJiPwowxD6iz3SFGko8kMr public regular 3sLepuFTMctJHoZrLv8tvJTFkDPS 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. lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base normal operator segments_view boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 205 5 function 2NNT2h7ABDXPG3SK6RppfZGzjwh5 public regular 3sLepuFTMctJHoZrLv8tvJTFkDPS brief text Conversion returns text A view of the segments. see reference segments_view 2QU7risgZzo8F84g7LttC6dG1GsH text . named identifier 2QU7risgZzo8F84g7LttC6dG1GsH segments_view conversion max_size boost/url/segments_base.hpp include/boost/url/segments_base.hpp 127 5 function 49XMCMWmytdEkqgT8ztZ7EwH9DS6 public regular 2ozZGf8LNFZmRaMXAL5TZg2G1emh 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. named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std normal constexpr static segments_view boost/url/segments_view.hpp include/boost/url/segments_view.hpp 50 1 boost/url/segments_ref.hpp include/boost/url/segments_ref.hpp 24 1 record 2QU7risgZzo8F84g7LttC6dG1GsH regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 GKjeDHooSf2HAMf239p3oFfT3i3 text , reference segments_encoded_ref 24XcpKBAcyXN6FLZk8kR4zGAmKak text , reference segments_ref 3sLepuFTMctJHoZrLv8tvJTFkDPS text . other __visibility__ class named identifier 2ozZGf8LNFZmRaMXAL5TZg2G1emh segments_base public 3wMHKqNF6d1YX7HEaegmKEXUx1jb VJqeBKHH52hkGqTQ2jJjqQCCAsx 2Q9XnteURWK8gFL8nH2H5tJJBYuA 3p9u5WQ1eRWbDt68F38n8Kpc7Tpf 3PQA5Uiny61SBNLpxRXMFUjHLZET 44brnuMYBwZWzJ16SaCs7ZGgqdFw v7WhCLgPhB18stnfBX2SCUMUWnv 3p7YqUq6a1Ec9cPiiNC19xB5qfJn JH511PGS46UxD6b3ckaXQbxHdqU 22utcNVxLypt7iaAVikdi2jEyC8k xQVmR56rEMQRfrRe54uq8J811ob 3fnojGuABPuXRX9fTa2ENXmXFoKs 65eXJr2ZVtrq4HHWS7jmjLV1vCk 3EN1k29zTsCwHHKyi7P75aSr6X9o FEc64aNwXUX5tpSuTGscsH4MLqi PMjHw8XHi2vVH1LumgeaRouzqB4 3nfksnuZPrVHzGyTh2rA3wkq7Z6r 49XMCMWmytdEkqgT8ztZ7EwH9DS6 2nLeAzfqLsgeKqsx7kmgVJaydjQj named identifier 3sLepuFTMctJHoZrLv8tvJTFkDPS segments_ref 3sLepuFTMctJHoZrLv8tvJTFkDPS named identifier GKjeDHooSf2HAMf239p3oFfT3i3 segments_encoded_view GKjeDHooSf2HAMf239p3oFfT3i3 named identifier 27ryuyAvvRyzfzgketja5uQcFBcK url_view_base 27ryuyAvvRyzfzgketja5uQcFBcK const_iterator boost/url/segments_base.hpp include/boost/url/segments_base.hpp 77 5 typedef 3wMHKqNF6d1YX7HEaegmKEXUx1jb public regular 2ozZGf8LNFZmRaMXAL5TZg2G1emh 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 named identifier 3fYKK3ZjraBrPr17gDowH5ka89WM iterator const_reference boost/url/segments_base.hpp include/boost/url/segments_base.hpp 100 5 typedef VJqeBKHH52hkGqTQ2jJjqQCCAsx public regular 2ozZGf8LNFZmRaMXAL5TZg2G1emh paragraph text This is the type of value returned when iterators of the view are dereferenced. brief text The reference type reference named identifier 2A6bDeBwiisGpHzTYMLSbQTSaSa3 string identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std difference_type boost/url/segments_base.hpp include/boost/url/segments_base.hpp 108 5 typedef 2Q9XnteURWK8gFL8nH2H5tJJBYuA public regular 2ozZGf8LNFZmRaMXAL5TZg2G1emh brief text A signed integer type used to represent differences. named identifier EKxMGCxxySWyqBbWqvvL9j9KhWv ptrdiff_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std reference boost/url/segments_base.hpp include/boost/url/segments_base.hpp 97 5 typedef 3p9u5WQ1eRWbDt68F38n8Kpc7Tpf public regular 2ozZGf8LNFZmRaMXAL5TZg2G1emh paragraph text This is the type of value returned when iterators of the view are dereferenced. brief text The reference type named identifier 2A6bDeBwiisGpHzTYMLSbQTSaSa3 string identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std size_type boost/url/segments_base.hpp include/boost/url/segments_base.hpp 104 5 typedef 3PQA5Uiny61SBNLpxRXMFUjHLZET public regular 2ozZGf8LNFZmRaMXAL5TZg2G1emh brief text An unsigned integer type used to represent size. named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std value_type boost/url/segments_base.hpp include/boost/url/segments_base.hpp 90 5 typedef 44brnuMYBwZWzJ16SaCs7ZGgqdFw public regular 2ozZGf8LNFZmRaMXAL5TZg2G1emh 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 named identifier 2A6bDeBwiisGpHzTYMLSbQTSaSa3 string identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std 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 record v7WhCLgPhB18stnfBX2SCUMUWnv public see-below 2QU7risgZzo8F84g7LttC6dG1GsH 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 named identifier 3sLepuFTMctJHoZrLv8tvJTFkDPS segments_ref 3sLepuFTMctJHoZrLv8tvJTFkDPS named identifier 2ozZGf8LNFZmRaMXAL5TZg2G1emh segments_base 2ozZGf8LNFZmRaMXAL5TZg2G1emh segments_view boost/url/segments_view.hpp include/boost/url/segments_view.hpp 108 5 boost/url/segments_view.hpp include/boost/url/segments_view.hpp 82 5 boost/url/segments_view.hpp include/boost/url/segments_view.hpp 159 5 boost/url/segments_view.hpp include/boost/url/segments_view.hpp 224 5 overloads 3p7YqUq6a1Ec9cPiiNC19xB5qfJn public regular 2QU7risgZzo8F84g7LttC6dG1GsH 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 3mjRkCa2V3BxfR6Q2KQ8WmGxAmah 3vVWjCXUvmEjiGhLRwPPJ4GHJHK4 4EuWnfddd7WkUQNNPQMrCZG1HqMS 3SD7xiwjneAjaNTdvTdEwwtaowiS named identifier void void segments_view boost/url/segments_view.hpp include/boost/url/segments_view.hpp 82 5 function 3mjRkCa2V3BxfR6Q2KQ8WmGxAmah public regular 2QU7risgZzo8F84g7LttC6dG1GsH 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 named identifier void void constructor segments_view boost/url/segments_view.hpp include/boost/url/segments_view.hpp 108 5 function 3vVWjCXUvmEjiGhLRwPPJ4GHJHK4 public regular 2QU7risgZzo8F84g7LttC6dG1GsH 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 named identifier void void lvalue-reference named identifier 2QU7risgZzo8F84g7LttC6dG1GsH segments_view other constructor constexpr segments_view boost/url/segments_view.hpp include/boost/url/segments_view.hpp 159 5 function 4EuWnfddd7WkUQNNPQMrCZG1HqMS public regular 2QU7risgZzo8F84g7LttC6dG1GsH 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 named identifier void void named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s constructor segments_view boost/url/segments_view.hpp include/boost/url/segments_view.hpp 224 5 function 3SD7xiwjneAjaNTdvTdEwwtaowiS public regular 2QU7risgZzo8F84g7LttC6dG1GsH paragraph text This function creates a new reference segments_view 3p7YqUq6a1Ec9cPiiNC19xB5qfJn 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 3p7YqUq6a1Ec9cPiiNC19xB5qfJn 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 named identifier void void named identifier 3fYKK3ZjraBrPr17gDowH5ka89WM iterator first named identifier 3fYKK3ZjraBrPr17gDowH5ka89WM iterator last constructor operator= boost/url/segments_view.hpp include/boost/url/segments_view.hpp 253 5 function JH511PGS46UxD6b3ckaXQbxHdqU public regular 2QU7risgZzo8F84g7LttC6dG1GsH 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 lvalue-reference named identifier 2QU7risgZzo8F84g7LttC6dG1GsH segments_view lvalue-reference named identifier 2QU7risgZzo8F84g7LttC6dG1GsH segments_view other normal = back boost/url/segments_base.hpp include/boost/url/segments_base.hpp 279 5 function 22utcNVxLypt7iaAVikdi2jEyC8k public regular 2ozZGf8LNFZmRaMXAL5TZg2G1emh 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. named identifier 2A6bDeBwiisGpHzTYMLSbQTSaSa3 string identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std normal begin boost/url/segments_base.hpp include/boost/url/segments_base.hpp 293 5 function xQVmR56rEMQRfrRe54uq8J811ob public regular 2ozZGf8LNFZmRaMXAL5TZg2G1emh 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. named identifier 3fYKK3ZjraBrPr17gDowH5ka89WM iterator normal buffer boost/url/segments_base.hpp include/boost/url/segments_base.hpp 155 5 function 3fnojGuABPuXRX9fTa2ENXmXFoKs public regular 2ozZGf8LNFZmRaMXAL5TZg2G1emh 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. named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal empty boost/url/segments_base.hpp include/boost/url/segments_base.hpp 194 5 function 65eXJr2ZVtrq4HHWS7jmjLV1vCk public regular 2ozZGf8LNFZmRaMXAL5TZg2G1emh 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 . named identifier bool bool normal end boost/url/segments_base.hpp include/boost/url/segments_base.hpp 306 5 function 3EN1k29zTsCwHHKyi7P75aSr6X9o public regular 2ozZGf8LNFZmRaMXAL5TZg2G1emh 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. named identifier 3fYKK3ZjraBrPr17gDowH5ka89WM iterator normal front boost/url/segments_base.hpp include/boost/url/segments_base.hpp 246 5 function FEc64aNwXUX5tpSuTGscsH4MLqi public regular 2ozZGf8LNFZmRaMXAL5TZg2G1emh 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. named identifier 2A6bDeBwiisGpHzTYMLSbQTSaSa3 string identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std normal is_absolute boost/url/segments_base.hpp include/boost/url/segments_base.hpp 176 5 function PMjHw8XHi2vVH1LumgeaRouzqB4 public regular 2ozZGf8LNFZmRaMXAL5TZg2G1emh 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 . named identifier bool bool normal size boost/url/segments_base.hpp include/boost/url/segments_base.hpp 212 5 function 3nfksnuZPrVHzGyTh2rA3wkq7Z6r public regular 2ozZGf8LNFZmRaMXAL5TZg2G1emh 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. named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std normal max_size boost/url/segments_base.hpp include/boost/url/segments_base.hpp 127 5 function 49XMCMWmytdEkqgT8ztZ7EwH9DS6 public regular 2ozZGf8LNFZmRaMXAL5TZg2G1emh 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. named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std normal constexpr static static_url boost/url/static_url.hpp include/boost/url/static_url.hpp 105 1 boost/url/static_url.hpp include/boost/url/static_url.hpp 23 1 record 48MaMwY7JqeST8Mfy8WBA7wGLSzT regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 75qVNpuBHShJ8KKEUv4RCrwxEAB text , reference url_view 3hrVvoVYoDkX9t3w9abTXxDqGRaW text . reference format_to cLKVoifuzVMusLZv1zV2vk1L2K3 reference format_to 3bDKeYzcaysYNkwtHjg2EkeVGZf3 reference operator!= tkwNEJdWJqwprh85787u3xpyauu reference operator< 22wNuw5VxKWrVLMDGM9VPFjJshU6 reference operator<= 3QqsgavNMQTmxMW1t9qAoAocshM6 reference operator== GhudPV3CuyCeCKSftvpKEQLQtJ4 reference operator> 3CgAf4w5dyww6CMhGWkJm1fJiHum reference operator>= 2V16XgrptBcWFtoZaJ3DExhQXY6 reference resolve 4ZbWvyKBMwfyhwwk3YYEco8ttTeS class named identifier 2egpzk38s9q8jE4fNG71Y15WvAVC static_url_base public 2FM33w3VkxdNdGSDKw13tmqvwXM6 288cBhLgfKz4LvcbJUb9ir3LHtuX 2a9a4snZZMsE8ALP9QosQTaUVdAE 3fqhU2zdn6LwiSAm9upTzbtboK1U 3ESzuLSF2zD1TghU6qemdUksdP2V oHRP7v9PjrTqy9YjGBt8xxSqTLn HxCZYcsETDaw1bRzUVB9HpjzDZH r7EPCNuC2kWeArshSQf9kS35QJA 3Lh94K8cNrPFyFYw36XmhhtFMLpf VbvXoprikWfUm5mR56ZFYECXt9J 4DmmNdXmY3VWyP6HoKWQVEExBzaV 2GaF4F3gH2Y5LkyYXCrr3VyP9tpJ ipF8M41qPyuMM5XLe5JGZYSc42h FMBiWLrznwNXgkDuu4xneE9NeCD 3oodjUy4VDbgnxfeqkxwvqQvf7hK 4SGWNm9TD3ZACEqJ9fmnWL1ZF47q 492Pha8s74Xj1GjgZ82x193B56bP 3gVZJ5SpfCzYoZgafZW71cueQ3u3 3WcGK7mkJngNwmU5zz1zx9Vr7iC3 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym M5bG6HzwZUo4ycGCKLY5CsUUXun 3VZ9J5FmgK7VsNUfrHxuyT4pNTGm 3oB1p7aLxKXx3FxEqHaKSnCiNfXM 3NGtuSVjhTWXrAF9sPpeS5FwZQN8 UJaw1aYaRaLhmYt2h416g598hi4 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC 3qDJMHEiC1T5Vik6nGt2CJvFxFDM 4Bt9AGe8WEFmjA79MWAiGPDtMUW8 2T5XA2udwnVeh4RFi6U9UrLirJFJ 2omNW7ayWzkboBBXgc2Rm6C4y5kb 2RYFJUJHdYjygxHWSb57bHWfkHgN 4QciDQp3vKjNuPEah54XMBvrjvyD 4CLeCb8bTxYAjEFuAXtr5VmQW6FE 21mA7muF2gpvzFjJxaqjvjnnm6XY 2wLECn7WbsBXGLpheUngfa9GEf1q 2x7XawH6QTh6eBg2hNRqzQ3WME2m SytR6d7pUELeR1RNUpcWrXWQcY8 KoSC71QaaCYQtpr7xCwndbzWaKR Zvcpzzy9h3HWgiqp7UZuEiWf4A7 9sSdyLcyHxeuasmCKqifZp3ga5s 4E8a8HgQbryrd4KcNHFajdVyLWib 2gNagLmHXZAqycctaaYmEYZc9pv mSWKjRHEDFTnpxGSra6Q5eS7fjS 2hgDJpXv5LpubtS8phLLnGk4a7XZ fJUAi8AuTYXrvKUXGmRsYCKtuUu 3NcThfHpyrE2MGK3r1ZdDUkxt64s 4QGdwRPvEY3Q8wPJNH3oHNu9zmPu 3yxd9xhUPXZfG61goL9J5qasNtV1 2Y2vSJirKKiNcY5ZWTxe7KbgEoxi u9u4vhnqKMqqHiEHp1FsRcu7qA6 3hdYD66PBzHcr6JTNLGtXFRmpwjB 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL wc1MNXXCH1K1Shz81BmxVy1opwc 2aNVu1ZJUXAnkA1MUK2cfojoNCyj p8uqDVjGDrU4Eg9axo7dsTkztws 363HbS6bzsgdHiLTk4Kr8pdkZJZY 49Yox1iKKs7LmQ3wu1nCZXGKWEKf gad9Da1zgjMxhSBVYwatzxrMkRJ 3enjBrPeM5GQF9RgdB5wyhPULJWk 3svvmttxGQFPJ5xorXojZpnqbFVp gdA4fV9oxdLEei55j1uU1Q6gqCB 3ugXMRzpnLUeDPQKs7L1kMf3dhBG U6C6WyTFCp1b2MuAWjhrat5Za7L x8mx5AfxqwMaZQ3MLREUq4PoLLj 385VbbDMBhTV6zCBdGxUdDob8acZ zpt1tVsUzr9PpovdHt6x8TgTZMD 45Z6NdRjyroghszwmeBJuKmyuKLU 4AoadMoEhkiTY9v83LDBwQt31Uti 3aL5x6QNsMGNDAo8DP539u5TsZpp 2bXmGRYoLQKFALtmsM2vVVCvmnVn 3ennHwNWt7xsAZJR5EwoxTZK2167 3AqxZUVDaMdhbV64CuyLZ76PNFmR 2F5rUu5czVzhZb7r3cdJiW6Yfc2V 2z1iJGSd7fyFmj4AvaVz5zjk3kER 3fTM9QkQKNHmAEW57jg9jKwrrwfT 24HVoTb3hMrWVBMHrtxD1buWstCN 38qMKR2N6SZjeBHcBknb4Hk7LukZ 2S62bxXG7Kan1q3dhZv8NCkAuj7z 481Pze8cid7r1NzzieokbUMHLKsh 22carPeUUqk8w28wgyndzSrSPjSd 2cNxjGmiTtfUhWJ3CCo5qbyvNNAa 26KuBv3X6zCSbdDd7zJyPcJxEoS9 4WEDpyKefo5t88Abshsu3K5XgTvt 2cUp3QLVsbaUtWiqxpSKgiMteYwj 24jcE2oP2XGCjyUd1XnQxhd7Qdp5 YrfPJSXXcYSDzYgctFw6a3fUdW9 NkkRWsxnLPD4F7FQPKfgpmV6H7C 4FgKrPH1ECyNgs1vcaiAPnLMT6FM 28xgRdwaP5PGzXY3mVnkCAGwVkpy 37PhBDWLXfXBDNeEpn1HkXoNuCyK 3Td9zTwt4PTSxpLkXFtY9hXK7MjB 2CzvXBAaPUBsGuksdxFjYoCWPChB 4b7SsvokaeMTXQXBKywBXGVroR2 2VcPodtQRfdxGMDGqtdgapGUiQ1P 3fKgZ24wCPPwkDdf5ZKqb2NjuvkK 4AcGLPyjUZeiY2ME8FjsmVzBGGvP e1kf55N8tdw9pJqTsqtDYk2MNAq 3SFq2qA8k2zEJqijAGATcPyJbc5F ARVq1tGy4yWK9mj1g55GHdfhBcy 2sDfJ2dyCc57DXbV7a5CFj6Ryo7N 2WW1EfGgnaL8MKTS5uMZLWkF9P7o 2Z9j51jzFxpMXyB1ZjxR329S4Puk 4Yfg3yG11SsLgpAe6dzENEPz39dk 24JMPq739KrKuemXwWK8zpXGtWvz 3QgkE48ZuKvk3EGbnydRNa7ob9XL 3uYCaZr2Kk1eGAMsuRXTehXkXZwv 39V9A9oqw6EqsRw4R5mxeMpeqePo 2TwwpddeAxzjzfbTirqgZeddg3n6 named specialization qxhkZ7vJu8kXFjx3zKMDAQk258p hash identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std type named identifier 48MaMwY7JqeST8Mfy8WBA7wGLSzT static_url qxhkZ7vJu8kXFjx3zKMDAQk258p static_url boost/url/static_url.hpp include/boost/url/static_url.hpp 164 5 overloads 2FM33w3VkxdNdGSDKw13tmqvwXM6 public regular 48MaMwY7JqeST8Mfy8WBA7wGLSzT 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 3843f5yNG2S3popKRvEikG6y4rDB 3DqDKt5WH3anahANEGmnBCMN7tx6 2p4mpMu7nJwSxXQ6mUhJi1gLoBEc 3darWa5Z7jDVGxGA9H3KQ55zq8Yt named identifier void void static_url boost/url/static_url.hpp include/boost/url/static_url.hpp 164 5 function 3843f5yNG2S3popKRvEikG6y4rDB public regular 48MaMwY7JqeST8Mfy8WBA7wGLSzT 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 named identifier void void constructor static_url boost/url/static_url.hpp include/boost/url/static_url.hpp 242 5 function 3DqDKt5WH3anahANEGmnBCMN7tx6 public regular 48MaMwY7JqeST8Mfy8WBA7wGLSzT 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 named identifier void void lvalue-reference named identifier 48MaMwY7JqeST8Mfy8WBA7wGLSzT static_url u constructor static_url boost/url/static_url.hpp include/boost/url/static_url.hpp 216 5 function 2p4mpMu7nJwSxXQ6mUhJi1gLoBEc public regular 48MaMwY7JqeST8Mfy8WBA7wGLSzT 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 named identifier void void named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s constructor static_url boost/url/static_url.hpp include/boost/url/static_url.hpp 270 5 function 3darWa5Z7jDVGxGA9H3KQ55zq8Yt public regular 48MaMwY7JqeST8Mfy8WBA7wGLSzT 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 named identifier void void lvalue-reference named identifier 27ryuyAvvRyzfzgketja5uQcFBcK url_view_base u constructor ~static_url boost/url/static_url.hpp include/boost/url/static_url.hpp 129 5 function 288cBhLgfKz4LvcbJUb9ir3LHtuX public regular 48MaMwY7JqeST8Mfy8WBA7wGLSzT 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 named identifier void void destructor operator= boost/url/static_url.hpp include/boost/url/static_url.hpp 298 5 overloads 2a9a4snZZMsE8ALP9QosQTaUVdAE public regular 48MaMwY7JqeST8Mfy8WBA7wGLSzT 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 = 2RBs5wHJFD2Cg42f2gSqYBSrSsuo 3jkn1wuKbzAFpsCuo9MkCGCmdu1Z lvalue-reference named identifier 48MaMwY7JqeST8Mfy8WBA7wGLSzT static_url operator= boost/url/static_url.hpp include/boost/url/static_url.hpp 298 5 function 2RBs5wHJFD2Cg42f2gSqYBSrSsuo public regular 48MaMwY7JqeST8Mfy8WBA7wGLSzT 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 lvalue-reference named identifier 48MaMwY7JqeST8Mfy8WBA7wGLSzT static_url lvalue-reference named identifier 48MaMwY7JqeST8Mfy8WBA7wGLSzT static_url u normal = operator= boost/url/static_url.hpp include/boost/url/static_url.hpp 331 5 function 3jkn1wuKbzAFpsCuo9MkCGCmdu1Z public regular 48MaMwY7JqeST8Mfy8WBA7wGLSzT 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 lvalue-reference named identifier 48MaMwY7JqeST8Mfy8WBA7wGLSzT static_url lvalue-reference named identifier 27ryuyAvvRyzfzgketja5uQcFBcK url_view_base u normal = authority boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 564 5 function 3fqhU2zdn6LwiSAm9upTzbtboK1U public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text This function returns the authority as an reference authority_view 2fwXocwnoAG9WDGbqM3quKphV1qq 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 2GaF4F3gH2Y5LkyYXCrr3VyP9tpJ text , reference has_authority 2omNW7ayWzkboBBXgc2Rm6C4y5kb text . named identifier 2fwXocwnoAG9WDGbqM3quKphV1qq authority_view normal buffer boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 282 5 function 3ESzuLSF2zD1TghU6qemdUksdP2V public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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. named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core normal c_str boost/url/url_base.hpp include/boost/url/url_base.hpp 127 5 function oHRP7v9PjrTqy9YjGBt8xxSqTLn public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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. pointer named identifier char char normal capacity boost/url/url_base.hpp include/boost/url/url_base.hpp 146 5 function HxCZYcsETDaw1bRzUVB9HpjzDZH public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std normal clear boost/url/url_base.hpp include/boost/url/url_base.hpp 165 5 function r7EPCNuC2kWeArshSQf9kS35QJA public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 named identifier void void normal compare boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2446 5 function 3Lh94K8cNrPFyFYw36XmhhtFMLpf public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 named identifier int int lvalue-reference named identifier 27ryuyAvvRyzfzgketja5uQcFBcK url_view_base other normal data boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 258 5 function VbvXoprikWfUm5mR56ZFYECXt9J public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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. pointer named identifier char char normal empty boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 238 5 function 4DmmNdXmY3VWyP6HoKWQVEExBzaV public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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. named identifier bool bool normal encoded_authority boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 601 5 function 2GaF4F3gH2Y5LkyYXCrr3VyP9tpJ public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 3fqhU2zdn6LwiSAm9upTzbtboK1U text , reference has_authority 2omNW7ayWzkboBBXgc2Rm6C4y5kb text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_fragment boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2280 5 function ipF8M41qPyuMM5XLe5JGZYSc42h public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2T5XA2udwnVeh4RFi6U9UrLirJFJ text , reference has_fragment 2RYFJUJHdYjygxHWSb57bHWfkHgN text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_host boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1120 5 function FMBiWLrznwNXgkDuu4xneE9NeCD public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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. named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_host_address boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1237 5 function 3oodjUy4VDbgnxfeqkxwvqQvf7hK public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text The value returned by this function depends on the type of host returned from the function reference host_type mSWKjRHEDFTnpxGSra6Q5eS7fjS text . list paragraph text If the type is reference host_type::ipv4 4B5yLFvhkpef7XX8ryKTaBWz8d6D text , then the IPv4 address string is returned. paragraph text If the type is reference host_type::ipv6 2y7UTsNbko8TLegXS5EpSa1goNog text , then the IPv6 address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::ipvfuture 25qx7TTMyctoe4LxqgMPXccSpy5Q text , then the IPvFuture address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::name QfoSUW8M1SPUL5EFVKwAUabTKCa 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 wGjRbosZ4DQY7xCpjwAZqPVHiim 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. named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_host_and_port boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2325 5 function 4SGWNm9TD3ZACEqJ9fmnWL1ZF47q public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4CLeCb8bTxYAjEFuAXtr5VmQW6FE text , reference port p8uqDVjGDrU4Eg9axo7dsTkztws text , reference port_number 363HbS6bzsgdHiLTk4Kr8pdkZJZY text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_host_name boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1441 5 function 492Pha8s74Xj1GjgZ82x193B56bP public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text If the host type is reference host_type::name QfoSUW8M1SPUL5EFVKwAUabTKCa 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. named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_origin boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2355 5 function 3gVZJ5SpfCzYoZgafZW71cueQ3u3 public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 3oB1p7aLxKXx3FxEqHaKSnCiNfXM text , reference encoded_target UJaw1aYaRaLhmYt2h416g598hi4 text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_params boost/url/url_base.hpp include/boost/url/url_base.hpp 2248 5 boost/url/url_base.hpp include/boost/url/url_base.hpp 2300 5 overloads 3WcGK7mkJngNwmU5zz1zx9Vr7iC3 public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3hdYD66PBzHcr6JTNLGtXFRmpwjB text , reference remove_query 2R5rf2bDtEpPE9hwtv8Ln4i6EAHv text , reference set_encoded_query v9Dry5ACH8wLSd7BYqpiHbGB7V8 text , reference set_query 4THvHraYktHgYNzU3qniR2MhXpuX text . see reference encoded_query 3VZ9J5FmgK7VsNUfrHxuyT4pNTGm text , reference has_query 21mA7muF2gpvzFjJxaqjvjnnm6XY text , reference params 3hdYD66PBzHcr6JTNLGtXFRmpwjB text , reference query 49Yox1iKKs7LmQ3wu1nCZXGKWEKf text . normal 2Tfz89EdRJCtmaAcvePE2sFdTaFs WLnpSWkKJP479aAk2KVz4BEDpZ8 auto auto encoded_params boost/url/url_base.hpp include/boost/url/url_base.hpp 2300 5 function 2Tfz89EdRJCtmaAcvePE2sFdTaFs public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3hdYD66PBzHcr6JTNLGtXFRmpwjB text , reference remove_query 2R5rf2bDtEpPE9hwtv8Ln4i6EAHv text , reference set_encoded_query v9Dry5ACH8wLSd7BYqpiHbGB7V8 text , reference set_query 4THvHraYktHgYNzU3qniR2MhXpuX text . named identifier 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe params_encoded_ref normal encoded_params boost/url/url_base.hpp include/boost/url/url_base.hpp 2248 5 function WLnpSWkKJP479aAk2KVz4BEDpZ8 public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3VZ9J5FmgK7VsNUfrHxuyT4pNTGm text , reference has_query 21mA7muF2gpvzFjJxaqjvjnnm6XY text , reference params 3hdYD66PBzHcr6JTNLGtXFRmpwjB text , reference query 49Yox1iKKs7LmQ3wu1nCZXGKWEKf text . named identifier 3w4FJjjADY3EEHqUmBj5mvDKqdEB params_encoded_view normal encoded_password boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 996 5 function 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4QciDQp3vKjNuPEah54XMBvrjvyD text , reference has_userinfo 2x7XawH6QTh6eBg2hNRqzQ3WME2m text , reference encoded_user 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC text , reference encoded_userinfo 3qDJMHEiC1T5Vik6nGt2CJvFxFDM text , reference password 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL text , reference user 4Yfg3yG11SsLgpAe6dzENEPz39dk text , reference userinfo 24JMPq739KrKuemXwWK8zpXGtWvz text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_path boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1799 5 function M5bG6HzwZUo4ycGCKLY5CsUUXun public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2hgDJpXv5LpubtS8phLLnGk4a7XZ text , reference encoded_segments 3jZFG9bXfeYJfGzZnt2Zim38gmMB text . reference path wc1MNXXCH1K1Shz81BmxVy1opwc text , reference segments 3YxJjcnyfcHtM9xLtszAHET8pyFv text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_query boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2040 5 function 3VZ9J5FmgK7VsNUfrHxuyT4pNTGm public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2N3uW9xQekt6pX19rHqrM5vcnVUH text , reference has_query 21mA7muF2gpvzFjJxaqjvjnnm6XY text , reference params 2RJGYan9E8WvVKQM1LmRNNdUCc7E text , reference query 49Yox1iKKs7LmQ3wu1nCZXGKWEKf text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_resource boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2387 5 function 3oB1p7aLxKXx3FxEqHaKSnCiNfXM public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 3gVZJ5SpfCzYoZgafZW71cueQ3u3 text , reference encoded_target UJaw1aYaRaLhmYt2h416g598hi4 text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_segments boost/url/url_base.hpp include/boost/url/url_base.hpp 2018 5 boost/url/url_base.hpp include/boost/url/url_base.hpp 2014 5 overloads 3NGtuSVjhTWXrAF9sPpeS5FwZQN8 public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 4Ek5WSaWmrfbmnMRzJv3oVPGKCua text , reference set_encoded_path MCx88BPGS5KgE3qhBfh89e3U57J text , reference set_path 3v9Fip9faoKhfWb6eQhiSgANjWdV text , reference set_path_absolute 4b7SsvokaeMTXQXBKywBXGVroR2 text . see reference is_path_absolute 2hgDJpXv5LpubtS8phLLnGk4a7XZ text , reference encoded_path M5bG6HzwZUo4ycGCKLY5CsUUXun text , reference path wc1MNXXCH1K1Shz81BmxVy1opwc text , reference segments 2bXmGRYoLQKFALtmsM2vVVCvmnVn text , reference segments_encoded_view GKjeDHooSf2HAMf239p3oFfT3i3 text . normal 4Ek5WSaWmrfbmnMRzJv3oVPGKCua 4CifMdq25fpMkWFY7dcZ9ZwXrmCV auto auto encoded_segments boost/url/url_base.hpp include/boost/url/url_base.hpp 2014 5 function 4Ek5WSaWmrfbmnMRzJv3oVPGKCua public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3NGtuSVjhTWXrAF9sPpeS5FwZQN8 text , reference set_encoded_path MCx88BPGS5KgE3qhBfh89e3U57J text , reference set_path 3v9Fip9faoKhfWb6eQhiSgANjWdV text , reference set_path_absolute 4b7SsvokaeMTXQXBKywBXGVroR2 text . named identifier 24XcpKBAcyXN6FLZk8kR4zGAmKak segments_encoded_ref normal encoded_segments boost/url/url_base.hpp include/boost/url/url_base.hpp 2018 5 function 4CifMdq25fpMkWFY7dcZ9ZwXrmCV public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 2hgDJpXv5LpubtS8phLLnGk4a7XZ text , reference encoded_path M5bG6HzwZUo4ycGCKLY5CsUUXun text , reference path wc1MNXXCH1K1Shz81BmxVy1opwc text , reference segments 2bXmGRYoLQKFALtmsM2vVVCvmnVn text , reference segments_encoded_view GKjeDHooSf2HAMf239p3oFfT3i3 text . named identifier GKjeDHooSf2HAMf239p3oFfT3i3 segments_encoded_view normal encoded_target boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2419 5 function UJaw1aYaRaLhmYt2h416g598hi4 public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 3gVZJ5SpfCzYoZgafZW71cueQ3u3 text , reference encoded_resource 3oB1p7aLxKXx3FxEqHaKSnCiNfXM text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_user boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 901 5 function 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4QciDQp3vKjNuPEah54XMBvrjvyD text , reference has_userinfo 2x7XawH6QTh6eBg2hNRqzQ3WME2m text , reference encoded_password 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym text , reference encoded_userinfo 3qDJMHEiC1T5Vik6nGt2CJvFxFDM text , reference password 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL text , reference user 4Yfg3yG11SsLgpAe6dzENEPz39dk text , reference userinfo 24JMPq739KrKuemXwWK8zpXGtWvz text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_userinfo boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 800 5 function 3qDJMHEiC1T5Vik6nGt2CJvFxFDM public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4QciDQp3vKjNuPEah54XMBvrjvyD text , reference has_userinfo 2x7XawH6QTh6eBg2hNRqzQ3WME2m text , reference encoded_password 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym text , reference encoded_user 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC text , reference password 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL text , reference user 4Yfg3yG11SsLgpAe6dzENEPz39dk text , reference userinfo 24JMPq739KrKuemXwWK8zpXGtWvz text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_zone_id boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1526 5 function 4Bt9AGe8WEFmjA79MWAiGPDtMUW8 public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text If the host type is reference host_type::ipv6 2y7UTsNbko8TLegXS5EpSa1goNog 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. named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal fragment boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2233 5 function 2T5XA2udwnVeh4RFi6U9UrLirJFJ public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 ipF8M41qPyuMM5XLe5JGZYSc42h text , reference has_fragment 2RYFJUJHdYjygxHWSb57bHWfkHgN text . named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal has_authority boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 528 5 function 2omNW7ayWzkboBBXgc2Rm6C4y5kb public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 3fqhU2zdn6LwiSAm9upTzbtboK1U text , reference encoded_authority 2GaF4F3gH2Y5LkyYXCrr3VyP9tpJ text . named identifier bool bool normal has_fragment boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2173 5 function 2RYFJUJHdYjygxHWSb57bHWfkHgN public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 ipF8M41qPyuMM5XLe5JGZYSc42h text , reference fragment 2T5XA2udwnVeh4RFi6U9UrLirJFJ text . named identifier bool bool normal has_password boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 689 5 function 4QciDQp3vKjNuPEah54XMBvrjvyD public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2x7XawH6QTh6eBg2hNRqzQ3WME2m text , reference encoded_password 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym text , reference encoded_user 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC text , reference encoded_userinfo 3qDJMHEiC1T5Vik6nGt2CJvFxFDM text , reference password 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL text , reference user 4Yfg3yG11SsLgpAe6dzENEPz39dk text , reference userinfo 24JMPq739KrKuemXwWK8zpXGtWvz text . named identifier bool bool normal has_port boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1568 5 function 4CLeCb8bTxYAjEFuAXtr5VmQW6FE public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4SGWNm9TD3ZACEqJ9fmnWL1ZF47q text , reference port p8uqDVjGDrU4Eg9axo7dsTkztws text , reference port_number 363HbS6bzsgdHiLTk4Kr8pdkZJZY text . named identifier bool bool normal has_query boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1937 5 function 21mA7muF2gpvzFjJxaqjvjnnm6XY public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2N3uW9xQekt6pX19rHqrM5vcnVUH text , reference encoded_query 3VZ9J5FmgK7VsNUfrHxuyT4pNTGm text , reference params 2RJGYan9E8WvVKQM1LmRNNdUCc7E text , reference query 49Yox1iKKs7LmQ3wu1nCZXGKWEKf text . named identifier bool bool normal has_scheme boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 384 5 function 2wLECn7WbsBXGLpheUngfa9GEf1q public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4AoadMoEhkiTY9v83LDBwQt31Uti text , reference scheme_id 3aL5x6QNsMGNDAo8DP539u5TsZpp text . named identifier bool bool normal has_userinfo boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 647 5 function 2x7XawH6QTh6eBg2hNRqzQ3WME2m public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4QciDQp3vKjNuPEah54XMBvrjvyD text , reference encoded_password 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym text , reference encoded_user 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC text , reference encoded_userinfo 3qDJMHEiC1T5Vik6nGt2CJvFxFDM text , reference password 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL text , reference user 4Yfg3yG11SsLgpAe6dzENEPz39dk text , reference userinfo 24JMPq739KrKuemXwWK8zpXGtWvz text . named identifier bool bool normal host boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1076 5 function SytR6d7pUELeR1RNUpcWrXWQcY8 public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal host_address boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1174 5 function KoSC71QaaCYQtpr7xCwndbzWaKR public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text The value returned by this function depends on the type of host returned from the function reference host_type mSWKjRHEDFTnpxGSra6Q5eS7fjS text . list paragraph text If the type is reference host_type::ipv4 4B5yLFvhkpef7XX8ryKTaBWz8d6D text , then the IPv4 address string is returned. paragraph text If the type is reference host_type::ipv6 2y7UTsNbko8TLegXS5EpSa1goNog text , then the IPv6 address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::ipvfuture 25qx7TTMyctoe4LxqgMPXccSpy5Q text , then the IPvFuture address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::name QfoSUW8M1SPUL5EFVKwAUabTKCa 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 wGjRbosZ4DQY7xCpjwAZqPVHiim 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 named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal host_ipv4_address boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1277 5 function Zvcpzzy9h3HWgiqp7UZuEiWf4A7 public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text If the host type is reference host_type::ipv4 4B5yLFvhkpef7XX8ryKTaBWz8d6D text , this function returns the address as a value of type reference ipv4_address 4Xmd9k1GBKGKQj6PYc1qdt4tMUae 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 4Xmd9k1GBKGKQj6PYc1qdt4tMUae text . named identifier 4Xmd9k1GBKGKQj6PYc1qdt4tMUae ipv4_address normal host_ipv6_address boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1325 5 function 9sSdyLcyHxeuasmCKqifZp3ga5s public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text If the host type is reference host_type::ipv6 2y7UTsNbko8TLegXS5EpSa1goNog text , this function returns the address as a value of type reference ipv6_address 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T 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 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T text . named identifier 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T ipv6_address normal host_ipvfuture boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1358 5 function 4E8a8HgQbryrd4KcNHFajdVyLWib public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text If the host type is reference host_type::ipvfuture 25qx7TTMyctoe4LxqgMPXccSpy5Q 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. named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core normal host_name boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1395 5 function 2gNagLmHXZAqycctaaYmEYZc9pv public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text If the host type is reference host_type::name QfoSUW8M1SPUL5EFVKwAUabTKCa 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 named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal host_type boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1036 5 function mSWKjRHEDFTnpxGSra6Q5eS7fjS public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text This function returns one of the following constants representing the type of host present. list paragraph reference host_type::ipv4 4B5yLFvhkpef7XX8ryKTaBWz8d6D paragraph reference host_type::ipv6 2y7UTsNbko8TLegXS5EpSa1goNog paragraph reference host_type::ipvfuture 25qx7TTMyctoe4LxqgMPXccSpy5Q paragraph reference host_type::name QfoSUW8M1SPUL5EFVKwAUabTKCa paragraph reference host_type::none wGjRbosZ4DQY7xCpjwAZqPVHiim unordered paragraph text When reference has_authority 2omNW7ayWzkboBBXgc2Rm6C4y5kb text is false, the host type is reference host_type::none wGjRbosZ4DQY7xCpjwAZqPVHiim 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. named identifier 2M8hT55CSziFA9Zup4mKYdwvgUiE host_type identifier 2ejQGW57K8g7MFJhHAwPt5aumoLa urls normal is_path_absolute boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1691 5 function 2hgDJpXv5LpubtS8phLLnGk4a7XZ public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 M5bG6HzwZUo4ycGCKLY5CsUUXun text , reference encoded_segments 3jZFG9bXfeYJfGzZnt2Zim38gmMB text . reference path wc1MNXXCH1K1Shz81BmxVy1opwc text , reference segments 3YxJjcnyfcHtM9xLtszAHET8pyFv text . named identifier bool bool normal normalize boost/url/static_url.hpp include/boost/url/static_url.hpp 430 5 function fJUAi8AuTYXrvKUXGmRsYCKtuUu public regular 48MaMwY7JqeST8Mfy8WBA7wGLSzT 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 2wRwHBqb7uW8pRyBdHK2ag5gYr4R text , reference normalize_authority 2zt8gXYuprJZ5xnizAdcRJtmZjtg text , reference normalize_path 3KJZbPVLLm3Soiy8k42MN7tVSaXm text , reference normalize_query 4884zAuWwzykYzmScr5SZBYcsB5v text , reference normalize_fragment ziQA742syG1pxZjceNXdoMPPJRV lvalue-reference named identifier 48MaMwY7JqeST8Mfy8WBA7wGLSzT static_url normal normalize_authority boost/url/static_url.hpp include/boost/url/static_url.hpp 434 5 function 3NcThfHpyrE2MGK3r1ZdDUkxt64s public regular 48MaMwY7JqeST8Mfy8WBA7wGLSzT 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 lvalue-reference named identifier 48MaMwY7JqeST8Mfy8WBA7wGLSzT static_url normal normalize_fragment boost/url/static_url.hpp include/boost/url/static_url.hpp 440 5 function 4QGdwRPvEY3Q8wPJNH3oHNu9zmPu public regular 48MaMwY7JqeST8Mfy8WBA7wGLSzT 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 lvalue-reference named identifier 48MaMwY7JqeST8Mfy8WBA7wGLSzT static_url normal normalize_path boost/url/static_url.hpp include/boost/url/static_url.hpp 436 5 function 3yxd9xhUPXZfG61goL9J5qasNtV1 public regular 48MaMwY7JqeST8Mfy8WBA7wGLSzT 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 lvalue-reference named identifier 48MaMwY7JqeST8Mfy8WBA7wGLSzT static_url normal normalize_query boost/url/static_url.hpp include/boost/url/static_url.hpp 438 5 function 2Y2vSJirKKiNcY5ZWTxe7KbgEoxi public regular 48MaMwY7JqeST8Mfy8WBA7wGLSzT 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 lvalue-reference named identifier 48MaMwY7JqeST8Mfy8WBA7wGLSzT static_url normal normalize_scheme boost/url/static_url.hpp include/boost/url/static_url.hpp 432 5 function u9u4vhnqKMqqHiEHp1FsRcu7qA6 public regular 48MaMwY7JqeST8Mfy8WBA7wGLSzT 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 lvalue-reference named identifier 48MaMwY7JqeST8Mfy8WBA7wGLSzT static_url normal params boost/url/url_base.hpp include/boost/url/url_base.hpp 2186 5 boost/url/url_base.hpp include/boost/url/url_base.hpp 2182 5 boost/url/url_base.hpp include/boost/url/url_base.hpp 2244 5 boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2087 5 overloads 3hdYD66PBzHcr6JTNLGtXFRmpwjB public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3WcGK7mkJngNwmU5zz1zx9Vr7iC3 text , reference remove_query 2R5rf2bDtEpPE9hwtv8Ln4i6EAHv text , reference set_encoded_query v9Dry5ACH8wLSd7BYqpiHbGB7V8 text , reference set_query 4THvHraYktHgYNzU3qniR2MhXpuX text . see reference encoded_params 3WcGK7mkJngNwmU5zz1zx9Vr7iC3 text , reference encoded_query 3VZ9J5FmgK7VsNUfrHxuyT4pNTGm text , reference has_query 21mA7muF2gpvzFjJxaqjvjnnm6XY text , reference query 49Yox1iKKs7LmQ3wu1nCZXGKWEKf text . normal h2KhFjqyUKC3HGV5g2PZnGhgtie 3WKTuUvsgrf9YbmTdPXZLGJTg7AG 3oKGEwnRxyroFWsdqYwHqERdPKZ9 2Dh1FrqKLpBQUzJVYtqvr6ziuTX6 auto auto params boost/url/url_base.hpp include/boost/url/url_base.hpp 2182 5 function h2KhFjqyUKC3HGV5g2PZnGhgtie public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3WcGK7mkJngNwmU5zz1zx9Vr7iC3 text , reference remove_query 2R5rf2bDtEpPE9hwtv8Ln4i6EAHv text , reference set_encoded_query v9Dry5ACH8wLSd7BYqpiHbGB7V8 text , reference set_query 4THvHraYktHgYNzU3qniR2MhXpuX text . named identifier 4MtPiWDytNMbqCE6iciHidLK5Y4c params_ref normal params boost/url/url_base.hpp include/boost/url/url_base.hpp 2186 5 function 3WKTuUvsgrf9YbmTdPXZLGJTg7AG public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3WcGK7mkJngNwmU5zz1zx9Vr7iC3 text , reference encoded_query 3VZ9J5FmgK7VsNUfrHxuyT4pNTGm text , reference has_query 21mA7muF2gpvzFjJxaqjvjnnm6XY text , reference query 49Yox1iKKs7LmQ3wu1nCZXGKWEKf text . named identifier DJiFqyFR7zZh4N3HNJHhiAj7JPV params_view normal params boost/url/url_base.hpp include/boost/url/url_base.hpp 2244 5 function 3oKGEwnRxyroFWsdqYwHqERdPKZ9 public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3WcGK7mkJngNwmU5zz1zx9Vr7iC3 text , reference remove_query 2R5rf2bDtEpPE9hwtv8Ln4i6EAHv text , reference set_encoded_query v9Dry5ACH8wLSd7BYqpiHbGB7V8 text , reference set_query 4THvHraYktHgYNzU3qniR2MhXpuX text . named identifier 4MtPiWDytNMbqCE6iciHidLK5Y4c params_ref named identifier 5dyN7z5egGMdJFpXz9WbaL549xC encoding_opts opt normal params boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2087 5 function 2Dh1FrqKLpBQUzJVYtqvr6ziuTX6 public regular 27ryuyAvvRyzfzgketja5uQcFBcK named identifier DJiFqyFR7zZh4N3HNJHhiAj7JPV params_view named identifier 5dyN7z5egGMdJFpXz9WbaL549xC encoding_opts opt normal password boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 947 5 function 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4QciDQp3vKjNuPEah54XMBvrjvyD text , reference has_userinfo 2x7XawH6QTh6eBg2hNRqzQ3WME2m text , reference encoded_password 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym text , reference encoded_user 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC text , reference encoded_userinfo 3qDJMHEiC1T5Vik6nGt2CJvFxFDM text , reference user 4Yfg3yG11SsLgpAe6dzENEPz39dk text , reference userinfo 24JMPq739KrKuemXwWK8zpXGtWvz text . named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal path boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1744 5 function wc1MNXXCH1K1Shz81BmxVy1opwc public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2hgDJpXv5LpubtS8phLLnGk4a7XZ text , reference encoded_path M5bG6HzwZUo4ycGCKLY5CsUUXun text , reference encoded_segments 3jZFG9bXfeYJfGzZnt2Zim38gmMB text . reference segments 3YxJjcnyfcHtM9xLtszAHET8pyFv text . named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal persist boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 341 5 function 2aNVu1ZJUXAnkA1MUK2cfojoNCyj public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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. named specialization 3ndPMWYzhtTVAVCHsDKjaQkrDfmC shared_ptr identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std type named identifier 3hrVvoVYoDkX9t3w9abTXxDqGRaW url_view normal port boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1604 5 function p8uqDVjGDrU4Eg9axo7dsTkztws public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4SGWNm9TD3ZACEqJ9fmnWL1ZF47q text , reference has_port 4CLeCb8bTxYAjEFuAXtr5VmQW6FE text , reference port_number 363HbS6bzsgdHiLTk4Kr8pdkZJZY text . named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core normal port_number boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1640 5 function 363HbS6bzsgdHiLTk4Kr8pdkZJZY public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4SGWNm9TD3ZACEqJ9fmnWL1ZF47q text , reference has_port 4CLeCb8bTxYAjEFuAXtr5VmQW6FE text , reference port p8uqDVjGDrU4Eg9axo7dsTkztws text . named identifier w7yWEPLwtMpd5GnNHsV5ASwVxkX uint16_t normal query boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1987 5 function 49Yox1iKKs7LmQ3wu1nCZXGKWEKf public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2N3uW9xQekt6pX19rHqrM5vcnVUH text , reference encoded_query 3VZ9J5FmgK7VsNUfrHxuyT4pNTGm text , reference has_query 21mA7muF2gpvzFjJxaqjvjnnm6XY text , reference params 2RJGYan9E8WvVKQM1LmRNNdUCc7E text . named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal remove_authority boost/url/static_url.hpp include/boost/url/static_url.hpp 355 5 function gad9Da1zgjMxhSBVYwatzxrMkRJ public regular 48MaMwY7JqeST8Mfy8WBA7wGLSzT 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 2Br6ianGRhYuRbDpvbNVHc3kytth text . lvalue-reference named identifier 48MaMwY7JqeST8Mfy8WBA7wGLSzT static_url normal remove_fragment boost/url/static_url.hpp include/boost/url/static_url.hpp 420 5 function 3enjBrPeM5GQF9RgdB5wyhPULJWk public regular 48MaMwY7JqeST8Mfy8WBA7wGLSzT 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 3enjBrPeM5GQF9RgdB5wyhPULJWk text , reference set_encoded_fragment 3AqxZUVDaMdhbV64CuyLZ76PNFmR text , reference set_fragment 4WEDpyKefo5t88Abshsu3K5XgTvt text . lvalue-reference named identifier 48MaMwY7JqeST8Mfy8WBA7wGLSzT static_url normal remove_origin boost/url/static_url.hpp include/boost/url/static_url.hpp 427 5 function 3svvmttxGQFPJ5xorXojZpnqbFVp public regular 48MaMwY7JqeST8Mfy8WBA7wGLSzT 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 lvalue-reference named identifier 48MaMwY7JqeST8Mfy8WBA7wGLSzT static_url normal remove_password boost/url/static_url.hpp include/boost/url/static_url.hpp 372 5 function gdA4fV9oxdLEei55j1uU1Q6gqCB public regular 48MaMwY7JqeST8Mfy8WBA7wGLSzT 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 3M3tGnhVHGx7Vc2eUaFuGy7VoCxu text , reference set_encoded_user 2MEk1Cda8bzLjEPBG1V7MJvLRyqJ text , reference set_password 2YAaMd9PbnTHhrrZTFuaATwNBjuR text , reference set_user MYZLHVqFcgnRAf8PVbRnn3ZdMGq text . lvalue-reference named identifier 48MaMwY7JqeST8Mfy8WBA7wGLSzT static_url normal remove_port boost/url/static_url.hpp include/boost/url/static_url.hpp 401 5 function 3ugXMRzpnLUeDPQKs7L1kMf3dhBG public regular 48MaMwY7JqeST8Mfy8WBA7wGLSzT 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 3LEFuHiJFofpCmdb6z7kwJ5NBNyV text . lvalue-reference named identifier 48MaMwY7JqeST8Mfy8WBA7wGLSzT static_url normal remove_query boost/url/static_url.hpp include/boost/url/static_url.hpp 417 5 function U6C6WyTFCp1b2MuAWjhrat5Za7L public regular 48MaMwY7JqeST8Mfy8WBA7wGLSzT 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 3WcGK7mkJngNwmU5zz1zx9Vr7iC3 text , reference params 3hdYD66PBzHcr6JTNLGtXFRmpwjB text , reference set_encoded_query v9Dry5ACH8wLSd7BYqpiHbGB7V8 text , reference set_query 4THvHraYktHgYNzU3qniR2MhXpuX text . lvalue-reference named identifier 48MaMwY7JqeST8Mfy8WBA7wGLSzT static_url normal remove_scheme boost/url/static_url.hpp include/boost/url/static_url.hpp 350 5 function x8mx5AfxqwMaZQ3MLREUq4PoLLj public regular 48MaMwY7JqeST8Mfy8WBA7wGLSzT 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 e1kf55N8tdw9pJqTsqtDYk2MNAq text . lvalue-reference named identifier 48MaMwY7JqeST8Mfy8WBA7wGLSzT static_url normal remove_userinfo boost/url/static_url.hpp include/boost/url/static_url.hpp 362 5 function 385VbbDMBhTV6zCBdGxUdDob8acZ public regular 48MaMwY7JqeST8Mfy8WBA7wGLSzT 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 2cNxjGmiTtfUhWJ3CCo5qbyvNNAa text , reference set_userinfo 2sDfJ2dyCc57DXbV7a5CFj6Ryo7N text . lvalue-reference named identifier 48MaMwY7JqeST8Mfy8WBA7wGLSzT static_url normal reserve boost/url/url_base.hpp include/boost/url/url_base.hpp 187 5 function zpt1tVsUzr9PpovdHt6x8TgTZMD public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 named identifier void void named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std n normal resolve boost/url/url_base.hpp include/boost/url/url_base.hpp 2973 5 function 45Z6NdRjyroghszwmeBJuKmyuKLU public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 75qVNpuBHShJ8KKEUv4RCrwxEAB text , reference url_view 3hrVvoVYoDkX9t3w9abTXxDqGRaW text . named specialization qQFMz11M2hdnkDE2M6AYnTSkQhv result identifier dgHcH1svHs5X3czTwE2RBXQ7tGq system type named identifier void void lvalue-reference named identifier 27ryuyAvvRyzfzgketja5uQcFBcK url_view_base ref normal scheme boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 421 5 function 4AoadMoEhkiTY9v83LDBwQt31Uti public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2wLECn7WbsBXGLpheUngfa9GEf1q text , reference scheme_id 3aL5x6QNsMGNDAo8DP539u5TsZpp text . named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core normal scheme_id boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 471 5 function 3aL5x6QNsMGNDAo8DP539u5TsZpp public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 tVuW4uzt1HMgUxPtxroTuMsNi2G 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 d3jNvGWyWHyaA1snRDXYWd5jjkA text . paragraph text Otherwise, if the scheme is absent the value returned is reference urls::scheme::none 2DEQCVdvMZA94BHRjTMB2n7Ttdp2 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 2wLECn7WbsBXGLpheUngfa9GEf1q text , reference scheme 4AoadMoEhkiTY9v83LDBwQt31Uti text . named identifier tVuW4uzt1HMgUxPtxroTuMsNi2G scheme identifier 2ejQGW57K8g7MFJhHAwPt5aumoLa urls normal segments boost/url/url_base.hpp include/boost/url/url_base.hpp 1955 5 boost/url/url_base.hpp include/boost/url/url_base.hpp 1951 5 overloads 2bXmGRYoLQKFALtmsM2vVVCvmnVn public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3NGtuSVjhTWXrAF9sPpeS5FwZQN8 text , reference set_encoded_path MCx88BPGS5KgE3qhBfh89e3U57J text , reference set_path 3v9Fip9faoKhfWb6eQhiSgANjWdV text , reference set_path_absolute 4b7SsvokaeMTXQXBKywBXGVroR2 text . see reference is_path_absolute 2hgDJpXv5LpubtS8phLLnGk4a7XZ text , reference encoded_path M5bG6HzwZUo4ycGCKLY5CsUUXun text , reference encoded_segments 3NGtuSVjhTWXrAF9sPpeS5FwZQN8 text . reference path wc1MNXXCH1K1Shz81BmxVy1opwc text , reference segments_view 2QU7risgZzo8F84g7LttC6dG1GsH text . normal 4J7mUgLL9CaiS3Kv4ZcaRamupUkL uWpBZKqgnJKFef7rkZxJTw2WsxX auto auto segments boost/url/url_base.hpp include/boost/url/url_base.hpp 1951 5 function 4J7mUgLL9CaiS3Kv4ZcaRamupUkL public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3NGtuSVjhTWXrAF9sPpeS5FwZQN8 text , reference set_encoded_path MCx88BPGS5KgE3qhBfh89e3U57J text , reference set_path 3v9Fip9faoKhfWb6eQhiSgANjWdV text , reference set_path_absolute 4b7SsvokaeMTXQXBKywBXGVroR2 text . named identifier 3sLepuFTMctJHoZrLv8tvJTFkDPS segments_ref identifier 2ejQGW57K8g7MFJhHAwPt5aumoLa urls normal segments boost/url/url_base.hpp include/boost/url/url_base.hpp 1955 5 function uWpBZKqgnJKFef7rkZxJTw2WsxX public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 2hgDJpXv5LpubtS8phLLnGk4a7XZ text , reference encoded_path M5bG6HzwZUo4ycGCKLY5CsUUXun text , reference encoded_segments 3NGtuSVjhTWXrAF9sPpeS5FwZQN8 text . reference path wc1MNXXCH1K1Shz81BmxVy1opwc text , reference segments_view 2QU7risgZzo8F84g7LttC6dG1GsH text . named identifier 2QU7risgZzo8F84g7LttC6dG1GsH segments_view normal set_encoded_authority boost/url/static_url.hpp include/boost/url/static_url.hpp 353 5 function 3ennHwNWt7xsAZJR5EwoxTZK2167 public regular 48MaMwY7JqeST8Mfy8WBA7wGLSzT 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 gad9Da1zgjMxhSBVYwatzxrMkRJ text . lvalue-reference named identifier 48MaMwY7JqeST8Mfy8WBA7wGLSzT static_url named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view s normal set_encoded_fragment boost/url/static_url.hpp include/boost/url/static_url.hpp 424 5 function 3AqxZUVDaMdhbV64CuyLZ76PNFmR public regular 48MaMwY7JqeST8Mfy8WBA7wGLSzT 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 3enjBrPeM5GQF9RgdB5wyhPULJWk text , reference set_fragment 4WEDpyKefo5t88Abshsu3K5XgTvt text . lvalue-reference named identifier 48MaMwY7JqeST8Mfy8WBA7wGLSzT static_url named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view s normal set_encoded_host boost/url/static_url.hpp include/boost/url/static_url.hpp 377 5 function 2F5rUu5czVzhZb7r3cdJiW6Yfc2V public regular 48MaMwY7JqeST8Mfy8WBA7wGLSzT 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 4B5yLFvhkpef7XX8ryKTaBWz8d6D 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 2y7UTsNbko8TLegXS5EpSa1goNog 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 25qx7TTMyctoe4LxqgMPXccSpy5Q 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 QfoSUW8M1SPUL5EFVKwAUabTKCa 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 2z1iJGSd7fyFmj4AvaVz5zjk3kER text , reference set_encoded_host_name 3fTM9QkQKNHmAEW57jg9jKwrrwfT text , reference set_host 2cUp3QLVsbaUtWiqxpSKgiMteYwj text , reference set_host_address 24jcE2oP2XGCjyUd1XnQxhd7Qdp5 text , reference set_host_ipv4 YrfPJSXXcYSDzYgctFw6a3fUdW9 text , reference set_host_ipv6 NkkRWsxnLPD4F7FQPKfgpmV6H7C text , reference set_host_ipvfuture 4FgKrPH1ECyNgs1vcaiAPnLMT6FM text , reference set_host_name 28xgRdwaP5PGzXY3mVnkCAGwVkpy text . lvalue-reference named identifier 48MaMwY7JqeST8Mfy8WBA7wGLSzT static_url named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view s normal set_encoded_host_address boost/url/static_url.hpp include/boost/url/static_url.hpp 381 5 function 2z1iJGSd7fyFmj4AvaVz5zjk3kER public regular 48MaMwY7JqeST8Mfy8WBA7wGLSzT 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 4B5yLFvhkpef7XX8ryKTaBWz8d6D 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 2y7UTsNbko8TLegXS5EpSa1goNog 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 25qx7TTMyctoe4LxqgMPXccSpy5Q 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 QfoSUW8M1SPUL5EFVKwAUabTKCa 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 2F5rUu5czVzhZb7r3cdJiW6Yfc2V text , reference set_encoded_host_name 3fTM9QkQKNHmAEW57jg9jKwrrwfT text , reference set_host 2cUp3QLVsbaUtWiqxpSKgiMteYwj text , reference set_host_address 24jcE2oP2XGCjyUd1XnQxhd7Qdp5 text , reference set_host_ipv4 YrfPJSXXcYSDzYgctFw6a3fUdW9 text , reference set_host_ipv6 NkkRWsxnLPD4F7FQPKfgpmV6H7C text , reference set_host_ipvfuture 4FgKrPH1ECyNgs1vcaiAPnLMT6FM text , reference set_host_name 28xgRdwaP5PGzXY3mVnkCAGwVkpy text . lvalue-reference named identifier 48MaMwY7JqeST8Mfy8WBA7wGLSzT static_url named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view s normal set_encoded_host_name boost/url/static_url.hpp include/boost/url/static_url.hpp 395 5 function 3fTM9QkQKNHmAEW57jg9jKwrrwfT public regular 48MaMwY7JqeST8Mfy8WBA7wGLSzT 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 QfoSUW8M1SPUL5EFVKwAUabTKCa 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 2F5rUu5czVzhZb7r3cdJiW6Yfc2V text , reference set_encoded_host_address 2z1iJGSd7fyFmj4AvaVz5zjk3kER text , reference set_host 2cUp3QLVsbaUtWiqxpSKgiMteYwj text , reference set_host_address 24jcE2oP2XGCjyUd1XnQxhd7Qdp5 text , reference set_host_ipv4 YrfPJSXXcYSDzYgctFw6a3fUdW9 text , reference set_host_ipv6 NkkRWsxnLPD4F7FQPKfgpmV6H7C text , reference set_host_ipvfuture 4FgKrPH1ECyNgs1vcaiAPnLMT6FM text , reference set_host_name 28xgRdwaP5PGzXY3mVnkCAGwVkpy text . lvalue-reference named identifier 48MaMwY7JqeST8Mfy8WBA7wGLSzT static_url named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view s normal set_encoded_params boost/url/url_base.hpp include/boost/url/url_base.hpp 2419 5 function 24HVoTb3hMrWVBMHrtxD1buWstCN public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 4FzhNxmTaWz7pzZaXUiuVRmBs2SH text , reference params 3hdYD66PBzHcr6JTNLGtXFRmpwjB text , reference remove_query 2R5rf2bDtEpPE9hwtv8Ln4i6EAHv text , reference set_encoded_query v9Dry5ACH8wLSd7BYqpiHbGB7V8 text , reference set_query 4THvHraYktHgYNzU3qniR2MhXpuX text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named specialization 474HF6bGJmJntnocv1iPAYL2crja initializer_list identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std type named identifier 21okxUDyXpX2g3uj7TzYTtM4Skgh param_pct_view ps normal set_encoded_password boost/url/static_url.hpp include/boost/url/static_url.hpp 370 5 function 38qMKR2N6SZjeBHcBknb4Hk7LukZ public regular 48MaMwY7JqeST8Mfy8WBA7wGLSzT 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 gdA4fV9oxdLEei55j1uU1Q6gqCB text , reference set_encoded_password 38qMKR2N6SZjeBHcBknb4Hk7LukZ text , reference set_encoded_user 22carPeUUqk8w28wgyndzSrSPjSd text , reference set_user ARVq1tGy4yWK9mj1g55GHdfhBcy text . lvalue-reference named identifier 48MaMwY7JqeST8Mfy8WBA7wGLSzT static_url named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view s normal set_encoded_path boost/url/static_url.hpp include/boost/url/static_url.hpp 408 5 function 2S62bxXG7Kan1q3dhZv8NCkAuj7z public regular 48MaMwY7JqeST8Mfy8WBA7wGLSzT 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 3NGtuSVjhTWXrAF9sPpeS5FwZQN8 text , reference segments 2bXmGRYoLQKFALtmsM2vVVCvmnVn text , reference set_path 3v9Fip9faoKhfWb6eQhiSgANjWdV text , reference set_path_absolute 4b7SsvokaeMTXQXBKywBXGVroR2 text . lvalue-reference named identifier 48MaMwY7JqeST8Mfy8WBA7wGLSzT static_url named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view s normal set_encoded_query boost/url/static_url.hpp include/boost/url/static_url.hpp 413 5 function 481Pze8cid7r1NzzieokbUMHLKsh public regular 48MaMwY7JqeST8Mfy8WBA7wGLSzT 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 3WcGK7mkJngNwmU5zz1zx9Vr7iC3 text , reference params 3hdYD66PBzHcr6JTNLGtXFRmpwjB text , reference remove_query 2R5rf2bDtEpPE9hwtv8Ln4i6EAHv text , reference set_query 4THvHraYktHgYNzU3qniR2MhXpuX text . lvalue-reference named identifier 48MaMwY7JqeST8Mfy8WBA7wGLSzT static_url named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view s normal set_encoded_user boost/url/static_url.hpp include/boost/url/static_url.hpp 366 5 function 22carPeUUqk8w28wgyndzSrSPjSd public regular 48MaMwY7JqeST8Mfy8WBA7wGLSzT 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 gdA4fV9oxdLEei55j1uU1Q6gqCB text , reference set_encoded_password 38qMKR2N6SZjeBHcBknb4Hk7LukZ text , reference set_password 3Td9zTwt4PTSxpLkXFtY9hXK7MjB text , reference set_user ARVq1tGy4yWK9mj1g55GHdfhBcy text . lvalue-reference named identifier 48MaMwY7JqeST8Mfy8WBA7wGLSzT static_url named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view s normal set_encoded_userinfo boost/url/static_url.hpp include/boost/url/static_url.hpp 360 5 function 2cNxjGmiTtfUhWJ3CCo5qbyvNNAa public regular 48MaMwY7JqeST8Mfy8WBA7wGLSzT 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 4QciDQp3vKjNuPEah54XMBvrjvyD text returns true. Otherwise, paragraph text If there is no colon, the user is set to the string. The function reference has_password 4QciDQp3vKjNuPEah54XMBvrjvyD 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 sGNgGfijxwV9WzubTygPba9mCQn text , reference set_userinfo 3WPfZEH3k9jEMW6zLcD16Xd3Uqyg text . lvalue-reference named identifier 48MaMwY7JqeST8Mfy8WBA7wGLSzT static_url named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view s normal set_encoded_zone_id boost/url/static_url.hpp include/boost/url/static_url.hpp 389 5 boost/url/url_base.hpp include/boost/url/url_base.hpp 1411 5 overloads 26KuBv3X6zCSbdDd7zJyPcJxEoS9 public regular 48MaMwY7JqeST8Mfy8WBA7wGLSzT 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 4X1oAamqzgD6NUQuQqZgb3E7Y8hN 3aHdifouYxatTYKn3YthGh77UTk4 auto auto set_encoded_zone_id boost/url/url_base.hpp include/boost/url/url_base.hpp 1411 5 function 4X1oAamqzgD6NUQuQqZgb3E7Y8hN public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view s normal set_encoded_zone_id boost/url/static_url.hpp include/boost/url/static_url.hpp 389 5 function 3aHdifouYxatTYKn3YthGh77UTk4 public regular 48MaMwY7JqeST8Mfy8WBA7wGLSzT 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 lvalue-reference named identifier 48MaMwY7JqeST8Mfy8WBA7wGLSzT static_url lvalue-reference named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view s normal set_fragment boost/url/static_url.hpp include/boost/url/static_url.hpp 422 5 function 4WEDpyKefo5t88Abshsu3K5XgTvt public regular 48MaMwY7JqeST8Mfy8WBA7wGLSzT 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 2TNB4s1W5aG5wvgM5sFhpkadBvP9 text , reference set_encoded_fragment 2hLzEE9gAKyxVT6kbPLwfet2MGnC text . lvalue-reference named identifier 48MaMwY7JqeST8Mfy8WBA7wGLSzT static_url named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal set_host boost/url/static_url.hpp include/boost/url/static_url.hpp 375 5 function 2cUp3QLVsbaUtWiqxpSKgiMteYwj public regular 48MaMwY7JqeST8Mfy8WBA7wGLSzT 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 4B5yLFvhkpef7XX8ryKTaBWz8d6D 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 2y7UTsNbko8TLegXS5EpSa1goNog 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 25qx7TTMyctoe4LxqgMPXccSpy5Q 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 QfoSUW8M1SPUL5EFVKwAUabTKCa 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 2F5rUu5czVzhZb7r3cdJiW6Yfc2V text , reference set_encoded_host_address 2z1iJGSd7fyFmj4AvaVz5zjk3kER text , reference set_encoded_host_name 3fTM9QkQKNHmAEW57jg9jKwrrwfT text , reference set_host_address 24jcE2oP2XGCjyUd1XnQxhd7Qdp5 text , reference set_host_ipv4 YrfPJSXXcYSDzYgctFw6a3fUdW9 text , reference set_host_ipv6 NkkRWsxnLPD4F7FQPKfgpmV6H7C text , reference set_host_ipvfuture 4FgKrPH1ECyNgs1vcaiAPnLMT6FM text , reference set_host_name 28xgRdwaP5PGzXY3mVnkCAGwVkpy text . lvalue-reference named identifier 48MaMwY7JqeST8Mfy8WBA7wGLSzT static_url named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal set_host_address boost/url/static_url.hpp include/boost/url/static_url.hpp 379 5 function 24jcE2oP2XGCjyUd1XnQxhd7Qdp5 public regular 48MaMwY7JqeST8Mfy8WBA7wGLSzT 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 4B5yLFvhkpef7XX8ryKTaBWz8d6D 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 2y7UTsNbko8TLegXS5EpSa1goNog 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 25qx7TTMyctoe4LxqgMPXccSpy5Q 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 QfoSUW8M1SPUL5EFVKwAUabTKCa 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 2F5rUu5czVzhZb7r3cdJiW6Yfc2V text , reference set_encoded_host_address 2z1iJGSd7fyFmj4AvaVz5zjk3kER text , reference set_encoded_host_name 3fTM9QkQKNHmAEW57jg9jKwrrwfT text , reference set_host 2cUp3QLVsbaUtWiqxpSKgiMteYwj text , reference set_host_address 24jcE2oP2XGCjyUd1XnQxhd7Qdp5 text , reference set_host_ipv4 YrfPJSXXcYSDzYgctFw6a3fUdW9 text , reference set_host_ipv6 NkkRWsxnLPD4F7FQPKfgpmV6H7C text , reference set_host_ipvfuture 4FgKrPH1ECyNgs1vcaiAPnLMT6FM text , reference set_host_name 28xgRdwaP5PGzXY3mVnkCAGwVkpy text . lvalue-reference named identifier 48MaMwY7JqeST8Mfy8WBA7wGLSzT static_url named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal set_host_ipv4 boost/url/static_url.hpp include/boost/url/static_url.hpp 383 5 function YrfPJSXXcYSDzYgctFw6a3fUdW9 public regular 48MaMwY7JqeST8Mfy8WBA7wGLSzT paragraph text The host is set to the specified IPv4 address. The host type is reference host_type::ipv4 4B5yLFvhkpef7XX8ryKTaBWz8d6D 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 2F5rUu5czVzhZb7r3cdJiW6Yfc2V text , reference set_encoded_host_address 2z1iJGSd7fyFmj4AvaVz5zjk3kER text , reference set_encoded_host_name 3fTM9QkQKNHmAEW57jg9jKwrrwfT text , reference set_host 2cUp3QLVsbaUtWiqxpSKgiMteYwj text , reference set_host_address 24jcE2oP2XGCjyUd1XnQxhd7Qdp5 text , reference set_host_ipv6 NkkRWsxnLPD4F7FQPKfgpmV6H7C text , reference set_host_ipvfuture 4FgKrPH1ECyNgs1vcaiAPnLMT6FM text , reference set_host_name 28xgRdwaP5PGzXY3mVnkCAGwVkpy text . lvalue-reference named identifier 48MaMwY7JqeST8Mfy8WBA7wGLSzT static_url lvalue-reference named identifier 4Xmd9k1GBKGKQj6PYc1qdt4tMUae ipv4_address addr normal set_host_ipv6 boost/url/static_url.hpp include/boost/url/static_url.hpp 385 5 function NkkRWsxnLPD4F7FQPKfgpmV6H7C public regular 48MaMwY7JqeST8Mfy8WBA7wGLSzT paragraph text The host is set to the specified IPv6 address. The host type is reference host_type::ipv6 2y7UTsNbko8TLegXS5EpSa1goNog 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 osScXCjJkJkSf5jPTGH5dPVin3q text , reference set_encoded_host_address 4DwBiJMifXNsmVFdmgKDhGDJZ3wh text , reference set_encoded_host_name fBFYvCn8kJ47xA7NVhe1Rghp5J8 text , reference set_host 36GzQWnsLo7vUpJDLjUBWfUao6v7 text , reference set_host_address 3bzhb9DrxWPqshAd4mygzPBefvw8 text , reference set_host_ipv4 9UnBBXEqhvdW1scEozkygaKMjGZ text , reference set_host_ipvfuture 55atbAUaUexHuQt9WaRpVBqgfdg text , reference set_host_name soNQwVrosnpg6yBhJnz9p8yjZta text . lvalue-reference named identifier 48MaMwY7JqeST8Mfy8WBA7wGLSzT static_url lvalue-reference named identifier 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T ipv6_address addr normal set_host_ipvfuture boost/url/static_url.hpp include/boost/url/static_url.hpp 391 5 function 4FgKrPH1ECyNgs1vcaiAPnLMT6FM public regular 48MaMwY7JqeST8Mfy8WBA7wGLSzT paragraph text The host is set to the specified IPvFuture string. The host type is reference host_type::ipvfuture 25qx7TTMyctoe4LxqgMPXccSpy5Q 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 2F5rUu5czVzhZb7r3cdJiW6Yfc2V text , reference set_encoded_host_address 2z1iJGSd7fyFmj4AvaVz5zjk3kER text , reference set_encoded_host_name 3fTM9QkQKNHmAEW57jg9jKwrrwfT text , reference set_host 2cUp3QLVsbaUtWiqxpSKgiMteYwj text , reference set_host_address 24jcE2oP2XGCjyUd1XnQxhd7Qdp5 text , reference set_host_ipv4 YrfPJSXXcYSDzYgctFw6a3fUdW9 text , reference set_host_ipv6 NkkRWsxnLPD4F7FQPKfgpmV6H7C text , reference set_host_name 28xgRdwaP5PGzXY3mVnkCAGwVkpy text . lvalue-reference named identifier 48MaMwY7JqeST8Mfy8WBA7wGLSzT static_url named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal set_host_name boost/url/static_url.hpp include/boost/url/static_url.hpp 393 5 function 28xgRdwaP5PGzXY3mVnkCAGwVkpy public regular 48MaMwY7JqeST8Mfy8WBA7wGLSzT 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 QfoSUW8M1SPUL5EFVKwAUabTKCa 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 2F5rUu5czVzhZb7r3cdJiW6Yfc2V text , reference set_encoded_host_address 2z1iJGSd7fyFmj4AvaVz5zjk3kER text , reference set_encoded_host_name 3fTM9QkQKNHmAEW57jg9jKwrrwfT text , reference set_host 2cUp3QLVsbaUtWiqxpSKgiMteYwj text , reference set_host_address 24jcE2oP2XGCjyUd1XnQxhd7Qdp5 text , reference set_host_ipv4 YrfPJSXXcYSDzYgctFw6a3fUdW9 text , reference set_host_ipv6 NkkRWsxnLPD4F7FQPKfgpmV6H7C text , reference set_host_ipvfuture 4FgKrPH1ECyNgs1vcaiAPnLMT6FM text . lvalue-reference named identifier 48MaMwY7JqeST8Mfy8WBA7wGLSzT static_url named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal set_params boost/url/static_url.hpp include/boost/url/static_url.hpp 415 5 function 37PhBDWLXfXBDNeEpn1HkXoNuCyK public regular 48MaMwY7JqeST8Mfy8WBA7wGLSzT 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 3WcGK7mkJngNwmU5zz1zx9Vr7iC3 text , reference remove_query U6C6WyTFCp1b2MuAWjhrat5Za7L text , reference set_encoded_query 481Pze8cid7r1NzzieokbUMHLKsh text , reference set_query 4AcGLPyjUZeiY2ME8FjsmVzBGGvP text . lvalue-reference named identifier 48MaMwY7JqeST8Mfy8WBA7wGLSzT static_url named specialization 474HF6bGJmJntnocv1iPAYL2crja initializer_list identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std type named identifier AbvEAFQMtFaLMVMSA2NZ5D5a7nN param_view ps named identifier 5dyN7z5egGMdJFpXz9WbaL549xC encoding_opts opts {} normal set_password boost/url/static_url.hpp include/boost/url/static_url.hpp 368 5 function 3Td9zTwt4PTSxpLkXFtY9hXK7MjB public regular 48MaMwY7JqeST8Mfy8WBA7wGLSzT 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 igKd3Gv9P5L4VjvQSC6giswwMEQ text , reference set_encoded_password 3M3tGnhVHGx7Vc2eUaFuGy7VoCxu text , reference set_encoded_user 2MEk1Cda8bzLjEPBG1V7MJvLRyqJ text , reference set_user MYZLHVqFcgnRAf8PVbRnn3ZdMGq text . lvalue-reference named identifier 48MaMwY7JqeST8Mfy8WBA7wGLSzT static_url named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal set_path boost/url/static_url.hpp include/boost/url/static_url.hpp 406 5 function 2CzvXBAaPUBsGuksdxFjYoCWPChB public regular 48MaMwY7JqeST8Mfy8WBA7wGLSzT 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 MCx88BPGS5KgE3qhBfh89e3U57J text or reference segments 2bXmGRYoLQKFALtmsM2vVVCvmnVn 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 3NGtuSVjhTWXrAF9sPpeS5FwZQN8 text , reference segments 2bXmGRYoLQKFALtmsM2vVVCvmnVn text , reference set_encoded_path 2S62bxXG7Kan1q3dhZv8NCkAuj7z text , reference set_path_absolute 4b7SsvokaeMTXQXBKywBXGVroR2 text . lvalue-reference named identifier 48MaMwY7JqeST8Mfy8WBA7wGLSzT static_url named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal set_path_absolute boost/url/url_base.hpp include/boost/url/url_base.hpp 1760 5 function 4b7SsvokaeMTXQXBKywBXGVroR2 public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3NGtuSVjhTWXrAF9sPpeS5FwZQN8 text , reference segments 2bXmGRYoLQKFALtmsM2vVVCvmnVn text , reference set_encoded_path MCx88BPGS5KgE3qhBfh89e3U57J text , reference set_path 3v9Fip9faoKhfWb6eQhiSgANjWdV text . named identifier bool bool named identifier bool bool absolute normal set_port boost/url/static_url.hpp include/boost/url/static_url.hpp 399 5 function 2VcPodtQRfdxGMDGqtdgapGUiQ1P public regular 48MaMwY7JqeST8Mfy8WBA7wGLSzT 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 1B1sp4Ef6qEaa3XYv8pbQFsfkZt text , reference set_port 3LEFuHiJFofpCmdb6z7kwJ5NBNyV text . lvalue-reference named identifier 48MaMwY7JqeST8Mfy8WBA7wGLSzT static_url named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal set_port_number boost/url/static_url.hpp include/boost/url/static_url.hpp 397 5 function 3fKgZ24wCPPwkDdf5ZKqb2NjuvkK public regular 48MaMwY7JqeST8Mfy8WBA7wGLSzT 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 3ugXMRzpnLUeDPQKs7L1kMf3dhBG text , reference set_port 2VcPodtQRfdxGMDGqtdgapGUiQ1P text . lvalue-reference named identifier 48MaMwY7JqeST8Mfy8WBA7wGLSzT static_url named identifier w7yWEPLwtMpd5GnNHsV5ASwVxkX uint16_t n normal set_query boost/url/static_url.hpp include/boost/url/static_url.hpp 411 5 function 4AcGLPyjUZeiY2ME8FjsmVzBGGvP public regular 48MaMwY7JqeST8Mfy8WBA7wGLSzT 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 3WcGK7mkJngNwmU5zz1zx9Vr7iC3 text , reference params 3hdYD66PBzHcr6JTNLGtXFRmpwjB text , reference remove_query 2R5rf2bDtEpPE9hwtv8Ln4i6EAHv text , reference set_encoded_query v9Dry5ACH8wLSd7BYqpiHbGB7V8 text . lvalue-reference named identifier 48MaMwY7JqeST8Mfy8WBA7wGLSzT static_url named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal set_scheme boost/url/static_url.hpp include/boost/url/static_url.hpp 346 5 function e1kf55N8tdw9pJqTsqtDYk2MNAq public regular 48MaMwY7JqeST8Mfy8WBA7wGLSzT 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 3y1CD4diAVFMNJd23sVxV2aC2Kw6 text . lvalue-reference named identifier 48MaMwY7JqeST8Mfy8WBA7wGLSzT static_url named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal set_scheme_id boost/url/static_url.hpp include/boost/url/static_url.hpp 348 5 function 3SFq2qA8k2zEJqijAGATcPyJbc5F public regular 48MaMwY7JqeST8Mfy8WBA7wGLSzT paragraph text This function sets the scheme to the specified known reference urls::scheme tVuW4uzt1HMgUxPtxroTuMsNi2G text id, which may not be reference scheme::unknown d3jNvGWyWHyaA1snRDXYWd5jjkA text or else an exception is thrown. If the id is reference scheme::none 2DEQCVdvMZA94BHRjTMB2n7Ttdp2 text , this function behaves as if reference remove_scheme 3y1CD4diAVFMNJd23sVxV2aC2Kw6 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 lvalue-reference named identifier 48MaMwY7JqeST8Mfy8WBA7wGLSzT static_url named identifier tVuW4uzt1HMgUxPtxroTuMsNi2G scheme identifier 2ejQGW57K8g7MFJhHAwPt5aumoLa urls id normal set_user boost/url/static_url.hpp include/boost/url/static_url.hpp 364 5 function ARVq1tGy4yWK9mj1g55GHdfhBcy public regular 48MaMwY7JqeST8Mfy8WBA7wGLSzT 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 gdA4fV9oxdLEei55j1uU1Q6gqCB text , reference set_encoded_password 38qMKR2N6SZjeBHcBknb4Hk7LukZ text , reference set_encoded_user 22carPeUUqk8w28wgyndzSrSPjSd text , reference set_password 3Td9zTwt4PTSxpLkXFtY9hXK7MjB text . lvalue-reference named identifier 48MaMwY7JqeST8Mfy8WBA7wGLSzT static_url named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal set_userinfo boost/url/static_url.hpp include/boost/url/static_url.hpp 358 5 function 2sDfJ2dyCc57DXbV7a5CFj6Ryo7N public regular 48MaMwY7JqeST8Mfy8WBA7wGLSzT 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 4QciDQp3vKjNuPEah54XMBvrjvyD text returns true. Otherwise, paragraph text If there is no colon, the user is set to the string. The function reference has_password 4QciDQp3vKjNuPEah54XMBvrjvyD 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 385VbbDMBhTV6zCBdGxUdDob8acZ text , reference set_encoded_userinfo 2cNxjGmiTtfUhWJ3CCo5qbyvNNAa text . lvalue-reference named identifier 48MaMwY7JqeST8Mfy8WBA7wGLSzT static_url named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal set_zone_id boost/url/static_url.hpp include/boost/url/static_url.hpp 387 5 function 2WW1EfGgnaL8MKTS5uMZLWkF9P7o public regular 48MaMwY7JqeST8Mfy8WBA7wGLSzT 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 lvalue-reference named identifier 48MaMwY7JqeST8Mfy8WBA7wGLSzT static_url named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal size boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 201 5 function 2Z9j51jzFxpMXyB1ZjxR329S4Puk public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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. named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std normal user boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 848 5 function 4Yfg3yG11SsLgpAe6dzENEPz39dk public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4QciDQp3vKjNuPEah54XMBvrjvyD text , reference has_userinfo 2x7XawH6QTh6eBg2hNRqzQ3WME2m text , reference encoded_password 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym text , reference encoded_user 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC text , reference encoded_userinfo 3qDJMHEiC1T5Vik6nGt2CJvFxFDM text , reference password 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL text , reference userinfo 24JMPq739KrKuemXwWK8zpXGtWvz text . named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal userinfo boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 748 5 function 24JMPq739KrKuemXwWK8zpXGtWvz public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4UumWzLNRv3vgTVdDkz5PVqdSsSL 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 4QciDQp3vKjNuPEah54XMBvrjvyD text , reference has_userinfo 2x7XawH6QTh6eBg2hNRqzQ3WME2m text , reference encoded_password 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym text , reference encoded_user 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC text , reference encoded_userinfo 3qDJMHEiC1T5Vik6nGt2CJvFxFDM text , reference password 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL text , reference user 4Yfg3yG11SsLgpAe6dzENEPz39dk text . named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal zone_id boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1480 5 function 3QgkE48ZuKvk3EGbnydRNa7ob9XL public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text If the host type is reference host_type::ipv6 2y7UTsNbko8TLegXS5EpSa1goNog 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 named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal operator basic_string_view<char> boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 299 5 function 3uYCaZr2Kk1eGAMsuRXTehXkXZwv public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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. named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core conversion max_size boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 173 5 function 39V9A9oqw6EqsRw4R5mxeMpeqePo public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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. named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std normal constexpr static 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 function 2TwwpddeAxzjzfbTirqgZeddg3n6 protected regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std salt 0 normal static_url_base boost/url/static_url.hpp include/boost/url/static_url.hpp 52 1 record 2egpzk38s9q8jE4fNG71Y15WvAVC regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 75qVNpuBHShJ8KKEUv4RCrwxEAB paragraph reference url_view 3hrVvoVYoDkX9t3w9abTXxDqGRaW paragraph reference static_url 48MaMwY7JqeST8Mfy8WBA7wGLSzT unordered heading text Parsing Functions 1 list paragraph reference parse_absolute_uri 2ARWB82XdRYexehQmFQZjcEKzoSi paragraph reference parse_origin_form YwftbCXGz1kG5uRUguacNEwrkaP paragraph reference parse_relative_ref u1SFmy6a6wtXTYxrMnssMwa7K6G paragraph reference parse_uri 2nNq8RtS22vhgfkFAo8dGh6NW87n paragraph reference parse_uri_reference 4KCrVrNi2iTJ15zBNtvdSNip4rmV unordered brief text Common implementation for all static URLs reference format_to cLKVoifuzVMusLZv1zV2vk1L2K3 reference format_to 3bDKeYzcaysYNkwtHjg2EkeVGZf3 reference operator!= tkwNEJdWJqwprh85787u3xpyauu reference operator< 22wNuw5VxKWrVLMDGM9VPFjJshU6 reference operator<= 3QqsgavNMQTmxMW1t9qAoAocshM6 reference operator== GhudPV3CuyCeCKSftvpKEQLQtJ4 reference operator> 3CgAf4w5dyww6CMhGWkJm1fJiHum reference operator>= 2V16XgrptBcWFtoZaJ3DExhQXY6 reference resolve 4ZbWvyKBMwfyhwwk3YYEco8ttTeS other __visibility__ class named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base public 48MaMwY7JqeST8Mfy8WBA7wGLSzT 3fqhU2zdn6LwiSAm9upTzbtboK1U 3ESzuLSF2zD1TghU6qemdUksdP2V oHRP7v9PjrTqy9YjGBt8xxSqTLn HxCZYcsETDaw1bRzUVB9HpjzDZH r7EPCNuC2kWeArshSQf9kS35QJA 3Lh94K8cNrPFyFYw36XmhhtFMLpf VbvXoprikWfUm5mR56ZFYECXt9J 4DmmNdXmY3VWyP6HoKWQVEExBzaV 2GaF4F3gH2Y5LkyYXCrr3VyP9tpJ ipF8M41qPyuMM5XLe5JGZYSc42h FMBiWLrznwNXgkDuu4xneE9NeCD 3oodjUy4VDbgnxfeqkxwvqQvf7hK 4SGWNm9TD3ZACEqJ9fmnWL1ZF47q 492Pha8s74Xj1GjgZ82x193B56bP 3gVZJ5SpfCzYoZgafZW71cueQ3u3 3WcGK7mkJngNwmU5zz1zx9Vr7iC3 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym M5bG6HzwZUo4ycGCKLY5CsUUXun 3VZ9J5FmgK7VsNUfrHxuyT4pNTGm 3oB1p7aLxKXx3FxEqHaKSnCiNfXM 3NGtuSVjhTWXrAF9sPpeS5FwZQN8 UJaw1aYaRaLhmYt2h416g598hi4 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC 3qDJMHEiC1T5Vik6nGt2CJvFxFDM 4Bt9AGe8WEFmjA79MWAiGPDtMUW8 2T5XA2udwnVeh4RFi6U9UrLirJFJ 2omNW7ayWzkboBBXgc2Rm6C4y5kb 2RYFJUJHdYjygxHWSb57bHWfkHgN 4QciDQp3vKjNuPEah54XMBvrjvyD 4CLeCb8bTxYAjEFuAXtr5VmQW6FE 21mA7muF2gpvzFjJxaqjvjnnm6XY 2wLECn7WbsBXGLpheUngfa9GEf1q 2x7XawH6QTh6eBg2hNRqzQ3WME2m SytR6d7pUELeR1RNUpcWrXWQcY8 KoSC71QaaCYQtpr7xCwndbzWaKR Zvcpzzy9h3HWgiqp7UZuEiWf4A7 9sSdyLcyHxeuasmCKqifZp3ga5s 4E8a8HgQbryrd4KcNHFajdVyLWib 2gNagLmHXZAqycctaaYmEYZc9pv mSWKjRHEDFTnpxGSra6Q5eS7fjS 2hgDJpXv5LpubtS8phLLnGk4a7XZ 3655iutEyVMXNoWhFCVBWGtCcakA 2zt8gXYuprJZ5xnizAdcRJtmZjtg ziQA742syG1pxZjceNXdoMPPJRV 3KJZbPVLLm3Soiy8k42MN7tVSaXm 4884zAuWwzykYzmScr5SZBYcsB5v 2wRwHBqb7uW8pRyBdHK2ag5gYr4R 3hdYD66PBzHcr6JTNLGtXFRmpwjB 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL wc1MNXXCH1K1Shz81BmxVy1opwc 2aNVu1ZJUXAnkA1MUK2cfojoNCyj p8uqDVjGDrU4Eg9axo7dsTkztws 363HbS6bzsgdHiLTk4Kr8pdkZJZY 49Yox1iKKs7LmQ3wu1nCZXGKWEKf 2bHQfxWtGijDtNutjkX9m9nmNJgq 2TNB4s1W5aG5wvgM5sFhpkadBvP9 pNfxsxtkcrtaLBrtxg4hje6Qwve igKd3Gv9P5L4VjvQSC6giswwMEQ 1B1sp4Ef6qEaa3XYv8pbQFsfkZt 2R5rf2bDtEpPE9hwtv8Ln4i6EAHv 3y1CD4diAVFMNJd23sVxV2aC2Kw6 sGNgGfijxwV9WzubTygPba9mCQn zpt1tVsUzr9PpovdHt6x8TgTZMD 45Z6NdRjyroghszwmeBJuKmyuKLU 4AoadMoEhkiTY9v83LDBwQt31Uti 3aL5x6QNsMGNDAo8DP539u5TsZpp 2bXmGRYoLQKFALtmsM2vVVCvmnVn 2Br6ianGRhYuRbDpvbNVHc3kytth 2hLzEE9gAKyxVT6kbPLwfet2MGnC osScXCjJkJkSf5jPTGH5dPVin3q 4DwBiJMifXNsmVFdmgKDhGDJZ3wh fBFYvCn8kJ47xA7NVhe1Rghp5J8 24HVoTb3hMrWVBMHrtxD1buWstCN 3M3tGnhVHGx7Vc2eUaFuGy7VoCxu MCx88BPGS5KgE3qhBfh89e3U57J v9Dry5ACH8wLSd7BYqpiHbGB7V8 2MEk1Cda8bzLjEPBG1V7MJvLRyqJ gNzAQHZHDPXQiqwfYS6GwxUvQsG 4X1oAamqzgD6NUQuQqZgb3E7Y8hN 2BFpJxb9o2AGu7rRGKFVoFsW7Pi4 36GzQWnsLo7vUpJDLjUBWfUao6v7 3bzhb9DrxWPqshAd4mygzPBefvw8 9UnBBXEqhvdW1scEozkygaKMjGZ 6SijdGWstqVJuYLMAU9YBwkBXSG 55atbAUaUexHuQt9WaRpVBqgfdg soNQwVrosnpg6yBhJnz9p8yjZta 4FzhNxmTaWz7pzZaXUiuVRmBs2SH 2YAaMd9PbnTHhrrZTFuaATwNBjuR 3v9Fip9faoKhfWb6eQhiSgANjWdV 4b7SsvokaeMTXQXBKywBXGVroR2 3LEFuHiJFofpCmdb6z7kwJ5NBNyV 49Q25jBbiW4ssURp7srqLCYtJxmr 4THvHraYktHgYNzU3qniR2MhXpuX 3QW2cbeaw11tvSPbrjEnJSQu2CC7 2wEQzdwYGT3faB4EpgEZkgYTqM2G MYZLHVqFcgnRAf8PVbRnn3ZdMGq 3WPfZEH3k9jEMW6zLcD16Xd3Uqyg 2gcj9bRhg1wZZAtNMQkD6jo35SjJ 2Z9j51jzFxpMXyB1ZjxR329S4Puk 4Yfg3yG11SsLgpAe6dzENEPz39dk 24JMPq739KrKuemXwWK8zpXGtWvz 3QgkE48ZuKvk3EGbnydRNa7ob9XL 3uYCaZr2Kk1eGAMsuRXTehXkXZwv 39V9A9oqw6EqsRw4R5mxeMpeqePo 2TwwpddeAxzjzfbTirqgZeddg3n6 3W9fYp1ZFAS3ZywBc5Df2pHLpWKC 2hXMK3JELH797t6CoH3m83CAMvfu 2eMZ38JedTPxM6DAGtBYqwBgEhBY 2E7V5rQdFb2GZTaPa2BDL1jFoEbN 4HpbrqkhKu981m5tZTeYnbNfCEwX 2uCVDchxtcSeMWmVTFWZM9ryu2Y4 48MaMwY7JqeST8Mfy8WBA7wGLSzT authority boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 564 5 function 3fqhU2zdn6LwiSAm9upTzbtboK1U public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text This function returns the authority as an reference authority_view 2fwXocwnoAG9WDGbqM3quKphV1qq 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 2GaF4F3gH2Y5LkyYXCrr3VyP9tpJ text , reference has_authority 2omNW7ayWzkboBBXgc2Rm6C4y5kb text . named identifier 2fwXocwnoAG9WDGbqM3quKphV1qq authority_view normal buffer boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 282 5 function 3ESzuLSF2zD1TghU6qemdUksdP2V public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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. named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core normal c_str boost/url/url_base.hpp include/boost/url/url_base.hpp 127 5 function oHRP7v9PjrTqy9YjGBt8xxSqTLn public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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. pointer named identifier char char normal capacity boost/url/url_base.hpp include/boost/url/url_base.hpp 146 5 function HxCZYcsETDaw1bRzUVB9HpjzDZH public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std normal clear boost/url/url_base.hpp include/boost/url/url_base.hpp 165 5 function r7EPCNuC2kWeArshSQf9kS35QJA public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 named identifier void void normal compare boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2446 5 function 3Lh94K8cNrPFyFYw36XmhhtFMLpf public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 named identifier int int lvalue-reference named identifier 27ryuyAvvRyzfzgketja5uQcFBcK url_view_base other normal data boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 258 5 function VbvXoprikWfUm5mR56ZFYECXt9J public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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. pointer named identifier char char normal empty boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 238 5 function 4DmmNdXmY3VWyP6HoKWQVEExBzaV public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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. named identifier bool bool normal encoded_authority boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 601 5 function 2GaF4F3gH2Y5LkyYXCrr3VyP9tpJ public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 3fqhU2zdn6LwiSAm9upTzbtboK1U text , reference has_authority 2omNW7ayWzkboBBXgc2Rm6C4y5kb text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_fragment boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2280 5 function ipF8M41qPyuMM5XLe5JGZYSc42h public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2T5XA2udwnVeh4RFi6U9UrLirJFJ text , reference has_fragment 2RYFJUJHdYjygxHWSb57bHWfkHgN text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_host boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1120 5 function FMBiWLrznwNXgkDuu4xneE9NeCD public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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. named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_host_address boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1237 5 function 3oodjUy4VDbgnxfeqkxwvqQvf7hK public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text The value returned by this function depends on the type of host returned from the function reference host_type mSWKjRHEDFTnpxGSra6Q5eS7fjS text . list paragraph text If the type is reference host_type::ipv4 4B5yLFvhkpef7XX8ryKTaBWz8d6D text , then the IPv4 address string is returned. paragraph text If the type is reference host_type::ipv6 2y7UTsNbko8TLegXS5EpSa1goNog text , then the IPv6 address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::ipvfuture 25qx7TTMyctoe4LxqgMPXccSpy5Q text , then the IPvFuture address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::name QfoSUW8M1SPUL5EFVKwAUabTKCa 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 wGjRbosZ4DQY7xCpjwAZqPVHiim 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. named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_host_and_port boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2325 5 function 4SGWNm9TD3ZACEqJ9fmnWL1ZF47q public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4CLeCb8bTxYAjEFuAXtr5VmQW6FE text , reference port p8uqDVjGDrU4Eg9axo7dsTkztws text , reference port_number 363HbS6bzsgdHiLTk4Kr8pdkZJZY text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_host_name boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1441 5 function 492Pha8s74Xj1GjgZ82x193B56bP public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text If the host type is reference host_type::name QfoSUW8M1SPUL5EFVKwAUabTKCa 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. named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_origin boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2355 5 function 3gVZJ5SpfCzYoZgafZW71cueQ3u3 public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 3oB1p7aLxKXx3FxEqHaKSnCiNfXM text , reference encoded_target UJaw1aYaRaLhmYt2h416g598hi4 text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_params boost/url/url_base.hpp include/boost/url/url_base.hpp 2248 5 boost/url/url_base.hpp include/boost/url/url_base.hpp 2300 5 overloads 3WcGK7mkJngNwmU5zz1zx9Vr7iC3 public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3hdYD66PBzHcr6JTNLGtXFRmpwjB text , reference remove_query 2R5rf2bDtEpPE9hwtv8Ln4i6EAHv text , reference set_encoded_query v9Dry5ACH8wLSd7BYqpiHbGB7V8 text , reference set_query 4THvHraYktHgYNzU3qniR2MhXpuX text . see reference encoded_query 3VZ9J5FmgK7VsNUfrHxuyT4pNTGm text , reference has_query 21mA7muF2gpvzFjJxaqjvjnnm6XY text , reference params 3hdYD66PBzHcr6JTNLGtXFRmpwjB text , reference query 49Yox1iKKs7LmQ3wu1nCZXGKWEKf text . normal 2Tfz89EdRJCtmaAcvePE2sFdTaFs WLnpSWkKJP479aAk2KVz4BEDpZ8 auto auto encoded_params boost/url/url_base.hpp include/boost/url/url_base.hpp 2300 5 function 2Tfz89EdRJCtmaAcvePE2sFdTaFs public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3hdYD66PBzHcr6JTNLGtXFRmpwjB text , reference remove_query 2R5rf2bDtEpPE9hwtv8Ln4i6EAHv text , reference set_encoded_query v9Dry5ACH8wLSd7BYqpiHbGB7V8 text , reference set_query 4THvHraYktHgYNzU3qniR2MhXpuX text . named identifier 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe params_encoded_ref normal encoded_params boost/url/url_base.hpp include/boost/url/url_base.hpp 2248 5 function WLnpSWkKJP479aAk2KVz4BEDpZ8 public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3VZ9J5FmgK7VsNUfrHxuyT4pNTGm text , reference has_query 21mA7muF2gpvzFjJxaqjvjnnm6XY text , reference params 3hdYD66PBzHcr6JTNLGtXFRmpwjB text , reference query 49Yox1iKKs7LmQ3wu1nCZXGKWEKf text . named identifier 3w4FJjjADY3EEHqUmBj5mvDKqdEB params_encoded_view normal encoded_password boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 996 5 function 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4QciDQp3vKjNuPEah54XMBvrjvyD text , reference has_userinfo 2x7XawH6QTh6eBg2hNRqzQ3WME2m text , reference encoded_user 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC text , reference encoded_userinfo 3qDJMHEiC1T5Vik6nGt2CJvFxFDM text , reference password 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL text , reference user 4Yfg3yG11SsLgpAe6dzENEPz39dk text , reference userinfo 24JMPq739KrKuemXwWK8zpXGtWvz text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_path boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1799 5 function M5bG6HzwZUo4ycGCKLY5CsUUXun public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2hgDJpXv5LpubtS8phLLnGk4a7XZ text , reference encoded_segments 3jZFG9bXfeYJfGzZnt2Zim38gmMB text . reference path wc1MNXXCH1K1Shz81BmxVy1opwc text , reference segments 3YxJjcnyfcHtM9xLtszAHET8pyFv text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_query boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2040 5 function 3VZ9J5FmgK7VsNUfrHxuyT4pNTGm public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2N3uW9xQekt6pX19rHqrM5vcnVUH text , reference has_query 21mA7muF2gpvzFjJxaqjvjnnm6XY text , reference params 2RJGYan9E8WvVKQM1LmRNNdUCc7E text , reference query 49Yox1iKKs7LmQ3wu1nCZXGKWEKf text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_resource boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2387 5 function 3oB1p7aLxKXx3FxEqHaKSnCiNfXM public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 3gVZJ5SpfCzYoZgafZW71cueQ3u3 text , reference encoded_target UJaw1aYaRaLhmYt2h416g598hi4 text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_segments boost/url/url_base.hpp include/boost/url/url_base.hpp 2018 5 boost/url/url_base.hpp include/boost/url/url_base.hpp 2014 5 overloads 3NGtuSVjhTWXrAF9sPpeS5FwZQN8 public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 4Ek5WSaWmrfbmnMRzJv3oVPGKCua text , reference set_encoded_path MCx88BPGS5KgE3qhBfh89e3U57J text , reference set_path 3v9Fip9faoKhfWb6eQhiSgANjWdV text , reference set_path_absolute 4b7SsvokaeMTXQXBKywBXGVroR2 text . see reference is_path_absolute 2hgDJpXv5LpubtS8phLLnGk4a7XZ text , reference encoded_path M5bG6HzwZUo4ycGCKLY5CsUUXun text , reference path wc1MNXXCH1K1Shz81BmxVy1opwc text , reference segments 2bXmGRYoLQKFALtmsM2vVVCvmnVn text , reference segments_encoded_view GKjeDHooSf2HAMf239p3oFfT3i3 text . normal 4Ek5WSaWmrfbmnMRzJv3oVPGKCua 4CifMdq25fpMkWFY7dcZ9ZwXrmCV auto auto encoded_segments boost/url/url_base.hpp include/boost/url/url_base.hpp 2014 5 function 4Ek5WSaWmrfbmnMRzJv3oVPGKCua public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3NGtuSVjhTWXrAF9sPpeS5FwZQN8 text , reference set_encoded_path MCx88BPGS5KgE3qhBfh89e3U57J text , reference set_path 3v9Fip9faoKhfWb6eQhiSgANjWdV text , reference set_path_absolute 4b7SsvokaeMTXQXBKywBXGVroR2 text . named identifier 24XcpKBAcyXN6FLZk8kR4zGAmKak segments_encoded_ref normal encoded_segments boost/url/url_base.hpp include/boost/url/url_base.hpp 2018 5 function 4CifMdq25fpMkWFY7dcZ9ZwXrmCV public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 2hgDJpXv5LpubtS8phLLnGk4a7XZ text , reference encoded_path M5bG6HzwZUo4ycGCKLY5CsUUXun text , reference path wc1MNXXCH1K1Shz81BmxVy1opwc text , reference segments 2bXmGRYoLQKFALtmsM2vVVCvmnVn text , reference segments_encoded_view GKjeDHooSf2HAMf239p3oFfT3i3 text . named identifier GKjeDHooSf2HAMf239p3oFfT3i3 segments_encoded_view normal encoded_target boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2419 5 function UJaw1aYaRaLhmYt2h416g598hi4 public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 3gVZJ5SpfCzYoZgafZW71cueQ3u3 text , reference encoded_resource 3oB1p7aLxKXx3FxEqHaKSnCiNfXM text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_user boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 901 5 function 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4QciDQp3vKjNuPEah54XMBvrjvyD text , reference has_userinfo 2x7XawH6QTh6eBg2hNRqzQ3WME2m text , reference encoded_password 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym text , reference encoded_userinfo 3qDJMHEiC1T5Vik6nGt2CJvFxFDM text , reference password 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL text , reference user 4Yfg3yG11SsLgpAe6dzENEPz39dk text , reference userinfo 24JMPq739KrKuemXwWK8zpXGtWvz text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_userinfo boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 800 5 function 3qDJMHEiC1T5Vik6nGt2CJvFxFDM public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4QciDQp3vKjNuPEah54XMBvrjvyD text , reference has_userinfo 2x7XawH6QTh6eBg2hNRqzQ3WME2m text , reference encoded_password 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym text , reference encoded_user 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC text , reference password 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL text , reference user 4Yfg3yG11SsLgpAe6dzENEPz39dk text , reference userinfo 24JMPq739KrKuemXwWK8zpXGtWvz text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_zone_id boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1526 5 function 4Bt9AGe8WEFmjA79MWAiGPDtMUW8 public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text If the host type is reference host_type::ipv6 2y7UTsNbko8TLegXS5EpSa1goNog 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. named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal fragment boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2233 5 function 2T5XA2udwnVeh4RFi6U9UrLirJFJ public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 ipF8M41qPyuMM5XLe5JGZYSc42h text , reference has_fragment 2RYFJUJHdYjygxHWSb57bHWfkHgN text . named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal has_authority boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 528 5 function 2omNW7ayWzkboBBXgc2Rm6C4y5kb public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 3fqhU2zdn6LwiSAm9upTzbtboK1U text , reference encoded_authority 2GaF4F3gH2Y5LkyYXCrr3VyP9tpJ text . named identifier bool bool normal has_fragment boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2173 5 function 2RYFJUJHdYjygxHWSb57bHWfkHgN public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 ipF8M41qPyuMM5XLe5JGZYSc42h text , reference fragment 2T5XA2udwnVeh4RFi6U9UrLirJFJ text . named identifier bool bool normal has_password boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 689 5 function 4QciDQp3vKjNuPEah54XMBvrjvyD public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2x7XawH6QTh6eBg2hNRqzQ3WME2m text , reference encoded_password 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym text , reference encoded_user 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC text , reference encoded_userinfo 3qDJMHEiC1T5Vik6nGt2CJvFxFDM text , reference password 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL text , reference user 4Yfg3yG11SsLgpAe6dzENEPz39dk text , reference userinfo 24JMPq739KrKuemXwWK8zpXGtWvz text . named identifier bool bool normal has_port boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1568 5 function 4CLeCb8bTxYAjEFuAXtr5VmQW6FE public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4SGWNm9TD3ZACEqJ9fmnWL1ZF47q text , reference port p8uqDVjGDrU4Eg9axo7dsTkztws text , reference port_number 363HbS6bzsgdHiLTk4Kr8pdkZJZY text . named identifier bool bool normal has_query boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1937 5 function 21mA7muF2gpvzFjJxaqjvjnnm6XY public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2N3uW9xQekt6pX19rHqrM5vcnVUH text , reference encoded_query 3VZ9J5FmgK7VsNUfrHxuyT4pNTGm text , reference params 2RJGYan9E8WvVKQM1LmRNNdUCc7E text , reference query 49Yox1iKKs7LmQ3wu1nCZXGKWEKf text . named identifier bool bool normal has_scheme boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 384 5 function 2wLECn7WbsBXGLpheUngfa9GEf1q public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4AoadMoEhkiTY9v83LDBwQt31Uti text , reference scheme_id 3aL5x6QNsMGNDAo8DP539u5TsZpp text . named identifier bool bool normal has_userinfo boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 647 5 function 2x7XawH6QTh6eBg2hNRqzQ3WME2m public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4QciDQp3vKjNuPEah54XMBvrjvyD text , reference encoded_password 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym text , reference encoded_user 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC text , reference encoded_userinfo 3qDJMHEiC1T5Vik6nGt2CJvFxFDM text , reference password 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL text , reference user 4Yfg3yG11SsLgpAe6dzENEPz39dk text , reference userinfo 24JMPq739KrKuemXwWK8zpXGtWvz text . named identifier bool bool normal host boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1076 5 function SytR6d7pUELeR1RNUpcWrXWQcY8 public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal host_address boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1174 5 function KoSC71QaaCYQtpr7xCwndbzWaKR public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text The value returned by this function depends on the type of host returned from the function reference host_type mSWKjRHEDFTnpxGSra6Q5eS7fjS text . list paragraph text If the type is reference host_type::ipv4 4B5yLFvhkpef7XX8ryKTaBWz8d6D text , then the IPv4 address string is returned. paragraph text If the type is reference host_type::ipv6 2y7UTsNbko8TLegXS5EpSa1goNog text , then the IPv6 address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::ipvfuture 25qx7TTMyctoe4LxqgMPXccSpy5Q text , then the IPvFuture address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::name QfoSUW8M1SPUL5EFVKwAUabTKCa 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 wGjRbosZ4DQY7xCpjwAZqPVHiim 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 named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal host_ipv4_address boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1277 5 function Zvcpzzy9h3HWgiqp7UZuEiWf4A7 public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text If the host type is reference host_type::ipv4 4B5yLFvhkpef7XX8ryKTaBWz8d6D text , this function returns the address as a value of type reference ipv4_address 4Xmd9k1GBKGKQj6PYc1qdt4tMUae 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 4Xmd9k1GBKGKQj6PYc1qdt4tMUae text . named identifier 4Xmd9k1GBKGKQj6PYc1qdt4tMUae ipv4_address normal host_ipv6_address boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1325 5 function 9sSdyLcyHxeuasmCKqifZp3ga5s public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text If the host type is reference host_type::ipv6 2y7UTsNbko8TLegXS5EpSa1goNog text , this function returns the address as a value of type reference ipv6_address 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T 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 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T text . named identifier 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T ipv6_address normal host_ipvfuture boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1358 5 function 4E8a8HgQbryrd4KcNHFajdVyLWib public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text If the host type is reference host_type::ipvfuture 25qx7TTMyctoe4LxqgMPXccSpy5Q 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. named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core normal host_name boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1395 5 function 2gNagLmHXZAqycctaaYmEYZc9pv public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text If the host type is reference host_type::name QfoSUW8M1SPUL5EFVKwAUabTKCa 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 named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal host_type boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1036 5 function mSWKjRHEDFTnpxGSra6Q5eS7fjS public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text This function returns one of the following constants representing the type of host present. list paragraph reference host_type::ipv4 4B5yLFvhkpef7XX8ryKTaBWz8d6D paragraph reference host_type::ipv6 2y7UTsNbko8TLegXS5EpSa1goNog paragraph reference host_type::ipvfuture 25qx7TTMyctoe4LxqgMPXccSpy5Q paragraph reference host_type::name QfoSUW8M1SPUL5EFVKwAUabTKCa paragraph reference host_type::none wGjRbosZ4DQY7xCpjwAZqPVHiim unordered paragraph text When reference has_authority 2omNW7ayWzkboBBXgc2Rm6C4y5kb text is false, the host type is reference host_type::none wGjRbosZ4DQY7xCpjwAZqPVHiim 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. named identifier 2M8hT55CSziFA9Zup4mKYdwvgUiE host_type identifier 2ejQGW57K8g7MFJhHAwPt5aumoLa urls normal is_path_absolute boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1691 5 function 2hgDJpXv5LpubtS8phLLnGk4a7XZ public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 M5bG6HzwZUo4ycGCKLY5CsUUXun text , reference encoded_segments 3jZFG9bXfeYJfGzZnt2Zim38gmMB text . reference path wc1MNXXCH1K1Shz81BmxVy1opwc text , reference segments 3YxJjcnyfcHtM9xLtszAHET8pyFv text . named identifier bool bool normal normalize boost/url/url_base.hpp include/boost/url/url_base.hpp 2731 5 function 3655iutEyVMXNoWhFCVBWGtCcakA public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 2wRwHBqb7uW8pRyBdHK2ag5gYr4R text , reference normalize_authority 2zt8gXYuprJZ5xnizAdcRJtmZjtg text , reference normalize_path 3KJZbPVLLm3Soiy8k42MN7tVSaXm text , reference normalize_query 4884zAuWwzykYzmScr5SZBYcsB5v text , reference normalize_fragment ziQA742syG1pxZjceNXdoMPPJRV lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base normal normalize_authority boost/url/url_base.hpp include/boost/url/url_base.hpp 2786 5 function 2zt8gXYuprJZ5xnizAdcRJtmZjtg public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base normal normalize_fragment boost/url/url_base.hpp include/boost/url/url_base.hpp 2873 5 function ziQA742syG1pxZjceNXdoMPPJRV public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base normal normalize_path boost/url/url_base.hpp include/boost/url/url_base.hpp 2817 5 function 3KJZbPVLLm3Soiy8k42MN7tVSaXm public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base normal normalize_query boost/url/url_base.hpp include/boost/url/url_base.hpp 2845 5 function 4884zAuWwzykYzmScr5SZBYcsB5v public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base normal normalize_scheme boost/url/url_base.hpp include/boost/url/url_base.hpp 2756 5 function 2wRwHBqb7uW8pRyBdHK2ag5gYr4R public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base normal params boost/url/url_base.hpp include/boost/url/url_base.hpp 2186 5 boost/url/url_base.hpp include/boost/url/url_base.hpp 2182 5 boost/url/url_base.hpp include/boost/url/url_base.hpp 2244 5 boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2087 5 overloads 3hdYD66PBzHcr6JTNLGtXFRmpwjB public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3WcGK7mkJngNwmU5zz1zx9Vr7iC3 text , reference remove_query 2R5rf2bDtEpPE9hwtv8Ln4i6EAHv text , reference set_encoded_query v9Dry5ACH8wLSd7BYqpiHbGB7V8 text , reference set_query 4THvHraYktHgYNzU3qniR2MhXpuX text . see reference encoded_params 3WcGK7mkJngNwmU5zz1zx9Vr7iC3 text , reference encoded_query 3VZ9J5FmgK7VsNUfrHxuyT4pNTGm text , reference has_query 21mA7muF2gpvzFjJxaqjvjnnm6XY text , reference query 49Yox1iKKs7LmQ3wu1nCZXGKWEKf text . normal h2KhFjqyUKC3HGV5g2PZnGhgtie 3WKTuUvsgrf9YbmTdPXZLGJTg7AG 3oKGEwnRxyroFWsdqYwHqERdPKZ9 2Dh1FrqKLpBQUzJVYtqvr6ziuTX6 auto auto params boost/url/url_base.hpp include/boost/url/url_base.hpp 2182 5 function h2KhFjqyUKC3HGV5g2PZnGhgtie public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3WcGK7mkJngNwmU5zz1zx9Vr7iC3 text , reference remove_query 2R5rf2bDtEpPE9hwtv8Ln4i6EAHv text , reference set_encoded_query v9Dry5ACH8wLSd7BYqpiHbGB7V8 text , reference set_query 4THvHraYktHgYNzU3qniR2MhXpuX text . named identifier 4MtPiWDytNMbqCE6iciHidLK5Y4c params_ref normal params boost/url/url_base.hpp include/boost/url/url_base.hpp 2186 5 function 3WKTuUvsgrf9YbmTdPXZLGJTg7AG public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3WcGK7mkJngNwmU5zz1zx9Vr7iC3 text , reference encoded_query 3VZ9J5FmgK7VsNUfrHxuyT4pNTGm text , reference has_query 21mA7muF2gpvzFjJxaqjvjnnm6XY text , reference query 49Yox1iKKs7LmQ3wu1nCZXGKWEKf text . named identifier DJiFqyFR7zZh4N3HNJHhiAj7JPV params_view normal params boost/url/url_base.hpp include/boost/url/url_base.hpp 2244 5 function 3oKGEwnRxyroFWsdqYwHqERdPKZ9 public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3WcGK7mkJngNwmU5zz1zx9Vr7iC3 text , reference remove_query 2R5rf2bDtEpPE9hwtv8Ln4i6EAHv text , reference set_encoded_query v9Dry5ACH8wLSd7BYqpiHbGB7V8 text , reference set_query 4THvHraYktHgYNzU3qniR2MhXpuX text . named identifier 4MtPiWDytNMbqCE6iciHidLK5Y4c params_ref named identifier 5dyN7z5egGMdJFpXz9WbaL549xC encoding_opts opt normal params boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2087 5 function 2Dh1FrqKLpBQUzJVYtqvr6ziuTX6 public regular 27ryuyAvvRyzfzgketja5uQcFBcK named identifier DJiFqyFR7zZh4N3HNJHhiAj7JPV params_view named identifier 5dyN7z5egGMdJFpXz9WbaL549xC encoding_opts opt normal password boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 947 5 function 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4QciDQp3vKjNuPEah54XMBvrjvyD text , reference has_userinfo 2x7XawH6QTh6eBg2hNRqzQ3WME2m text , reference encoded_password 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym text , reference encoded_user 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC text , reference encoded_userinfo 3qDJMHEiC1T5Vik6nGt2CJvFxFDM text , reference user 4Yfg3yG11SsLgpAe6dzENEPz39dk text , reference userinfo 24JMPq739KrKuemXwWK8zpXGtWvz text . named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal path boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1744 5 function wc1MNXXCH1K1Shz81BmxVy1opwc public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2hgDJpXv5LpubtS8phLLnGk4a7XZ text , reference encoded_path M5bG6HzwZUo4ycGCKLY5CsUUXun text , reference encoded_segments 3jZFG9bXfeYJfGzZnt2Zim38gmMB text . reference segments 3YxJjcnyfcHtM9xLtszAHET8pyFv text . named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal persist boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 341 5 function 2aNVu1ZJUXAnkA1MUK2cfojoNCyj public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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. named specialization 3ndPMWYzhtTVAVCHsDKjaQkrDfmC shared_ptr identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std type named identifier 3hrVvoVYoDkX9t3w9abTXxDqGRaW url_view normal port boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1604 5 function p8uqDVjGDrU4Eg9axo7dsTkztws public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4SGWNm9TD3ZACEqJ9fmnWL1ZF47q text , reference has_port 4CLeCb8bTxYAjEFuAXtr5VmQW6FE text , reference port_number 363HbS6bzsgdHiLTk4Kr8pdkZJZY text . named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core normal port_number boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1640 5 function 363HbS6bzsgdHiLTk4Kr8pdkZJZY public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4SGWNm9TD3ZACEqJ9fmnWL1ZF47q text , reference has_port 4CLeCb8bTxYAjEFuAXtr5VmQW6FE text , reference port p8uqDVjGDrU4Eg9axo7dsTkztws text . named identifier w7yWEPLwtMpd5GnNHsV5ASwVxkX uint16_t normal query boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1987 5 function 49Yox1iKKs7LmQ3wu1nCZXGKWEKf public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2N3uW9xQekt6pX19rHqrM5vcnVUH text , reference encoded_query 3VZ9J5FmgK7VsNUfrHxuyT4pNTGm text , reference has_query 21mA7muF2gpvzFjJxaqjvjnnm6XY text , reference params 2RJGYan9E8WvVKQM1LmRNNdUCc7E text . named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal remove_authority boost/url/url_base.hpp include/boost/url/url_base.hpp 408 5 function 2bHQfxWtGijDtNutjkX9m9nmNJgq public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 2Br6ianGRhYuRbDpvbNVHc3kytth text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base normal remove_fragment boost/url/url_base.hpp include/boost/url/url_base.hpp 2510 5 function 2TNB4s1W5aG5wvgM5sFhpkadBvP9 public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 2TNB4s1W5aG5wvgM5sFhpkadBvP9 text , reference set_encoded_fragment 2hLzEE9gAKyxVT6kbPLwfet2MGnC text , reference set_fragment 2BFpJxb9o2AGu7rRGKFVoFsW7Pi4 text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base normal remove_origin boost/url/url_base.hpp include/boost/url/url_base.hpp 2644 5 function pNfxsxtkcrtaLBrtxg4hje6Qwve public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base normal remove_password boost/url/url_base.hpp include/boost/url/url_base.hpp 857 5 function igKd3Gv9P5L4VjvQSC6giswwMEQ public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3M3tGnhVHGx7Vc2eUaFuGy7VoCxu text , reference set_encoded_user 2MEk1Cda8bzLjEPBG1V7MJvLRyqJ text , reference set_password 2YAaMd9PbnTHhrrZTFuaATwNBjuR text , reference set_user MYZLHVqFcgnRAf8PVbRnn3ZdMGq text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base normal remove_port boost/url/url_base.hpp include/boost/url/url_base.hpp 1696 5 function 1B1sp4Ef6qEaa3XYv8pbQFsfkZt public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3LEFuHiJFofpCmdb6z7kwJ5NBNyV text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base normal remove_query boost/url/url_base.hpp include/boost/url/url_base.hpp 2463 5 function 2R5rf2bDtEpPE9hwtv8Ln4i6EAHv public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3WcGK7mkJngNwmU5zz1zx9Vr7iC3 text , reference params 3hdYD66PBzHcr6JTNLGtXFRmpwjB text , reference set_encoded_query v9Dry5ACH8wLSd7BYqpiHbGB7V8 text , reference set_query 4THvHraYktHgYNzU3qniR2MhXpuX text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base normal remove_scheme boost/url/url_base.hpp include/boost/url/url_base.hpp 318 5 function 3y1CD4diAVFMNJd23sVxV2aC2Kw6 public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3QW2cbeaw11tvSPbrjEnJSQu2CC7 text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base normal remove_userinfo boost/url/url_base.hpp include/boost/url/url_base.hpp 585 5 function sGNgGfijxwV9WzubTygPba9mCQn public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 gNzAQHZHDPXQiqwfYS6GwxUvQsG text , reference set_userinfo 3WPfZEH3k9jEMW6zLcD16Xd3Uqyg text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base normal reserve boost/url/url_base.hpp include/boost/url/url_base.hpp 187 5 function zpt1tVsUzr9PpovdHt6x8TgTZMD public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 named identifier void void named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std n normal resolve boost/url/url_base.hpp include/boost/url/url_base.hpp 2973 5 function 45Z6NdRjyroghszwmeBJuKmyuKLU public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 75qVNpuBHShJ8KKEUv4RCrwxEAB text , reference url_view 3hrVvoVYoDkX9t3w9abTXxDqGRaW text . named specialization qQFMz11M2hdnkDE2M6AYnTSkQhv result identifier dgHcH1svHs5X3czTwE2RBXQ7tGq system type named identifier void void lvalue-reference named identifier 27ryuyAvvRyzfzgketja5uQcFBcK url_view_base ref normal scheme boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 421 5 function 4AoadMoEhkiTY9v83LDBwQt31Uti public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2wLECn7WbsBXGLpheUngfa9GEf1q text , reference scheme_id 3aL5x6QNsMGNDAo8DP539u5TsZpp text . named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core normal scheme_id boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 471 5 function 3aL5x6QNsMGNDAo8DP539u5TsZpp public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 tVuW4uzt1HMgUxPtxroTuMsNi2G 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 d3jNvGWyWHyaA1snRDXYWd5jjkA text . paragraph text Otherwise, if the scheme is absent the value returned is reference urls::scheme::none 2DEQCVdvMZA94BHRjTMB2n7Ttdp2 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 2wLECn7WbsBXGLpheUngfa9GEf1q text , reference scheme 4AoadMoEhkiTY9v83LDBwQt31Uti text . named identifier tVuW4uzt1HMgUxPtxroTuMsNi2G scheme identifier 2ejQGW57K8g7MFJhHAwPt5aumoLa urls normal segments boost/url/url_base.hpp include/boost/url/url_base.hpp 1955 5 boost/url/url_base.hpp include/boost/url/url_base.hpp 1951 5 overloads 2bXmGRYoLQKFALtmsM2vVVCvmnVn public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3NGtuSVjhTWXrAF9sPpeS5FwZQN8 text , reference set_encoded_path MCx88BPGS5KgE3qhBfh89e3U57J text , reference set_path 3v9Fip9faoKhfWb6eQhiSgANjWdV text , reference set_path_absolute 4b7SsvokaeMTXQXBKywBXGVroR2 text . see reference is_path_absolute 2hgDJpXv5LpubtS8phLLnGk4a7XZ text , reference encoded_path M5bG6HzwZUo4ycGCKLY5CsUUXun text , reference encoded_segments 3NGtuSVjhTWXrAF9sPpeS5FwZQN8 text . reference path wc1MNXXCH1K1Shz81BmxVy1opwc text , reference segments_view 2QU7risgZzo8F84g7LttC6dG1GsH text . normal 4J7mUgLL9CaiS3Kv4ZcaRamupUkL uWpBZKqgnJKFef7rkZxJTw2WsxX auto auto segments boost/url/url_base.hpp include/boost/url/url_base.hpp 1951 5 function 4J7mUgLL9CaiS3Kv4ZcaRamupUkL public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3NGtuSVjhTWXrAF9sPpeS5FwZQN8 text , reference set_encoded_path MCx88BPGS5KgE3qhBfh89e3U57J text , reference set_path 3v9Fip9faoKhfWb6eQhiSgANjWdV text , reference set_path_absolute 4b7SsvokaeMTXQXBKywBXGVroR2 text . named identifier 3sLepuFTMctJHoZrLv8tvJTFkDPS segments_ref identifier 2ejQGW57K8g7MFJhHAwPt5aumoLa urls normal segments boost/url/url_base.hpp include/boost/url/url_base.hpp 1955 5 function uWpBZKqgnJKFef7rkZxJTw2WsxX public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 2hgDJpXv5LpubtS8phLLnGk4a7XZ text , reference encoded_path M5bG6HzwZUo4ycGCKLY5CsUUXun text , reference encoded_segments 3NGtuSVjhTWXrAF9sPpeS5FwZQN8 text . reference path wc1MNXXCH1K1Shz81BmxVy1opwc text , reference segments_view 2QU7risgZzo8F84g7LttC6dG1GsH text . named identifier 2QU7risgZzo8F84g7LttC6dG1GsH segments_view normal set_encoded_authority boost/url/url_base.hpp include/boost/url/url_base.hpp 364 5 function 2Br6ianGRhYuRbDpvbNVHc3kytth public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 2bHQfxWtGijDtNutjkX9m9nmNJgq text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view s normal set_encoded_fragment boost/url/url_base.hpp include/boost/url/url_base.hpp 2611 5 function 2hLzEE9gAKyxVT6kbPLwfet2MGnC public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 2TNB4s1W5aG5wvgM5sFhpkadBvP9 text , reference set_fragment 2BFpJxb9o2AGu7rRGKFVoFsW7Pi4 text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view s normal set_encoded_host boost/url/url_base.hpp include/boost/url/url_base.hpp 1027 5 function osScXCjJkJkSf5jPTGH5dPVin3q public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 4B5yLFvhkpef7XX8ryKTaBWz8d6D 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 2y7UTsNbko8TLegXS5EpSa1goNog 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 25qx7TTMyctoe4LxqgMPXccSpy5Q 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 QfoSUW8M1SPUL5EFVKwAUabTKCa 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 4DwBiJMifXNsmVFdmgKDhGDJZ3wh text , reference set_encoded_host_name fBFYvCn8kJ47xA7NVhe1Rghp5J8 text , reference set_host 36GzQWnsLo7vUpJDLjUBWfUao6v7 text , reference set_host_address 3bzhb9DrxWPqshAd4mygzPBefvw8 text , reference set_host_ipv4 9UnBBXEqhvdW1scEozkygaKMjGZ text , reference set_host_ipv6 6SijdGWstqVJuYLMAU9YBwkBXSG text , reference set_host_ipvfuture 55atbAUaUexHuQt9WaRpVBqgfdg text , reference set_host_name soNQwVrosnpg6yBhJnz9p8yjZta text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view s normal set_encoded_host_address boost/url/url_base.hpp include/boost/url/url_base.hpp 1230 5 function 4DwBiJMifXNsmVFdmgKDhGDJZ3wh public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 4B5yLFvhkpef7XX8ryKTaBWz8d6D 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 2y7UTsNbko8TLegXS5EpSa1goNog 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 25qx7TTMyctoe4LxqgMPXccSpy5Q 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 QfoSUW8M1SPUL5EFVKwAUabTKCa 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 osScXCjJkJkSf5jPTGH5dPVin3q text , reference set_encoded_host_name fBFYvCn8kJ47xA7NVhe1Rghp5J8 text , reference set_host 36GzQWnsLo7vUpJDLjUBWfUao6v7 text , reference set_host_address 3bzhb9DrxWPqshAd4mygzPBefvw8 text , reference set_host_ipv4 9UnBBXEqhvdW1scEozkygaKMjGZ text , reference set_host_ipv6 6SijdGWstqVJuYLMAU9YBwkBXSG text , reference set_host_ipvfuture 55atbAUaUexHuQt9WaRpVBqgfdg text , reference set_host_name soNQwVrosnpg6yBhJnz9p8yjZta text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view s normal set_encoded_host_name boost/url/url_base.hpp include/boost/url/url_base.hpp 1566 5 function fBFYvCn8kJ47xA7NVhe1Rghp5J8 public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 QfoSUW8M1SPUL5EFVKwAUabTKCa 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 osScXCjJkJkSf5jPTGH5dPVin3q text , reference set_encoded_host_address 4DwBiJMifXNsmVFdmgKDhGDJZ3wh text , reference set_host 36GzQWnsLo7vUpJDLjUBWfUao6v7 text , reference set_host_address 3bzhb9DrxWPqshAd4mygzPBefvw8 text , reference set_host_ipv4 9UnBBXEqhvdW1scEozkygaKMjGZ text , reference set_host_ipv6 6SijdGWstqVJuYLMAU9YBwkBXSG text , reference set_host_ipvfuture 55atbAUaUexHuQt9WaRpVBqgfdg text , reference set_host_name soNQwVrosnpg6yBhJnz9p8yjZta text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view s normal set_encoded_params boost/url/url_base.hpp include/boost/url/url_base.hpp 2419 5 function 24HVoTb3hMrWVBMHrtxD1buWstCN public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 4FzhNxmTaWz7pzZaXUiuVRmBs2SH text , reference params 3hdYD66PBzHcr6JTNLGtXFRmpwjB text , reference remove_query 2R5rf2bDtEpPE9hwtv8Ln4i6EAHv text , reference set_encoded_query v9Dry5ACH8wLSd7BYqpiHbGB7V8 text , reference set_query 4THvHraYktHgYNzU3qniR2MhXpuX text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named specialization 474HF6bGJmJntnocv1iPAYL2crja initializer_list identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std type named identifier 21okxUDyXpX2g3uj7TzYTtM4Skgh param_pct_view ps normal set_encoded_password boost/url/url_base.hpp include/boost/url/url_base.hpp 804 5 function 3M3tGnhVHGx7Vc2eUaFuGy7VoCxu public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 igKd3Gv9P5L4VjvQSC6giswwMEQ text , reference set_encoded_password 3M3tGnhVHGx7Vc2eUaFuGy7VoCxu text , reference set_encoded_user 2MEk1Cda8bzLjEPBG1V7MJvLRyqJ text , reference set_user MYZLHVqFcgnRAf8PVbRnn3ZdMGq text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view s normal set_encoded_path boost/url/url_base.hpp include/boost/url/url_base.hpp 1894 5 function MCx88BPGS5KgE3qhBfh89e3U57J public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3NGtuSVjhTWXrAF9sPpeS5FwZQN8 text , reference segments 2bXmGRYoLQKFALtmsM2vVVCvmnVn text , reference set_path 3v9Fip9faoKhfWb6eQhiSgANjWdV text , reference set_path_absolute 4b7SsvokaeMTXQXBKywBXGVroR2 text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view s normal set_encoded_query boost/url/url_base.hpp include/boost/url/url_base.hpp 2132 5 function v9Dry5ACH8wLSd7BYqpiHbGB7V8 public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3WcGK7mkJngNwmU5zz1zx9Vr7iC3 text , reference params 3hdYD66PBzHcr6JTNLGtXFRmpwjB text , reference remove_query 2R5rf2bDtEpPE9hwtv8Ln4i6EAHv text , reference set_query 4THvHraYktHgYNzU3qniR2MhXpuX text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view s normal set_encoded_user boost/url/url_base.hpp include/boost/url/url_base.hpp 692 5 function 2MEk1Cda8bzLjEPBG1V7MJvLRyqJ public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 igKd3Gv9P5L4VjvQSC6giswwMEQ text , reference set_encoded_password 3M3tGnhVHGx7Vc2eUaFuGy7VoCxu text , reference set_password 2YAaMd9PbnTHhrrZTFuaATwNBjuR text , reference set_user MYZLHVqFcgnRAf8PVbRnn3ZdMGq text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view s normal set_encoded_userinfo boost/url/url_base.hpp include/boost/url/url_base.hpp 542 5 function gNzAQHZHDPXQiqwfYS6GwxUvQsG public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 4QciDQp3vKjNuPEah54XMBvrjvyD text returns true. Otherwise, paragraph text If there is no colon, the user is set to the string. The function reference has_password 4QciDQp3vKjNuPEah54XMBvrjvyD 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 sGNgGfijxwV9WzubTygPba9mCQn text , reference set_userinfo 3WPfZEH3k9jEMW6zLcD16Xd3Uqyg text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view s normal set_encoded_zone_id boost/url/url_base.hpp include/boost/url/url_base.hpp 1411 5 function 4X1oAamqzgD6NUQuQqZgb3E7Y8hN public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view s normal set_fragment boost/url/url_base.hpp include/boost/url/url_base.hpp 2556 5 function 2BFpJxb9o2AGu7rRGKFVoFsW7Pi4 public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 2TNB4s1W5aG5wvgM5sFhpkadBvP9 text , reference set_encoded_fragment 2hLzEE9gAKyxVT6kbPLwfet2MGnC text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal set_host boost/url/url_base.hpp include/boost/url/url_base.hpp 941 5 function 36GzQWnsLo7vUpJDLjUBWfUao6v7 public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 4B5yLFvhkpef7XX8ryKTaBWz8d6D 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 2y7UTsNbko8TLegXS5EpSa1goNog 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 25qx7TTMyctoe4LxqgMPXccSpy5Q 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 QfoSUW8M1SPUL5EFVKwAUabTKCa 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 osScXCjJkJkSf5jPTGH5dPVin3q text , reference set_encoded_host_address 4DwBiJMifXNsmVFdmgKDhGDJZ3wh text , reference set_encoded_host_name fBFYvCn8kJ47xA7NVhe1Rghp5J8 text , reference set_host_address 3bzhb9DrxWPqshAd4mygzPBefvw8 text , reference set_host_ipv4 9UnBBXEqhvdW1scEozkygaKMjGZ text , reference set_host_ipv6 6SijdGWstqVJuYLMAU9YBwkBXSG text , reference set_host_ipvfuture 55atbAUaUexHuQt9WaRpVBqgfdg text , reference set_host_name soNQwVrosnpg6yBhJnz9p8yjZta text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal set_host_address boost/url/url_base.hpp include/boost/url/url_base.hpp 1126 5 function 3bzhb9DrxWPqshAd4mygzPBefvw8 public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 4B5yLFvhkpef7XX8ryKTaBWz8d6D 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 2y7UTsNbko8TLegXS5EpSa1goNog 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 25qx7TTMyctoe4LxqgMPXccSpy5Q 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 QfoSUW8M1SPUL5EFVKwAUabTKCa 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 osScXCjJkJkSf5jPTGH5dPVin3q text , reference set_encoded_host_address 4DwBiJMifXNsmVFdmgKDhGDJZ3wh text , reference set_encoded_host_name fBFYvCn8kJ47xA7NVhe1Rghp5J8 text , reference set_host 36GzQWnsLo7vUpJDLjUBWfUao6v7 text , reference set_host_address 3bzhb9DrxWPqshAd4mygzPBefvw8 text , reference set_host_ipv4 9UnBBXEqhvdW1scEozkygaKMjGZ text , reference set_host_ipv6 6SijdGWstqVJuYLMAU9YBwkBXSG text , reference set_host_ipvfuture 55atbAUaUexHuQt9WaRpVBqgfdg text , reference set_host_name soNQwVrosnpg6yBhJnz9p8yjZta text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal set_host_ipv4 boost/url/url_base.hpp include/boost/url/url_base.hpp 1287 5 function 9UnBBXEqhvdW1scEozkygaKMjGZ public regular 2TREmHUMfZeMQz9yyw5HzqB91APN paragraph text The host is set to the specified IPv4 address. The host type is reference host_type::ipv4 4B5yLFvhkpef7XX8ryKTaBWz8d6D 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 osScXCjJkJkSf5jPTGH5dPVin3q text , reference set_encoded_host_address 4DwBiJMifXNsmVFdmgKDhGDJZ3wh text , reference set_encoded_host_name fBFYvCn8kJ47xA7NVhe1Rghp5J8 text , reference set_host 36GzQWnsLo7vUpJDLjUBWfUao6v7 text , reference set_host_address 3bzhb9DrxWPqshAd4mygzPBefvw8 text , reference set_host_ipv6 6SijdGWstqVJuYLMAU9YBwkBXSG text , reference set_host_ipvfuture 55atbAUaUexHuQt9WaRpVBqgfdg text , reference set_host_name soNQwVrosnpg6yBhJnz9p8yjZta text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base lvalue-reference named identifier 4Xmd9k1GBKGKQj6PYc1qdt4tMUae ipv4_address addr normal set_host_ipv6 boost/url/url_base.hpp include/boost/url/url_base.hpp 1353 5 function 6SijdGWstqVJuYLMAU9YBwkBXSG public regular 2TREmHUMfZeMQz9yyw5HzqB91APN paragraph text The host is set to the specified IPv6 address. The host type is reference host_type::ipv6 2y7UTsNbko8TLegXS5EpSa1goNog 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 osScXCjJkJkSf5jPTGH5dPVin3q text , reference set_encoded_host_address 4DwBiJMifXNsmVFdmgKDhGDJZ3wh text , reference set_encoded_host_name fBFYvCn8kJ47xA7NVhe1Rghp5J8 text , reference set_host 36GzQWnsLo7vUpJDLjUBWfUao6v7 text , reference set_host_address 3bzhb9DrxWPqshAd4mygzPBefvw8 text , reference set_host_ipv4 9UnBBXEqhvdW1scEozkygaKMjGZ text , reference set_host_ipvfuture 55atbAUaUexHuQt9WaRpVBqgfdg text , reference set_host_name soNQwVrosnpg6yBhJnz9p8yjZta text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base lvalue-reference named identifier 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T ipv6_address addr normal set_host_ipvfuture boost/url/url_base.hpp include/boost/url/url_base.hpp 1464 5 function 55atbAUaUexHuQt9WaRpVBqgfdg public regular 2TREmHUMfZeMQz9yyw5HzqB91APN paragraph text The host is set to the specified IPvFuture string. The host type is reference host_type::ipvfuture 25qx7TTMyctoe4LxqgMPXccSpy5Q 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 osScXCjJkJkSf5jPTGH5dPVin3q text , reference set_encoded_host_address 4DwBiJMifXNsmVFdmgKDhGDJZ3wh text , reference set_encoded_host_name fBFYvCn8kJ47xA7NVhe1Rghp5J8 text , reference set_host 36GzQWnsLo7vUpJDLjUBWfUao6v7 text , reference set_host_address 3bzhb9DrxWPqshAd4mygzPBefvw8 text , reference set_host_ipv4 9UnBBXEqhvdW1scEozkygaKMjGZ text , reference set_host_ipv6 6SijdGWstqVJuYLMAU9YBwkBXSG text , reference set_host_name soNQwVrosnpg6yBhJnz9p8yjZta text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal set_host_name boost/url/url_base.hpp include/boost/url/url_base.hpp 1512 5 function soNQwVrosnpg6yBhJnz9p8yjZta public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 QfoSUW8M1SPUL5EFVKwAUabTKCa 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 osScXCjJkJkSf5jPTGH5dPVin3q text , reference set_encoded_host_address 4DwBiJMifXNsmVFdmgKDhGDJZ3wh text , reference set_encoded_host_name fBFYvCn8kJ47xA7NVhe1Rghp5J8 text , reference set_host 36GzQWnsLo7vUpJDLjUBWfUao6v7 text , reference set_host_address 3bzhb9DrxWPqshAd4mygzPBefvw8 text , reference set_host_ipv4 9UnBBXEqhvdW1scEozkygaKMjGZ text , reference set_host_ipv6 6SijdGWstqVJuYLMAU9YBwkBXSG text , reference set_host_ipvfuture 55atbAUaUexHuQt9WaRpVBqgfdg text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal set_params boost/url/url_base.hpp include/boost/url/url_base.hpp 2355 5 function 4FzhNxmTaWz7pzZaXUiuVRmBs2SH public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3WcGK7mkJngNwmU5zz1zx9Vr7iC3 text , reference remove_query 2R5rf2bDtEpPE9hwtv8Ln4i6EAHv text , reference set_encoded_query v9Dry5ACH8wLSd7BYqpiHbGB7V8 text , reference set_query 4THvHraYktHgYNzU3qniR2MhXpuX text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named specialization 474HF6bGJmJntnocv1iPAYL2crja initializer_list identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std type named identifier AbvEAFQMtFaLMVMSA2NZ5D5a7nN param_view ps named identifier 5dyN7z5egGMdJFpXz9WbaL549xC encoding_opts opts {} normal set_password boost/url/url_base.hpp include/boost/url/url_base.hpp 746 5 function 2YAaMd9PbnTHhrrZTFuaATwNBjuR public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 igKd3Gv9P5L4VjvQSC6giswwMEQ text , reference set_encoded_password 3M3tGnhVHGx7Vc2eUaFuGy7VoCxu text , reference set_encoded_user 2MEk1Cda8bzLjEPBG1V7MJvLRyqJ text , reference set_user MYZLHVqFcgnRAf8PVbRnn3ZdMGq text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal set_path boost/url/url_base.hpp include/boost/url/url_base.hpp 1827 5 function 3v9Fip9faoKhfWb6eQhiSgANjWdV public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 MCx88BPGS5KgE3qhBfh89e3U57J text or reference segments 2bXmGRYoLQKFALtmsM2vVVCvmnVn 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 3NGtuSVjhTWXrAF9sPpeS5FwZQN8 text , reference segments 2bXmGRYoLQKFALtmsM2vVVCvmnVn text , reference set_encoded_path MCx88BPGS5KgE3qhBfh89e3U57J text , reference set_path_absolute 4b7SsvokaeMTXQXBKywBXGVroR2 text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal set_path_absolute boost/url/url_base.hpp include/boost/url/url_base.hpp 1760 5 function 4b7SsvokaeMTXQXBKywBXGVroR2 public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3NGtuSVjhTWXrAF9sPpeS5FwZQN8 text , reference segments 2bXmGRYoLQKFALtmsM2vVVCvmnVn text , reference set_encoded_path MCx88BPGS5KgE3qhBfh89e3U57J text , reference set_path 3v9Fip9faoKhfWb6eQhiSgANjWdV text . named identifier bool bool named identifier bool bool absolute normal set_port boost/url/url_base.hpp include/boost/url/url_base.hpp 1656 5 function 3LEFuHiJFofpCmdb6z7kwJ5NBNyV public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 1B1sp4Ef6qEaa3XYv8pbQFsfkZt text , reference set_port 3LEFuHiJFofpCmdb6z7kwJ5NBNyV text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal set_port_number boost/url/url_base.hpp include/boost/url/url_base.hpp 1612 5 function 49Q25jBbiW4ssURp7srqLCYtJxmr public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 1B1sp4Ef6qEaa3XYv8pbQFsfkZt text , reference set_port 3LEFuHiJFofpCmdb6z7kwJ5NBNyV text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier w7yWEPLwtMpd5GnNHsV5ASwVxkX uint16_t n normal set_query boost/url/url_base.hpp include/boost/url/url_base.hpp 2076 5 function 4THvHraYktHgYNzU3qniR2MhXpuX public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3WcGK7mkJngNwmU5zz1zx9Vr7iC3 text , reference params 3hdYD66PBzHcr6JTNLGtXFRmpwjB text , reference remove_query 2R5rf2bDtEpPE9hwtv8Ln4i6EAHv text , reference set_encoded_query v9Dry5ACH8wLSd7BYqpiHbGB7V8 text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal set_scheme boost/url/url_base.hpp include/boost/url/url_base.hpp 245 5 function 3QW2cbeaw11tvSPbrjEnJSQu2CC7 public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3y1CD4diAVFMNJd23sVxV2aC2Kw6 text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal set_scheme_id boost/url/url_base.hpp include/boost/url/url_base.hpp 280 5 function 2wEQzdwYGT3faB4EpgEZkgYTqM2G public regular 2TREmHUMfZeMQz9yyw5HzqB91APN paragraph text This function sets the scheme to the specified known reference urls::scheme tVuW4uzt1HMgUxPtxroTuMsNi2G text id, which may not be reference scheme::unknown d3jNvGWyWHyaA1snRDXYWd5jjkA text or else an exception is thrown. If the id is reference scheme::none 2DEQCVdvMZA94BHRjTMB2n7Ttdp2 text , this function behaves as if reference remove_scheme 3y1CD4diAVFMNJd23sVxV2aC2Kw6 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 lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier tVuW4uzt1HMgUxPtxroTuMsNi2G scheme identifier 2ejQGW57K8g7MFJhHAwPt5aumoLa urls id normal set_user boost/url/url_base.hpp include/boost/url/url_base.hpp 635 5 function MYZLHVqFcgnRAf8PVbRnn3ZdMGq public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 igKd3Gv9P5L4VjvQSC6giswwMEQ text , reference set_encoded_password 3M3tGnhVHGx7Vc2eUaFuGy7VoCxu text , reference set_encoded_user 2MEk1Cda8bzLjEPBG1V7MJvLRyqJ text , reference set_password 2YAaMd9PbnTHhrrZTFuaATwNBjuR text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal set_userinfo boost/url/url_base.hpp include/boost/url/url_base.hpp 475 5 function 3WPfZEH3k9jEMW6zLcD16Xd3Uqyg public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 4QciDQp3vKjNuPEah54XMBvrjvyD text returns true. Otherwise, paragraph text If there is no colon, the user is set to the string. The function reference has_password 4QciDQp3vKjNuPEah54XMBvrjvyD 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 sGNgGfijxwV9WzubTygPba9mCQn text , reference set_encoded_userinfo gNzAQHZHDPXQiqwfYS6GwxUvQsG text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal set_zone_id boost/url/url_base.hpp include/boost/url/url_base.hpp 1380 5 function 2gcj9bRhg1wZZAtNMQkD6jo35SjJ public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal size boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 201 5 function 2Z9j51jzFxpMXyB1ZjxR329S4Puk public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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. named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std normal user boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 848 5 function 4Yfg3yG11SsLgpAe6dzENEPz39dk public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4QciDQp3vKjNuPEah54XMBvrjvyD text , reference has_userinfo 2x7XawH6QTh6eBg2hNRqzQ3WME2m text , reference encoded_password 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym text , reference encoded_user 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC text , reference encoded_userinfo 3qDJMHEiC1T5Vik6nGt2CJvFxFDM text , reference password 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL text , reference userinfo 24JMPq739KrKuemXwWK8zpXGtWvz text . named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal userinfo boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 748 5 function 24JMPq739KrKuemXwWK8zpXGtWvz public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4UumWzLNRv3vgTVdDkz5PVqdSsSL 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 4QciDQp3vKjNuPEah54XMBvrjvyD text , reference has_userinfo 2x7XawH6QTh6eBg2hNRqzQ3WME2m text , reference encoded_password 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym text , reference encoded_user 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC text , reference encoded_userinfo 3qDJMHEiC1T5Vik6nGt2CJvFxFDM text , reference password 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL text , reference user 4Yfg3yG11SsLgpAe6dzENEPz39dk text . named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal zone_id boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1480 5 function 3QgkE48ZuKvk3EGbnydRNa7ob9XL public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text If the host type is reference host_type::ipv6 2y7UTsNbko8TLegXS5EpSa1goNog 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 named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal operator basic_string_view<char> boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 299 5 function 3uYCaZr2Kk1eGAMsuRXTehXkXZwv public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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. named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core conversion max_size boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 173 5 function 39V9A9oqw6EqsRw4R5mxeMpeqePo public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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. named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std normal constexpr static 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 function 2TwwpddeAxzjzfbTirqgZeddg3n6 protected regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std salt 0 normal url boost/url/url.hpp include/boost/url/url.hpp 63 1 record 75qVNpuBHShJ8KKEUv4RCrwxEAB regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 2ARWB82XdRYexehQmFQZjcEKzoSi text , reference parse_relative_ref u1SFmy6a6wtXTYxrMnssMwa7K6G text , reference parse_uri 2nNq8RtS22vhgfkFAo8dGh6NW87n text , reference parse_uri_reference 4KCrVrNi2iTJ15zBNtvdSNip4rmV text , reference resolve 45Z6NdRjyroghszwmeBJuKmyuKLU text . reference format cuQ8MuepPWHG3r6QpaZ22LK8zmn reference format 2EzepoMYt7Gu64d8BqD8A3pLzzj6 reference format_to cLKVoifuzVMusLZv1zV2vk1L2K3 reference format_to 3bDKeYzcaysYNkwtHjg2EkeVGZf3 reference operator!= tkwNEJdWJqwprh85787u3xpyauu reference operator< 22wNuw5VxKWrVLMDGM9VPFjJshU6 reference operator<= 3QqsgavNMQTmxMW1t9qAoAocshM6 reference operator== GhudPV3CuyCeCKSftvpKEQLQtJ4 reference operator> 3CgAf4w5dyww6CMhGWkJm1fJiHum reference operator>= 2V16XgrptBcWFtoZaJ3DExhQXY6 reference resolve 4ZbWvyKBMwfyhwwk3YYEco8ttTeS other __visibility__ class named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base public 3HzpaVwQhcv1cDKXaxspYHyUDhaY 4NaFXZSv1kGkjaFwnVR3h8UdGTXt 2QEDZxzyojiKU5c9VTzig8LBK6SX 3fqhU2zdn6LwiSAm9upTzbtboK1U 3ESzuLSF2zD1TghU6qemdUksdP2V oHRP7v9PjrTqy9YjGBt8xxSqTLn HxCZYcsETDaw1bRzUVB9HpjzDZH r7EPCNuC2kWeArshSQf9kS35QJA 3Lh94K8cNrPFyFYw36XmhhtFMLpf VbvXoprikWfUm5mR56ZFYECXt9J 4DmmNdXmY3VWyP6HoKWQVEExBzaV 2GaF4F3gH2Y5LkyYXCrr3VyP9tpJ ipF8M41qPyuMM5XLe5JGZYSc42h FMBiWLrznwNXgkDuu4xneE9NeCD 3oodjUy4VDbgnxfeqkxwvqQvf7hK 4SGWNm9TD3ZACEqJ9fmnWL1ZF47q 492Pha8s74Xj1GjgZ82x193B56bP 3gVZJ5SpfCzYoZgafZW71cueQ3u3 3WcGK7mkJngNwmU5zz1zx9Vr7iC3 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym M5bG6HzwZUo4ycGCKLY5CsUUXun 3VZ9J5FmgK7VsNUfrHxuyT4pNTGm 3oB1p7aLxKXx3FxEqHaKSnCiNfXM 3NGtuSVjhTWXrAF9sPpeS5FwZQN8 UJaw1aYaRaLhmYt2h416g598hi4 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC 3qDJMHEiC1T5Vik6nGt2CJvFxFDM 4Bt9AGe8WEFmjA79MWAiGPDtMUW8 2T5XA2udwnVeh4RFi6U9UrLirJFJ 2omNW7ayWzkboBBXgc2Rm6C4y5kb 2RYFJUJHdYjygxHWSb57bHWfkHgN 4QciDQp3vKjNuPEah54XMBvrjvyD 4CLeCb8bTxYAjEFuAXtr5VmQW6FE 21mA7muF2gpvzFjJxaqjvjnnm6XY 2wLECn7WbsBXGLpheUngfa9GEf1q 2x7XawH6QTh6eBg2hNRqzQ3WME2m SytR6d7pUELeR1RNUpcWrXWQcY8 KoSC71QaaCYQtpr7xCwndbzWaKR Zvcpzzy9h3HWgiqp7UZuEiWf4A7 9sSdyLcyHxeuasmCKqifZp3ga5s 4E8a8HgQbryrd4KcNHFajdVyLWib 2gNagLmHXZAqycctaaYmEYZc9pv mSWKjRHEDFTnpxGSra6Q5eS7fjS 2hgDJpXv5LpubtS8phLLnGk4a7XZ 3admKSg7ZAHH4zBsuUC8HFxR2375 2E5z2jhAgP7jEaRTLV4JiaFvDPz2 3yQdciJbRHJ7Q12TZribXR1pLVYF 3pjTFFQppAe7J9LbsFwaGwEHdJqj 2iPchP2kSD2jxV4aiYg5dJEycPCq 3q5bwHqsBrEN7TKhbLVyEErrscBt 3hdYD66PBzHcr6JTNLGtXFRmpwjB 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL wc1MNXXCH1K1Shz81BmxVy1opwc 2aNVu1ZJUXAnkA1MUK2cfojoNCyj p8uqDVjGDrU4Eg9axo7dsTkztws 363HbS6bzsgdHiLTk4Kr8pdkZJZY 49Yox1iKKs7LmQ3wu1nCZXGKWEKf 3Zu2JdbQ8yz6vHr33nTTLyb1MJUg mtjDuAmUewepK9ZAPGKm4KZvSUZ 3AYLpa5qXMGfmwmjHU6QbgPqUL52 4NNwWhYB52k9eRWaWW11TyR6tgWR 3FmFpDaKVNyQ7bXNSdrzCGsVJM7P 36kaFnfGXgbj1nqCcaNfBSQmxuGS 3mQ82A3cBXgmgWLYuxa1y3o1qUZ5 SbtgEkcVVKjqXDg5qLkUoLeu649 zpt1tVsUzr9PpovdHt6x8TgTZMD 45Z6NdRjyroghszwmeBJuKmyuKLU 4AoadMoEhkiTY9v83LDBwQt31Uti 3aL5x6QNsMGNDAo8DP539u5TsZpp 2bXmGRYoLQKFALtmsM2vVVCvmnVn 3dAGNoeC7UAPMMB2zm3mCESohLWS wvX6pfjqRkAZY4jEA4LMeXi7RgW vqmQxG49x1A1LB55DWAQVaDfhBF 4PKBCyDPbv2dwEoy4fCo67rjvQA4 3nKWM4uGNScqDM2BKxNiFVrzvMr8 3xY1fCKgTcftAHenafLadYf7osQE 2fgvJkQWk6Y3UiAumQKpQCeSMgtF 3YKaVav7iU4CADoq5TDKsfmzh5Tk JmPno9gmDpQRQfbUP3rzokugA7a JFREUzkcBvd4d7YpAe3ZbWKJv98 2Qhtn8WbDtyHvC8Yw52Ri2Up2bsZ 2iRCpGiijC5ZJdA9PPAtoyfJ3hGd 37FipzgBGWwbp1ZX95UuSuef5rpL k82DjZnEEWSXkViYt3vzyaK5tdm yP9ss9fySL76cVwxgy2zuer9Jmf 2zqhENhNgNKSwfiRLq9dhNQPJsDf XGCarXEBGEFfTakWXL5MvKVGRS3 HCV4H1sf2pryFawpghkGQCDVBTp 2FJzNSUiS2pzEJTFnsJs38Hh4u5Y rfMzJAA8APDm5UYHxYTSddwT4Qh xxS4ufnn9fuGnTr3GGJVKBp3JFc 4McpqTciHbP7MYJJafnvFkRJGcZ5 4b7SsvokaeMTXQXBKywBXGVroR2 266h2w9HS6kseMj1JLKfE29grSy6 37rP3DgdsXDStY3czt9RfRWfTLz 44c22UJ7fFsbi4WZDMrzQBmXRnGS 37UrudcyHKBs5jCUYvSP79srd3DV 3QiBknt8XFpLT3JuHBwnKYTvYvod 2XmiAqTQhm8wEWD8R3PizB5WMF1w 3XpMK24TMhcVwJ9PAHwZxSLqRo7H 2nFEAVSsAAzJCxRts4ijkBxPtXWA 2Z9j51jzFxpMXyB1ZjxR329S4Puk 2vCUaWVXdv8xAJxyzhvVxgN8uuE4 4Yfg3yG11SsLgpAe6dzENEPz39dk 24JMPq739KrKuemXwWK8zpXGtWvz 3QgkE48ZuKvk3EGbnydRNa7ob9XL 3uYCaZr2Kk1eGAMsuRXTehXkXZwv 39V9A9oqw6EqsRw4R5mxeMpeqePo 2TwwpddeAxzjzfbTirqgZeddg3n6 4QKANyq8ka1qffCSDkjZhTajoFJT yAYxvdZ2d3wfPiDRUgC73Xi4Cyt 3hqnCkSbh43Gi6Ny8KoJegB5wd3h 2ntneEaB6YUYsDoSj5izrgZwM78v oVV61j5ahgAT1hqtP1NMn1wUC62 299twYCrVpg7w7wmSD6oVDHL3UpM 3TA5xAVGZHDj1nxZB9BputbD8861 named specialization hash identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std type named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url url boost/url/url.hpp include/boost/url/url.hpp 217 5 boost/url/url.hpp include/boost/url/url.hpp 120 5 boost/url/url.hpp include/boost/url/url.hpp 169 5 boost/url/url.hpp include/boost/url/url.hpp 194 5 overloads 3HzpaVwQhcv1cDKXaxspYHyUDhaY public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 4MMs3FDjRdnjVJbD6CVqUuwD2TNs 4SdJ79f2B7ygpLH6fLu69CU8pfrw FdvanRQ6L1mt3MNsjCzoAwHVUPJ 2vjzMQujvunb6kxms79dBkPdkiz 28szXQ4q6XEFzpJ6AV7E74NKfzu named identifier void void url boost/url/url.hpp include/boost/url/url.hpp 120 5 function 4MMs3FDjRdnjVJbD6CVqUuwD2TNs public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 named identifier void void constructor url boost/url/url.hpp include/boost/url/url.hpp 243 5 function 4SdJ79f2B7ygpLH6fLu69CU8pfrw public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 named identifier void void lvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url u constructor url boost/url/url.hpp include/boost/url/url.hpp 194 5 function FdvanRQ6L1mt3MNsjCzoAwHVUPJ public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 named identifier void void rvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url u constructor url boost/url/url.hpp include/boost/url/url.hpp 169 5 function 2vjzMQujvunb6kxms79dBkPdkiz public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 named identifier void void named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s constructor url boost/url/url.hpp include/boost/url/url.hpp 217 5 function 28szXQ4q6XEFzpJ6AV7E74NKfzu public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 named identifier void void lvalue-reference named identifier 27ryuyAvvRyzfzgketja5uQcFBcK url_view_base u constructor ~url boost/url/url.hpp include/boost/url/url.hpp 85 5 function 4NaFXZSv1kGkjaFwnVR3h8UdGTXt public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 named identifier void void destructor operator= boost/url/url.hpp include/boost/url/url.hpp 299 5 boost/url/url.hpp include/boost/url/url.hpp 272 5 overloads 2QEDZxzyojiKU5c9VTzig8LBK6SX public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 = 2PQb1RXmpTiVxLMBnypV4834druz 33ZBKAuffWqAW55iwZLrmCx4Zv84 3Z8mNBZxNLnmK11JSXPCDbSsBNtQ lvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url operator= boost/url/url.hpp include/boost/url/url.hpp 329 5 function 2PQb1RXmpTiVxLMBnypV4834druz public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 lvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url lvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url u normal = operator= boost/url/url.hpp include/boost/url/url.hpp 272 5 function 33ZBKAuffWqAW55iwZLrmCx4Zv84 public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 lvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url rvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url u normal = operator= boost/url/url.hpp include/boost/url/url.hpp 299 5 function 3Z8mNBZxNLnmK11JSXPCDbSsBNtQ public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 lvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url lvalue-reference named identifier 27ryuyAvvRyzfzgketja5uQcFBcK url_view_base u normal = authority boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 564 5 function 3fqhU2zdn6LwiSAm9upTzbtboK1U public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text This function returns the authority as an reference authority_view 2fwXocwnoAG9WDGbqM3quKphV1qq 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 2GaF4F3gH2Y5LkyYXCrr3VyP9tpJ text , reference has_authority 2omNW7ayWzkboBBXgc2Rm6C4y5kb text . named identifier 2fwXocwnoAG9WDGbqM3quKphV1qq authority_view normal buffer boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 282 5 function 3ESzuLSF2zD1TghU6qemdUksdP2V public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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. named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core normal c_str boost/url/url_base.hpp include/boost/url/url_base.hpp 127 5 function oHRP7v9PjrTqy9YjGBt8xxSqTLn public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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. pointer named identifier char char normal capacity boost/url/url_base.hpp include/boost/url/url_base.hpp 146 5 function HxCZYcsETDaw1bRzUVB9HpjzDZH public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std normal clear boost/url/url_base.hpp include/boost/url/url_base.hpp 165 5 function r7EPCNuC2kWeArshSQf9kS35QJA public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 named identifier void void normal compare boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2446 5 function 3Lh94K8cNrPFyFYw36XmhhtFMLpf public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 named identifier int int lvalue-reference named identifier 27ryuyAvvRyzfzgketja5uQcFBcK url_view_base other normal data boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 258 5 function VbvXoprikWfUm5mR56ZFYECXt9J public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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. pointer named identifier char char normal empty boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 238 5 function 4DmmNdXmY3VWyP6HoKWQVEExBzaV public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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. named identifier bool bool normal encoded_authority boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 601 5 function 2GaF4F3gH2Y5LkyYXCrr3VyP9tpJ public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 3fqhU2zdn6LwiSAm9upTzbtboK1U text , reference has_authority 2omNW7ayWzkboBBXgc2Rm6C4y5kb text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_fragment boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2280 5 function ipF8M41qPyuMM5XLe5JGZYSc42h public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2T5XA2udwnVeh4RFi6U9UrLirJFJ text , reference has_fragment 2RYFJUJHdYjygxHWSb57bHWfkHgN text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_host boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1120 5 function FMBiWLrznwNXgkDuu4xneE9NeCD public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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. named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_host_address boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1237 5 function 3oodjUy4VDbgnxfeqkxwvqQvf7hK public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text The value returned by this function depends on the type of host returned from the function reference host_type mSWKjRHEDFTnpxGSra6Q5eS7fjS text . list paragraph text If the type is reference host_type::ipv4 4B5yLFvhkpef7XX8ryKTaBWz8d6D text , then the IPv4 address string is returned. paragraph text If the type is reference host_type::ipv6 2y7UTsNbko8TLegXS5EpSa1goNog text , then the IPv6 address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::ipvfuture 25qx7TTMyctoe4LxqgMPXccSpy5Q text , then the IPvFuture address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::name QfoSUW8M1SPUL5EFVKwAUabTKCa 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 wGjRbosZ4DQY7xCpjwAZqPVHiim 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. named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_host_and_port boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2325 5 function 4SGWNm9TD3ZACEqJ9fmnWL1ZF47q public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4CLeCb8bTxYAjEFuAXtr5VmQW6FE text , reference port p8uqDVjGDrU4Eg9axo7dsTkztws text , reference port_number 363HbS6bzsgdHiLTk4Kr8pdkZJZY text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_host_name boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1441 5 function 492Pha8s74Xj1GjgZ82x193B56bP public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text If the host type is reference host_type::name QfoSUW8M1SPUL5EFVKwAUabTKCa 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. named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_origin boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2355 5 function 3gVZJ5SpfCzYoZgafZW71cueQ3u3 public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 3oB1p7aLxKXx3FxEqHaKSnCiNfXM text , reference encoded_target UJaw1aYaRaLhmYt2h416g598hi4 text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_params boost/url/url_base.hpp include/boost/url/url_base.hpp 2248 5 boost/url/url_base.hpp include/boost/url/url_base.hpp 2300 5 overloads 3WcGK7mkJngNwmU5zz1zx9Vr7iC3 public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3hdYD66PBzHcr6JTNLGtXFRmpwjB text , reference remove_query 2R5rf2bDtEpPE9hwtv8Ln4i6EAHv text , reference set_encoded_query v9Dry5ACH8wLSd7BYqpiHbGB7V8 text , reference set_query 4THvHraYktHgYNzU3qniR2MhXpuX text . see reference encoded_query 3VZ9J5FmgK7VsNUfrHxuyT4pNTGm text , reference has_query 21mA7muF2gpvzFjJxaqjvjnnm6XY text , reference params 3hdYD66PBzHcr6JTNLGtXFRmpwjB text , reference query 49Yox1iKKs7LmQ3wu1nCZXGKWEKf text . normal 2Tfz89EdRJCtmaAcvePE2sFdTaFs WLnpSWkKJP479aAk2KVz4BEDpZ8 auto auto encoded_params boost/url/url_base.hpp include/boost/url/url_base.hpp 2300 5 function 2Tfz89EdRJCtmaAcvePE2sFdTaFs public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3hdYD66PBzHcr6JTNLGtXFRmpwjB text , reference remove_query 2R5rf2bDtEpPE9hwtv8Ln4i6EAHv text , reference set_encoded_query v9Dry5ACH8wLSd7BYqpiHbGB7V8 text , reference set_query 4THvHraYktHgYNzU3qniR2MhXpuX text . named identifier 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe params_encoded_ref normal encoded_params boost/url/url_base.hpp include/boost/url/url_base.hpp 2248 5 function WLnpSWkKJP479aAk2KVz4BEDpZ8 public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3VZ9J5FmgK7VsNUfrHxuyT4pNTGm text , reference has_query 21mA7muF2gpvzFjJxaqjvjnnm6XY text , reference params 3hdYD66PBzHcr6JTNLGtXFRmpwjB text , reference query 49Yox1iKKs7LmQ3wu1nCZXGKWEKf text . named identifier 3w4FJjjADY3EEHqUmBj5mvDKqdEB params_encoded_view normal encoded_password boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 996 5 function 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4QciDQp3vKjNuPEah54XMBvrjvyD text , reference has_userinfo 2x7XawH6QTh6eBg2hNRqzQ3WME2m text , reference encoded_user 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC text , reference encoded_userinfo 3qDJMHEiC1T5Vik6nGt2CJvFxFDM text , reference password 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL text , reference user 4Yfg3yG11SsLgpAe6dzENEPz39dk text , reference userinfo 24JMPq739KrKuemXwWK8zpXGtWvz text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_path boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1799 5 function M5bG6HzwZUo4ycGCKLY5CsUUXun public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2hgDJpXv5LpubtS8phLLnGk4a7XZ text , reference encoded_segments 3jZFG9bXfeYJfGzZnt2Zim38gmMB text . reference path wc1MNXXCH1K1Shz81BmxVy1opwc text , reference segments 3YxJjcnyfcHtM9xLtszAHET8pyFv text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_query boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2040 5 function 3VZ9J5FmgK7VsNUfrHxuyT4pNTGm public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2N3uW9xQekt6pX19rHqrM5vcnVUH text , reference has_query 21mA7muF2gpvzFjJxaqjvjnnm6XY text , reference params 2RJGYan9E8WvVKQM1LmRNNdUCc7E text , reference query 49Yox1iKKs7LmQ3wu1nCZXGKWEKf text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_resource boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2387 5 function 3oB1p7aLxKXx3FxEqHaKSnCiNfXM public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 3gVZJ5SpfCzYoZgafZW71cueQ3u3 text , reference encoded_target UJaw1aYaRaLhmYt2h416g598hi4 text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_segments boost/url/url_base.hpp include/boost/url/url_base.hpp 2018 5 boost/url/url_base.hpp include/boost/url/url_base.hpp 2014 5 overloads 3NGtuSVjhTWXrAF9sPpeS5FwZQN8 public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 4Ek5WSaWmrfbmnMRzJv3oVPGKCua text , reference set_encoded_path MCx88BPGS5KgE3qhBfh89e3U57J text , reference set_path 3v9Fip9faoKhfWb6eQhiSgANjWdV text , reference set_path_absolute 4b7SsvokaeMTXQXBKywBXGVroR2 text . see reference is_path_absolute 2hgDJpXv5LpubtS8phLLnGk4a7XZ text , reference encoded_path M5bG6HzwZUo4ycGCKLY5CsUUXun text , reference path wc1MNXXCH1K1Shz81BmxVy1opwc text , reference segments 2bXmGRYoLQKFALtmsM2vVVCvmnVn text , reference segments_encoded_view GKjeDHooSf2HAMf239p3oFfT3i3 text . normal 4Ek5WSaWmrfbmnMRzJv3oVPGKCua 4CifMdq25fpMkWFY7dcZ9ZwXrmCV auto auto encoded_segments boost/url/url_base.hpp include/boost/url/url_base.hpp 2014 5 function 4Ek5WSaWmrfbmnMRzJv3oVPGKCua public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3NGtuSVjhTWXrAF9sPpeS5FwZQN8 text , reference set_encoded_path MCx88BPGS5KgE3qhBfh89e3U57J text , reference set_path 3v9Fip9faoKhfWb6eQhiSgANjWdV text , reference set_path_absolute 4b7SsvokaeMTXQXBKywBXGVroR2 text . named identifier 24XcpKBAcyXN6FLZk8kR4zGAmKak segments_encoded_ref normal encoded_segments boost/url/url_base.hpp include/boost/url/url_base.hpp 2018 5 function 4CifMdq25fpMkWFY7dcZ9ZwXrmCV public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 2hgDJpXv5LpubtS8phLLnGk4a7XZ text , reference encoded_path M5bG6HzwZUo4ycGCKLY5CsUUXun text , reference path wc1MNXXCH1K1Shz81BmxVy1opwc text , reference segments 2bXmGRYoLQKFALtmsM2vVVCvmnVn text , reference segments_encoded_view GKjeDHooSf2HAMf239p3oFfT3i3 text . named identifier GKjeDHooSf2HAMf239p3oFfT3i3 segments_encoded_view normal encoded_target boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2419 5 function UJaw1aYaRaLhmYt2h416g598hi4 public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 3gVZJ5SpfCzYoZgafZW71cueQ3u3 text , reference encoded_resource 3oB1p7aLxKXx3FxEqHaKSnCiNfXM text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_user boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 901 5 function 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4QciDQp3vKjNuPEah54XMBvrjvyD text , reference has_userinfo 2x7XawH6QTh6eBg2hNRqzQ3WME2m text , reference encoded_password 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym text , reference encoded_userinfo 3qDJMHEiC1T5Vik6nGt2CJvFxFDM text , reference password 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL text , reference user 4Yfg3yG11SsLgpAe6dzENEPz39dk text , reference userinfo 24JMPq739KrKuemXwWK8zpXGtWvz text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_userinfo boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 800 5 function 3qDJMHEiC1T5Vik6nGt2CJvFxFDM public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4QciDQp3vKjNuPEah54XMBvrjvyD text , reference has_userinfo 2x7XawH6QTh6eBg2hNRqzQ3WME2m text , reference encoded_password 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym text , reference encoded_user 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC text , reference password 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL text , reference user 4Yfg3yG11SsLgpAe6dzENEPz39dk text , reference userinfo 24JMPq739KrKuemXwWK8zpXGtWvz text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_zone_id boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1526 5 function 4Bt9AGe8WEFmjA79MWAiGPDtMUW8 public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text If the host type is reference host_type::ipv6 2y7UTsNbko8TLegXS5EpSa1goNog 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. named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal fragment boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2233 5 function 2T5XA2udwnVeh4RFi6U9UrLirJFJ public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 ipF8M41qPyuMM5XLe5JGZYSc42h text , reference has_fragment 2RYFJUJHdYjygxHWSb57bHWfkHgN text . named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal has_authority boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 528 5 function 2omNW7ayWzkboBBXgc2Rm6C4y5kb public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 3fqhU2zdn6LwiSAm9upTzbtboK1U text , reference encoded_authority 2GaF4F3gH2Y5LkyYXCrr3VyP9tpJ text . named identifier bool bool normal has_fragment boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2173 5 function 2RYFJUJHdYjygxHWSb57bHWfkHgN public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 ipF8M41qPyuMM5XLe5JGZYSc42h text , reference fragment 2T5XA2udwnVeh4RFi6U9UrLirJFJ text . named identifier bool bool normal has_password boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 689 5 function 4QciDQp3vKjNuPEah54XMBvrjvyD public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2x7XawH6QTh6eBg2hNRqzQ3WME2m text , reference encoded_password 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym text , reference encoded_user 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC text , reference encoded_userinfo 3qDJMHEiC1T5Vik6nGt2CJvFxFDM text , reference password 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL text , reference user 4Yfg3yG11SsLgpAe6dzENEPz39dk text , reference userinfo 24JMPq739KrKuemXwWK8zpXGtWvz text . named identifier bool bool normal has_port boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1568 5 function 4CLeCb8bTxYAjEFuAXtr5VmQW6FE public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4SGWNm9TD3ZACEqJ9fmnWL1ZF47q text , reference port p8uqDVjGDrU4Eg9axo7dsTkztws text , reference port_number 363HbS6bzsgdHiLTk4Kr8pdkZJZY text . named identifier bool bool normal has_query boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1937 5 function 21mA7muF2gpvzFjJxaqjvjnnm6XY public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2N3uW9xQekt6pX19rHqrM5vcnVUH text , reference encoded_query 3VZ9J5FmgK7VsNUfrHxuyT4pNTGm text , reference params 2RJGYan9E8WvVKQM1LmRNNdUCc7E text , reference query 49Yox1iKKs7LmQ3wu1nCZXGKWEKf text . named identifier bool bool normal has_scheme boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 384 5 function 2wLECn7WbsBXGLpheUngfa9GEf1q public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4AoadMoEhkiTY9v83LDBwQt31Uti text , reference scheme_id 3aL5x6QNsMGNDAo8DP539u5TsZpp text . named identifier bool bool normal has_userinfo boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 647 5 function 2x7XawH6QTh6eBg2hNRqzQ3WME2m public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4QciDQp3vKjNuPEah54XMBvrjvyD text , reference encoded_password 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym text , reference encoded_user 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC text , reference encoded_userinfo 3qDJMHEiC1T5Vik6nGt2CJvFxFDM text , reference password 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL text , reference user 4Yfg3yG11SsLgpAe6dzENEPz39dk text , reference userinfo 24JMPq739KrKuemXwWK8zpXGtWvz text . named identifier bool bool normal host boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1076 5 function SytR6d7pUELeR1RNUpcWrXWQcY8 public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal host_address boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1174 5 function KoSC71QaaCYQtpr7xCwndbzWaKR public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text The value returned by this function depends on the type of host returned from the function reference host_type mSWKjRHEDFTnpxGSra6Q5eS7fjS text . list paragraph text If the type is reference host_type::ipv4 4B5yLFvhkpef7XX8ryKTaBWz8d6D text , then the IPv4 address string is returned. paragraph text If the type is reference host_type::ipv6 2y7UTsNbko8TLegXS5EpSa1goNog text , then the IPv6 address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::ipvfuture 25qx7TTMyctoe4LxqgMPXccSpy5Q text , then the IPvFuture address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::name QfoSUW8M1SPUL5EFVKwAUabTKCa 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 wGjRbosZ4DQY7xCpjwAZqPVHiim 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 named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal host_ipv4_address boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1277 5 function Zvcpzzy9h3HWgiqp7UZuEiWf4A7 public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text If the host type is reference host_type::ipv4 4B5yLFvhkpef7XX8ryKTaBWz8d6D text , this function returns the address as a value of type reference ipv4_address 4Xmd9k1GBKGKQj6PYc1qdt4tMUae 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 4Xmd9k1GBKGKQj6PYc1qdt4tMUae text . named identifier 4Xmd9k1GBKGKQj6PYc1qdt4tMUae ipv4_address normal host_ipv6_address boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1325 5 function 9sSdyLcyHxeuasmCKqifZp3ga5s public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text If the host type is reference host_type::ipv6 2y7UTsNbko8TLegXS5EpSa1goNog text , this function returns the address as a value of type reference ipv6_address 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T 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 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T text . named identifier 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T ipv6_address normal host_ipvfuture boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1358 5 function 4E8a8HgQbryrd4KcNHFajdVyLWib public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text If the host type is reference host_type::ipvfuture 25qx7TTMyctoe4LxqgMPXccSpy5Q 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. named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core normal host_name boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1395 5 function 2gNagLmHXZAqycctaaYmEYZc9pv public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text If the host type is reference host_type::name QfoSUW8M1SPUL5EFVKwAUabTKCa 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 named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal host_type boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1036 5 function mSWKjRHEDFTnpxGSra6Q5eS7fjS public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text This function returns one of the following constants representing the type of host present. list paragraph reference host_type::ipv4 4B5yLFvhkpef7XX8ryKTaBWz8d6D paragraph reference host_type::ipv6 2y7UTsNbko8TLegXS5EpSa1goNog paragraph reference host_type::ipvfuture 25qx7TTMyctoe4LxqgMPXccSpy5Q paragraph reference host_type::name QfoSUW8M1SPUL5EFVKwAUabTKCa paragraph reference host_type::none wGjRbosZ4DQY7xCpjwAZqPVHiim unordered paragraph text When reference has_authority 2omNW7ayWzkboBBXgc2Rm6C4y5kb text is false, the host type is reference host_type::none wGjRbosZ4DQY7xCpjwAZqPVHiim 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. named identifier 2M8hT55CSziFA9Zup4mKYdwvgUiE host_type identifier 2ejQGW57K8g7MFJhHAwPt5aumoLa urls normal is_path_absolute boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1691 5 function 2hgDJpXv5LpubtS8phLLnGk4a7XZ public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 M5bG6HzwZUo4ycGCKLY5CsUUXun text , reference encoded_segments 3jZFG9bXfeYJfGzZnt2Zim38gmMB text . reference path wc1MNXXCH1K1Shz81BmxVy1opwc text , reference segments 3YxJjcnyfcHtM9xLtszAHET8pyFv text . named identifier bool bool normal normalize boost/url/url.hpp include/boost/url/url.hpp 499 5 function 3admKSg7ZAHH4zBsuUC8HFxR2375 public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 3q5bwHqsBrEN7TKhbLVyEErrscBt text , reference normalize_authority 2E5z2jhAgP7jEaRTLV4JiaFvDPz2 text , reference normalize_path 3pjTFFQppAe7J9LbsFwaGwEHdJqj text , reference normalize_query 2iPchP2kSD2jxV4aiYg5dJEycPCq text , reference normalize_fragment 3yQdciJbRHJ7Q12TZribXR1pLVYF lvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url normal normalize_authority boost/url/url.hpp include/boost/url/url.hpp 503 5 function 2E5z2jhAgP7jEaRTLV4JiaFvDPz2 public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 lvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url normal normalize_fragment boost/url/url.hpp include/boost/url/url.hpp 509 5 function 3yQdciJbRHJ7Q12TZribXR1pLVYF public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 lvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url normal normalize_path boost/url/url.hpp include/boost/url/url.hpp 505 5 function 3pjTFFQppAe7J9LbsFwaGwEHdJqj public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 lvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url normal normalize_query boost/url/url.hpp include/boost/url/url.hpp 507 5 function 2iPchP2kSD2jxV4aiYg5dJEycPCq public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 lvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url normal normalize_scheme boost/url/url.hpp include/boost/url/url.hpp 501 5 function 3q5bwHqsBrEN7TKhbLVyEErrscBt public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 lvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url normal params boost/url/url_base.hpp include/boost/url/url_base.hpp 2186 5 boost/url/url_base.hpp include/boost/url/url_base.hpp 2182 5 boost/url/url_base.hpp include/boost/url/url_base.hpp 2244 5 boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2087 5 overloads 3hdYD66PBzHcr6JTNLGtXFRmpwjB public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3WcGK7mkJngNwmU5zz1zx9Vr7iC3 text , reference remove_query 2R5rf2bDtEpPE9hwtv8Ln4i6EAHv text , reference set_encoded_query v9Dry5ACH8wLSd7BYqpiHbGB7V8 text , reference set_query 4THvHraYktHgYNzU3qniR2MhXpuX text . see reference encoded_params 3WcGK7mkJngNwmU5zz1zx9Vr7iC3 text , reference encoded_query 3VZ9J5FmgK7VsNUfrHxuyT4pNTGm text , reference has_query 21mA7muF2gpvzFjJxaqjvjnnm6XY text , reference query 49Yox1iKKs7LmQ3wu1nCZXGKWEKf text . normal h2KhFjqyUKC3HGV5g2PZnGhgtie 3WKTuUvsgrf9YbmTdPXZLGJTg7AG 3oKGEwnRxyroFWsdqYwHqERdPKZ9 2Dh1FrqKLpBQUzJVYtqvr6ziuTX6 auto auto params boost/url/url_base.hpp include/boost/url/url_base.hpp 2182 5 function h2KhFjqyUKC3HGV5g2PZnGhgtie public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3WcGK7mkJngNwmU5zz1zx9Vr7iC3 text , reference remove_query 2R5rf2bDtEpPE9hwtv8Ln4i6EAHv text , reference set_encoded_query v9Dry5ACH8wLSd7BYqpiHbGB7V8 text , reference set_query 4THvHraYktHgYNzU3qniR2MhXpuX text . named identifier 4MtPiWDytNMbqCE6iciHidLK5Y4c params_ref normal params boost/url/url_base.hpp include/boost/url/url_base.hpp 2186 5 function 3WKTuUvsgrf9YbmTdPXZLGJTg7AG public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3WcGK7mkJngNwmU5zz1zx9Vr7iC3 text , reference encoded_query 3VZ9J5FmgK7VsNUfrHxuyT4pNTGm text , reference has_query 21mA7muF2gpvzFjJxaqjvjnnm6XY text , reference query 49Yox1iKKs7LmQ3wu1nCZXGKWEKf text . named identifier DJiFqyFR7zZh4N3HNJHhiAj7JPV params_view normal params boost/url/url_base.hpp include/boost/url/url_base.hpp 2244 5 function 3oKGEwnRxyroFWsdqYwHqERdPKZ9 public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3WcGK7mkJngNwmU5zz1zx9Vr7iC3 text , reference remove_query 2R5rf2bDtEpPE9hwtv8Ln4i6EAHv text , reference set_encoded_query v9Dry5ACH8wLSd7BYqpiHbGB7V8 text , reference set_query 4THvHraYktHgYNzU3qniR2MhXpuX text . named identifier 4MtPiWDytNMbqCE6iciHidLK5Y4c params_ref named identifier 5dyN7z5egGMdJFpXz9WbaL549xC encoding_opts opt normal params boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2087 5 function 2Dh1FrqKLpBQUzJVYtqvr6ziuTX6 public regular 27ryuyAvvRyzfzgketja5uQcFBcK named identifier DJiFqyFR7zZh4N3HNJHhiAj7JPV params_view named identifier 5dyN7z5egGMdJFpXz9WbaL549xC encoding_opts opt normal password boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 947 5 function 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4QciDQp3vKjNuPEah54XMBvrjvyD text , reference has_userinfo 2x7XawH6QTh6eBg2hNRqzQ3WME2m text , reference encoded_password 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym text , reference encoded_user 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC text , reference encoded_userinfo 3qDJMHEiC1T5Vik6nGt2CJvFxFDM text , reference user 4Yfg3yG11SsLgpAe6dzENEPz39dk text , reference userinfo 24JMPq739KrKuemXwWK8zpXGtWvz text . named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal path boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1744 5 function wc1MNXXCH1K1Shz81BmxVy1opwc public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2hgDJpXv5LpubtS8phLLnGk4a7XZ text , reference encoded_path M5bG6HzwZUo4ycGCKLY5CsUUXun text , reference encoded_segments 3jZFG9bXfeYJfGzZnt2Zim38gmMB text . reference segments 3YxJjcnyfcHtM9xLtszAHET8pyFv text . named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal persist boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 341 5 function 2aNVu1ZJUXAnkA1MUK2cfojoNCyj public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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. named specialization 3ndPMWYzhtTVAVCHsDKjaQkrDfmC shared_ptr identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std type named identifier 3hrVvoVYoDkX9t3w9abTXxDqGRaW url_view normal port boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1604 5 function p8uqDVjGDrU4Eg9axo7dsTkztws public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4SGWNm9TD3ZACEqJ9fmnWL1ZF47q text , reference has_port 4CLeCb8bTxYAjEFuAXtr5VmQW6FE text , reference port_number 363HbS6bzsgdHiLTk4Kr8pdkZJZY text . named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core normal port_number boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1640 5 function 363HbS6bzsgdHiLTk4Kr8pdkZJZY public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4SGWNm9TD3ZACEqJ9fmnWL1ZF47q text , reference has_port 4CLeCb8bTxYAjEFuAXtr5VmQW6FE text , reference port p8uqDVjGDrU4Eg9axo7dsTkztws text . named identifier w7yWEPLwtMpd5GnNHsV5ASwVxkX uint16_t normal query boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1987 5 function 49Yox1iKKs7LmQ3wu1nCZXGKWEKf public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2N3uW9xQekt6pX19rHqrM5vcnVUH text , reference encoded_query 3VZ9J5FmgK7VsNUfrHxuyT4pNTGm text , reference has_query 21mA7muF2gpvzFjJxaqjvjnnm6XY text , reference params 2RJGYan9E8WvVKQM1LmRNNdUCc7E text . named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal remove_authority boost/url/url.hpp include/boost/url/url.hpp 422 5 function 3Zu2JdbQ8yz6vHr33nTTLyb1MJUg public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 3dAGNoeC7UAPMMB2zm3mCESohLWS text . lvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url normal remove_fragment boost/url/url.hpp include/boost/url/url.hpp 489 5 function mtjDuAmUewepK9ZAPGKm4KZvSUZ public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 2TNB4s1W5aG5wvgM5sFhpkadBvP9 text , reference set_encoded_fragment 2hLzEE9gAKyxVT6kbPLwfet2MGnC text , reference set_fragment 2BFpJxb9o2AGu7rRGKFVoFsW7Pi4 text . lvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url normal remove_origin boost/url/url.hpp include/boost/url/url.hpp 496 5 function 3AYLpa5qXMGfmwmjHU6QbgPqUL52 public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 lvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url normal remove_password boost/url/url.hpp include/boost/url/url.hpp 439 5 function 4NNwWhYB52k9eRWaWW11TyR6tgWR public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 2fgvJkQWk6Y3UiAumQKpQCeSMgtF text , reference set_encoded_user JFREUzkcBvd4d7YpAe3ZbWKJv98 text , reference set_password xxS4ufnn9fuGnTr3GGJVKBp3JFc text , reference set_user 2XmiAqTQhm8wEWD8R3PizB5WMF1w text . lvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url normal remove_port boost/url/url.hpp include/boost/url/url.hpp 468 5 function 3FmFpDaKVNyQ7bXNSdrzCGsVJM7P public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 266h2w9HS6kseMj1JLKfE29grSy6 text . lvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url normal remove_query boost/url/url.hpp include/boost/url/url.hpp 486 5 function 36kaFnfGXgbj1nqCcaNfBSQmxuGS public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 3WcGK7mkJngNwmU5zz1zx9Vr7iC3 text , reference params 3hdYD66PBzHcr6JTNLGtXFRmpwjB text , reference set_encoded_query JmPno9gmDpQRQfbUP3rzokugA7a text , reference set_query 44c22UJ7fFsbi4WZDMrzQBmXRnGS text . lvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url normal remove_scheme boost/url/url.hpp include/boost/url/url.hpp 417 5 function 3mQ82A3cBXgmgWLYuxa1y3o1qUZ5 public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 3QW2cbeaw11tvSPbrjEnJSQu2CC7 text . lvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url normal remove_userinfo boost/url/url.hpp include/boost/url/url.hpp 429 5 function SbtgEkcVVKjqXDg5qLkUoLeu649 public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 gNzAQHZHDPXQiqwfYS6GwxUvQsG text , reference set_userinfo 3WPfZEH3k9jEMW6zLcD16Xd3Uqyg text . lvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url normal reserve boost/url/url_base.hpp include/boost/url/url_base.hpp 187 5 function zpt1tVsUzr9PpovdHt6x8TgTZMD public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 named identifier void void named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std n normal resolve boost/url/url_base.hpp include/boost/url/url_base.hpp 2973 5 function 45Z6NdRjyroghszwmeBJuKmyuKLU public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 75qVNpuBHShJ8KKEUv4RCrwxEAB text , reference url_view 3hrVvoVYoDkX9t3w9abTXxDqGRaW text . named specialization qQFMz11M2hdnkDE2M6AYnTSkQhv result identifier dgHcH1svHs5X3czTwE2RBXQ7tGq system type named identifier void void lvalue-reference named identifier 27ryuyAvvRyzfzgketja5uQcFBcK url_view_base ref normal scheme boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 421 5 function 4AoadMoEhkiTY9v83LDBwQt31Uti public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2wLECn7WbsBXGLpheUngfa9GEf1q text , reference scheme_id 3aL5x6QNsMGNDAo8DP539u5TsZpp text . named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core normal scheme_id boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 471 5 function 3aL5x6QNsMGNDAo8DP539u5TsZpp public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 tVuW4uzt1HMgUxPtxroTuMsNi2G 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 d3jNvGWyWHyaA1snRDXYWd5jjkA text . paragraph text Otherwise, if the scheme is absent the value returned is reference urls::scheme::none 2DEQCVdvMZA94BHRjTMB2n7Ttdp2 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 2wLECn7WbsBXGLpheUngfa9GEf1q text , reference scheme 4AoadMoEhkiTY9v83LDBwQt31Uti text . named identifier tVuW4uzt1HMgUxPtxroTuMsNi2G scheme identifier 2ejQGW57K8g7MFJhHAwPt5aumoLa urls normal segments boost/url/url_base.hpp include/boost/url/url_base.hpp 1955 5 boost/url/url_base.hpp include/boost/url/url_base.hpp 1951 5 overloads 2bXmGRYoLQKFALtmsM2vVVCvmnVn public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3NGtuSVjhTWXrAF9sPpeS5FwZQN8 text , reference set_encoded_path MCx88BPGS5KgE3qhBfh89e3U57J text , reference set_path 3v9Fip9faoKhfWb6eQhiSgANjWdV text , reference set_path_absolute 4b7SsvokaeMTXQXBKywBXGVroR2 text . see reference is_path_absolute 2hgDJpXv5LpubtS8phLLnGk4a7XZ text , reference encoded_path M5bG6HzwZUo4ycGCKLY5CsUUXun text , reference encoded_segments 3NGtuSVjhTWXrAF9sPpeS5FwZQN8 text . reference path wc1MNXXCH1K1Shz81BmxVy1opwc text , reference segments_view 2QU7risgZzo8F84g7LttC6dG1GsH text . normal 4J7mUgLL9CaiS3Kv4ZcaRamupUkL uWpBZKqgnJKFef7rkZxJTw2WsxX auto auto segments boost/url/url_base.hpp include/boost/url/url_base.hpp 1951 5 function 4J7mUgLL9CaiS3Kv4ZcaRamupUkL public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3NGtuSVjhTWXrAF9sPpeS5FwZQN8 text , reference set_encoded_path MCx88BPGS5KgE3qhBfh89e3U57J text , reference set_path 3v9Fip9faoKhfWb6eQhiSgANjWdV text , reference set_path_absolute 4b7SsvokaeMTXQXBKywBXGVroR2 text . named identifier 3sLepuFTMctJHoZrLv8tvJTFkDPS segments_ref identifier 2ejQGW57K8g7MFJhHAwPt5aumoLa urls normal segments boost/url/url_base.hpp include/boost/url/url_base.hpp 1955 5 function uWpBZKqgnJKFef7rkZxJTw2WsxX public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 2hgDJpXv5LpubtS8phLLnGk4a7XZ text , reference encoded_path M5bG6HzwZUo4ycGCKLY5CsUUXun text , reference encoded_segments 3NGtuSVjhTWXrAF9sPpeS5FwZQN8 text . reference path wc1MNXXCH1K1Shz81BmxVy1opwc text , reference segments_view 2QU7risgZzo8F84g7LttC6dG1GsH text . named identifier 2QU7risgZzo8F84g7LttC6dG1GsH segments_view normal set_encoded_authority boost/url/url.hpp include/boost/url/url.hpp 420 5 function 3dAGNoeC7UAPMMB2zm3mCESohLWS public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 2bHQfxWtGijDtNutjkX9m9nmNJgq text . lvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view s normal set_encoded_fragment boost/url/url.hpp include/boost/url/url.hpp 493 5 function wvX6pfjqRkAZY4jEA4LMeXi7RgW public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 2TNB4s1W5aG5wvgM5sFhpkadBvP9 text , reference set_fragment 2BFpJxb9o2AGu7rRGKFVoFsW7Pi4 text . lvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view s normal set_encoded_host boost/url/url.hpp include/boost/url/url.hpp 444 5 function vqmQxG49x1A1LB55DWAQVaDfhBF public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 4B5yLFvhkpef7XX8ryKTaBWz8d6D 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 2y7UTsNbko8TLegXS5EpSa1goNog 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 25qx7TTMyctoe4LxqgMPXccSpy5Q 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 QfoSUW8M1SPUL5EFVKwAUabTKCa 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 4DwBiJMifXNsmVFdmgKDhGDJZ3wh text , reference set_encoded_host_name fBFYvCn8kJ47xA7NVhe1Rghp5J8 text , reference set_host 36GzQWnsLo7vUpJDLjUBWfUao6v7 text , reference set_host_address 3bzhb9DrxWPqshAd4mygzPBefvw8 text , reference set_host_ipv4 9UnBBXEqhvdW1scEozkygaKMjGZ text , reference set_host_ipv6 6SijdGWstqVJuYLMAU9YBwkBXSG text , reference set_host_ipvfuture 55atbAUaUexHuQt9WaRpVBqgfdg text , reference set_host_name soNQwVrosnpg6yBhJnz9p8yjZta text . lvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view s normal set_encoded_host_address boost/url/url.hpp include/boost/url/url.hpp 448 5 function 4PKBCyDPbv2dwEoy4fCo67rjvQA4 public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 4B5yLFvhkpef7XX8ryKTaBWz8d6D 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 2y7UTsNbko8TLegXS5EpSa1goNog 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 25qx7TTMyctoe4LxqgMPXccSpy5Q 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 QfoSUW8M1SPUL5EFVKwAUabTKCa 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 osScXCjJkJkSf5jPTGH5dPVin3q text , reference set_encoded_host_name fBFYvCn8kJ47xA7NVhe1Rghp5J8 text , reference set_host 36GzQWnsLo7vUpJDLjUBWfUao6v7 text , reference set_host_address 3bzhb9DrxWPqshAd4mygzPBefvw8 text , reference set_host_ipv4 9UnBBXEqhvdW1scEozkygaKMjGZ text , reference set_host_ipv6 6SijdGWstqVJuYLMAU9YBwkBXSG text , reference set_host_ipvfuture 55atbAUaUexHuQt9WaRpVBqgfdg text , reference set_host_name soNQwVrosnpg6yBhJnz9p8yjZta text . lvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view s normal set_encoded_host_name boost/url/url.hpp include/boost/url/url.hpp 462 5 function 3nKWM4uGNScqDM2BKxNiFVrzvMr8 public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 QfoSUW8M1SPUL5EFVKwAUabTKCa 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 osScXCjJkJkSf5jPTGH5dPVin3q text , reference set_encoded_host_address 4DwBiJMifXNsmVFdmgKDhGDJZ3wh text , reference set_host 36GzQWnsLo7vUpJDLjUBWfUao6v7 text , reference set_host_address 3bzhb9DrxWPqshAd4mygzPBefvw8 text , reference set_host_ipv4 9UnBBXEqhvdW1scEozkygaKMjGZ text , reference set_host_ipv6 6SijdGWstqVJuYLMAU9YBwkBXSG text , reference set_host_ipvfuture 55atbAUaUexHuQt9WaRpVBqgfdg text , reference set_host_name soNQwVrosnpg6yBhJnz9p8yjZta text . lvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view s normal set_encoded_params boost/url/url.hpp include/boost/url/url.hpp 484 5 function 3xY1fCKgTcftAHenafLadYf7osQE public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 rfMzJAA8APDm5UYHxYTSddwT4Qh text , reference params 3hdYD66PBzHcr6JTNLGtXFRmpwjB text , reference remove_query 36kaFnfGXgbj1nqCcaNfBSQmxuGS text , reference set_encoded_query JmPno9gmDpQRQfbUP3rzokugA7a text , reference set_query 44c22UJ7fFsbi4WZDMrzQBmXRnGS text . lvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url named specialization 474HF6bGJmJntnocv1iPAYL2crja initializer_list identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std type named identifier 21okxUDyXpX2g3uj7TzYTtM4Skgh param_pct_view ps normal set_encoded_password boost/url/url.hpp include/boost/url/url.hpp 437 5 function 2fgvJkQWk6Y3UiAumQKpQCeSMgtF public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 igKd3Gv9P5L4VjvQSC6giswwMEQ text , reference set_encoded_password 3M3tGnhVHGx7Vc2eUaFuGy7VoCxu text , reference set_encoded_user 2MEk1Cda8bzLjEPBG1V7MJvLRyqJ text , reference set_user MYZLHVqFcgnRAf8PVbRnn3ZdMGq text . lvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view s normal set_encoded_path boost/url/url.hpp include/boost/url/url.hpp 475 5 function 3YKaVav7iU4CADoq5TDKsfmzh5Tk public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 3NGtuSVjhTWXrAF9sPpeS5FwZQN8 text , reference segments 2bXmGRYoLQKFALtmsM2vVVCvmnVn text , reference set_path 4McpqTciHbP7MYJJafnvFkRJGcZ5 text , reference set_path_absolute 4b7SsvokaeMTXQXBKywBXGVroR2 text . lvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view s normal set_encoded_query boost/url/url.hpp include/boost/url/url.hpp 480 5 function JmPno9gmDpQRQfbUP3rzokugA7a public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 3WcGK7mkJngNwmU5zz1zx9Vr7iC3 text , reference params 3hdYD66PBzHcr6JTNLGtXFRmpwjB text , reference remove_query 36kaFnfGXgbj1nqCcaNfBSQmxuGS text , reference set_query 44c22UJ7fFsbi4WZDMrzQBmXRnGS text . lvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view s normal set_encoded_user boost/url/url.hpp include/boost/url/url.hpp 433 5 function JFREUzkcBvd4d7YpAe3ZbWKJv98 public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 igKd3Gv9P5L4VjvQSC6giswwMEQ text , reference set_encoded_password 3M3tGnhVHGx7Vc2eUaFuGy7VoCxu text , reference set_password 2YAaMd9PbnTHhrrZTFuaATwNBjuR text , reference set_user MYZLHVqFcgnRAf8PVbRnn3ZdMGq text . lvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view s normal set_encoded_userinfo boost/url/url.hpp include/boost/url/url.hpp 427 5 function 2Qhtn8WbDtyHvC8Yw52Ri2Up2bsZ public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 4QciDQp3vKjNuPEah54XMBvrjvyD text returns true. Otherwise, paragraph text If there is no colon, the user is set to the string. The function reference has_password 4QciDQp3vKjNuPEah54XMBvrjvyD 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 SbtgEkcVVKjqXDg5qLkUoLeu649 text , reference set_userinfo 3XpMK24TMhcVwJ9PAHwZxSLqRo7H text . lvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view s normal set_encoded_zone_id boost/url/url.hpp include/boost/url/url.hpp 456 5 boost/url/url_base.hpp include/boost/url/url_base.hpp 1411 5 overloads 2iRCpGiijC5ZJdA9PPAtoyfJ3hGd public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 4X1oAamqzgD6NUQuQqZgb3E7Y8hN xZHzDR85CyKchq2igVsAugcq3do auto auto set_encoded_zone_id boost/url/url_base.hpp include/boost/url/url_base.hpp 1411 5 function 4X1oAamqzgD6NUQuQqZgb3E7Y8hN public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view s normal set_encoded_zone_id boost/url/url.hpp include/boost/url/url.hpp 456 5 function xZHzDR85CyKchq2igVsAugcq3do public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 lvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url lvalue-reference named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view s normal set_fragment boost/url/url.hpp include/boost/url/url.hpp 491 5 function 37FipzgBGWwbp1ZX95UuSuef5rpL public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 mtjDuAmUewepK9ZAPGKm4KZvSUZ text , reference set_encoded_fragment wvX6pfjqRkAZY4jEA4LMeXi7RgW text . lvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal set_host boost/url/url.hpp include/boost/url/url.hpp 442 5 function k82DjZnEEWSXkViYt3vzyaK5tdm public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 4B5yLFvhkpef7XX8ryKTaBWz8d6D 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 2y7UTsNbko8TLegXS5EpSa1goNog 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 25qx7TTMyctoe4LxqgMPXccSpy5Q 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 QfoSUW8M1SPUL5EFVKwAUabTKCa 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 osScXCjJkJkSf5jPTGH5dPVin3q text , reference set_encoded_host_address 4DwBiJMifXNsmVFdmgKDhGDJZ3wh text , reference set_encoded_host_name fBFYvCn8kJ47xA7NVhe1Rghp5J8 text , reference set_host_address 3bzhb9DrxWPqshAd4mygzPBefvw8 text , reference set_host_ipv4 9UnBBXEqhvdW1scEozkygaKMjGZ text , reference set_host_ipv6 6SijdGWstqVJuYLMAU9YBwkBXSG text , reference set_host_ipvfuture 55atbAUaUexHuQt9WaRpVBqgfdg text , reference set_host_name soNQwVrosnpg6yBhJnz9p8yjZta text . lvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal set_host_address boost/url/url.hpp include/boost/url/url.hpp 446 5 function yP9ss9fySL76cVwxgy2zuer9Jmf public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 4B5yLFvhkpef7XX8ryKTaBWz8d6D 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 2y7UTsNbko8TLegXS5EpSa1goNog 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 25qx7TTMyctoe4LxqgMPXccSpy5Q 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 QfoSUW8M1SPUL5EFVKwAUabTKCa 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 osScXCjJkJkSf5jPTGH5dPVin3q text , reference set_encoded_host_address 4DwBiJMifXNsmVFdmgKDhGDJZ3wh text , reference set_encoded_host_name fBFYvCn8kJ47xA7NVhe1Rghp5J8 text , reference set_host 36GzQWnsLo7vUpJDLjUBWfUao6v7 text , reference set_host_address 3bzhb9DrxWPqshAd4mygzPBefvw8 text , reference set_host_ipv4 9UnBBXEqhvdW1scEozkygaKMjGZ text , reference set_host_ipv6 6SijdGWstqVJuYLMAU9YBwkBXSG text , reference set_host_ipvfuture 55atbAUaUexHuQt9WaRpVBqgfdg text , reference set_host_name soNQwVrosnpg6yBhJnz9p8yjZta text . lvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal set_host_ipv4 boost/url/url.hpp include/boost/url/url.hpp 450 5 function 2zqhENhNgNKSwfiRLq9dhNQPJsDf public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB paragraph text The host is set to the specified IPv4 address. The host type is reference host_type::ipv4 4B5yLFvhkpef7XX8ryKTaBWz8d6D 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 osScXCjJkJkSf5jPTGH5dPVin3q text , reference set_encoded_host_address 4DwBiJMifXNsmVFdmgKDhGDJZ3wh text , reference set_encoded_host_name fBFYvCn8kJ47xA7NVhe1Rghp5J8 text , reference set_host 36GzQWnsLo7vUpJDLjUBWfUao6v7 text , reference set_host_address 3bzhb9DrxWPqshAd4mygzPBefvw8 text , reference set_host_ipv6 6SijdGWstqVJuYLMAU9YBwkBXSG text , reference set_host_ipvfuture 55atbAUaUexHuQt9WaRpVBqgfdg text , reference set_host_name soNQwVrosnpg6yBhJnz9p8yjZta text . lvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url lvalue-reference named identifier 4Xmd9k1GBKGKQj6PYc1qdt4tMUae ipv4_address addr normal set_host_ipv6 boost/url/url.hpp include/boost/url/url.hpp 452 5 function XGCarXEBGEFfTakWXL5MvKVGRS3 public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB paragraph text The host is set to the specified IPv6 address. The host type is reference host_type::ipv6 2y7UTsNbko8TLegXS5EpSa1goNog 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 vqmQxG49x1A1LB55DWAQVaDfhBF text , reference set_encoded_host_address 4PKBCyDPbv2dwEoy4fCo67rjvQA4 text , reference set_encoded_host_name 3nKWM4uGNScqDM2BKxNiFVrzvMr8 text , reference set_host k82DjZnEEWSXkViYt3vzyaK5tdm text , reference set_host_address yP9ss9fySL76cVwxgy2zuer9Jmf text , reference set_host_ipv4 2zqhENhNgNKSwfiRLq9dhNQPJsDf text , reference set_host_ipvfuture HCV4H1sf2pryFawpghkGQCDVBTp text , reference set_host_name 2FJzNSUiS2pzEJTFnsJs38Hh4u5Y text . lvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url lvalue-reference named identifier 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T ipv6_address addr normal set_host_ipvfuture boost/url/url.hpp include/boost/url/url.hpp 458 5 function HCV4H1sf2pryFawpghkGQCDVBTp public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB paragraph text The host is set to the specified IPvFuture string. The host type is reference host_type::ipvfuture 25qx7TTMyctoe4LxqgMPXccSpy5Q 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 osScXCjJkJkSf5jPTGH5dPVin3q text , reference set_encoded_host_address 4DwBiJMifXNsmVFdmgKDhGDJZ3wh text , reference set_encoded_host_name fBFYvCn8kJ47xA7NVhe1Rghp5J8 text , reference set_host 36GzQWnsLo7vUpJDLjUBWfUao6v7 text , reference set_host_address 3bzhb9DrxWPqshAd4mygzPBefvw8 text , reference set_host_ipv4 9UnBBXEqhvdW1scEozkygaKMjGZ text , reference set_host_ipv6 6SijdGWstqVJuYLMAU9YBwkBXSG text , reference set_host_name soNQwVrosnpg6yBhJnz9p8yjZta text . lvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal set_host_name boost/url/url.hpp include/boost/url/url.hpp 460 5 function 2FJzNSUiS2pzEJTFnsJs38Hh4u5Y public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 QfoSUW8M1SPUL5EFVKwAUabTKCa 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 osScXCjJkJkSf5jPTGH5dPVin3q text , reference set_encoded_host_address 4DwBiJMifXNsmVFdmgKDhGDJZ3wh text , reference set_encoded_host_name fBFYvCn8kJ47xA7NVhe1Rghp5J8 text , reference set_host 36GzQWnsLo7vUpJDLjUBWfUao6v7 text , reference set_host_address 3bzhb9DrxWPqshAd4mygzPBefvw8 text , reference set_host_ipv4 9UnBBXEqhvdW1scEozkygaKMjGZ text , reference set_host_ipv6 6SijdGWstqVJuYLMAU9YBwkBXSG text , reference set_host_ipvfuture 55atbAUaUexHuQt9WaRpVBqgfdg text . lvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal set_params boost/url/url.hpp include/boost/url/url.hpp 482 5 function rfMzJAA8APDm5UYHxYTSddwT4Qh public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 3WcGK7mkJngNwmU5zz1zx9Vr7iC3 text , reference remove_query 2R5rf2bDtEpPE9hwtv8Ln4i6EAHv text , reference set_encoded_query v9Dry5ACH8wLSd7BYqpiHbGB7V8 text , reference set_query 4THvHraYktHgYNzU3qniR2MhXpuX text . lvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url named specialization 474HF6bGJmJntnocv1iPAYL2crja initializer_list identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std type named identifier AbvEAFQMtFaLMVMSA2NZ5D5a7nN param_view ps named identifier 5dyN7z5egGMdJFpXz9WbaL549xC encoding_opts opts {} normal set_password boost/url/url.hpp include/boost/url/url.hpp 435 5 function xxS4ufnn9fuGnTr3GGJVKBp3JFc public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 4NNwWhYB52k9eRWaWW11TyR6tgWR text , reference set_encoded_password 2fgvJkQWk6Y3UiAumQKpQCeSMgtF text , reference set_encoded_user JFREUzkcBvd4d7YpAe3ZbWKJv98 text , reference set_user 2XmiAqTQhm8wEWD8R3PizB5WMF1w text . lvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal set_path boost/url/url.hpp include/boost/url/url.hpp 473 5 function 4McpqTciHbP7MYJJafnvFkRJGcZ5 public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 MCx88BPGS5KgE3qhBfh89e3U57J text or reference segments 2bXmGRYoLQKFALtmsM2vVVCvmnVn 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 3NGtuSVjhTWXrAF9sPpeS5FwZQN8 text , reference segments 2bXmGRYoLQKFALtmsM2vVVCvmnVn text , reference set_encoded_path MCx88BPGS5KgE3qhBfh89e3U57J text , reference set_path_absolute 4b7SsvokaeMTXQXBKywBXGVroR2 text . lvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal set_path_absolute boost/url/url_base.hpp include/boost/url/url_base.hpp 1760 5 function 4b7SsvokaeMTXQXBKywBXGVroR2 public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3NGtuSVjhTWXrAF9sPpeS5FwZQN8 text , reference segments 2bXmGRYoLQKFALtmsM2vVVCvmnVn text , reference set_encoded_path MCx88BPGS5KgE3qhBfh89e3U57J text , reference set_path 3v9Fip9faoKhfWb6eQhiSgANjWdV text . named identifier bool bool named identifier bool bool absolute normal set_port boost/url/url.hpp include/boost/url/url.hpp 466 5 function 266h2w9HS6kseMj1JLKfE29grSy6 public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 3FmFpDaKVNyQ7bXNSdrzCGsVJM7P text , reference set_port 266h2w9HS6kseMj1JLKfE29grSy6 text . lvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal set_port_number boost/url/url.hpp include/boost/url/url.hpp 464 5 function 37rP3DgdsXDStY3czt9RfRWfTLz public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 1B1sp4Ef6qEaa3XYv8pbQFsfkZt text , reference set_port 3LEFuHiJFofpCmdb6z7kwJ5NBNyV text . lvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url named identifier w7yWEPLwtMpd5GnNHsV5ASwVxkX uint16_t n normal set_query boost/url/url.hpp include/boost/url/url.hpp 478 5 function 44c22UJ7fFsbi4WZDMrzQBmXRnGS public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 3WcGK7mkJngNwmU5zz1zx9Vr7iC3 text , reference params 3hdYD66PBzHcr6JTNLGtXFRmpwjB text , reference remove_query 36kaFnfGXgbj1nqCcaNfBSQmxuGS text , reference set_encoded_query JmPno9gmDpQRQfbUP3rzokugA7a text . lvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal set_scheme boost/url/url.hpp include/boost/url/url.hpp 413 5 function 37UrudcyHKBs5jCUYvSP79srd3DV public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 3mQ82A3cBXgmgWLYuxa1y3o1qUZ5 text . lvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal set_scheme_id boost/url/url.hpp include/boost/url/url.hpp 415 5 function 3QiBknt8XFpLT3JuHBwnKYTvYvod public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB paragraph text This function sets the scheme to the specified known reference urls::scheme tVuW4uzt1HMgUxPtxroTuMsNi2G text id, which may not be reference scheme::unknown d3jNvGWyWHyaA1snRDXYWd5jjkA text or else an exception is thrown. If the id is reference scheme::none 2DEQCVdvMZA94BHRjTMB2n7Ttdp2 text , this function behaves as if reference remove_scheme 3y1CD4diAVFMNJd23sVxV2aC2Kw6 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 lvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url named identifier tVuW4uzt1HMgUxPtxroTuMsNi2G scheme identifier 2ejQGW57K8g7MFJhHAwPt5aumoLa urls id normal set_user boost/url/url.hpp include/boost/url/url.hpp 431 5 function 2XmiAqTQhm8wEWD8R3PizB5WMF1w public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 igKd3Gv9P5L4VjvQSC6giswwMEQ text , reference set_encoded_password 3M3tGnhVHGx7Vc2eUaFuGy7VoCxu text , reference set_encoded_user 2MEk1Cda8bzLjEPBG1V7MJvLRyqJ text , reference set_password 2YAaMd9PbnTHhrrZTFuaATwNBjuR text . lvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal set_userinfo boost/url/url.hpp include/boost/url/url.hpp 425 5 function 3XpMK24TMhcVwJ9PAHwZxSLqRo7H public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 4QciDQp3vKjNuPEah54XMBvrjvyD text returns true. Otherwise, paragraph text If there is no colon, the user is set to the string. The function reference has_password 4QciDQp3vKjNuPEah54XMBvrjvyD 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 sGNgGfijxwV9WzubTygPba9mCQn text , reference set_encoded_userinfo gNzAQHZHDPXQiqwfYS6GwxUvQsG text . lvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal set_zone_id boost/url/url.hpp include/boost/url/url.hpp 454 5 function 2nFEAVSsAAzJCxRts4ijkBxPtXWA public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 lvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal size boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 201 5 function 2Z9j51jzFxpMXyB1ZjxR329S4Puk public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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. named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std normal swap boost/url/url.hpp include/boost/url/url.hpp 363 5 function 2vCUaWVXdv8xAJxyzhvVxgN8uuE4 public regular 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 named identifier void void lvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url other normal user boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 848 5 function 4Yfg3yG11SsLgpAe6dzENEPz39dk public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4QciDQp3vKjNuPEah54XMBvrjvyD text , reference has_userinfo 2x7XawH6QTh6eBg2hNRqzQ3WME2m text , reference encoded_password 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym text , reference encoded_user 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC text , reference encoded_userinfo 3qDJMHEiC1T5Vik6nGt2CJvFxFDM text , reference password 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL text , reference userinfo 24JMPq739KrKuemXwWK8zpXGtWvz text . named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal userinfo boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 748 5 function 24JMPq739KrKuemXwWK8zpXGtWvz public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4UumWzLNRv3vgTVdDkz5PVqdSsSL 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 4QciDQp3vKjNuPEah54XMBvrjvyD text , reference has_userinfo 2x7XawH6QTh6eBg2hNRqzQ3WME2m text , reference encoded_password 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym text , reference encoded_user 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC text , reference encoded_userinfo 3qDJMHEiC1T5Vik6nGt2CJvFxFDM text , reference password 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL text , reference user 4Yfg3yG11SsLgpAe6dzENEPz39dk text . named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal zone_id boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1480 5 function 3QgkE48ZuKvk3EGbnydRNa7ob9XL public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text If the host type is reference host_type::ipv6 2y7UTsNbko8TLegXS5EpSa1goNog 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 named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal operator basic_string_view<char> boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 299 5 function 3uYCaZr2Kk1eGAMsuRXTehXkXZwv public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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. named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core conversion max_size boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 173 5 function 39V9A9oqw6EqsRw4R5mxeMpeqePo public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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. named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std normal constexpr static 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 function 2TwwpddeAxzjzfbTirqgZeddg3n6 protected regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std salt 0 normal url_base boost/url/url_base.hpp include/boost/url/url_base.hpp 61 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 2TREmHUMfZeMQz9yyw5HzqB91APN regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 75qVNpuBHShJ8KKEUv4RCrwxEAB paragraph reference url_view 3hrVvoVYoDkX9t3w9abTXxDqGRaW paragraph reference static_url 48MaMwY7JqeST8Mfy8WBA7wGLSzT unordered heading text Functions 1 list paragraph reference parse_absolute_uri 2ARWB82XdRYexehQmFQZjcEKzoSi paragraph reference parse_origin_form YwftbCXGz1kG5uRUguacNEwrkaP paragraph reference parse_relative_ref u1SFmy6a6wtXTYxrMnssMwa7K6G paragraph reference parse_uri 2nNq8RtS22vhgfkFAo8dGh6NW87n paragraph reference parse_uri_reference 4KCrVrNi2iTJ15zBNtvdSNip4rmV unordered brief text Common functionality for containers reference format_to cLKVoifuzVMusLZv1zV2vk1L2K3 reference format_to 3bDKeYzcaysYNkwtHjg2EkeVGZf3 reference operator!= tkwNEJdWJqwprh85787u3xpyauu reference operator< 22wNuw5VxKWrVLMDGM9VPFjJshU6 reference operator<= 3QqsgavNMQTmxMW1t9qAoAocshM6 reference operator== GhudPV3CuyCeCKSftvpKEQLQtJ4 reference operator> 3CgAf4w5dyww6CMhGWkJm1fJiHum reference operator>= 2V16XgrptBcWFtoZaJ3DExhQXY6 other __visibility__ class named identifier 27ryuyAvvRyzfzgketja5uQcFBcK url_view_base public 2egpzk38s9q8jE4fNG71Y15WvAVC 75qVNpuBHShJ8KKEUv4RCrwxEAB 3fqhU2zdn6LwiSAm9upTzbtboK1U 3ESzuLSF2zD1TghU6qemdUksdP2V oHRP7v9PjrTqy9YjGBt8xxSqTLn HxCZYcsETDaw1bRzUVB9HpjzDZH r7EPCNuC2kWeArshSQf9kS35QJA 3Lh94K8cNrPFyFYw36XmhhtFMLpf VbvXoprikWfUm5mR56ZFYECXt9J 4DmmNdXmY3VWyP6HoKWQVEExBzaV 2GaF4F3gH2Y5LkyYXCrr3VyP9tpJ ipF8M41qPyuMM5XLe5JGZYSc42h FMBiWLrznwNXgkDuu4xneE9NeCD 3oodjUy4VDbgnxfeqkxwvqQvf7hK 4SGWNm9TD3ZACEqJ9fmnWL1ZF47q 492Pha8s74Xj1GjgZ82x193B56bP 3gVZJ5SpfCzYoZgafZW71cueQ3u3 3WcGK7mkJngNwmU5zz1zx9Vr7iC3 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym M5bG6HzwZUo4ycGCKLY5CsUUXun 3VZ9J5FmgK7VsNUfrHxuyT4pNTGm 3oB1p7aLxKXx3FxEqHaKSnCiNfXM 3NGtuSVjhTWXrAF9sPpeS5FwZQN8 UJaw1aYaRaLhmYt2h416g598hi4 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC 3qDJMHEiC1T5Vik6nGt2CJvFxFDM 4Bt9AGe8WEFmjA79MWAiGPDtMUW8 2T5XA2udwnVeh4RFi6U9UrLirJFJ 2omNW7ayWzkboBBXgc2Rm6C4y5kb 2RYFJUJHdYjygxHWSb57bHWfkHgN 4QciDQp3vKjNuPEah54XMBvrjvyD 4CLeCb8bTxYAjEFuAXtr5VmQW6FE 21mA7muF2gpvzFjJxaqjvjnnm6XY 2wLECn7WbsBXGLpheUngfa9GEf1q 2x7XawH6QTh6eBg2hNRqzQ3WME2m SytR6d7pUELeR1RNUpcWrXWQcY8 KoSC71QaaCYQtpr7xCwndbzWaKR Zvcpzzy9h3HWgiqp7UZuEiWf4A7 9sSdyLcyHxeuasmCKqifZp3ga5s 4E8a8HgQbryrd4KcNHFajdVyLWib 2gNagLmHXZAqycctaaYmEYZc9pv mSWKjRHEDFTnpxGSra6Q5eS7fjS 2hgDJpXv5LpubtS8phLLnGk4a7XZ 3655iutEyVMXNoWhFCVBWGtCcakA 2zt8gXYuprJZ5xnizAdcRJtmZjtg ziQA742syG1pxZjceNXdoMPPJRV 3KJZbPVLLm3Soiy8k42MN7tVSaXm 4884zAuWwzykYzmScr5SZBYcsB5v 2wRwHBqb7uW8pRyBdHK2ag5gYr4R 3hdYD66PBzHcr6JTNLGtXFRmpwjB 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL wc1MNXXCH1K1Shz81BmxVy1opwc 2aNVu1ZJUXAnkA1MUK2cfojoNCyj p8uqDVjGDrU4Eg9axo7dsTkztws 363HbS6bzsgdHiLTk4Kr8pdkZJZY 49Yox1iKKs7LmQ3wu1nCZXGKWEKf 2bHQfxWtGijDtNutjkX9m9nmNJgq 2TNB4s1W5aG5wvgM5sFhpkadBvP9 pNfxsxtkcrtaLBrtxg4hje6Qwve igKd3Gv9P5L4VjvQSC6giswwMEQ 1B1sp4Ef6qEaa3XYv8pbQFsfkZt 2R5rf2bDtEpPE9hwtv8Ln4i6EAHv 3y1CD4diAVFMNJd23sVxV2aC2Kw6 sGNgGfijxwV9WzubTygPba9mCQn zpt1tVsUzr9PpovdHt6x8TgTZMD 45Z6NdRjyroghszwmeBJuKmyuKLU 4AoadMoEhkiTY9v83LDBwQt31Uti 3aL5x6QNsMGNDAo8DP539u5TsZpp 2bXmGRYoLQKFALtmsM2vVVCvmnVn 2Br6ianGRhYuRbDpvbNVHc3kytth 2hLzEE9gAKyxVT6kbPLwfet2MGnC osScXCjJkJkSf5jPTGH5dPVin3q 4DwBiJMifXNsmVFdmgKDhGDJZ3wh fBFYvCn8kJ47xA7NVhe1Rghp5J8 24HVoTb3hMrWVBMHrtxD1buWstCN 3M3tGnhVHGx7Vc2eUaFuGy7VoCxu MCx88BPGS5KgE3qhBfh89e3U57J v9Dry5ACH8wLSd7BYqpiHbGB7V8 2MEk1Cda8bzLjEPBG1V7MJvLRyqJ gNzAQHZHDPXQiqwfYS6GwxUvQsG 4X1oAamqzgD6NUQuQqZgb3E7Y8hN 2BFpJxb9o2AGu7rRGKFVoFsW7Pi4 36GzQWnsLo7vUpJDLjUBWfUao6v7 3bzhb9DrxWPqshAd4mygzPBefvw8 9UnBBXEqhvdW1scEozkygaKMjGZ 6SijdGWstqVJuYLMAU9YBwkBXSG 55atbAUaUexHuQt9WaRpVBqgfdg soNQwVrosnpg6yBhJnz9p8yjZta 4FzhNxmTaWz7pzZaXUiuVRmBs2SH 2YAaMd9PbnTHhrrZTFuaATwNBjuR 3v9Fip9faoKhfWb6eQhiSgANjWdV 4b7SsvokaeMTXQXBKywBXGVroR2 3LEFuHiJFofpCmdb6z7kwJ5NBNyV 49Q25jBbiW4ssURp7srqLCYtJxmr 4THvHraYktHgYNzU3qniR2MhXpuX 3QW2cbeaw11tvSPbrjEnJSQu2CC7 2wEQzdwYGT3faB4EpgEZkgYTqM2G MYZLHVqFcgnRAf8PVbRnn3ZdMGq 3WPfZEH3k9jEMW6zLcD16Xd3Uqyg 2gcj9bRhg1wZZAtNMQkD6jo35SjJ 2Z9j51jzFxpMXyB1ZjxR329S4Puk 4Yfg3yG11SsLgpAe6dzENEPz39dk 24JMPq739KrKuemXwWK8zpXGtWvz 3QgkE48ZuKvk3EGbnydRNa7ob9XL 3uYCaZr2Kk1eGAMsuRXTehXkXZwv 39V9A9oqw6EqsRw4R5mxeMpeqePo 2TwwpddeAxzjzfbTirqgZeddg3n6 ejjpGuzS8vnazJKDpArePRDURTP 193y57NAXkxcM9fKySHvheRB2X8 3nqCWJxrEtf9TtCuoKEpwfAp96zW 3k7euYhzaVrTcXeXwZiHejAT6o6d 3nTHfA2KjghLpV5cpqmWJxJvcsm7 3ft7axdJgjwjdw4KFdaQEWKaWBys 2yXnChhXV3kySYoS2QXPwTP5dbDQ 4UU8RGiqYcnmMEbtrpSqk8apGQTf 3V2poLSM9Siif2SXjwPzanvjc9MM 3vpaT5EK4R6RHAnuZHhtwpA2LSv9 3C1XW4EwWaindPvnTZ4hZnsMPrWb 3Xw2HhyVg9ZPU9cwNBhTmMgVGmBL 32XjupiczqYK4m8NrR98wR5MWTEm 44htNw7eZsSARdKej7qxDg1iKZm1 yuXL3hZuBejTd2NSWAnxmGYYA1C 2bH9LNY3yAC9FqvXzUbxVpJLcbxx 3Fp7uY6yZiEyqEGzFPqaL2Ym91ZN 21F3hVYTcsjuRQJy8kqZ1TqHb9EP 2aG19LyDybi21HzGrAT2kFHWYWQi 3Zw2sbHaVLQErNnLZNFHw3x2dCuw 2bW67DzNaLAtY85HH1gYxSXAe5gk wUJLAQfPJnsP9pBtG39kRohLx15 Yb9WVk587BBf9Yf3aQWJxyr7tyP 22Fc8QE4pNgz6MQkRFET2BVuZJSU 3NTNskJnvNHoxZCTB8oPHEW8J12T 2YS81Xtf7Gzpbm7TP5kCgkaR7NuE rWhSnMKy5PuaKTpKByDn1QdS7th 4ZbWvyKBMwfyhwwk3YYEco8ttTeS named identifier 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe params_encoded_ref 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe named identifier 24XcpKBAcyXN6FLZk8kR4zGAmKak segments_encoded_ref 24XcpKBAcyXN6FLZk8kR4zGAmKak named identifier 3sLepuFTMctJHoZrLv8tvJTFkDPS segments_ref 3sLepuFTMctJHoZrLv8tvJTFkDPS named identifier 4MtPiWDytNMbqCE6iciHidLK5Y4c params_ref 4MtPiWDytNMbqCE6iciHidLK5Y4c named identifier 2egpzk38s9q8jE4fNG71Y15WvAVC static_url_base 2egpzk38s9q8jE4fNG71Y15WvAVC named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url 75qVNpuBHShJ8KKEUv4RCrwxEAB authority boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 564 5 function 3fqhU2zdn6LwiSAm9upTzbtboK1U public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text This function returns the authority as an reference authority_view 2fwXocwnoAG9WDGbqM3quKphV1qq 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 2GaF4F3gH2Y5LkyYXCrr3VyP9tpJ text , reference has_authority 2omNW7ayWzkboBBXgc2Rm6C4y5kb text . named identifier 2fwXocwnoAG9WDGbqM3quKphV1qq authority_view normal buffer boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 282 5 function 3ESzuLSF2zD1TghU6qemdUksdP2V public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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. named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core normal c_str boost/url/url_base.hpp include/boost/url/url_base.hpp 127 5 function oHRP7v9PjrTqy9YjGBt8xxSqTLn public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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. pointer named identifier char char normal capacity boost/url/url_base.hpp include/boost/url/url_base.hpp 146 5 function HxCZYcsETDaw1bRzUVB9HpjzDZH public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std normal clear boost/url/url_base.hpp include/boost/url/url_base.hpp 165 5 function r7EPCNuC2kWeArshSQf9kS35QJA public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 named identifier void void normal compare boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2446 5 function 3Lh94K8cNrPFyFYw36XmhhtFMLpf public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 named identifier int int lvalue-reference named identifier 27ryuyAvvRyzfzgketja5uQcFBcK url_view_base other normal data boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 258 5 function VbvXoprikWfUm5mR56ZFYECXt9J public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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. pointer named identifier char char normal empty boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 238 5 function 4DmmNdXmY3VWyP6HoKWQVEExBzaV public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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. named identifier bool bool normal encoded_authority boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 601 5 function 2GaF4F3gH2Y5LkyYXCrr3VyP9tpJ public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 3fqhU2zdn6LwiSAm9upTzbtboK1U text , reference has_authority 2omNW7ayWzkboBBXgc2Rm6C4y5kb text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_fragment boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2280 5 function ipF8M41qPyuMM5XLe5JGZYSc42h public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2T5XA2udwnVeh4RFi6U9UrLirJFJ text , reference has_fragment 2RYFJUJHdYjygxHWSb57bHWfkHgN text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_host boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1120 5 function FMBiWLrznwNXgkDuu4xneE9NeCD public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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. named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_host_address boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1237 5 function 3oodjUy4VDbgnxfeqkxwvqQvf7hK public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text The value returned by this function depends on the type of host returned from the function reference host_type mSWKjRHEDFTnpxGSra6Q5eS7fjS text . list paragraph text If the type is reference host_type::ipv4 4B5yLFvhkpef7XX8ryKTaBWz8d6D text , then the IPv4 address string is returned. paragraph text If the type is reference host_type::ipv6 2y7UTsNbko8TLegXS5EpSa1goNog text , then the IPv6 address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::ipvfuture 25qx7TTMyctoe4LxqgMPXccSpy5Q text , then the IPvFuture address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::name QfoSUW8M1SPUL5EFVKwAUabTKCa 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 wGjRbosZ4DQY7xCpjwAZqPVHiim 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. named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_host_and_port boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2325 5 function 4SGWNm9TD3ZACEqJ9fmnWL1ZF47q public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4CLeCb8bTxYAjEFuAXtr5VmQW6FE text , reference port p8uqDVjGDrU4Eg9axo7dsTkztws text , reference port_number 363HbS6bzsgdHiLTk4Kr8pdkZJZY text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_host_name boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1441 5 function 492Pha8s74Xj1GjgZ82x193B56bP public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text If the host type is reference host_type::name QfoSUW8M1SPUL5EFVKwAUabTKCa 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. named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_origin boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2355 5 function 3gVZJ5SpfCzYoZgafZW71cueQ3u3 public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 3oB1p7aLxKXx3FxEqHaKSnCiNfXM text , reference encoded_target UJaw1aYaRaLhmYt2h416g598hi4 text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_params boost/url/url_base.hpp include/boost/url/url_base.hpp 2248 5 boost/url/url_base.hpp include/boost/url/url_base.hpp 2300 5 overloads 3WcGK7mkJngNwmU5zz1zx9Vr7iC3 public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3hdYD66PBzHcr6JTNLGtXFRmpwjB text , reference remove_query 2R5rf2bDtEpPE9hwtv8Ln4i6EAHv text , reference set_encoded_query v9Dry5ACH8wLSd7BYqpiHbGB7V8 text , reference set_query 4THvHraYktHgYNzU3qniR2MhXpuX text . see reference encoded_query 3VZ9J5FmgK7VsNUfrHxuyT4pNTGm text , reference has_query 21mA7muF2gpvzFjJxaqjvjnnm6XY text , reference params 3hdYD66PBzHcr6JTNLGtXFRmpwjB text , reference query 49Yox1iKKs7LmQ3wu1nCZXGKWEKf text . normal 2Tfz89EdRJCtmaAcvePE2sFdTaFs WLnpSWkKJP479aAk2KVz4BEDpZ8 auto auto encoded_params boost/url/url_base.hpp include/boost/url/url_base.hpp 2300 5 function 2Tfz89EdRJCtmaAcvePE2sFdTaFs public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3hdYD66PBzHcr6JTNLGtXFRmpwjB text , reference remove_query 2R5rf2bDtEpPE9hwtv8Ln4i6EAHv text , reference set_encoded_query v9Dry5ACH8wLSd7BYqpiHbGB7V8 text , reference set_query 4THvHraYktHgYNzU3qniR2MhXpuX text . named identifier 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe params_encoded_ref normal encoded_params boost/url/url_base.hpp include/boost/url/url_base.hpp 2248 5 function WLnpSWkKJP479aAk2KVz4BEDpZ8 public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3VZ9J5FmgK7VsNUfrHxuyT4pNTGm text , reference has_query 21mA7muF2gpvzFjJxaqjvjnnm6XY text , reference params 3hdYD66PBzHcr6JTNLGtXFRmpwjB text , reference query 49Yox1iKKs7LmQ3wu1nCZXGKWEKf text . named identifier 3w4FJjjADY3EEHqUmBj5mvDKqdEB params_encoded_view normal encoded_password boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 996 5 function 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4QciDQp3vKjNuPEah54XMBvrjvyD text , reference has_userinfo 2x7XawH6QTh6eBg2hNRqzQ3WME2m text , reference encoded_user 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC text , reference encoded_userinfo 3qDJMHEiC1T5Vik6nGt2CJvFxFDM text , reference password 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL text , reference user 4Yfg3yG11SsLgpAe6dzENEPz39dk text , reference userinfo 24JMPq739KrKuemXwWK8zpXGtWvz text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_path boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1799 5 function M5bG6HzwZUo4ycGCKLY5CsUUXun public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2hgDJpXv5LpubtS8phLLnGk4a7XZ text , reference encoded_segments 3jZFG9bXfeYJfGzZnt2Zim38gmMB text . reference path wc1MNXXCH1K1Shz81BmxVy1opwc text , reference segments 3YxJjcnyfcHtM9xLtszAHET8pyFv text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_query boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2040 5 function 3VZ9J5FmgK7VsNUfrHxuyT4pNTGm public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2N3uW9xQekt6pX19rHqrM5vcnVUH text , reference has_query 21mA7muF2gpvzFjJxaqjvjnnm6XY text , reference params 2RJGYan9E8WvVKQM1LmRNNdUCc7E text , reference query 49Yox1iKKs7LmQ3wu1nCZXGKWEKf text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_resource boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2387 5 function 3oB1p7aLxKXx3FxEqHaKSnCiNfXM public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 3gVZJ5SpfCzYoZgafZW71cueQ3u3 text , reference encoded_target UJaw1aYaRaLhmYt2h416g598hi4 text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_segments boost/url/url_base.hpp include/boost/url/url_base.hpp 2018 5 boost/url/url_base.hpp include/boost/url/url_base.hpp 2014 5 overloads 3NGtuSVjhTWXrAF9sPpeS5FwZQN8 public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 4Ek5WSaWmrfbmnMRzJv3oVPGKCua text , reference set_encoded_path MCx88BPGS5KgE3qhBfh89e3U57J text , reference set_path 3v9Fip9faoKhfWb6eQhiSgANjWdV text , reference set_path_absolute 4b7SsvokaeMTXQXBKywBXGVroR2 text . see reference is_path_absolute 2hgDJpXv5LpubtS8phLLnGk4a7XZ text , reference encoded_path M5bG6HzwZUo4ycGCKLY5CsUUXun text , reference path wc1MNXXCH1K1Shz81BmxVy1opwc text , reference segments 2bXmGRYoLQKFALtmsM2vVVCvmnVn text , reference segments_encoded_view GKjeDHooSf2HAMf239p3oFfT3i3 text . normal 4Ek5WSaWmrfbmnMRzJv3oVPGKCua 4CifMdq25fpMkWFY7dcZ9ZwXrmCV auto auto encoded_segments boost/url/url_base.hpp include/boost/url/url_base.hpp 2014 5 function 4Ek5WSaWmrfbmnMRzJv3oVPGKCua public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3NGtuSVjhTWXrAF9sPpeS5FwZQN8 text , reference set_encoded_path MCx88BPGS5KgE3qhBfh89e3U57J text , reference set_path 3v9Fip9faoKhfWb6eQhiSgANjWdV text , reference set_path_absolute 4b7SsvokaeMTXQXBKywBXGVroR2 text . named identifier 24XcpKBAcyXN6FLZk8kR4zGAmKak segments_encoded_ref normal encoded_segments boost/url/url_base.hpp include/boost/url/url_base.hpp 2018 5 function 4CifMdq25fpMkWFY7dcZ9ZwXrmCV public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 2hgDJpXv5LpubtS8phLLnGk4a7XZ text , reference encoded_path M5bG6HzwZUo4ycGCKLY5CsUUXun text , reference path wc1MNXXCH1K1Shz81BmxVy1opwc text , reference segments 2bXmGRYoLQKFALtmsM2vVVCvmnVn text , reference segments_encoded_view GKjeDHooSf2HAMf239p3oFfT3i3 text . named identifier GKjeDHooSf2HAMf239p3oFfT3i3 segments_encoded_view normal encoded_target boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2419 5 function UJaw1aYaRaLhmYt2h416g598hi4 public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 3gVZJ5SpfCzYoZgafZW71cueQ3u3 text , reference encoded_resource 3oB1p7aLxKXx3FxEqHaKSnCiNfXM text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_user boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 901 5 function 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4QciDQp3vKjNuPEah54XMBvrjvyD text , reference has_userinfo 2x7XawH6QTh6eBg2hNRqzQ3WME2m text , reference encoded_password 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym text , reference encoded_userinfo 3qDJMHEiC1T5Vik6nGt2CJvFxFDM text , reference password 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL text , reference user 4Yfg3yG11SsLgpAe6dzENEPz39dk text , reference userinfo 24JMPq739KrKuemXwWK8zpXGtWvz text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_userinfo boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 800 5 function 3qDJMHEiC1T5Vik6nGt2CJvFxFDM public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4QciDQp3vKjNuPEah54XMBvrjvyD text , reference has_userinfo 2x7XawH6QTh6eBg2hNRqzQ3WME2m text , reference encoded_password 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym text , reference encoded_user 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC text , reference password 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL text , reference user 4Yfg3yG11SsLgpAe6dzENEPz39dk text , reference userinfo 24JMPq739KrKuemXwWK8zpXGtWvz text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_zone_id boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1526 5 function 4Bt9AGe8WEFmjA79MWAiGPDtMUW8 public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text If the host type is reference host_type::ipv6 2y7UTsNbko8TLegXS5EpSa1goNog 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. named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal fragment boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2233 5 function 2T5XA2udwnVeh4RFi6U9UrLirJFJ public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 ipF8M41qPyuMM5XLe5JGZYSc42h text , reference has_fragment 2RYFJUJHdYjygxHWSb57bHWfkHgN text . named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal has_authority boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 528 5 function 2omNW7ayWzkboBBXgc2Rm6C4y5kb public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 3fqhU2zdn6LwiSAm9upTzbtboK1U text , reference encoded_authority 2GaF4F3gH2Y5LkyYXCrr3VyP9tpJ text . named identifier bool bool normal has_fragment boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2173 5 function 2RYFJUJHdYjygxHWSb57bHWfkHgN public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 ipF8M41qPyuMM5XLe5JGZYSc42h text , reference fragment 2T5XA2udwnVeh4RFi6U9UrLirJFJ text . named identifier bool bool normal has_password boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 689 5 function 4QciDQp3vKjNuPEah54XMBvrjvyD public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2x7XawH6QTh6eBg2hNRqzQ3WME2m text , reference encoded_password 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym text , reference encoded_user 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC text , reference encoded_userinfo 3qDJMHEiC1T5Vik6nGt2CJvFxFDM text , reference password 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL text , reference user 4Yfg3yG11SsLgpAe6dzENEPz39dk text , reference userinfo 24JMPq739KrKuemXwWK8zpXGtWvz text . named identifier bool bool normal has_port boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1568 5 function 4CLeCb8bTxYAjEFuAXtr5VmQW6FE public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4SGWNm9TD3ZACEqJ9fmnWL1ZF47q text , reference port p8uqDVjGDrU4Eg9axo7dsTkztws text , reference port_number 363HbS6bzsgdHiLTk4Kr8pdkZJZY text . named identifier bool bool normal has_query boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1937 5 function 21mA7muF2gpvzFjJxaqjvjnnm6XY public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2N3uW9xQekt6pX19rHqrM5vcnVUH text , reference encoded_query 3VZ9J5FmgK7VsNUfrHxuyT4pNTGm text , reference params 2RJGYan9E8WvVKQM1LmRNNdUCc7E text , reference query 49Yox1iKKs7LmQ3wu1nCZXGKWEKf text . named identifier bool bool normal has_scheme boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 384 5 function 2wLECn7WbsBXGLpheUngfa9GEf1q public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4AoadMoEhkiTY9v83LDBwQt31Uti text , reference scheme_id 3aL5x6QNsMGNDAo8DP539u5TsZpp text . named identifier bool bool normal has_userinfo boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 647 5 function 2x7XawH6QTh6eBg2hNRqzQ3WME2m public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4QciDQp3vKjNuPEah54XMBvrjvyD text , reference encoded_password 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym text , reference encoded_user 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC text , reference encoded_userinfo 3qDJMHEiC1T5Vik6nGt2CJvFxFDM text , reference password 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL text , reference user 4Yfg3yG11SsLgpAe6dzENEPz39dk text , reference userinfo 24JMPq739KrKuemXwWK8zpXGtWvz text . named identifier bool bool normal host boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1076 5 function SytR6d7pUELeR1RNUpcWrXWQcY8 public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal host_address boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1174 5 function KoSC71QaaCYQtpr7xCwndbzWaKR public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text The value returned by this function depends on the type of host returned from the function reference host_type mSWKjRHEDFTnpxGSra6Q5eS7fjS text . list paragraph text If the type is reference host_type::ipv4 4B5yLFvhkpef7XX8ryKTaBWz8d6D text , then the IPv4 address string is returned. paragraph text If the type is reference host_type::ipv6 2y7UTsNbko8TLegXS5EpSa1goNog text , then the IPv6 address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::ipvfuture 25qx7TTMyctoe4LxqgMPXccSpy5Q text , then the IPvFuture address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::name QfoSUW8M1SPUL5EFVKwAUabTKCa 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 wGjRbosZ4DQY7xCpjwAZqPVHiim 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 named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal host_ipv4_address boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1277 5 function Zvcpzzy9h3HWgiqp7UZuEiWf4A7 public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text If the host type is reference host_type::ipv4 4B5yLFvhkpef7XX8ryKTaBWz8d6D text , this function returns the address as a value of type reference ipv4_address 4Xmd9k1GBKGKQj6PYc1qdt4tMUae 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 4Xmd9k1GBKGKQj6PYc1qdt4tMUae text . named identifier 4Xmd9k1GBKGKQj6PYc1qdt4tMUae ipv4_address normal host_ipv6_address boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1325 5 function 9sSdyLcyHxeuasmCKqifZp3ga5s public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text If the host type is reference host_type::ipv6 2y7UTsNbko8TLegXS5EpSa1goNog text , this function returns the address as a value of type reference ipv6_address 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T 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 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T text . named identifier 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T ipv6_address normal host_ipvfuture boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1358 5 function 4E8a8HgQbryrd4KcNHFajdVyLWib public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text If the host type is reference host_type::ipvfuture 25qx7TTMyctoe4LxqgMPXccSpy5Q 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. named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core normal host_name boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1395 5 function 2gNagLmHXZAqycctaaYmEYZc9pv public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text If the host type is reference host_type::name QfoSUW8M1SPUL5EFVKwAUabTKCa 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 named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal host_type boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1036 5 function mSWKjRHEDFTnpxGSra6Q5eS7fjS public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text This function returns one of the following constants representing the type of host present. list paragraph reference host_type::ipv4 4B5yLFvhkpef7XX8ryKTaBWz8d6D paragraph reference host_type::ipv6 2y7UTsNbko8TLegXS5EpSa1goNog paragraph reference host_type::ipvfuture 25qx7TTMyctoe4LxqgMPXccSpy5Q paragraph reference host_type::name QfoSUW8M1SPUL5EFVKwAUabTKCa paragraph reference host_type::none wGjRbosZ4DQY7xCpjwAZqPVHiim unordered paragraph text When reference has_authority 2omNW7ayWzkboBBXgc2Rm6C4y5kb text is false, the host type is reference host_type::none wGjRbosZ4DQY7xCpjwAZqPVHiim 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. named identifier 2M8hT55CSziFA9Zup4mKYdwvgUiE host_type identifier 2ejQGW57K8g7MFJhHAwPt5aumoLa urls normal is_path_absolute boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1691 5 function 2hgDJpXv5LpubtS8phLLnGk4a7XZ public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 M5bG6HzwZUo4ycGCKLY5CsUUXun text , reference encoded_segments 3jZFG9bXfeYJfGzZnt2Zim38gmMB text . reference path wc1MNXXCH1K1Shz81BmxVy1opwc text , reference segments 3YxJjcnyfcHtM9xLtszAHET8pyFv text . named identifier bool bool normal normalize boost/url/url_base.hpp include/boost/url/url_base.hpp 2731 5 function 3655iutEyVMXNoWhFCVBWGtCcakA public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 2wRwHBqb7uW8pRyBdHK2ag5gYr4R text , reference normalize_authority 2zt8gXYuprJZ5xnizAdcRJtmZjtg text , reference normalize_path 3KJZbPVLLm3Soiy8k42MN7tVSaXm text , reference normalize_query 4884zAuWwzykYzmScr5SZBYcsB5v text , reference normalize_fragment ziQA742syG1pxZjceNXdoMPPJRV lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base normal normalize_authority boost/url/url_base.hpp include/boost/url/url_base.hpp 2786 5 function 2zt8gXYuprJZ5xnizAdcRJtmZjtg public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base normal normalize_fragment boost/url/url_base.hpp include/boost/url/url_base.hpp 2873 5 function ziQA742syG1pxZjceNXdoMPPJRV public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base normal normalize_path boost/url/url_base.hpp include/boost/url/url_base.hpp 2817 5 function 3KJZbPVLLm3Soiy8k42MN7tVSaXm public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base normal normalize_query boost/url/url_base.hpp include/boost/url/url_base.hpp 2845 5 function 4884zAuWwzykYzmScr5SZBYcsB5v public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base normal normalize_scheme boost/url/url_base.hpp include/boost/url/url_base.hpp 2756 5 function 2wRwHBqb7uW8pRyBdHK2ag5gYr4R public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base normal params boost/url/url_base.hpp include/boost/url/url_base.hpp 2186 5 boost/url/url_base.hpp include/boost/url/url_base.hpp 2182 5 boost/url/url_base.hpp include/boost/url/url_base.hpp 2244 5 boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2087 5 overloads 3hdYD66PBzHcr6JTNLGtXFRmpwjB public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3WcGK7mkJngNwmU5zz1zx9Vr7iC3 text , reference remove_query 2R5rf2bDtEpPE9hwtv8Ln4i6EAHv text , reference set_encoded_query v9Dry5ACH8wLSd7BYqpiHbGB7V8 text , reference set_query 4THvHraYktHgYNzU3qniR2MhXpuX text . see reference encoded_params 3WcGK7mkJngNwmU5zz1zx9Vr7iC3 text , reference encoded_query 3VZ9J5FmgK7VsNUfrHxuyT4pNTGm text , reference has_query 21mA7muF2gpvzFjJxaqjvjnnm6XY text , reference query 49Yox1iKKs7LmQ3wu1nCZXGKWEKf text . normal h2KhFjqyUKC3HGV5g2PZnGhgtie 3WKTuUvsgrf9YbmTdPXZLGJTg7AG 3oKGEwnRxyroFWsdqYwHqERdPKZ9 2Dh1FrqKLpBQUzJVYtqvr6ziuTX6 auto auto params boost/url/url_base.hpp include/boost/url/url_base.hpp 2182 5 function h2KhFjqyUKC3HGV5g2PZnGhgtie public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3WcGK7mkJngNwmU5zz1zx9Vr7iC3 text , reference remove_query 2R5rf2bDtEpPE9hwtv8Ln4i6EAHv text , reference set_encoded_query v9Dry5ACH8wLSd7BYqpiHbGB7V8 text , reference set_query 4THvHraYktHgYNzU3qniR2MhXpuX text . named identifier 4MtPiWDytNMbqCE6iciHidLK5Y4c params_ref normal params boost/url/url_base.hpp include/boost/url/url_base.hpp 2186 5 function 3WKTuUvsgrf9YbmTdPXZLGJTg7AG public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3WcGK7mkJngNwmU5zz1zx9Vr7iC3 text , reference encoded_query 3VZ9J5FmgK7VsNUfrHxuyT4pNTGm text , reference has_query 21mA7muF2gpvzFjJxaqjvjnnm6XY text , reference query 49Yox1iKKs7LmQ3wu1nCZXGKWEKf text . named identifier DJiFqyFR7zZh4N3HNJHhiAj7JPV params_view normal params boost/url/url_base.hpp include/boost/url/url_base.hpp 2244 5 function 3oKGEwnRxyroFWsdqYwHqERdPKZ9 public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3WcGK7mkJngNwmU5zz1zx9Vr7iC3 text , reference remove_query 2R5rf2bDtEpPE9hwtv8Ln4i6EAHv text , reference set_encoded_query v9Dry5ACH8wLSd7BYqpiHbGB7V8 text , reference set_query 4THvHraYktHgYNzU3qniR2MhXpuX text . named identifier 4MtPiWDytNMbqCE6iciHidLK5Y4c params_ref named identifier 5dyN7z5egGMdJFpXz9WbaL549xC encoding_opts opt normal params boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2087 5 function 2Dh1FrqKLpBQUzJVYtqvr6ziuTX6 public regular 27ryuyAvvRyzfzgketja5uQcFBcK named identifier DJiFqyFR7zZh4N3HNJHhiAj7JPV params_view named identifier 5dyN7z5egGMdJFpXz9WbaL549xC encoding_opts opt normal password boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 947 5 function 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4QciDQp3vKjNuPEah54XMBvrjvyD text , reference has_userinfo 2x7XawH6QTh6eBg2hNRqzQ3WME2m text , reference encoded_password 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym text , reference encoded_user 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC text , reference encoded_userinfo 3qDJMHEiC1T5Vik6nGt2CJvFxFDM text , reference user 4Yfg3yG11SsLgpAe6dzENEPz39dk text , reference userinfo 24JMPq739KrKuemXwWK8zpXGtWvz text . named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal path boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1744 5 function wc1MNXXCH1K1Shz81BmxVy1opwc public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2hgDJpXv5LpubtS8phLLnGk4a7XZ text , reference encoded_path M5bG6HzwZUo4ycGCKLY5CsUUXun text , reference encoded_segments 3jZFG9bXfeYJfGzZnt2Zim38gmMB text . reference segments 3YxJjcnyfcHtM9xLtszAHET8pyFv text . named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal persist boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 341 5 function 2aNVu1ZJUXAnkA1MUK2cfojoNCyj public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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. named specialization 3ndPMWYzhtTVAVCHsDKjaQkrDfmC shared_ptr identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std type named identifier 3hrVvoVYoDkX9t3w9abTXxDqGRaW url_view normal port boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1604 5 function p8uqDVjGDrU4Eg9axo7dsTkztws public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4SGWNm9TD3ZACEqJ9fmnWL1ZF47q text , reference has_port 4CLeCb8bTxYAjEFuAXtr5VmQW6FE text , reference port_number 363HbS6bzsgdHiLTk4Kr8pdkZJZY text . named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core normal port_number boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1640 5 function 363HbS6bzsgdHiLTk4Kr8pdkZJZY public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4SGWNm9TD3ZACEqJ9fmnWL1ZF47q text , reference has_port 4CLeCb8bTxYAjEFuAXtr5VmQW6FE text , reference port p8uqDVjGDrU4Eg9axo7dsTkztws text . named identifier w7yWEPLwtMpd5GnNHsV5ASwVxkX uint16_t normal query boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1987 5 function 49Yox1iKKs7LmQ3wu1nCZXGKWEKf public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2N3uW9xQekt6pX19rHqrM5vcnVUH text , reference encoded_query 3VZ9J5FmgK7VsNUfrHxuyT4pNTGm text , reference has_query 21mA7muF2gpvzFjJxaqjvjnnm6XY text , reference params 2RJGYan9E8WvVKQM1LmRNNdUCc7E text . named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal remove_authority boost/url/url_base.hpp include/boost/url/url_base.hpp 408 5 function 2bHQfxWtGijDtNutjkX9m9nmNJgq public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 2Br6ianGRhYuRbDpvbNVHc3kytth text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base normal remove_fragment boost/url/url_base.hpp include/boost/url/url_base.hpp 2510 5 function 2TNB4s1W5aG5wvgM5sFhpkadBvP9 public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 2TNB4s1W5aG5wvgM5sFhpkadBvP9 text , reference set_encoded_fragment 2hLzEE9gAKyxVT6kbPLwfet2MGnC text , reference set_fragment 2BFpJxb9o2AGu7rRGKFVoFsW7Pi4 text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base normal remove_origin boost/url/url_base.hpp include/boost/url/url_base.hpp 2644 5 function pNfxsxtkcrtaLBrtxg4hje6Qwve public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base normal remove_password boost/url/url_base.hpp include/boost/url/url_base.hpp 857 5 function igKd3Gv9P5L4VjvQSC6giswwMEQ public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3M3tGnhVHGx7Vc2eUaFuGy7VoCxu text , reference set_encoded_user 2MEk1Cda8bzLjEPBG1V7MJvLRyqJ text , reference set_password 2YAaMd9PbnTHhrrZTFuaATwNBjuR text , reference set_user MYZLHVqFcgnRAf8PVbRnn3ZdMGq text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base normal remove_port boost/url/url_base.hpp include/boost/url/url_base.hpp 1696 5 function 1B1sp4Ef6qEaa3XYv8pbQFsfkZt public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3LEFuHiJFofpCmdb6z7kwJ5NBNyV text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base normal remove_query boost/url/url_base.hpp include/boost/url/url_base.hpp 2463 5 function 2R5rf2bDtEpPE9hwtv8Ln4i6EAHv public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3WcGK7mkJngNwmU5zz1zx9Vr7iC3 text , reference params 3hdYD66PBzHcr6JTNLGtXFRmpwjB text , reference set_encoded_query v9Dry5ACH8wLSd7BYqpiHbGB7V8 text , reference set_query 4THvHraYktHgYNzU3qniR2MhXpuX text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base normal remove_scheme boost/url/url_base.hpp include/boost/url/url_base.hpp 318 5 function 3y1CD4diAVFMNJd23sVxV2aC2Kw6 public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3QW2cbeaw11tvSPbrjEnJSQu2CC7 text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base normal remove_userinfo boost/url/url_base.hpp include/boost/url/url_base.hpp 585 5 function sGNgGfijxwV9WzubTygPba9mCQn public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 gNzAQHZHDPXQiqwfYS6GwxUvQsG text , reference set_userinfo 3WPfZEH3k9jEMW6zLcD16Xd3Uqyg text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base normal reserve boost/url/url_base.hpp include/boost/url/url_base.hpp 187 5 function zpt1tVsUzr9PpovdHt6x8TgTZMD public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 named identifier void void named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std n normal resolve boost/url/url_base.hpp include/boost/url/url_base.hpp 2973 5 function 45Z6NdRjyroghszwmeBJuKmyuKLU public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 75qVNpuBHShJ8KKEUv4RCrwxEAB text , reference url_view 3hrVvoVYoDkX9t3w9abTXxDqGRaW text . named specialization qQFMz11M2hdnkDE2M6AYnTSkQhv result identifier dgHcH1svHs5X3czTwE2RBXQ7tGq system type named identifier void void lvalue-reference named identifier 27ryuyAvvRyzfzgketja5uQcFBcK url_view_base ref normal scheme boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 421 5 function 4AoadMoEhkiTY9v83LDBwQt31Uti public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2wLECn7WbsBXGLpheUngfa9GEf1q text , reference scheme_id 3aL5x6QNsMGNDAo8DP539u5TsZpp text . named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core normal scheme_id boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 471 5 function 3aL5x6QNsMGNDAo8DP539u5TsZpp public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 tVuW4uzt1HMgUxPtxroTuMsNi2G 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 d3jNvGWyWHyaA1snRDXYWd5jjkA text . paragraph text Otherwise, if the scheme is absent the value returned is reference urls::scheme::none 2DEQCVdvMZA94BHRjTMB2n7Ttdp2 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 2wLECn7WbsBXGLpheUngfa9GEf1q text , reference scheme 4AoadMoEhkiTY9v83LDBwQt31Uti text . named identifier tVuW4uzt1HMgUxPtxroTuMsNi2G scheme identifier 2ejQGW57K8g7MFJhHAwPt5aumoLa urls normal segments boost/url/url_base.hpp include/boost/url/url_base.hpp 1955 5 boost/url/url_base.hpp include/boost/url/url_base.hpp 1951 5 overloads 2bXmGRYoLQKFALtmsM2vVVCvmnVn public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3NGtuSVjhTWXrAF9sPpeS5FwZQN8 text , reference set_encoded_path MCx88BPGS5KgE3qhBfh89e3U57J text , reference set_path 3v9Fip9faoKhfWb6eQhiSgANjWdV text , reference set_path_absolute 4b7SsvokaeMTXQXBKywBXGVroR2 text . see reference is_path_absolute 2hgDJpXv5LpubtS8phLLnGk4a7XZ text , reference encoded_path M5bG6HzwZUo4ycGCKLY5CsUUXun text , reference encoded_segments 3NGtuSVjhTWXrAF9sPpeS5FwZQN8 text . reference path wc1MNXXCH1K1Shz81BmxVy1opwc text , reference segments_view 2QU7risgZzo8F84g7LttC6dG1GsH text . normal 4J7mUgLL9CaiS3Kv4ZcaRamupUkL uWpBZKqgnJKFef7rkZxJTw2WsxX auto auto segments boost/url/url_base.hpp include/boost/url/url_base.hpp 1951 5 function 4J7mUgLL9CaiS3Kv4ZcaRamupUkL public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3NGtuSVjhTWXrAF9sPpeS5FwZQN8 text , reference set_encoded_path MCx88BPGS5KgE3qhBfh89e3U57J text , reference set_path 3v9Fip9faoKhfWb6eQhiSgANjWdV text , reference set_path_absolute 4b7SsvokaeMTXQXBKywBXGVroR2 text . named identifier 3sLepuFTMctJHoZrLv8tvJTFkDPS segments_ref identifier 2ejQGW57K8g7MFJhHAwPt5aumoLa urls normal segments boost/url/url_base.hpp include/boost/url/url_base.hpp 1955 5 function uWpBZKqgnJKFef7rkZxJTw2WsxX public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 2hgDJpXv5LpubtS8phLLnGk4a7XZ text , reference encoded_path M5bG6HzwZUo4ycGCKLY5CsUUXun text , reference encoded_segments 3NGtuSVjhTWXrAF9sPpeS5FwZQN8 text . reference path wc1MNXXCH1K1Shz81BmxVy1opwc text , reference segments_view 2QU7risgZzo8F84g7LttC6dG1GsH text . named identifier 2QU7risgZzo8F84g7LttC6dG1GsH segments_view normal set_encoded_authority boost/url/url_base.hpp include/boost/url/url_base.hpp 364 5 function 2Br6ianGRhYuRbDpvbNVHc3kytth public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 2bHQfxWtGijDtNutjkX9m9nmNJgq text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view s normal set_encoded_fragment boost/url/url_base.hpp include/boost/url/url_base.hpp 2611 5 function 2hLzEE9gAKyxVT6kbPLwfet2MGnC public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 2TNB4s1W5aG5wvgM5sFhpkadBvP9 text , reference set_fragment 2BFpJxb9o2AGu7rRGKFVoFsW7Pi4 text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view s normal set_encoded_host boost/url/url_base.hpp include/boost/url/url_base.hpp 1027 5 function osScXCjJkJkSf5jPTGH5dPVin3q public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 4B5yLFvhkpef7XX8ryKTaBWz8d6D 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 2y7UTsNbko8TLegXS5EpSa1goNog 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 25qx7TTMyctoe4LxqgMPXccSpy5Q 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 QfoSUW8M1SPUL5EFVKwAUabTKCa 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 4DwBiJMifXNsmVFdmgKDhGDJZ3wh text , reference set_encoded_host_name fBFYvCn8kJ47xA7NVhe1Rghp5J8 text , reference set_host 36GzQWnsLo7vUpJDLjUBWfUao6v7 text , reference set_host_address 3bzhb9DrxWPqshAd4mygzPBefvw8 text , reference set_host_ipv4 9UnBBXEqhvdW1scEozkygaKMjGZ text , reference set_host_ipv6 6SijdGWstqVJuYLMAU9YBwkBXSG text , reference set_host_ipvfuture 55atbAUaUexHuQt9WaRpVBqgfdg text , reference set_host_name soNQwVrosnpg6yBhJnz9p8yjZta text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view s normal set_encoded_host_address boost/url/url_base.hpp include/boost/url/url_base.hpp 1230 5 function 4DwBiJMifXNsmVFdmgKDhGDJZ3wh public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 4B5yLFvhkpef7XX8ryKTaBWz8d6D 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 2y7UTsNbko8TLegXS5EpSa1goNog 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 25qx7TTMyctoe4LxqgMPXccSpy5Q 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 QfoSUW8M1SPUL5EFVKwAUabTKCa 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 osScXCjJkJkSf5jPTGH5dPVin3q text , reference set_encoded_host_name fBFYvCn8kJ47xA7NVhe1Rghp5J8 text , reference set_host 36GzQWnsLo7vUpJDLjUBWfUao6v7 text , reference set_host_address 3bzhb9DrxWPqshAd4mygzPBefvw8 text , reference set_host_ipv4 9UnBBXEqhvdW1scEozkygaKMjGZ text , reference set_host_ipv6 6SijdGWstqVJuYLMAU9YBwkBXSG text , reference set_host_ipvfuture 55atbAUaUexHuQt9WaRpVBqgfdg text , reference set_host_name soNQwVrosnpg6yBhJnz9p8yjZta text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view s normal set_encoded_host_name boost/url/url_base.hpp include/boost/url/url_base.hpp 1566 5 function fBFYvCn8kJ47xA7NVhe1Rghp5J8 public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 QfoSUW8M1SPUL5EFVKwAUabTKCa 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 osScXCjJkJkSf5jPTGH5dPVin3q text , reference set_encoded_host_address 4DwBiJMifXNsmVFdmgKDhGDJZ3wh text , reference set_host 36GzQWnsLo7vUpJDLjUBWfUao6v7 text , reference set_host_address 3bzhb9DrxWPqshAd4mygzPBefvw8 text , reference set_host_ipv4 9UnBBXEqhvdW1scEozkygaKMjGZ text , reference set_host_ipv6 6SijdGWstqVJuYLMAU9YBwkBXSG text , reference set_host_ipvfuture 55atbAUaUexHuQt9WaRpVBqgfdg text , reference set_host_name soNQwVrosnpg6yBhJnz9p8yjZta text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view s normal set_encoded_params boost/url/url_base.hpp include/boost/url/url_base.hpp 2419 5 function 24HVoTb3hMrWVBMHrtxD1buWstCN public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 4FzhNxmTaWz7pzZaXUiuVRmBs2SH text , reference params 3hdYD66PBzHcr6JTNLGtXFRmpwjB text , reference remove_query 2R5rf2bDtEpPE9hwtv8Ln4i6EAHv text , reference set_encoded_query v9Dry5ACH8wLSd7BYqpiHbGB7V8 text , reference set_query 4THvHraYktHgYNzU3qniR2MhXpuX text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named specialization 474HF6bGJmJntnocv1iPAYL2crja initializer_list identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std type named identifier 21okxUDyXpX2g3uj7TzYTtM4Skgh param_pct_view ps normal set_encoded_password boost/url/url_base.hpp include/boost/url/url_base.hpp 804 5 function 3M3tGnhVHGx7Vc2eUaFuGy7VoCxu public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 igKd3Gv9P5L4VjvQSC6giswwMEQ text , reference set_encoded_password 3M3tGnhVHGx7Vc2eUaFuGy7VoCxu text , reference set_encoded_user 2MEk1Cda8bzLjEPBG1V7MJvLRyqJ text , reference set_user MYZLHVqFcgnRAf8PVbRnn3ZdMGq text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view s normal set_encoded_path boost/url/url_base.hpp include/boost/url/url_base.hpp 1894 5 function MCx88BPGS5KgE3qhBfh89e3U57J public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3NGtuSVjhTWXrAF9sPpeS5FwZQN8 text , reference segments 2bXmGRYoLQKFALtmsM2vVVCvmnVn text , reference set_path 3v9Fip9faoKhfWb6eQhiSgANjWdV text , reference set_path_absolute 4b7SsvokaeMTXQXBKywBXGVroR2 text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view s normal set_encoded_query boost/url/url_base.hpp include/boost/url/url_base.hpp 2132 5 function v9Dry5ACH8wLSd7BYqpiHbGB7V8 public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3WcGK7mkJngNwmU5zz1zx9Vr7iC3 text , reference params 3hdYD66PBzHcr6JTNLGtXFRmpwjB text , reference remove_query 2R5rf2bDtEpPE9hwtv8Ln4i6EAHv text , reference set_query 4THvHraYktHgYNzU3qniR2MhXpuX text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view s normal set_encoded_user boost/url/url_base.hpp include/boost/url/url_base.hpp 692 5 function 2MEk1Cda8bzLjEPBG1V7MJvLRyqJ public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 igKd3Gv9P5L4VjvQSC6giswwMEQ text , reference set_encoded_password 3M3tGnhVHGx7Vc2eUaFuGy7VoCxu text , reference set_password 2YAaMd9PbnTHhrrZTFuaATwNBjuR text , reference set_user MYZLHVqFcgnRAf8PVbRnn3ZdMGq text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view s normal set_encoded_userinfo boost/url/url_base.hpp include/boost/url/url_base.hpp 542 5 function gNzAQHZHDPXQiqwfYS6GwxUvQsG public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 4QciDQp3vKjNuPEah54XMBvrjvyD text returns true. Otherwise, paragraph text If there is no colon, the user is set to the string. The function reference has_password 4QciDQp3vKjNuPEah54XMBvrjvyD 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 sGNgGfijxwV9WzubTygPba9mCQn text , reference set_userinfo 3WPfZEH3k9jEMW6zLcD16Xd3Uqyg text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view s normal set_encoded_zone_id boost/url/url_base.hpp include/boost/url/url_base.hpp 1411 5 function 4X1oAamqzgD6NUQuQqZgb3E7Y8hN public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view s normal set_fragment boost/url/url_base.hpp include/boost/url/url_base.hpp 2556 5 function 2BFpJxb9o2AGu7rRGKFVoFsW7Pi4 public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 2TNB4s1W5aG5wvgM5sFhpkadBvP9 text , reference set_encoded_fragment 2hLzEE9gAKyxVT6kbPLwfet2MGnC text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal set_host boost/url/url_base.hpp include/boost/url/url_base.hpp 941 5 function 36GzQWnsLo7vUpJDLjUBWfUao6v7 public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 4B5yLFvhkpef7XX8ryKTaBWz8d6D 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 2y7UTsNbko8TLegXS5EpSa1goNog 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 25qx7TTMyctoe4LxqgMPXccSpy5Q 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 QfoSUW8M1SPUL5EFVKwAUabTKCa 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 osScXCjJkJkSf5jPTGH5dPVin3q text , reference set_encoded_host_address 4DwBiJMifXNsmVFdmgKDhGDJZ3wh text , reference set_encoded_host_name fBFYvCn8kJ47xA7NVhe1Rghp5J8 text , reference set_host_address 3bzhb9DrxWPqshAd4mygzPBefvw8 text , reference set_host_ipv4 9UnBBXEqhvdW1scEozkygaKMjGZ text , reference set_host_ipv6 6SijdGWstqVJuYLMAU9YBwkBXSG text , reference set_host_ipvfuture 55atbAUaUexHuQt9WaRpVBqgfdg text , reference set_host_name soNQwVrosnpg6yBhJnz9p8yjZta text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal set_host_address boost/url/url_base.hpp include/boost/url/url_base.hpp 1126 5 function 3bzhb9DrxWPqshAd4mygzPBefvw8 public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 4B5yLFvhkpef7XX8ryKTaBWz8d6D 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 2y7UTsNbko8TLegXS5EpSa1goNog 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 25qx7TTMyctoe4LxqgMPXccSpy5Q 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 QfoSUW8M1SPUL5EFVKwAUabTKCa 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 osScXCjJkJkSf5jPTGH5dPVin3q text , reference set_encoded_host_address 4DwBiJMifXNsmVFdmgKDhGDJZ3wh text , reference set_encoded_host_name fBFYvCn8kJ47xA7NVhe1Rghp5J8 text , reference set_host 36GzQWnsLo7vUpJDLjUBWfUao6v7 text , reference set_host_address 3bzhb9DrxWPqshAd4mygzPBefvw8 text , reference set_host_ipv4 9UnBBXEqhvdW1scEozkygaKMjGZ text , reference set_host_ipv6 6SijdGWstqVJuYLMAU9YBwkBXSG text , reference set_host_ipvfuture 55atbAUaUexHuQt9WaRpVBqgfdg text , reference set_host_name soNQwVrosnpg6yBhJnz9p8yjZta text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal set_host_ipv4 boost/url/url_base.hpp include/boost/url/url_base.hpp 1287 5 function 9UnBBXEqhvdW1scEozkygaKMjGZ public regular 2TREmHUMfZeMQz9yyw5HzqB91APN paragraph text The host is set to the specified IPv4 address. The host type is reference host_type::ipv4 4B5yLFvhkpef7XX8ryKTaBWz8d6D 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 osScXCjJkJkSf5jPTGH5dPVin3q text , reference set_encoded_host_address 4DwBiJMifXNsmVFdmgKDhGDJZ3wh text , reference set_encoded_host_name fBFYvCn8kJ47xA7NVhe1Rghp5J8 text , reference set_host 36GzQWnsLo7vUpJDLjUBWfUao6v7 text , reference set_host_address 3bzhb9DrxWPqshAd4mygzPBefvw8 text , reference set_host_ipv6 6SijdGWstqVJuYLMAU9YBwkBXSG text , reference set_host_ipvfuture 55atbAUaUexHuQt9WaRpVBqgfdg text , reference set_host_name soNQwVrosnpg6yBhJnz9p8yjZta text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base lvalue-reference named identifier 4Xmd9k1GBKGKQj6PYc1qdt4tMUae ipv4_address addr normal set_host_ipv6 boost/url/url_base.hpp include/boost/url/url_base.hpp 1353 5 function 6SijdGWstqVJuYLMAU9YBwkBXSG public regular 2TREmHUMfZeMQz9yyw5HzqB91APN paragraph text The host is set to the specified IPv6 address. The host type is reference host_type::ipv6 2y7UTsNbko8TLegXS5EpSa1goNog 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 osScXCjJkJkSf5jPTGH5dPVin3q text , reference set_encoded_host_address 4DwBiJMifXNsmVFdmgKDhGDJZ3wh text , reference set_encoded_host_name fBFYvCn8kJ47xA7NVhe1Rghp5J8 text , reference set_host 36GzQWnsLo7vUpJDLjUBWfUao6v7 text , reference set_host_address 3bzhb9DrxWPqshAd4mygzPBefvw8 text , reference set_host_ipv4 9UnBBXEqhvdW1scEozkygaKMjGZ text , reference set_host_ipvfuture 55atbAUaUexHuQt9WaRpVBqgfdg text , reference set_host_name soNQwVrosnpg6yBhJnz9p8yjZta text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base lvalue-reference named identifier 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T ipv6_address addr normal set_host_ipvfuture boost/url/url_base.hpp include/boost/url/url_base.hpp 1464 5 function 55atbAUaUexHuQt9WaRpVBqgfdg public regular 2TREmHUMfZeMQz9yyw5HzqB91APN paragraph text The host is set to the specified IPvFuture string. The host type is reference host_type::ipvfuture 25qx7TTMyctoe4LxqgMPXccSpy5Q 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 osScXCjJkJkSf5jPTGH5dPVin3q text , reference set_encoded_host_address 4DwBiJMifXNsmVFdmgKDhGDJZ3wh text , reference set_encoded_host_name fBFYvCn8kJ47xA7NVhe1Rghp5J8 text , reference set_host 36GzQWnsLo7vUpJDLjUBWfUao6v7 text , reference set_host_address 3bzhb9DrxWPqshAd4mygzPBefvw8 text , reference set_host_ipv4 9UnBBXEqhvdW1scEozkygaKMjGZ text , reference set_host_ipv6 6SijdGWstqVJuYLMAU9YBwkBXSG text , reference set_host_name soNQwVrosnpg6yBhJnz9p8yjZta text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal set_host_name boost/url/url_base.hpp include/boost/url/url_base.hpp 1512 5 function soNQwVrosnpg6yBhJnz9p8yjZta public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 QfoSUW8M1SPUL5EFVKwAUabTKCa 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 osScXCjJkJkSf5jPTGH5dPVin3q text , reference set_encoded_host_address 4DwBiJMifXNsmVFdmgKDhGDJZ3wh text , reference set_encoded_host_name fBFYvCn8kJ47xA7NVhe1Rghp5J8 text , reference set_host 36GzQWnsLo7vUpJDLjUBWfUao6v7 text , reference set_host_address 3bzhb9DrxWPqshAd4mygzPBefvw8 text , reference set_host_ipv4 9UnBBXEqhvdW1scEozkygaKMjGZ text , reference set_host_ipv6 6SijdGWstqVJuYLMAU9YBwkBXSG text , reference set_host_ipvfuture 55atbAUaUexHuQt9WaRpVBqgfdg text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal set_params boost/url/url_base.hpp include/boost/url/url_base.hpp 2355 5 function 4FzhNxmTaWz7pzZaXUiuVRmBs2SH public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3WcGK7mkJngNwmU5zz1zx9Vr7iC3 text , reference remove_query 2R5rf2bDtEpPE9hwtv8Ln4i6EAHv text , reference set_encoded_query v9Dry5ACH8wLSd7BYqpiHbGB7V8 text , reference set_query 4THvHraYktHgYNzU3qniR2MhXpuX text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named specialization 474HF6bGJmJntnocv1iPAYL2crja initializer_list identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std type named identifier AbvEAFQMtFaLMVMSA2NZ5D5a7nN param_view ps named identifier 5dyN7z5egGMdJFpXz9WbaL549xC encoding_opts opts {} normal set_password boost/url/url_base.hpp include/boost/url/url_base.hpp 746 5 function 2YAaMd9PbnTHhrrZTFuaATwNBjuR public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 igKd3Gv9P5L4VjvQSC6giswwMEQ text , reference set_encoded_password 3M3tGnhVHGx7Vc2eUaFuGy7VoCxu text , reference set_encoded_user 2MEk1Cda8bzLjEPBG1V7MJvLRyqJ text , reference set_user MYZLHVqFcgnRAf8PVbRnn3ZdMGq text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal set_path boost/url/url_base.hpp include/boost/url/url_base.hpp 1827 5 function 3v9Fip9faoKhfWb6eQhiSgANjWdV public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 MCx88BPGS5KgE3qhBfh89e3U57J text or reference segments 2bXmGRYoLQKFALtmsM2vVVCvmnVn 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 3NGtuSVjhTWXrAF9sPpeS5FwZQN8 text , reference segments 2bXmGRYoLQKFALtmsM2vVVCvmnVn text , reference set_encoded_path MCx88BPGS5KgE3qhBfh89e3U57J text , reference set_path_absolute 4b7SsvokaeMTXQXBKywBXGVroR2 text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal set_path_absolute boost/url/url_base.hpp include/boost/url/url_base.hpp 1760 5 function 4b7SsvokaeMTXQXBKywBXGVroR2 public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3NGtuSVjhTWXrAF9sPpeS5FwZQN8 text , reference segments 2bXmGRYoLQKFALtmsM2vVVCvmnVn text , reference set_encoded_path MCx88BPGS5KgE3qhBfh89e3U57J text , reference set_path 3v9Fip9faoKhfWb6eQhiSgANjWdV text . named identifier bool bool named identifier bool bool absolute normal set_port boost/url/url_base.hpp include/boost/url/url_base.hpp 1656 5 function 3LEFuHiJFofpCmdb6z7kwJ5NBNyV public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 1B1sp4Ef6qEaa3XYv8pbQFsfkZt text , reference set_port 3LEFuHiJFofpCmdb6z7kwJ5NBNyV text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal set_port_number boost/url/url_base.hpp include/boost/url/url_base.hpp 1612 5 function 49Q25jBbiW4ssURp7srqLCYtJxmr public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 1B1sp4Ef6qEaa3XYv8pbQFsfkZt text , reference set_port 3LEFuHiJFofpCmdb6z7kwJ5NBNyV text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier w7yWEPLwtMpd5GnNHsV5ASwVxkX uint16_t n normal set_query boost/url/url_base.hpp include/boost/url/url_base.hpp 2076 5 function 4THvHraYktHgYNzU3qniR2MhXpuX public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3WcGK7mkJngNwmU5zz1zx9Vr7iC3 text , reference params 3hdYD66PBzHcr6JTNLGtXFRmpwjB text , reference remove_query 2R5rf2bDtEpPE9hwtv8Ln4i6EAHv text , reference set_encoded_query v9Dry5ACH8wLSd7BYqpiHbGB7V8 text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal set_scheme boost/url/url_base.hpp include/boost/url/url_base.hpp 245 5 function 3QW2cbeaw11tvSPbrjEnJSQu2CC7 public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 3y1CD4diAVFMNJd23sVxV2aC2Kw6 text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal set_scheme_id boost/url/url_base.hpp include/boost/url/url_base.hpp 280 5 function 2wEQzdwYGT3faB4EpgEZkgYTqM2G public regular 2TREmHUMfZeMQz9yyw5HzqB91APN paragraph text This function sets the scheme to the specified known reference urls::scheme tVuW4uzt1HMgUxPtxroTuMsNi2G text id, which may not be reference scheme::unknown d3jNvGWyWHyaA1snRDXYWd5jjkA text or else an exception is thrown. If the id is reference scheme::none 2DEQCVdvMZA94BHRjTMB2n7Ttdp2 text , this function behaves as if reference remove_scheme 3y1CD4diAVFMNJd23sVxV2aC2Kw6 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 lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier tVuW4uzt1HMgUxPtxroTuMsNi2G scheme identifier 2ejQGW57K8g7MFJhHAwPt5aumoLa urls id normal set_user boost/url/url_base.hpp include/boost/url/url_base.hpp 635 5 function MYZLHVqFcgnRAf8PVbRnn3ZdMGq public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 igKd3Gv9P5L4VjvQSC6giswwMEQ text , reference set_encoded_password 3M3tGnhVHGx7Vc2eUaFuGy7VoCxu text , reference set_encoded_user 2MEk1Cda8bzLjEPBG1V7MJvLRyqJ text , reference set_password 2YAaMd9PbnTHhrrZTFuaATwNBjuR text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal set_userinfo boost/url/url_base.hpp include/boost/url/url_base.hpp 475 5 function 3WPfZEH3k9jEMW6zLcD16Xd3Uqyg public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 4QciDQp3vKjNuPEah54XMBvrjvyD text returns true. Otherwise, paragraph text If there is no colon, the user is set to the string. The function reference has_password 4QciDQp3vKjNuPEah54XMBvrjvyD 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 sGNgGfijxwV9WzubTygPba9mCQn text , reference set_encoded_userinfo gNzAQHZHDPXQiqwfYS6GwxUvQsG text . lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal set_zone_id boost/url/url_base.hpp include/boost/url/url_base.hpp 1380 5 function 2gcj9bRhg1wZZAtNMQkD6jo35SjJ public regular 2TREmHUMfZeMQz9yyw5HzqB91APN 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 lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal size boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 201 5 function 2Z9j51jzFxpMXyB1ZjxR329S4Puk public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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. named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std normal user boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 848 5 function 4Yfg3yG11SsLgpAe6dzENEPz39dk public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4QciDQp3vKjNuPEah54XMBvrjvyD text , reference has_userinfo 2x7XawH6QTh6eBg2hNRqzQ3WME2m text , reference encoded_password 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym text , reference encoded_user 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC text , reference encoded_userinfo 3qDJMHEiC1T5Vik6nGt2CJvFxFDM text , reference password 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL text , reference userinfo 24JMPq739KrKuemXwWK8zpXGtWvz text . named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal userinfo boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 748 5 function 24JMPq739KrKuemXwWK8zpXGtWvz public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4UumWzLNRv3vgTVdDkz5PVqdSsSL 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 4QciDQp3vKjNuPEah54XMBvrjvyD text , reference has_userinfo 2x7XawH6QTh6eBg2hNRqzQ3WME2m text , reference encoded_password 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym text , reference encoded_user 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC text , reference encoded_userinfo 3qDJMHEiC1T5Vik6nGt2CJvFxFDM text , reference password 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL text , reference user 4Yfg3yG11SsLgpAe6dzENEPz39dk text . named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal zone_id boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1480 5 function 3QgkE48ZuKvk3EGbnydRNa7ob9XL public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text If the host type is reference host_type::ipv6 2y7UTsNbko8TLegXS5EpSa1goNog 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 named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal operator basic_string_view<char> boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 299 5 function 3uYCaZr2Kk1eGAMsuRXTehXkXZwv public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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. named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core conversion max_size boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 173 5 function 39V9A9oqw6EqsRw4R5mxeMpeqePo public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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. named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std normal constexpr static 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 function 2TwwpddeAxzjzfbTirqgZeddg3n6 protected regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std salt 0 normal url_view boost/url/url_view.hpp include/boost/url/url_view.hpp 81 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 3hrVvoVYoDkX9t3w9abTXxDqGRaW regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 4KCrVrNi2iTJ15zBNtvdSNip4rmV text return a code text boost::system::result text containing either a valid reference url_view 3hog5YfRGdJJ2mrY8WL8PHPKRoCP 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 2ARWB82XdRYexehQmFQZjcEKzoSi text , reference parse_origin_form YwftbCXGz1kG5uRUguacNEwrkaP text , reference parse_relative_ref u1SFmy6a6wtXTYxrMnssMwa7K6G text , reference parse_uri 2nNq8RtS22vhgfkFAo8dGh6NW87n text , reference parse_uri_reference 4KCrVrNi2iTJ15zBNtvdSNip4rmV text . reference operator!= tkwNEJdWJqwprh85787u3xpyauu reference operator< 22wNuw5VxKWrVLMDGM9VPFjJshU6 reference operator<= 3QqsgavNMQTmxMW1t9qAoAocshM6 reference operator== GhudPV3CuyCeCKSftvpKEQLQtJ4 reference operator> 3CgAf4w5dyww6CMhGWkJm1fJiHum reference operator>= 2V16XgrptBcWFtoZaJ3DExhQXY6 reference parse_absolute_uri 2ARWB82XdRYexehQmFQZjcEKzoSi reference parse_origin_form YwftbCXGz1kG5uRUguacNEwrkaP reference parse_relative_ref u1SFmy6a6wtXTYxrMnssMwa7K6G reference parse_uri 2nNq8RtS22vhgfkFAo8dGh6NW87n reference parse_uri_reference 4KCrVrNi2iTJ15zBNtvdSNip4rmV reference resolve 4ZbWvyKBMwfyhwwk3YYEco8ttTeS other __visibility__ class named identifier 27ryuyAvvRyzfzgketja5uQcFBcK url_view_base public 3hog5YfRGdJJ2mrY8WL8PHPKRoCP ADHWwbqV8ENDWzLk5cFnd6AvyED EDzav3enQxX2FmUre5ToComGA9E 3fqhU2zdn6LwiSAm9upTzbtboK1U 3ESzuLSF2zD1TghU6qemdUksdP2V 3Lh94K8cNrPFyFYw36XmhhtFMLpf VbvXoprikWfUm5mR56ZFYECXt9J 4DmmNdXmY3VWyP6HoKWQVEExBzaV 2GaF4F3gH2Y5LkyYXCrr3VyP9tpJ ipF8M41qPyuMM5XLe5JGZYSc42h FMBiWLrznwNXgkDuu4xneE9NeCD 3oodjUy4VDbgnxfeqkxwvqQvf7hK 4SGWNm9TD3ZACEqJ9fmnWL1ZF47q 492Pha8s74Xj1GjgZ82x193B56bP 3gVZJ5SpfCzYoZgafZW71cueQ3u3 2N3uW9xQekt6pX19rHqrM5vcnVUH 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym M5bG6HzwZUo4ycGCKLY5CsUUXun 3VZ9J5FmgK7VsNUfrHxuyT4pNTGm 3oB1p7aLxKXx3FxEqHaKSnCiNfXM 3jZFG9bXfeYJfGzZnt2Zim38gmMB UJaw1aYaRaLhmYt2h416g598hi4 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC 3qDJMHEiC1T5Vik6nGt2CJvFxFDM 4Bt9AGe8WEFmjA79MWAiGPDtMUW8 2T5XA2udwnVeh4RFi6U9UrLirJFJ 2omNW7ayWzkboBBXgc2Rm6C4y5kb 2RYFJUJHdYjygxHWSb57bHWfkHgN 4QciDQp3vKjNuPEah54XMBvrjvyD 4CLeCb8bTxYAjEFuAXtr5VmQW6FE 21mA7muF2gpvzFjJxaqjvjnnm6XY 2wLECn7WbsBXGLpheUngfa9GEf1q 2x7XawH6QTh6eBg2hNRqzQ3WME2m SytR6d7pUELeR1RNUpcWrXWQcY8 KoSC71QaaCYQtpr7xCwndbzWaKR Zvcpzzy9h3HWgiqp7UZuEiWf4A7 9sSdyLcyHxeuasmCKqifZp3ga5s 4E8a8HgQbryrd4KcNHFajdVyLWib 2gNagLmHXZAqycctaaYmEYZc9pv mSWKjRHEDFTnpxGSra6Q5eS7fjS 2hgDJpXv5LpubtS8phLLnGk4a7XZ 2RJGYan9E8WvVKQM1LmRNNdUCc7E 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL wc1MNXXCH1K1Shz81BmxVy1opwc 2aNVu1ZJUXAnkA1MUK2cfojoNCyj p8uqDVjGDrU4Eg9axo7dsTkztws 363HbS6bzsgdHiLTk4Kr8pdkZJZY 49Yox1iKKs7LmQ3wu1nCZXGKWEKf 4AoadMoEhkiTY9v83LDBwQt31Uti 3aL5x6QNsMGNDAo8DP539u5TsZpp 3YxJjcnyfcHtM9xLtszAHET8pyFv 2Z9j51jzFxpMXyB1ZjxR329S4Puk 4Yfg3yG11SsLgpAe6dzENEPz39dk 24JMPq739KrKuemXwWK8zpXGtWvz 3QgkE48ZuKvk3EGbnydRNa7ob9XL 3uYCaZr2Kk1eGAMsuRXTehXkXZwv vh7YCFWtdcoNVetmju9YoNtWx1G 2TwwpddeAxzjzfbTirqgZeddg3n6 named identifier 44gF3RWPKyorxySQWG1hnA4vjiJu params_encoded_base 44gF3RWPKyorxySQWG1hnA4vjiJu named identifier 3JqzyR89pExMFqZFBHMskoM3dq3x params_base 3JqzyR89pExMFqZFBHMskoM3dq3x named identifier 27ryuyAvvRyzfzgketja5uQcFBcK url_view_base 27ryuyAvvRyzfzgketja5uQcFBcK named specialization hash identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std type named identifier 3hrVvoVYoDkX9t3w9abTXxDqGRaW url_view url_view boost/url/url_view.hpp include/boost/url/url_view.hpp 153 5 boost/url/url_view.hpp include/boost/url/url_view.hpp 205 5 overloads 3hog5YfRGdJJ2mrY8WL8PHPKRoCP public regular 3hrVvoVYoDkX9t3w9abTXxDqGRaW 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 4KCrVrNi2iTJ15zBNtvdSNip4rmV text . see reference parse_uri_reference 4KCrVrNi2iTJ15zBNtvdSNip4rmV text . constructor 3qe7fDRi3SjBnMScPVphHnxq93jz Wfxm8eGajwsQKCfvmK1uRUi3wqP 2ooYdRr9PontpXmsXT7o9ETaC7zy XBiTk6sNMvGUDCexRR2rDcmCkdJ 3HC66M3qurEkJcj38p72yrtHtYPC 4RjR1kYPPK9BPnjLEm6V4fWR4Q6 named identifier void void url_view boost/url/url_view.hpp include/boost/url/url_view.hpp 153 5 function 3qe7fDRi3SjBnMScPVphHnxq93jz public regular 3hrVvoVYoDkX9t3w9abTXxDqGRaW 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 named identifier void void constructor constexpr url_view boost/url/url_view.hpp include/boost/url/url_view.hpp 249 5 function Wfxm8eGajwsQKCfvmK1uRUi3wqP public regular 3hrVvoVYoDkX9t3w9abTXxDqGRaW 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 named identifier void void lvalue-reference named identifier 3hrVvoVYoDkX9t3w9abTXxDqGRaW url_view other constructor constexpr url_view boost/url/url_view.hpp include/boost/url/url_view.hpp 255 5 function 2ooYdRr9PontpXmsXT7o9ETaC7zy public regular 3hrVvoVYoDkX9t3w9abTXxDqGRaW brief text Move constructor param text The object to move construct from other named identifier void void rvalue-reference named identifier 3hrVvoVYoDkX9t3w9abTXxDqGRaW url_view other constructor constexpr url_view boost/url/url_view.hpp include/boost/url/url_view.hpp 205 5 function XBiTk6sNMvGUDCexRR2rDcmCkdJ public regular 3hrVvoVYoDkX9t3w9abTXxDqGRaW 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 4KCrVrNi2iTJ15zBNtvdSNip4rmV text . named identifier void void named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s constructor url_view boost/url/url_view.hpp include/boost/url/url_view.hpp 278 5 function 3HC66M3qurEkJcj38p72yrtHtYPC public regular 3hrVvoVYoDkX9t3w9abTXxDqGRaW 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 named identifier void void lvalue-reference named identifier 27ryuyAvvRyzfzgketja5uQcFBcK url_view_base other constructor constexpr url_view boost/url/url_view.hpp include/boost/url/url_view.hpp 208 5 function 4RjR1kYPPK9BPnjLEm6V4fWR4Q6 public regular 3hrVvoVYoDkX9t3w9abTXxDqGRaW 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 4KCrVrNi2iTJ15zBNtvdSNip4rmV text . named identifier void void lvalue-reference named identifier String s constructor ~url_view boost/url/url_view.hpp include/boost/url/url_view.hpp 117 5 function ADHWwbqV8ENDWzLk5cFnd6AvyED public regular 3hrVvoVYoDkX9t3w9abTXxDqGRaW paragraph text Any params, segments, iterators, or other views which reference the same underlying character buffer remain valid. brief text Destructor named identifier void void destructor constexpr operator= boost/url/url_view.hpp include/boost/url/url_view.hpp 306 5 overloads EDzav3enQxX2FmUre5ToComGA9E public regular 3hrVvoVYoDkX9t3w9abTXxDqGRaW brief text Assignment returns text A reference to this object. param text The other view. other normal = e6VTo7SUojNDr8XSyF3UTxKouih 4YfYatx9wDPcRrYS3o2EJAMeDkYr lvalue-reference named identifier 3hrVvoVYoDkX9t3w9abTXxDqGRaW url_view operator= boost/url/url_view.hpp include/boost/url/url_view.hpp 306 5 function e6VTo7SUojNDr8XSyF3UTxKouih public regular 3hrVvoVYoDkX9t3w9abTXxDqGRaW 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 lvalue-reference named identifier 3hrVvoVYoDkX9t3w9abTXxDqGRaW url_view lvalue-reference named identifier 3hrVvoVYoDkX9t3w9abTXxDqGRaW url_view other normal constexpr = operator= boost/url/url_view.hpp include/boost/url/url_view.hpp 336 5 function 4YfYatx9wDPcRrYS3o2EJAMeDkYr public regular 3hrVvoVYoDkX9t3w9abTXxDqGRaW 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 lvalue-reference named identifier 3hrVvoVYoDkX9t3w9abTXxDqGRaW url_view lvalue-reference named identifier 27ryuyAvvRyzfzgketja5uQcFBcK url_view_base other normal constexpr = authority boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 564 5 function 3fqhU2zdn6LwiSAm9upTzbtboK1U public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text This function returns the authority as an reference authority_view 2fwXocwnoAG9WDGbqM3quKphV1qq 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 2GaF4F3gH2Y5LkyYXCrr3VyP9tpJ text , reference has_authority 2omNW7ayWzkboBBXgc2Rm6C4y5kb text . named identifier 2fwXocwnoAG9WDGbqM3quKphV1qq authority_view normal buffer boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 282 5 function 3ESzuLSF2zD1TghU6qemdUksdP2V public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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. named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core normal compare boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2446 5 function 3Lh94K8cNrPFyFYw36XmhhtFMLpf public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 named identifier int int lvalue-reference named identifier 27ryuyAvvRyzfzgketja5uQcFBcK url_view_base other normal data boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 258 5 function VbvXoprikWfUm5mR56ZFYECXt9J public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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. pointer named identifier char char normal empty boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 238 5 function 4DmmNdXmY3VWyP6HoKWQVEExBzaV public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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. named identifier bool bool normal encoded_authority boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 601 5 function 2GaF4F3gH2Y5LkyYXCrr3VyP9tpJ public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 3fqhU2zdn6LwiSAm9upTzbtboK1U text , reference has_authority 2omNW7ayWzkboBBXgc2Rm6C4y5kb text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_fragment boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2280 5 function ipF8M41qPyuMM5XLe5JGZYSc42h public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2T5XA2udwnVeh4RFi6U9UrLirJFJ text , reference has_fragment 2RYFJUJHdYjygxHWSb57bHWfkHgN text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_host boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1120 5 function FMBiWLrznwNXgkDuu4xneE9NeCD public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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. named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_host_address boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1237 5 function 3oodjUy4VDbgnxfeqkxwvqQvf7hK public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text The value returned by this function depends on the type of host returned from the function reference host_type mSWKjRHEDFTnpxGSra6Q5eS7fjS text . list paragraph text If the type is reference host_type::ipv4 4B5yLFvhkpef7XX8ryKTaBWz8d6D text , then the IPv4 address string is returned. paragraph text If the type is reference host_type::ipv6 2y7UTsNbko8TLegXS5EpSa1goNog text , then the IPv6 address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::ipvfuture 25qx7TTMyctoe4LxqgMPXccSpy5Q text , then the IPvFuture address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::name QfoSUW8M1SPUL5EFVKwAUabTKCa 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 wGjRbosZ4DQY7xCpjwAZqPVHiim 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. named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_host_and_port boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2325 5 function 4SGWNm9TD3ZACEqJ9fmnWL1ZF47q public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4CLeCb8bTxYAjEFuAXtr5VmQW6FE text , reference port p8uqDVjGDrU4Eg9axo7dsTkztws text , reference port_number 363HbS6bzsgdHiLTk4Kr8pdkZJZY text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_host_name boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1441 5 function 492Pha8s74Xj1GjgZ82x193B56bP public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text If the host type is reference host_type::name QfoSUW8M1SPUL5EFVKwAUabTKCa 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. named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_origin boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2355 5 function 3gVZJ5SpfCzYoZgafZW71cueQ3u3 public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 3oB1p7aLxKXx3FxEqHaKSnCiNfXM text , reference encoded_target UJaw1aYaRaLhmYt2h416g598hi4 text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_params boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2130 5 function 2N3uW9xQekt6pX19rHqrM5vcnVUH public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 3VZ9J5FmgK7VsNUfrHxuyT4pNTGm text , reference has_query 21mA7muF2gpvzFjJxaqjvjnnm6XY text , reference params 2RJGYan9E8WvVKQM1LmRNNdUCc7E text , reference query 49Yox1iKKs7LmQ3wu1nCZXGKWEKf text . named identifier 3w4FJjjADY3EEHqUmBj5mvDKqdEB params_encoded_view normal encoded_password boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 996 5 function 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4QciDQp3vKjNuPEah54XMBvrjvyD text , reference has_userinfo 2x7XawH6QTh6eBg2hNRqzQ3WME2m text , reference encoded_user 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC text , reference encoded_userinfo 3qDJMHEiC1T5Vik6nGt2CJvFxFDM text , reference password 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL text , reference user 4Yfg3yG11SsLgpAe6dzENEPz39dk text , reference userinfo 24JMPq739KrKuemXwWK8zpXGtWvz text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_path boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1799 5 function M5bG6HzwZUo4ycGCKLY5CsUUXun public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2hgDJpXv5LpubtS8phLLnGk4a7XZ text , reference encoded_segments 3jZFG9bXfeYJfGzZnt2Zim38gmMB text . reference path wc1MNXXCH1K1Shz81BmxVy1opwc text , reference segments 3YxJjcnyfcHtM9xLtszAHET8pyFv text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_query boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2040 5 function 3VZ9J5FmgK7VsNUfrHxuyT4pNTGm public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2N3uW9xQekt6pX19rHqrM5vcnVUH text , reference has_query 21mA7muF2gpvzFjJxaqjvjnnm6XY text , reference params 2RJGYan9E8WvVKQM1LmRNNdUCc7E text , reference query 49Yox1iKKs7LmQ3wu1nCZXGKWEKf text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_resource boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2387 5 function 3oB1p7aLxKXx3FxEqHaKSnCiNfXM public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 3gVZJ5SpfCzYoZgafZW71cueQ3u3 text , reference encoded_target UJaw1aYaRaLhmYt2h416g598hi4 text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_segments boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1891 5 function 3jZFG9bXfeYJfGzZnt2Zim38gmMB public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2hgDJpXv5LpubtS8phLLnGk4a7XZ text , reference encoded_path M5bG6HzwZUo4ycGCKLY5CsUUXun text , reference path wc1MNXXCH1K1Shz81BmxVy1opwc text , reference segments 3YxJjcnyfcHtM9xLtszAHET8pyFv text , reference segments_encoded_view GKjeDHooSf2HAMf239p3oFfT3i3 text . named identifier GKjeDHooSf2HAMf239p3oFfT3i3 segments_encoded_view normal encoded_target boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2419 5 function UJaw1aYaRaLhmYt2h416g598hi4 public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 3gVZJ5SpfCzYoZgafZW71cueQ3u3 text , reference encoded_resource 3oB1p7aLxKXx3FxEqHaKSnCiNfXM text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_user boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 901 5 function 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4QciDQp3vKjNuPEah54XMBvrjvyD text , reference has_userinfo 2x7XawH6QTh6eBg2hNRqzQ3WME2m text , reference encoded_password 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym text , reference encoded_userinfo 3qDJMHEiC1T5Vik6nGt2CJvFxFDM text , reference password 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL text , reference user 4Yfg3yG11SsLgpAe6dzENEPz39dk text , reference userinfo 24JMPq739KrKuemXwWK8zpXGtWvz text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_userinfo boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 800 5 function 3qDJMHEiC1T5Vik6nGt2CJvFxFDM public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4QciDQp3vKjNuPEah54XMBvrjvyD text , reference has_userinfo 2x7XawH6QTh6eBg2hNRqzQ3WME2m text , reference encoded_password 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym text , reference encoded_user 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC text , reference password 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL text , reference user 4Yfg3yG11SsLgpAe6dzENEPz39dk text , reference userinfo 24JMPq739KrKuemXwWK8zpXGtWvz text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_zone_id boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1526 5 function 4Bt9AGe8WEFmjA79MWAiGPDtMUW8 public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text If the host type is reference host_type::ipv6 2y7UTsNbko8TLegXS5EpSa1goNog 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. named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal fragment boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2233 5 function 2T5XA2udwnVeh4RFi6U9UrLirJFJ public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 ipF8M41qPyuMM5XLe5JGZYSc42h text , reference has_fragment 2RYFJUJHdYjygxHWSb57bHWfkHgN text . named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal has_authority boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 528 5 function 2omNW7ayWzkboBBXgc2Rm6C4y5kb public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 3fqhU2zdn6LwiSAm9upTzbtboK1U text , reference encoded_authority 2GaF4F3gH2Y5LkyYXCrr3VyP9tpJ text . named identifier bool bool normal has_fragment boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2173 5 function 2RYFJUJHdYjygxHWSb57bHWfkHgN public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 ipF8M41qPyuMM5XLe5JGZYSc42h text , reference fragment 2T5XA2udwnVeh4RFi6U9UrLirJFJ text . named identifier bool bool normal has_password boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 689 5 function 4QciDQp3vKjNuPEah54XMBvrjvyD public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2x7XawH6QTh6eBg2hNRqzQ3WME2m text , reference encoded_password 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym text , reference encoded_user 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC text , reference encoded_userinfo 3qDJMHEiC1T5Vik6nGt2CJvFxFDM text , reference password 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL text , reference user 4Yfg3yG11SsLgpAe6dzENEPz39dk text , reference userinfo 24JMPq739KrKuemXwWK8zpXGtWvz text . named identifier bool bool normal has_port boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1568 5 function 4CLeCb8bTxYAjEFuAXtr5VmQW6FE public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4SGWNm9TD3ZACEqJ9fmnWL1ZF47q text , reference port p8uqDVjGDrU4Eg9axo7dsTkztws text , reference port_number 363HbS6bzsgdHiLTk4Kr8pdkZJZY text . named identifier bool bool normal has_query boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1937 5 function 21mA7muF2gpvzFjJxaqjvjnnm6XY public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2N3uW9xQekt6pX19rHqrM5vcnVUH text , reference encoded_query 3VZ9J5FmgK7VsNUfrHxuyT4pNTGm text , reference params 2RJGYan9E8WvVKQM1LmRNNdUCc7E text , reference query 49Yox1iKKs7LmQ3wu1nCZXGKWEKf text . named identifier bool bool normal has_scheme boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 384 5 function 2wLECn7WbsBXGLpheUngfa9GEf1q public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4AoadMoEhkiTY9v83LDBwQt31Uti text , reference scheme_id 3aL5x6QNsMGNDAo8DP539u5TsZpp text . named identifier bool bool normal has_userinfo boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 647 5 function 2x7XawH6QTh6eBg2hNRqzQ3WME2m public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4QciDQp3vKjNuPEah54XMBvrjvyD text , reference encoded_password 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym text , reference encoded_user 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC text , reference encoded_userinfo 3qDJMHEiC1T5Vik6nGt2CJvFxFDM text , reference password 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL text , reference user 4Yfg3yG11SsLgpAe6dzENEPz39dk text , reference userinfo 24JMPq739KrKuemXwWK8zpXGtWvz text . named identifier bool bool normal host boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1076 5 function SytR6d7pUELeR1RNUpcWrXWQcY8 public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal host_address boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1174 5 function KoSC71QaaCYQtpr7xCwndbzWaKR public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text The value returned by this function depends on the type of host returned from the function reference host_type mSWKjRHEDFTnpxGSra6Q5eS7fjS text . list paragraph text If the type is reference host_type::ipv4 4B5yLFvhkpef7XX8ryKTaBWz8d6D text , then the IPv4 address string is returned. paragraph text If the type is reference host_type::ipv6 2y7UTsNbko8TLegXS5EpSa1goNog text , then the IPv6 address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::ipvfuture 25qx7TTMyctoe4LxqgMPXccSpy5Q text , then the IPvFuture address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::name QfoSUW8M1SPUL5EFVKwAUabTKCa 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 wGjRbosZ4DQY7xCpjwAZqPVHiim 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 named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal host_ipv4_address boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1277 5 function Zvcpzzy9h3HWgiqp7UZuEiWf4A7 public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text If the host type is reference host_type::ipv4 4B5yLFvhkpef7XX8ryKTaBWz8d6D text , this function returns the address as a value of type reference ipv4_address 4Xmd9k1GBKGKQj6PYc1qdt4tMUae 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 4Xmd9k1GBKGKQj6PYc1qdt4tMUae text . named identifier 4Xmd9k1GBKGKQj6PYc1qdt4tMUae ipv4_address normal host_ipv6_address boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1325 5 function 9sSdyLcyHxeuasmCKqifZp3ga5s public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text If the host type is reference host_type::ipv6 2y7UTsNbko8TLegXS5EpSa1goNog text , this function returns the address as a value of type reference ipv6_address 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T 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 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T text . named identifier 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T ipv6_address normal host_ipvfuture boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1358 5 function 4E8a8HgQbryrd4KcNHFajdVyLWib public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text If the host type is reference host_type::ipvfuture 25qx7TTMyctoe4LxqgMPXccSpy5Q 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. named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core normal host_name boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1395 5 function 2gNagLmHXZAqycctaaYmEYZc9pv public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text If the host type is reference host_type::name QfoSUW8M1SPUL5EFVKwAUabTKCa 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 named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal host_type boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1036 5 function mSWKjRHEDFTnpxGSra6Q5eS7fjS public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text This function returns one of the following constants representing the type of host present. list paragraph reference host_type::ipv4 4B5yLFvhkpef7XX8ryKTaBWz8d6D paragraph reference host_type::ipv6 2y7UTsNbko8TLegXS5EpSa1goNog paragraph reference host_type::ipvfuture 25qx7TTMyctoe4LxqgMPXccSpy5Q paragraph reference host_type::name QfoSUW8M1SPUL5EFVKwAUabTKCa paragraph reference host_type::none wGjRbosZ4DQY7xCpjwAZqPVHiim unordered paragraph text When reference has_authority 2omNW7ayWzkboBBXgc2Rm6C4y5kb text is false, the host type is reference host_type::none wGjRbosZ4DQY7xCpjwAZqPVHiim 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. named identifier 2M8hT55CSziFA9Zup4mKYdwvgUiE host_type identifier 2ejQGW57K8g7MFJhHAwPt5aumoLa urls normal is_path_absolute boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1691 5 function 2hgDJpXv5LpubtS8phLLnGk4a7XZ public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 M5bG6HzwZUo4ycGCKLY5CsUUXun text , reference encoded_segments 3jZFG9bXfeYJfGzZnt2Zim38gmMB text . reference path wc1MNXXCH1K1Shz81BmxVy1opwc text , reference segments 3YxJjcnyfcHtM9xLtszAHET8pyFv text . named identifier bool bool normal params boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2084 5 boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2087 5 overloads 2RJGYan9E8WvVKQM1LmRNNdUCc7E public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2U5LKGfgSLLAxqQ86nkdDqCLX4FS 2Dh1FrqKLpBQUzJVYtqvr6ziuTX6 named identifier DJiFqyFR7zZh4N3HNJHhiAj7JPV params_view params boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2084 5 function 2U5LKGfgSLLAxqQ86nkdDqCLX4FS public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2N3uW9xQekt6pX19rHqrM5vcnVUH text , reference encoded_query 3VZ9J5FmgK7VsNUfrHxuyT4pNTGm text , reference has_query 21mA7muF2gpvzFjJxaqjvjnnm6XY text , reference query 49Yox1iKKs7LmQ3wu1nCZXGKWEKf text . named identifier DJiFqyFR7zZh4N3HNJHhiAj7JPV params_view normal params boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2087 5 function 2Dh1FrqKLpBQUzJVYtqvr6ziuTX6 public regular 27ryuyAvvRyzfzgketja5uQcFBcK named identifier DJiFqyFR7zZh4N3HNJHhiAj7JPV params_view named identifier 5dyN7z5egGMdJFpXz9WbaL549xC encoding_opts opt normal password boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 947 5 function 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4QciDQp3vKjNuPEah54XMBvrjvyD text , reference has_userinfo 2x7XawH6QTh6eBg2hNRqzQ3WME2m text , reference encoded_password 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym text , reference encoded_user 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC text , reference encoded_userinfo 3qDJMHEiC1T5Vik6nGt2CJvFxFDM text , reference user 4Yfg3yG11SsLgpAe6dzENEPz39dk text , reference userinfo 24JMPq739KrKuemXwWK8zpXGtWvz text . named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal path boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1744 5 function wc1MNXXCH1K1Shz81BmxVy1opwc public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2hgDJpXv5LpubtS8phLLnGk4a7XZ text , reference encoded_path M5bG6HzwZUo4ycGCKLY5CsUUXun text , reference encoded_segments 3jZFG9bXfeYJfGzZnt2Zim38gmMB text . reference segments 3YxJjcnyfcHtM9xLtszAHET8pyFv text . named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal persist boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 341 5 function 2aNVu1ZJUXAnkA1MUK2cfojoNCyj public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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. named specialization 3ndPMWYzhtTVAVCHsDKjaQkrDfmC shared_ptr identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std type named identifier 3hrVvoVYoDkX9t3w9abTXxDqGRaW url_view normal port boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1604 5 function p8uqDVjGDrU4Eg9axo7dsTkztws public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4SGWNm9TD3ZACEqJ9fmnWL1ZF47q text , reference has_port 4CLeCb8bTxYAjEFuAXtr5VmQW6FE text , reference port_number 363HbS6bzsgdHiLTk4Kr8pdkZJZY text . named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core normal port_number boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1640 5 function 363HbS6bzsgdHiLTk4Kr8pdkZJZY public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4SGWNm9TD3ZACEqJ9fmnWL1ZF47q text , reference has_port 4CLeCb8bTxYAjEFuAXtr5VmQW6FE text , reference port p8uqDVjGDrU4Eg9axo7dsTkztws text . named identifier w7yWEPLwtMpd5GnNHsV5ASwVxkX uint16_t normal query boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1987 5 function 49Yox1iKKs7LmQ3wu1nCZXGKWEKf public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2N3uW9xQekt6pX19rHqrM5vcnVUH text , reference encoded_query 3VZ9J5FmgK7VsNUfrHxuyT4pNTGm text , reference has_query 21mA7muF2gpvzFjJxaqjvjnnm6XY text , reference params 2RJGYan9E8WvVKQM1LmRNNdUCc7E text . named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal scheme boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 421 5 function 4AoadMoEhkiTY9v83LDBwQt31Uti public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2wLECn7WbsBXGLpheUngfa9GEf1q text , reference scheme_id 3aL5x6QNsMGNDAo8DP539u5TsZpp text . named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core normal scheme_id boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 471 5 function 3aL5x6QNsMGNDAo8DP539u5TsZpp public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 tVuW4uzt1HMgUxPtxroTuMsNi2G 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 d3jNvGWyWHyaA1snRDXYWd5jjkA text . paragraph text Otherwise, if the scheme is absent the value returned is reference urls::scheme::none 2DEQCVdvMZA94BHRjTMB2n7Ttdp2 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 2wLECn7WbsBXGLpheUngfa9GEf1q text , reference scheme 4AoadMoEhkiTY9v83LDBwQt31Uti text . named identifier tVuW4uzt1HMgUxPtxroTuMsNi2G scheme identifier 2ejQGW57K8g7MFJhHAwPt5aumoLa urls normal segments boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1840 5 function 3YxJjcnyfcHtM9xLtszAHET8pyFv public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2hgDJpXv5LpubtS8phLLnGk4a7XZ text , reference encoded_path M5bG6HzwZUo4ycGCKLY5CsUUXun text , reference encoded_segments 3jZFG9bXfeYJfGzZnt2Zim38gmMB text . reference path wc1MNXXCH1K1Shz81BmxVy1opwc text , reference segments_view 2QU7risgZzo8F84g7LttC6dG1GsH text . named identifier 2QU7risgZzo8F84g7LttC6dG1GsH segments_view normal size boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 201 5 function 2Z9j51jzFxpMXyB1ZjxR329S4Puk public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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. named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std normal user boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 848 5 function 4Yfg3yG11SsLgpAe6dzENEPz39dk public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4QciDQp3vKjNuPEah54XMBvrjvyD text , reference has_userinfo 2x7XawH6QTh6eBg2hNRqzQ3WME2m text , reference encoded_password 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym text , reference encoded_user 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC text , reference encoded_userinfo 3qDJMHEiC1T5Vik6nGt2CJvFxFDM text , reference password 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL text , reference userinfo 24JMPq739KrKuemXwWK8zpXGtWvz text . named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal userinfo boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 748 5 function 24JMPq739KrKuemXwWK8zpXGtWvz public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4UumWzLNRv3vgTVdDkz5PVqdSsSL 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 4QciDQp3vKjNuPEah54XMBvrjvyD text , reference has_userinfo 2x7XawH6QTh6eBg2hNRqzQ3WME2m text , reference encoded_password 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym text , reference encoded_user 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC text , reference encoded_userinfo 3qDJMHEiC1T5Vik6nGt2CJvFxFDM text , reference password 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL text , reference user 4Yfg3yG11SsLgpAe6dzENEPz39dk text . named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal zone_id boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1480 5 function 3QgkE48ZuKvk3EGbnydRNa7ob9XL public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text If the host type is reference host_type::ipv6 2y7UTsNbko8TLegXS5EpSa1goNog 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 named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal operator basic_string_view<char> boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 299 5 function 3uYCaZr2Kk1eGAMsuRXTehXkXZwv public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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. named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core conversion max_size boost/url/url_view.hpp include/boost/url/url_view.hpp 365 5 function vh7YCFWtdcoNVetmju9YoNtWx1G public regular 3hrVvoVYoDkX9t3w9abTXxDqGRaW 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. named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std normal constexpr static 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 function 2TwwpddeAxzjzfbTirqgZeddg3n6 protected regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std salt 0 normal url_view_base boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 65 1 record 27ryuyAvvRyzfzgketja5uQcFBcK regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 75qVNpuBHShJ8KKEUv4RCrwxEAB paragraph reference url_view 3hrVvoVYoDkX9t3w9abTXxDqGRaW paragraph reference static_url 48MaMwY7JqeST8Mfy8WBA7wGLSzT unordered heading text Functions 1 list paragraph reference parse_absolute_uri 2ARWB82XdRYexehQmFQZjcEKzoSi paragraph reference parse_origin_form YwftbCXGz1kG5uRUguacNEwrkaP paragraph reference parse_relative_ref u1SFmy6a6wtXTYxrMnssMwa7K6G paragraph reference parse_uri 2nNq8RtS22vhgfkFAo8dGh6NW87n paragraph reference parse_uri_reference 4KCrVrNi2iTJ15zBNtvdSNip4rmV unordered brief text Common functionality for containers reference resolve 4ZbWvyKBMwfyhwwk3YYEco8ttTeS other __visibility__ class 2TREmHUMfZeMQz9yyw5HzqB91APN 3hrVvoVYoDkX9t3w9abTXxDqGRaW 3fqhU2zdn6LwiSAm9upTzbtboK1U 3ESzuLSF2zD1TghU6qemdUksdP2V 3Lh94K8cNrPFyFYw36XmhhtFMLpf VbvXoprikWfUm5mR56ZFYECXt9J 4DmmNdXmY3VWyP6HoKWQVEExBzaV 2GaF4F3gH2Y5LkyYXCrr3VyP9tpJ ipF8M41qPyuMM5XLe5JGZYSc42h FMBiWLrznwNXgkDuu4xneE9NeCD 3oodjUy4VDbgnxfeqkxwvqQvf7hK 4SGWNm9TD3ZACEqJ9fmnWL1ZF47q 492Pha8s74Xj1GjgZ82x193B56bP 3gVZJ5SpfCzYoZgafZW71cueQ3u3 2N3uW9xQekt6pX19rHqrM5vcnVUH 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym M5bG6HzwZUo4ycGCKLY5CsUUXun 3VZ9J5FmgK7VsNUfrHxuyT4pNTGm 3oB1p7aLxKXx3FxEqHaKSnCiNfXM 3jZFG9bXfeYJfGzZnt2Zim38gmMB UJaw1aYaRaLhmYt2h416g598hi4 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC 3qDJMHEiC1T5Vik6nGt2CJvFxFDM 4Bt9AGe8WEFmjA79MWAiGPDtMUW8 2T5XA2udwnVeh4RFi6U9UrLirJFJ 2omNW7ayWzkboBBXgc2Rm6C4y5kb 2RYFJUJHdYjygxHWSb57bHWfkHgN 4QciDQp3vKjNuPEah54XMBvrjvyD 4CLeCb8bTxYAjEFuAXtr5VmQW6FE 21mA7muF2gpvzFjJxaqjvjnnm6XY 2wLECn7WbsBXGLpheUngfa9GEf1q 2x7XawH6QTh6eBg2hNRqzQ3WME2m SytR6d7pUELeR1RNUpcWrXWQcY8 KoSC71QaaCYQtpr7xCwndbzWaKR Zvcpzzy9h3HWgiqp7UZuEiWf4A7 9sSdyLcyHxeuasmCKqifZp3ga5s 4E8a8HgQbryrd4KcNHFajdVyLWib 2gNagLmHXZAqycctaaYmEYZc9pv mSWKjRHEDFTnpxGSra6Q5eS7fjS 2hgDJpXv5LpubtS8phLLnGk4a7XZ 2RJGYan9E8WvVKQM1LmRNNdUCc7E 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL wc1MNXXCH1K1Shz81BmxVy1opwc 2aNVu1ZJUXAnkA1MUK2cfojoNCyj p8uqDVjGDrU4Eg9axo7dsTkztws 363HbS6bzsgdHiLTk4Kr8pdkZJZY 49Yox1iKKs7LmQ3wu1nCZXGKWEKf 4AoadMoEhkiTY9v83LDBwQt31Uti 3aL5x6QNsMGNDAo8DP539u5TsZpp 3YxJjcnyfcHtM9xLtszAHET8pyFv 2Z9j51jzFxpMXyB1ZjxR329S4Puk 4Yfg3yG11SsLgpAe6dzENEPz39dk 24JMPq739KrKuemXwWK8zpXGtWvz 3QgkE48ZuKvk3EGbnydRNa7ob9XL 3uYCaZr2Kk1eGAMsuRXTehXkXZwv 39V9A9oqw6EqsRw4R5mxeMpeqePo 2TwwpddeAxzjzfbTirqgZeddg3n6 8engZzCuXMxFbXxDgzHBL33tej8 HhxcVzewagXK11ooDB4wdCWZ3JN Q9iEtdCuUziLxPG8KeW84KLUMoD CwZ4bVPjnMyCbXNQYkVmdvcdVcV 2EbGP8nXSdc55Ya9SNhxjcju2q3W kQ75BAf1XwqkfKbCcF6CVmVsbLF 2WQrPSULa5sDmBJZZUmZVGtNXXX4 3oAwiVUQGZVZ8idchisKnu4LLhgU 2BjQWbA94HXzpMQX4FBHh3aYTq2U 2V16XgrptBcWFtoZaJ3DExhQXY6 3CgAf4w5dyww6CMhGWkJm1fJiHum 3QqsgavNMQTmxMW1t9qAoAocshM6 22wNuw5VxKWrVLMDGM9VPFjJshU6 tkwNEJdWJqwprh85787u3xpyauu GhudPV3CuyCeCKSftvpKEQLQtJ4 named identifier 2QU7risgZzo8F84g7LttC6dG1GsH segments_view 2QU7risgZzo8F84g7LttC6dG1GsH named identifier 3sLepuFTMctJHoZrLv8tvJTFkDPS segments_ref 3sLepuFTMctJHoZrLv8tvJTFkDPS named identifier GKjeDHooSf2HAMf239p3oFfT3i3 segments_encoded_view GKjeDHooSf2HAMf239p3oFfT3i3 named identifier 24XcpKBAcyXN6FLZk8kR4zGAmKak segments_encoded_ref 24XcpKBAcyXN6FLZk8kR4zGAmKak named identifier 3P1yc8wQhLivRSyTPUbRYh2dtWLg segments_encoded_base 3P1yc8wQhLivRSyTPUbRYh2dtWLg named identifier 2ozZGf8LNFZmRaMXAL5TZg2G1emh segments_base 2ozZGf8LNFZmRaMXAL5TZg2G1emh named identifier DJiFqyFR7zZh4N3HNJHhiAj7JPV params_view DJiFqyFR7zZh4N3HNJHhiAj7JPV named identifier 4MtPiWDytNMbqCE6iciHidLK5Y4c params_ref 4MtPiWDytNMbqCE6iciHidLK5Y4c named identifier 3w4FJjjADY3EEHqUmBj5mvDKqdEB params_encoded_view 3w4FJjjADY3EEHqUmBj5mvDKqdEB named identifier 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe params_encoded_ref 3FBzcR2Jfn3yUAXxqBaEA7FzdXBe named identifier 44gF3RWPKyorxySQWG1hnA4vjiJu params_encoded_base 44gF3RWPKyorxySQWG1hnA4vjiJu named identifier 3JqzyR89pExMFqZFBHMskoM3dq3x params_base 3JqzyR89pExMFqZFBHMskoM3dq3x named identifier 2egpzk38s9q8jE4fNG71Y15WvAVC static_url_base 2egpzk38s9q8jE4fNG71Y15WvAVC named identifier 3hrVvoVYoDkX9t3w9abTXxDqGRaW url_view 3hrVvoVYoDkX9t3w9abTXxDqGRaW named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base 2TREmHUMfZeMQz9yyw5HzqB91APN named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url 75qVNpuBHShJ8KKEUv4RCrwxEAB authority boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 564 5 function 3fqhU2zdn6LwiSAm9upTzbtboK1U public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text This function returns the authority as an reference authority_view 2fwXocwnoAG9WDGbqM3quKphV1qq 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 2GaF4F3gH2Y5LkyYXCrr3VyP9tpJ text , reference has_authority 2omNW7ayWzkboBBXgc2Rm6C4y5kb text . named identifier 2fwXocwnoAG9WDGbqM3quKphV1qq authority_view normal buffer boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 282 5 function 3ESzuLSF2zD1TghU6qemdUksdP2V public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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. named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core normal compare boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2446 5 function 3Lh94K8cNrPFyFYw36XmhhtFMLpf public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 named identifier int int lvalue-reference named identifier 27ryuyAvvRyzfzgketja5uQcFBcK url_view_base other normal data boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 258 5 function VbvXoprikWfUm5mR56ZFYECXt9J public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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. pointer named identifier char char normal empty boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 238 5 function 4DmmNdXmY3VWyP6HoKWQVEExBzaV public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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. named identifier bool bool normal encoded_authority boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 601 5 function 2GaF4F3gH2Y5LkyYXCrr3VyP9tpJ public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 3fqhU2zdn6LwiSAm9upTzbtboK1U text , reference has_authority 2omNW7ayWzkboBBXgc2Rm6C4y5kb text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_fragment boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2280 5 function ipF8M41qPyuMM5XLe5JGZYSc42h public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2T5XA2udwnVeh4RFi6U9UrLirJFJ text , reference has_fragment 2RYFJUJHdYjygxHWSb57bHWfkHgN text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_host boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1120 5 function FMBiWLrznwNXgkDuu4xneE9NeCD public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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. named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_host_address boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1237 5 function 3oodjUy4VDbgnxfeqkxwvqQvf7hK public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text The value returned by this function depends on the type of host returned from the function reference host_type mSWKjRHEDFTnpxGSra6Q5eS7fjS text . list paragraph text If the type is reference host_type::ipv4 4B5yLFvhkpef7XX8ryKTaBWz8d6D text , then the IPv4 address string is returned. paragraph text If the type is reference host_type::ipv6 2y7UTsNbko8TLegXS5EpSa1goNog text , then the IPv6 address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::ipvfuture 25qx7TTMyctoe4LxqgMPXccSpy5Q text , then the IPvFuture address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::name QfoSUW8M1SPUL5EFVKwAUabTKCa 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 wGjRbosZ4DQY7xCpjwAZqPVHiim 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. named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_host_and_port boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2325 5 function 4SGWNm9TD3ZACEqJ9fmnWL1ZF47q public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4CLeCb8bTxYAjEFuAXtr5VmQW6FE text , reference port p8uqDVjGDrU4Eg9axo7dsTkztws text , reference port_number 363HbS6bzsgdHiLTk4Kr8pdkZJZY text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_host_name boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1441 5 function 492Pha8s74Xj1GjgZ82x193B56bP public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text If the host type is reference host_type::name QfoSUW8M1SPUL5EFVKwAUabTKCa 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. named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_origin boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2355 5 function 3gVZJ5SpfCzYoZgafZW71cueQ3u3 public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 3oB1p7aLxKXx3FxEqHaKSnCiNfXM text , reference encoded_target UJaw1aYaRaLhmYt2h416g598hi4 text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_params boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2130 5 function 2N3uW9xQekt6pX19rHqrM5vcnVUH public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 3VZ9J5FmgK7VsNUfrHxuyT4pNTGm text , reference has_query 21mA7muF2gpvzFjJxaqjvjnnm6XY text , reference params 2RJGYan9E8WvVKQM1LmRNNdUCc7E text , reference query 49Yox1iKKs7LmQ3wu1nCZXGKWEKf text . named identifier 3w4FJjjADY3EEHqUmBj5mvDKqdEB params_encoded_view normal encoded_password boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 996 5 function 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4QciDQp3vKjNuPEah54XMBvrjvyD text , reference has_userinfo 2x7XawH6QTh6eBg2hNRqzQ3WME2m text , reference encoded_user 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC text , reference encoded_userinfo 3qDJMHEiC1T5Vik6nGt2CJvFxFDM text , reference password 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL text , reference user 4Yfg3yG11SsLgpAe6dzENEPz39dk text , reference userinfo 24JMPq739KrKuemXwWK8zpXGtWvz text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_path boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1799 5 function M5bG6HzwZUo4ycGCKLY5CsUUXun public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2hgDJpXv5LpubtS8phLLnGk4a7XZ text , reference encoded_segments 3jZFG9bXfeYJfGzZnt2Zim38gmMB text . reference path wc1MNXXCH1K1Shz81BmxVy1opwc text , reference segments 3YxJjcnyfcHtM9xLtszAHET8pyFv text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_query boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2040 5 function 3VZ9J5FmgK7VsNUfrHxuyT4pNTGm public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2N3uW9xQekt6pX19rHqrM5vcnVUH text , reference has_query 21mA7muF2gpvzFjJxaqjvjnnm6XY text , reference params 2RJGYan9E8WvVKQM1LmRNNdUCc7E text , reference query 49Yox1iKKs7LmQ3wu1nCZXGKWEKf text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_resource boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2387 5 function 3oB1p7aLxKXx3FxEqHaKSnCiNfXM public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 3gVZJ5SpfCzYoZgafZW71cueQ3u3 text , reference encoded_target UJaw1aYaRaLhmYt2h416g598hi4 text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_segments boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1891 5 function 3jZFG9bXfeYJfGzZnt2Zim38gmMB public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2hgDJpXv5LpubtS8phLLnGk4a7XZ text , reference encoded_path M5bG6HzwZUo4ycGCKLY5CsUUXun text , reference path wc1MNXXCH1K1Shz81BmxVy1opwc text , reference segments 3YxJjcnyfcHtM9xLtszAHET8pyFv text , reference segments_encoded_view GKjeDHooSf2HAMf239p3oFfT3i3 text . named identifier GKjeDHooSf2HAMf239p3oFfT3i3 segments_encoded_view normal encoded_target boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2419 5 function UJaw1aYaRaLhmYt2h416g598hi4 public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 3gVZJ5SpfCzYoZgafZW71cueQ3u3 text , reference encoded_resource 3oB1p7aLxKXx3FxEqHaKSnCiNfXM text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_user boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 901 5 function 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4QciDQp3vKjNuPEah54XMBvrjvyD text , reference has_userinfo 2x7XawH6QTh6eBg2hNRqzQ3WME2m text , reference encoded_password 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym text , reference encoded_userinfo 3qDJMHEiC1T5Vik6nGt2CJvFxFDM text , reference password 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL text , reference user 4Yfg3yG11SsLgpAe6dzENEPz39dk text , reference userinfo 24JMPq739KrKuemXwWK8zpXGtWvz text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_userinfo boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 800 5 function 3qDJMHEiC1T5Vik6nGt2CJvFxFDM public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4QciDQp3vKjNuPEah54XMBvrjvyD text , reference has_userinfo 2x7XawH6QTh6eBg2hNRqzQ3WME2m text , reference encoded_password 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym text , reference encoded_user 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC text , reference password 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL text , reference user 4Yfg3yG11SsLgpAe6dzENEPz39dk text , reference userinfo 24JMPq739KrKuemXwWK8zpXGtWvz text . named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal encoded_zone_id boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1526 5 function 4Bt9AGe8WEFmjA79MWAiGPDtMUW8 public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text If the host type is reference host_type::ipv6 2y7UTsNbko8TLegXS5EpSa1goNog 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. named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view normal fragment boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2233 5 function 2T5XA2udwnVeh4RFi6U9UrLirJFJ public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 ipF8M41qPyuMM5XLe5JGZYSc42h text , reference has_fragment 2RYFJUJHdYjygxHWSb57bHWfkHgN text . named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal has_authority boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 528 5 function 2omNW7ayWzkboBBXgc2Rm6C4y5kb public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 3fqhU2zdn6LwiSAm9upTzbtboK1U text , reference encoded_authority 2GaF4F3gH2Y5LkyYXCrr3VyP9tpJ text . named identifier bool bool normal has_fragment boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2173 5 function 2RYFJUJHdYjygxHWSb57bHWfkHgN public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 ipF8M41qPyuMM5XLe5JGZYSc42h text , reference fragment 2T5XA2udwnVeh4RFi6U9UrLirJFJ text . named identifier bool bool normal has_password boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 689 5 function 4QciDQp3vKjNuPEah54XMBvrjvyD public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2x7XawH6QTh6eBg2hNRqzQ3WME2m text , reference encoded_password 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym text , reference encoded_user 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC text , reference encoded_userinfo 3qDJMHEiC1T5Vik6nGt2CJvFxFDM text , reference password 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL text , reference user 4Yfg3yG11SsLgpAe6dzENEPz39dk text , reference userinfo 24JMPq739KrKuemXwWK8zpXGtWvz text . named identifier bool bool normal has_port boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1568 5 function 4CLeCb8bTxYAjEFuAXtr5VmQW6FE public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4SGWNm9TD3ZACEqJ9fmnWL1ZF47q text , reference port p8uqDVjGDrU4Eg9axo7dsTkztws text , reference port_number 363HbS6bzsgdHiLTk4Kr8pdkZJZY text . named identifier bool bool normal has_query boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1937 5 function 21mA7muF2gpvzFjJxaqjvjnnm6XY public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2N3uW9xQekt6pX19rHqrM5vcnVUH text , reference encoded_query 3VZ9J5FmgK7VsNUfrHxuyT4pNTGm text , reference params 2RJGYan9E8WvVKQM1LmRNNdUCc7E text , reference query 49Yox1iKKs7LmQ3wu1nCZXGKWEKf text . named identifier bool bool normal has_scheme boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 384 5 function 2wLECn7WbsBXGLpheUngfa9GEf1q public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4AoadMoEhkiTY9v83LDBwQt31Uti text , reference scheme_id 3aL5x6QNsMGNDAo8DP539u5TsZpp text . named identifier bool bool normal has_userinfo boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 647 5 function 2x7XawH6QTh6eBg2hNRqzQ3WME2m public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4QciDQp3vKjNuPEah54XMBvrjvyD text , reference encoded_password 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym text , reference encoded_user 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC text , reference encoded_userinfo 3qDJMHEiC1T5Vik6nGt2CJvFxFDM text , reference password 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL text , reference user 4Yfg3yG11SsLgpAe6dzENEPz39dk text , reference userinfo 24JMPq739KrKuemXwWK8zpXGtWvz text . named identifier bool bool normal host boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1076 5 function SytR6d7pUELeR1RNUpcWrXWQcY8 public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal host_address boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1174 5 function KoSC71QaaCYQtpr7xCwndbzWaKR public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text The value returned by this function depends on the type of host returned from the function reference host_type mSWKjRHEDFTnpxGSra6Q5eS7fjS text . list paragraph text If the type is reference host_type::ipv4 4B5yLFvhkpef7XX8ryKTaBWz8d6D text , then the IPv4 address string is returned. paragraph text If the type is reference host_type::ipv6 2y7UTsNbko8TLegXS5EpSa1goNog text , then the IPv6 address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::ipvfuture 25qx7TTMyctoe4LxqgMPXccSpy5Q text , then the IPvFuture address string is returned, without any enclosing brackets. paragraph text If the type is reference host_type::name QfoSUW8M1SPUL5EFVKwAUabTKCa 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 wGjRbosZ4DQY7xCpjwAZqPVHiim 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 named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal host_ipv4_address boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1277 5 function Zvcpzzy9h3HWgiqp7UZuEiWf4A7 public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text If the host type is reference host_type::ipv4 4B5yLFvhkpef7XX8ryKTaBWz8d6D text , this function returns the address as a value of type reference ipv4_address 4Xmd9k1GBKGKQj6PYc1qdt4tMUae 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 4Xmd9k1GBKGKQj6PYc1qdt4tMUae text . named identifier 4Xmd9k1GBKGKQj6PYc1qdt4tMUae ipv4_address normal host_ipv6_address boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1325 5 function 9sSdyLcyHxeuasmCKqifZp3ga5s public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text If the host type is reference host_type::ipv6 2y7UTsNbko8TLegXS5EpSa1goNog text , this function returns the address as a value of type reference ipv6_address 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T 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 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T text . named identifier 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T ipv6_address normal host_ipvfuture boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1358 5 function 4E8a8HgQbryrd4KcNHFajdVyLWib public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text If the host type is reference host_type::ipvfuture 25qx7TTMyctoe4LxqgMPXccSpy5Q 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. named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core normal host_name boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1395 5 function 2gNagLmHXZAqycctaaYmEYZc9pv public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text If the host type is reference host_type::name QfoSUW8M1SPUL5EFVKwAUabTKCa 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 named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal host_type boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1036 5 function mSWKjRHEDFTnpxGSra6Q5eS7fjS public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text This function returns one of the following constants representing the type of host present. list paragraph reference host_type::ipv4 4B5yLFvhkpef7XX8ryKTaBWz8d6D paragraph reference host_type::ipv6 2y7UTsNbko8TLegXS5EpSa1goNog paragraph reference host_type::ipvfuture 25qx7TTMyctoe4LxqgMPXccSpy5Q paragraph reference host_type::name QfoSUW8M1SPUL5EFVKwAUabTKCa paragraph reference host_type::none wGjRbosZ4DQY7xCpjwAZqPVHiim unordered paragraph text When reference has_authority 2omNW7ayWzkboBBXgc2Rm6C4y5kb text is false, the host type is reference host_type::none wGjRbosZ4DQY7xCpjwAZqPVHiim 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. named identifier 2M8hT55CSziFA9Zup4mKYdwvgUiE host_type identifier 2ejQGW57K8g7MFJhHAwPt5aumoLa urls normal is_path_absolute boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1691 5 function 2hgDJpXv5LpubtS8phLLnGk4a7XZ public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 M5bG6HzwZUo4ycGCKLY5CsUUXun text , reference encoded_segments 3jZFG9bXfeYJfGzZnt2Zim38gmMB text . reference path wc1MNXXCH1K1Shz81BmxVy1opwc text , reference segments 3YxJjcnyfcHtM9xLtszAHET8pyFv text . named identifier bool bool normal params boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2084 5 boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2087 5 overloads 2RJGYan9E8WvVKQM1LmRNNdUCc7E public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2U5LKGfgSLLAxqQ86nkdDqCLX4FS 2Dh1FrqKLpBQUzJVYtqvr6ziuTX6 named identifier DJiFqyFR7zZh4N3HNJHhiAj7JPV params_view params boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2084 5 function 2U5LKGfgSLLAxqQ86nkdDqCLX4FS public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2N3uW9xQekt6pX19rHqrM5vcnVUH text , reference encoded_query 3VZ9J5FmgK7VsNUfrHxuyT4pNTGm text , reference has_query 21mA7muF2gpvzFjJxaqjvjnnm6XY text , reference query 49Yox1iKKs7LmQ3wu1nCZXGKWEKf text . named identifier DJiFqyFR7zZh4N3HNJHhiAj7JPV params_view normal params boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2087 5 function 2Dh1FrqKLpBQUzJVYtqvr6ziuTX6 public regular 27ryuyAvvRyzfzgketja5uQcFBcK named identifier DJiFqyFR7zZh4N3HNJHhiAj7JPV params_view named identifier 5dyN7z5egGMdJFpXz9WbaL549xC encoding_opts opt normal password boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 947 5 function 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4QciDQp3vKjNuPEah54XMBvrjvyD text , reference has_userinfo 2x7XawH6QTh6eBg2hNRqzQ3WME2m text , reference encoded_password 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym text , reference encoded_user 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC text , reference encoded_userinfo 3qDJMHEiC1T5Vik6nGt2CJvFxFDM text , reference user 4Yfg3yG11SsLgpAe6dzENEPz39dk text , reference userinfo 24JMPq739KrKuemXwWK8zpXGtWvz text . named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal path boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1744 5 function wc1MNXXCH1K1Shz81BmxVy1opwc public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2hgDJpXv5LpubtS8phLLnGk4a7XZ text , reference encoded_path M5bG6HzwZUo4ycGCKLY5CsUUXun text , reference encoded_segments 3jZFG9bXfeYJfGzZnt2Zim38gmMB text . reference segments 3YxJjcnyfcHtM9xLtszAHET8pyFv text . named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal persist boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 341 5 function 2aNVu1ZJUXAnkA1MUK2cfojoNCyj public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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. named specialization 3ndPMWYzhtTVAVCHsDKjaQkrDfmC shared_ptr identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std type named identifier 3hrVvoVYoDkX9t3w9abTXxDqGRaW url_view normal port boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1604 5 function p8uqDVjGDrU4Eg9axo7dsTkztws public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4SGWNm9TD3ZACEqJ9fmnWL1ZF47q text , reference has_port 4CLeCb8bTxYAjEFuAXtr5VmQW6FE text , reference port_number 363HbS6bzsgdHiLTk4Kr8pdkZJZY text . named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core normal port_number boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1640 5 function 363HbS6bzsgdHiLTk4Kr8pdkZJZY public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4SGWNm9TD3ZACEqJ9fmnWL1ZF47q text , reference has_port 4CLeCb8bTxYAjEFuAXtr5VmQW6FE text , reference port p8uqDVjGDrU4Eg9axo7dsTkztws text . named identifier w7yWEPLwtMpd5GnNHsV5ASwVxkX uint16_t normal query boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1987 5 function 49Yox1iKKs7LmQ3wu1nCZXGKWEKf public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2N3uW9xQekt6pX19rHqrM5vcnVUH text , reference encoded_query 3VZ9J5FmgK7VsNUfrHxuyT4pNTGm text , reference has_query 21mA7muF2gpvzFjJxaqjvjnnm6XY text , reference params 2RJGYan9E8WvVKQM1LmRNNdUCc7E text . named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal scheme boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 421 5 function 4AoadMoEhkiTY9v83LDBwQt31Uti public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2wLECn7WbsBXGLpheUngfa9GEf1q text , reference scheme_id 3aL5x6QNsMGNDAo8DP539u5TsZpp text . named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core normal scheme_id boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 471 5 function 3aL5x6QNsMGNDAo8DP539u5TsZpp public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 tVuW4uzt1HMgUxPtxroTuMsNi2G 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 d3jNvGWyWHyaA1snRDXYWd5jjkA text . paragraph text Otherwise, if the scheme is absent the value returned is reference urls::scheme::none 2DEQCVdvMZA94BHRjTMB2n7Ttdp2 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 2wLECn7WbsBXGLpheUngfa9GEf1q text , reference scheme 4AoadMoEhkiTY9v83LDBwQt31Uti text . named identifier tVuW4uzt1HMgUxPtxroTuMsNi2G scheme identifier 2ejQGW57K8g7MFJhHAwPt5aumoLa urls normal segments boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1840 5 function 3YxJjcnyfcHtM9xLtszAHET8pyFv public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 2hgDJpXv5LpubtS8phLLnGk4a7XZ text , reference encoded_path M5bG6HzwZUo4ycGCKLY5CsUUXun text , reference encoded_segments 3jZFG9bXfeYJfGzZnt2Zim38gmMB text . reference path wc1MNXXCH1K1Shz81BmxVy1opwc text , reference segments_view 2QU7risgZzo8F84g7LttC6dG1GsH text . named identifier 2QU7risgZzo8F84g7LttC6dG1GsH segments_view normal size boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 201 5 function 2Z9j51jzFxpMXyB1ZjxR329S4Puk public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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. named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std normal user boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 848 5 function 4Yfg3yG11SsLgpAe6dzENEPz39dk public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4QciDQp3vKjNuPEah54XMBvrjvyD text , reference has_userinfo 2x7XawH6QTh6eBg2hNRqzQ3WME2m text , reference encoded_password 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym text , reference encoded_user 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC text , reference encoded_userinfo 3qDJMHEiC1T5Vik6nGt2CJvFxFDM text , reference password 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL text , reference userinfo 24JMPq739KrKuemXwWK8zpXGtWvz text . named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal userinfo boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 748 5 function 24JMPq739KrKuemXwWK8zpXGtWvz public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 4UumWzLNRv3vgTVdDkz5PVqdSsSL 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 4QciDQp3vKjNuPEah54XMBvrjvyD text , reference has_userinfo 2x7XawH6QTh6eBg2hNRqzQ3WME2m text , reference encoded_password 2HDkV7JEPi5VoLU76HYZ95Hgh7Ym text , reference encoded_user 3FY7gR3dKVZ7cxjhoUCyuSe4ePtC text , reference encoded_userinfo 3qDJMHEiC1T5Vik6nGt2CJvFxFDM text , reference password 4Uf8MR1gCq2RodQ5QmqyxWYzUsLL text , reference user 4Yfg3yG11SsLgpAe6dzENEPz39dk text . named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal zone_id boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 1480 5 function 3QgkE48ZuKvk3EGbnydRNa7ob9XL public regular 27ryuyAvvRyzfzgketja5uQcFBcK paragraph text If the host type is reference host_type::ipv6 2y7UTsNbko8TLegXS5EpSa1goNog 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 named identifier result_type identifier StringToken rvalue-reference named identifier StringToken token {} normal operator basic_string_view<char> boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 299 5 function 3uYCaZr2Kk1eGAMsuRXTehXkXZwv public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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. named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core conversion max_size boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 173 5 function 39V9A9oqw6EqsRw4R5mxeMpeqePo public regular 27ryuyAvvRyzfzgketja5uQcFBcK 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. named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std normal constexpr static 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 function 2TwwpddeAxzjzfbTirqgZeddg3n6 protected regular 27ryuyAvvRyzfzgketja5uQcFBcK 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 named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std salt 0 normal error boost/url/error.hpp include/boost/url/error.hpp 22 1 enum 3uBPnjWo3AGtWCgQC8qvoJGUhjbU regular 2ejQGW57K8g7MFJhHAwPt5aumoLa brief text Error codes returned the library named identifier int int 24Cw32XTd3zbpxkDjtyE6KRgnBzT 3TEDoscPNmgQhUzRrssjR1yUxx6f 2zdi7kBQxTsXFMmty8t6Szc5vTyC ck2DttsM2gDM1U5acF1DMuLU9oi 3HStCMfbwKUr6qSXcHDh6aTq3aYw 3Mnei6J4Jb95WJXiYPqfY6M7AcvQ 2LTxbvBSVyUZ1chs1aqv2ibpgR6T wqxPD91Mh4ZwpDfJUXBC93A6U2R 4LBvvq1hZF9zabrZfsPQPk9g1wPP success boost/url/error.hpp include/boost/url/error.hpp 30 5 enum-constant 24Cw32XTd3zbpxkDjtyE6KRgnBzT regular 3uBPnjWo3AGtWCgQC8qvoJGUhjbU brief text The operation completed successfully. 0 0 illegal_null boost/url/error.hpp include/boost/url/error.hpp 35 5 enum-constant 3TEDoscPNmgQhUzRrssjR1yUxx6f regular 3uBPnjWo3AGtWCgQC8qvoJGUhjbU brief text Null encountered in pct-encoded. illegal_reserved_char boost/url/error.hpp include/boost/url/error.hpp 40 5 enum-constant 2zdi7kBQxTsXFMmty8t6Szc5vTyC regular 3uBPnjWo3AGtWCgQC8qvoJGUhjbU brief text Illegal reserved character in encoded string. non_canonical boost/url/error.hpp include/boost/url/error.hpp 45 5 enum-constant ck2DttsM2gDM1U5acF1DMuLU9oi regular 3uBPnjWo3AGtWCgQC8qvoJGUhjbU brief text A grammar element was not in canonical form. bad_pct_hexdig boost/url/error.hpp include/boost/url/error.hpp 54 5 enum-constant 3HStCMfbwKUr6qSXcHDh6aTq3aYw regular 3uBPnjWo3AGtWCgQC8qvoJGUhjbU 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 enum-constant 3Mnei6J4Jb95WJXiYPqfY6M7AcvQ regular 3uBPnjWo3AGtWCgQC8qvoJGUhjbU 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 enum-constant 2LTxbvBSVyUZ1chs1aqv2ibpgR6T regular 3uBPnjWo3AGtWCgQC8qvoJGUhjbU 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 enum-constant wqxPD91Mh4ZwpDfJUXBC93A6U2R regular 3uBPnjWo3AGtWCgQC8qvoJGUhjbU 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 enum-constant 4LBvvq1hZF9zabrZfsPQPk9g1wPP regular 3uBPnjWo3AGtWCgQC8qvoJGUhjbU brief text The URL is not a base URL host_type boost/url/host_type.hpp include/boost/url/host_type.hpp 24 1 enum 2M8hT55CSziFA9Zup4mKYdwvgUiE regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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. named identifier int int wGjRbosZ4DQY7xCpjwAZqPVHiim QfoSUW8M1SPUL5EFVKwAUabTKCa 4B5yLFvhkpef7XX8ryKTaBWz8d6D 2y7UTsNbko8TLegXS5EpSa1goNog 25qx7TTMyctoe4LxqgMPXccSpy5Q none boost/url/host_type.hpp include/boost/url/host_type.hpp 32 5 enum-constant wGjRbosZ4DQY7xCpjwAZqPVHiim regular 2M8hT55CSziFA9Zup4mKYdwvgUiE brief text No host is specified. name boost/url/host_type.hpp include/boost/url/host_type.hpp 37 5 enum-constant QfoSUW8M1SPUL5EFVKwAUabTKCa regular 2M8hT55CSziFA9Zup4mKYdwvgUiE brief text A host is specified by reg-name. ipv4 boost/url/host_type.hpp include/boost/url/host_type.hpp 42 5 enum-constant 4B5yLFvhkpef7XX8ryKTaBWz8d6D regular 2M8hT55CSziFA9Zup4mKYdwvgUiE brief text A host is specified by reference ipv4_address 4Xmd9k1GBKGKQj6PYc1qdt4tMUae text . ipv6 boost/url/host_type.hpp include/boost/url/host_type.hpp 47 5 enum-constant 2y7UTsNbko8TLegXS5EpSa1goNog regular 2M8hT55CSziFA9Zup4mKYdwvgUiE brief text A host is specified by reference ipv6_address 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T text . ipvfuture boost/url/host_type.hpp include/boost/url/host_type.hpp 52 5 enum-constant 25qx7TTMyctoe4LxqgMPXccSpy5Q regular 2M8hT55CSziFA9Zup4mKYdwvgUiE brief text A host is specified by IPvFuture. scheme boost/url/scheme.hpp include/boost/url/scheme.hpp 34 1 enum tVuW4uzt1HMgUxPtxroTuMsNi2G regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 3vkqqomfBUowfgqyeii3TrJVgnxo reference string_to_scheme 2Cc8cH7Z7ExrsLbjk4geBrdf5cZS reference to_string 2XRMQjtBJPK89zguipj5hUZFjVnV named identifier unsigned short unsigned short 2DEQCVdvMZA94BHRjTMB2n7Ttdp2 d3jNvGWyWHyaA1snRDXYWd5jjkA 2foMFZRihajKbFwnARr6PAJqEvoK 3ckUhtiFfBnLcNcF7rQTkyKKirdJ 4X5HyawPjAos7WKdWGkUUnLtaWUy ZZ74AbrFQrD6Rwf2capZeB3Cqr2 bk2D7tgoSkkeqiW8tt6j3ryE3MN how1u1DwcuRHstRTyNSjw6rc9JH none boost/url/scheme.hpp include/boost/url/scheme.hpp 38 5 enum-constant 2DEQCVdvMZA94BHRjTMB2n7Ttdp2 regular tVuW4uzt1HMgUxPtxroTuMsNi2G brief text Indicates that no scheme is present 0 0 unknown boost/url/scheme.hpp include/boost/url/scheme.hpp 42 5 enum-constant d3jNvGWyWHyaA1snRDXYWd5jjkA regular tVuW4uzt1HMgUxPtxroTuMsNi2G brief text Indicates the scheme is not a well-known scheme ftp boost/url/scheme.hpp include/boost/url/scheme.hpp 56 5 enum-constant 2foMFZRihajKbFwnARr6PAJqEvoK regular tVuW4uzt1HMgUxPtxroTuMsNi2G 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 enum-constant 3ckUhtiFfBnLcNcF7rQTkyKKirdJ regular tVuW4uzt1HMgUxPtxroTuMsNi2G 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 enum-constant 4X5HyawPjAos7WKdWGkUUnLtaWUy regular tVuW4uzt1HMgUxPtxroTuMsNi2G 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 enum-constant ZZ74AbrFQrD6Rwf2capZeB3Cqr2 regular tVuW4uzt1HMgUxPtxroTuMsNi2G 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 enum-constant bk2D7tgoSkkeqiW8tt6j3ryE3MN regular tVuW4uzt1HMgUxPtxroTuMsNi2G 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 enum-constant how1u1DwcuRHstRTyNSjw6rc9JH regular tVuW4uzt1HMgUxPtxroTuMsNi2G 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 function ThuCYkNXzjJHhdcL2TZSz7uRwM7 regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 2QoWAGV4WnZixaqkFZhZFWzYzizZ text , reference format_to HqUWyeBKSK1fBrdG5vHTeybKMGZ text . named specialization QNkXGvn4uvcuVhhsDd6QgTGgpMa named_arg type named identifier T named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core name lvalue-reference named identifier T arg normal decode boost/url/decode.hpp include/boost/url/decode.hpp 100 1 boost/url/decode.hpp include/boost/url/decode.hpp 146 1 overloads F3NQkSa7n8MbRcZdK1PdHd8YmK2 regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 2n98RXQSUhcZj4MCxYG9tY6jiRfq text , reference decoded_size 4WeAoq3Y12sashfxn8vcwvrbe3Td text , reference encoding_opts 5dyN7z5egGMdJFpXz9WbaL549xC text , reference string_token::return_string 4UumWzLNRv3vgTVdDkz5PVqdSsSL text . see reference decoded_size 4WeAoq3Y12sashfxn8vcwvrbe3Td text , reference encoding_opts 5dyN7z5egGMdJFpXz9WbaL549xC text , reference make_pct_string_view 39Smh5do547A49AGGeWYMFmMKD3e text . normal 2n98RXQSUhcZj4MCxYG9tY6jiRfq msHh9BYhbb6G4WVw4VvqA5xehkR auto auto decode boost/url/decode.hpp include/boost/url/decode.hpp 146 1 function 2n98RXQSUhcZj4MCxYG9tY6jiRfq regular 2ejQGW57K8g7MFJhHAwPt5aumoLa paragraph text This function percent-decodes the specified string and returns the result using any reference string_token gXLgKAknGYwc12RGZfBgr4HdDCT 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 F3NQkSa7n8MbRcZdK1PdHd8YmK2 text , reference decoded_size 4WeAoq3Y12sashfxn8vcwvrbe3Td text , reference encoding_opts 5dyN7z5egGMdJFpXz9WbaL549xC text , reference string_token::return_string 4UumWzLNRv3vgTVdDkz5PVqdSsSL text . named specialization qQFMz11M2hdnkDE2M6AYnTSkQhv result identifier dgHcH1svHs5X3czTwE2RBXQ7tGq system type named identifier result_type identifier StringToken named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s named identifier 5dyN7z5egGMdJFpXz9WbaL549xC encoding_opts opt {} rvalue-reference named identifier StringToken token {} normal decode boost/url/decode.hpp include/boost/url/decode.hpp 100 1 function msHh9BYhbb6G4WVw4VvqA5xehkR regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 4WeAoq3Y12sashfxn8vcwvrbe3Td text , reference encoding_opts 5dyN7z5egGMdJFpXz9WbaL549xC text , reference make_pct_string_view 39Smh5do547A49AGGeWYMFmMKD3e text . named specialization qQFMz11M2hdnkDE2M6AYnTSkQhv result identifier dgHcH1svHs5X3czTwE2RBXQ7tGq system type named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std pointer named identifier char char dest named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std size named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s named identifier 5dyN7z5egGMdJFpXz9WbaL549xC encoding_opts opt {} normal decoded_size boost/url/decode.hpp include/boost/url/decode.hpp 54 1 function 4WeAoq3Y12sashfxn8vcwvrbe3Td regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 F3NQkSa7n8MbRcZdK1PdHd8YmK2 text , reference encoding_opts 5dyN7z5egGMdJFpXz9WbaL549xC text , reference make_pct_string_view 39Smh5do547A49AGGeWYMFmMKD3e text . named specialization qQFMz11M2hdnkDE2M6AYnTSkQhv result identifier dgHcH1svHs5X3czTwE2RBXQ7tGq system type named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal default_port boost/url/scheme.hpp include/boost/url/scheme.hpp 173 1 function 3vkqqomfBUowfgqyeii3TrJVgnxo regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 2foMFZRihajKbFwnARr6PAJqEvoK text = 21 paragraph reference scheme::http 4X5HyawPjAos7WKdWGkUUnLtaWUy text , reference scheme::ws bk2D7tgoSkkeqiW8tt6j3ryE3MN text = 80 paragraph reference scheme::https ZZ74AbrFQrD6Rwf2capZeB3Cqr2 text , reference scheme::wss how1u1DwcuRHstRTyNSjw6rc9JH 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 tVuW4uzt1HMgUxPtxroTuMsNi2G named identifier w7yWEPLwtMpd5GnNHsV5ASwVxkX uint16_t named identifier tVuW4uzt1HMgUxPtxroTuMsNi2G scheme s normal encode boost/url/encode.hpp include/boost/url/encode.hpp 119 1 boost/url/encode.hpp include/boost/url/encode.hpp 180 1 overloads 3xB3BfuNs4uV9HRTA6DGtHfJP2Wh regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 tz3SDJxAC1V6KXUE6FSHFhaPznT text , reference encoded_size 2KWV3g149ZmZytTFz7sErpzwi7zX text , reference encoding_opts 5dyN7z5egGMdJFpXz9WbaL549xC text , see reference encode tz3SDJxAC1V6KXUE6FSHFhaPznT text , reference encoded_size 2KWV3g149ZmZytTFz7sErpzwi7zX text , reference make_pct_string_view 39Smh5do547A49AGGeWYMFmMKD3e text . normal tz3SDJxAC1V6KXUE6FSHFhaPznT 3AEzTzXrB8V4xcwAuGey4mYBbdRD auto auto encode boost/url/encode.hpp include/boost/url/encode.hpp 180 1 function tz3SDJxAC1V6KXUE6FSHFhaPznT regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 3xB3BfuNs4uV9HRTA6DGtHfJP2Wh text , reference encoded_size 2KWV3g149ZmZytTFz7sErpzwi7zX text , reference encoding_opts 5dyN7z5egGMdJFpXz9WbaL549xC text , named identifier result_type identifier StringToken named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s lvalue-reference named identifier CS allowed named identifier 5dyN7z5egGMdJFpXz9WbaL549xC encoding_opts opt {} rvalue-reference named identifier StringToken token {} normal encode boost/url/encode.hpp include/boost/url/encode.hpp 119 1 function 3AEzTzXrB8V4xcwAuGey4mYBbdRD regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 3xB3BfuNs4uV9HRTA6DGtHfJP2Wh text , reference encoded_size 2KWV3g149ZmZytTFz7sErpzwi7zX text , reference make_pct_string_view 39Smh5do547A49AGGeWYMFmMKD3e text . named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std pointer named identifier char char dest named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std size named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s lvalue-reference named identifier CS allowed named identifier 5dyN7z5egGMdJFpXz9WbaL549xC encoding_opts opt {} normal encode_unsafe boost/url/encode.hpp include/boost/url/encode.hpp 128 1 function 3p6NFmVMACBg2TKNhjDgbqESkCqF implementation-defined 2ejQGW57K8g7MFJhHAwPt5aumoLa named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std pointer named identifier char char dest named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std size named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s lvalue-reference named identifier CS allowed named identifier 5dyN7z5egGMdJFpXz9WbaL549xC encoding_opts opt normal encoded_size boost/url/encode.hpp include/boost/url/encode.hpp 63 1 function 2KWV3g149ZmZytTFz7sErpzwi7zX regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 3xB3BfuNs4uV9HRTA6DGtHfJP2Wh text , reference encoding_opts 5dyN7z5egGMdJFpXz9WbaL549xC text , reference make_pct_string_view 39Smh5do547A49AGGeWYMFmMKD3e text . named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s lvalue-reference named identifier CS allowed named identifier 5dyN7z5egGMdJFpXz9WbaL549xC encoding_opts opt {} normal format boost/url/format.hpp include/boost/url/format.hpp 159 1 overloads 2QoWAGV4WnZixaqkFZhZFWzYzizZ regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 HqUWyeBKSK1fBrdG5vHTeybKMGZ text . see reference format_to HqUWyeBKSK1fBrdG5vHTeybKMGZ text , reference arg ThuCYkNXzjJHhdcL2TZSz7uRwM7 text . normal cuQ8MuepPWHG3r6QpaZ22LK8zmn 2EzepoMYt7Gu64d8BqD8A3pLzzj6 named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url format boost/url/format.hpp include/boost/url/format.hpp 338 1 function cuQ8MuepPWHG3r6QpaZ22LK8zmn regular 2ejQGW57K8g7MFJhHAwPt5aumoLa paragraph text Format arguments according to the format URL string into a reference url 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 HqUWyeBKSK1fBrdG5vHTeybKMGZ text . reference url 75qVNpuBHShJ8KKEUv4RCrwxEAB named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core fmt named specialization 474HF6bGJmJntnocv1iPAYL2crja initializer_list identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std type named identifier 2268wJ294zj5ry16xNemaWKRCZKm format_arg args normal format boost/url/format.hpp include/boost/url/format.hpp 159 1 function 2EzepoMYt7Gu64d8BqD8A3pLzzj6 regular 2ejQGW57K8g7MFJhHAwPt5aumoLa paragraph text Format arguments according to the format URL string into a reference url 75qVNpuBHShJ8KKEUv4RCrwxEAB 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 HqUWyeBKSK1fBrdG5vHTeybKMGZ text , reference arg ThuCYkNXzjJHhdcL2TZSz7uRwM7 text . reference url 75qVNpuBHShJ8KKEUv4RCrwxEAB named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core fmt rvalue-reference named identifier Args args normal format_to boost/url/format.hpp include/boost/url/format.hpp 243 1 overloads HqUWyeBKSK1fBrdG5vHTeybKMGZ regular 2ejQGW57K8g7MFJhHAwPt5aumoLa brief text Format arguments into a URL param text An object that derives from reference url_base 2TREmHUMfZeMQz9yyw5HzqB91APN 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 2QoWAGV4WnZixaqkFZhZFWzYzizZ text . normal 3bDKeYzcaysYNkwtHjg2EkeVGZf3 cLKVoifuzVMusLZv1zV2vk1L2K3 named identifier void void format_to boost/url/format.hpp include/boost/url/format.hpp 435 1 function 3bDKeYzcaysYNkwtHjg2EkeVGZf3 regular 2ejQGW57K8g7MFJhHAwPt5aumoLa paragraph text Format arguments according to the format URL string into a reference url_base 2TREmHUMfZeMQz9yyw5HzqB91APN 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 2TREmHUMfZeMQz9yyw5HzqB91APN 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 2QoWAGV4WnZixaqkFZhZFWzYzizZ text . reference static_url 48MaMwY7JqeST8Mfy8WBA7wGLSzT reference static_url_base 2egpzk38s9q8jE4fNG71Y15WvAVC reference url 75qVNpuBHShJ8KKEUv4RCrwxEAB reference url_base 2TREmHUMfZeMQz9yyw5HzqB91APN named identifier void void lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base u named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core fmt named specialization 474HF6bGJmJntnocv1iPAYL2crja initializer_list identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std type named identifier 2268wJ294zj5ry16xNemaWKRCZKm format_arg args normal format_to boost/url/format.hpp include/boost/url/format.hpp 243 1 function cLKVoifuzVMusLZv1zV2vk1L2K3 regular 2ejQGW57K8g7MFJhHAwPt5aumoLa paragraph text Format arguments according to the format URL string into a reference url_base 2TREmHUMfZeMQz9yyw5HzqB91APN 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 2TREmHUMfZeMQz9yyw5HzqB91APN 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 2QoWAGV4WnZixaqkFZhZFWzYzizZ text . reference static_url 48MaMwY7JqeST8Mfy8WBA7wGLSzT reference static_url_base 2egpzk38s9q8jE4fNG71Y15WvAVC reference url 75qVNpuBHShJ8KKEUv4RCrwxEAB reference url_base 2TREmHUMfZeMQz9yyw5HzqB91APN named identifier void void lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base u named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core fmt rvalue-reference named 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 function 39Smh5do547A49AGGeWYMFmMKD3e public regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 named specialization qQFMz11M2hdnkDE2M6AYnTSkQhv result identifier dgHcH1svHs5X3czTwE2RBXQ7tGq system type named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD 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 eUt91i1T5kbaJ9ChAK4r9wB4Z4T implementation-defined 2ejQGW57K8g7MFJhHAwPt5aumoLa named identifier 3ZY5EydXePv2wNz8JPvc5skA7Bn4 pct_string_view pointer named identifier char char data named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std size named identifier zA9RqMgBvBSA4UNfdU9ni3RAWBy size_t identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std decoded_size normal constexpr parse_absolute_uri boost/url/parse.hpp include/boost/url/parse.hpp 63 1 function 2ARWB82XdRYexehQmFQZjcEKzoSi regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 YwftbCXGz1kG5uRUguacNEwrkaP text , reference parse_relative_ref u1SFmy6a6wtXTYxrMnssMwa7K6G text , reference parse_uri 2nNq8RtS22vhgfkFAo8dGh6NW87n text , reference parse_uri_reference 4KCrVrNi2iTJ15zBNtvdSNip4rmV text , reference url_view 3hrVvoVYoDkX9t3w9abTXxDqGRaW text . reference url_view 3hrVvoVYoDkX9t3w9abTXxDqGRaW named specialization qQFMz11M2hdnkDE2M6AYnTSkQhv result identifier dgHcH1svHs5X3czTwE2RBXQ7tGq system type named identifier 3hrVvoVYoDkX9t3w9abTXxDqGRaW url_view named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal constexpr parse_authority boost/url/authority_view.hpp include/boost/url/authority_view.hpp 1589 1 function 2eeZHdWXgsV3fMDoL3MrbjDNWopq regular 2ejQGW57K8g7MFJhHAwPt5aumoLa paragraph text This function parses a string according to the authority grammar below, and returns an reference authority_view 2fwXocwnoAG9WDGbqM3quKphV1qq 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 2fwXocwnoAG9WDGbqM3quKphV1qq text . reference authority_view 2fwXocwnoAG9WDGbqM3quKphV1qq named specialization qQFMz11M2hdnkDE2M6AYnTSkQhv result identifier dgHcH1svHs5X3czTwE2RBXQ7tGq system type named identifier 2fwXocwnoAG9WDGbqM3quKphV1qq authority_view named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal constexpr parse_ipv4_address boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 361 1 function 45AWvW23tadRhrV2Rr5Wwg5c83dx regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 4Xmd9k1GBKGKQj6PYc1qdt4tMUae named specialization qQFMz11M2hdnkDE2M6AYnTSkQhv result identifier dgHcH1svHs5X3czTwE2RBXQ7tGq system type named identifier 4Xmd9k1GBKGKQj6PYc1qdt4tMUae ipv4_address named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal parse_ipv6_address boost/url/ipv6_address.hpp include/boost/url/ipv6_address.hpp 404 1 function 2WWWLGhxBBf6EtKLCdxA28UdXFJ1 regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T named specialization qQFMz11M2hdnkDE2M6AYnTSkQhv result identifier dgHcH1svHs5X3czTwE2RBXQ7tGq system type named identifier 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T ipv6_address named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal parse_origin_form boost/url/parse.hpp include/boost/url/parse.hpp 109 1 function YwftbCXGz1kG5uRUguacNEwrkaP regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 2ARWB82XdRYexehQmFQZjcEKzoSi text , reference parse_relative_ref u1SFmy6a6wtXTYxrMnssMwa7K6G text , reference parse_uri 2nNq8RtS22vhgfkFAo8dGh6NW87n text , reference parse_uri_reference 4KCrVrNi2iTJ15zBNtvdSNip4rmV text , reference url_view 3hrVvoVYoDkX9t3w9abTXxDqGRaW text . reference url_view 3hrVvoVYoDkX9t3w9abTXxDqGRaW named specialization qQFMz11M2hdnkDE2M6AYnTSkQhv result identifier dgHcH1svHs5X3czTwE2RBXQ7tGq system type named identifier 3hrVvoVYoDkX9t3w9abTXxDqGRaW url_view named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal constexpr 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 function 27xn5abqwdvTfjVgEWccUE46qWjE public regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 GKjeDHooSf2HAMf239p3oFfT3i3 text . named specialization qQFMz11M2hdnkDE2M6AYnTSkQhv result identifier dgHcH1svHs5X3czTwE2RBXQ7tGq system type named identifier GKjeDHooSf2HAMf239p3oFfT3i3 segments_encoded_view named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD 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 function 3aMNKrgRSuUL46UjPvkFSPkcStNk public regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 3w4FJjjADY3EEHqUmBj5mvDKqdEB text . named specialization qQFMz11M2hdnkDE2M6AYnTSkQhv result identifier dgHcH1svHs5X3czTwE2RBXQ7tGq system type named identifier 3w4FJjjADY3EEHqUmBj5mvDKqdEB params_encoded_view named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal parse_relative_ref boost/url/parse.hpp include/boost/url/parse.hpp 161 1 function u1SFmy6a6wtXTYxrMnssMwa7K6G regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 2ARWB82XdRYexehQmFQZjcEKzoSi text , reference parse_origin_form YwftbCXGz1kG5uRUguacNEwrkaP text , reference parse_uri 2nNq8RtS22vhgfkFAo8dGh6NW87n text , reference parse_uri_reference 4KCrVrNi2iTJ15zBNtvdSNip4rmV text , reference url_view 3hrVvoVYoDkX9t3w9abTXxDqGRaW text . reference url_view 3hrVvoVYoDkX9t3w9abTXxDqGRaW named specialization qQFMz11M2hdnkDE2M6AYnTSkQhv result identifier dgHcH1svHs5X3czTwE2RBXQ7tGq system type named identifier 3hrVvoVYoDkX9t3w9abTXxDqGRaW url_view named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal constexpr parse_uri boost/url/parse.hpp include/boost/url/parse.hpp 210 1 function 2nNq8RtS22vhgfkFAo8dGh6NW87n regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 2ARWB82XdRYexehQmFQZjcEKzoSi text , reference parse_origin_form YwftbCXGz1kG5uRUguacNEwrkaP text , reference parse_relative_ref u1SFmy6a6wtXTYxrMnssMwa7K6G text , reference parse_uri_reference 4KCrVrNi2iTJ15zBNtvdSNip4rmV text , reference url_view 3hrVvoVYoDkX9t3w9abTXxDqGRaW text . reference url_view 3hrVvoVYoDkX9t3w9abTXxDqGRaW named specialization qQFMz11M2hdnkDE2M6AYnTSkQhv result identifier dgHcH1svHs5X3czTwE2RBXQ7tGq system type named identifier 3hrVvoVYoDkX9t3w9abTXxDqGRaW url_view named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal constexpr parse_uri_reference boost/url/parse.hpp include/boost/url/parse.hpp 271 1 function 4KCrVrNi2iTJ15zBNtvdSNip4rmV regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 2ARWB82XdRYexehQmFQZjcEKzoSi text , reference parse_origin_form YwftbCXGz1kG5uRUguacNEwrkaP text , reference parse_relative_ref u1SFmy6a6wtXTYxrMnssMwa7K6G text , reference parse_uri 2nNq8RtS22vhgfkFAo8dGh6NW87n text , reference url_view 3hrVvoVYoDkX9t3w9abTXxDqGRaW text . reference url_view 3hrVvoVYoDkX9t3w9abTXxDqGRaW named specialization qQFMz11M2hdnkDE2M6AYnTSkQhv result identifier dgHcH1svHs5X3czTwE2RBXQ7tGq system type named identifier 3hrVvoVYoDkX9t3w9abTXxDqGRaW url_view named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal constexpr pct_encoded_rule boost/url/rfc/pct_encoded_rule.hpp include/boost/url/rfc/pct_encoded_rule.hpp 86 1 function 3YbQmLbv9k5hQejotb1EQGfGvbSp regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 35v7twCJmdtKy88BJf2RKo7i4tri 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 35v7twCJmdtKy88BJf2RKo7i4tri text , reference pchars 42eTmvy8HvVVvNVPdDoa76n3UmQW text , reference pct_string_view 3ZY5EydXePv2wNz8JPvc5skA7Bn4 text . named specialization 8HhHaa6h2JiNhZ9E4zU7uYNKgjN pct_encoded_rule_t identifier 3jVzhUTY78j9Azdaoqzm3EeWXkEU implementation_defined type named identifier CS lvalue-reference named identifier CS cs normal constexpr resolve boost/url/url_base.hpp include/boost/url/url_base.hpp 3151 1 boost/url/url_base.hpp include/boost/url/url_base.hpp 2977 5 function 4ZbWvyKBMwfyhwwk3YYEco8ttTeS public regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 2TREmHUMfZeMQz9yyw5HzqB91APN 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 75qVNpuBHShJ8KKEUv4RCrwxEAB text , reference url_view 3hrVvoVYoDkX9t3w9abTXxDqGRaW text . reference static_url 48MaMwY7JqeST8Mfy8WBA7wGLSzT reference static_url_base 2egpzk38s9q8jE4fNG71Y15WvAVC reference url 75qVNpuBHShJ8KKEUv4RCrwxEAB reference url_view 3hrVvoVYoDkX9t3w9abTXxDqGRaW reference url_view_base 27ryuyAvvRyzfzgketja5uQcFBcK named specialization qQFMz11M2hdnkDE2M6AYnTSkQhv result identifier dgHcH1svHs5X3czTwE2RBXQ7tGq system type named identifier void void lvalue-reference named identifier 27ryuyAvvRyzfzgketja5uQcFBcK url_view_base base lvalue-reference named identifier 27ryuyAvvRyzfzgketja5uQcFBcK url_view_base ref lvalue-reference named identifier 2TREmHUMfZeMQz9yyw5HzqB91APN url_base dest normal string_to_scheme boost/url/scheme.hpp include/boost/url/scheme.hpp 141 1 function 2Cc8cH7Z7ExrsLbjk4geBrdf5cZS regular 2ejQGW57K8g7MFJhHAwPt5aumoLa paragraph text If the string does not identify a known scheme, the value reference scheme::unknown d3jNvGWyWHyaA1snRDXYWd5jjkA 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 tVuW4uzt1HMgUxPtxroTuMsNi2G named identifier tVuW4uzt1HMgUxPtxroTuMsNi2G scheme named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core s normal constexpr swap boost/url/url.hpp include/boost/url/url.hpp 400 5 function 3TA5xAVGZHDj1nxZB9BputbD8861 public regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 2vCUaWVXdv8xAJxyzhvVxgN8uuE4 named identifier void void lvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url v0 lvalue-reference named identifier 75qVNpuBHShJ8KKEUv4RCrwxEAB url v1 normal to_string boost/url/scheme.hpp include/boost/url/scheme.hpp 151 1 function 2XRMQjtBJPK89zguipj5hUZFjVnV regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 tVuW4uzt1HMgUxPtxroTuMsNi2G named identifier 28hchSQf1yxriaF3xPVBYBTDmxEH string_view identifier 2yhXyqRJb8cGER6KEEutsDnLWwWD core named identifier tVuW4uzt1HMgUxPtxroTuMsNi2G scheme s normal operator<< boost/url/authority_view.hpp include/boost/url/authority_view.hpp 1516 5 boost/url/authority_view.hpp include/boost/url/authority_view.hpp 1544 1 boost/url/decode_view.hpp include/boost/url/decode_view.hpp 1044 1 boost/url/params_base.hpp include/boost/url/params_base.hpp 566 1 boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 597 1 boost/url/segments_base.hpp include/boost/url/segments_base.hpp 329 1 boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 337 1 boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2801 1 overloads 22eZSjWyZJ484enpzywKvFyqeCSv public regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 << qsKtXZMCdwtUEZ1HgrXpjoJZvY 7fHrzgAgHgHmyXWP7b6SuvBQUXw z7TnBa9S5KdEUq8kHpMvpci8qco 2BjQWbA94HXzpMQX4FBHh3aYTq2U 4HEN1ajFF2C24FYgGLXT2dgqH48z 3Zmm3wPTignm7rohkCu6EcUy41zD 3hwNw4CTARP139dQnJwscTg76Dzv Kx2JRfqi5BkiXJCgoozmq6GWAL5 3avuwaQjDC7fskR8E1objWGmMBne lvalue-reference named identifier 2HrCakn2VFWrwzuwmx1m5Dq5CgYg ostream identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std operator<< boost/url/ipv6_address.hpp include/boost/url/ipv6_address.hpp 360 5 function qsKtXZMCdwtUEZ1HgrXpjoJZvY public regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 lvalue-reference named identifier 2HrCakn2VFWrwzuwmx1m5Dq5CgYg ostream identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std lvalue-reference named identifier 2HrCakn2VFWrwzuwmx1m5Dq5CgYg ostream identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std os lvalue-reference named identifier 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T ipv6_address addr normal << operator<< boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 325 5 function 7fHrzgAgHgHmyXWP7b6SuvBQUXw public regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 lvalue-reference named identifier 2HrCakn2VFWrwzuwmx1m5Dq5CgYg ostream identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std lvalue-reference named identifier 2HrCakn2VFWrwzuwmx1m5Dq5CgYg ostream identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std os lvalue-reference named identifier 4Xmd9k1GBKGKQj6PYc1qdt4tMUae ipv4_address addr normal << operator<< boost/url/decode_view.hpp include/boost/url/decode_view.hpp 1016 5 boost/url/decode_view.hpp include/boost/url/decode_view.hpp 1044 1 function z7TnBa9S5KdEUq8kHpMvpci8qco public regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 lvalue-reference named identifier 2HrCakn2VFWrwzuwmx1m5Dq5CgYg ostream identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std lvalue-reference named identifier 2HrCakn2VFWrwzuwmx1m5Dq5CgYg ostream identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std os lvalue-reference named identifier UXcENkB7t9T6PDWy1z6kk8ej8kT decode_view s normal << operator<< boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2745 5 boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2801 1 function 2BjQWbA94HXzpMQX4FBHh3aYTq2U public regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 lvalue-reference named identifier 2HrCakn2VFWrwzuwmx1m5Dq5CgYg ostream identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std lvalue-reference named identifier 2HrCakn2VFWrwzuwmx1m5Dq5CgYg ostream identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std os lvalue-reference named identifier 27ryuyAvvRyzfzgketja5uQcFBcK url_view_base u normal << operator<< boost/url/authority_view.hpp include/boost/url/authority_view.hpp 1516 5 boost/url/authority_view.hpp include/boost/url/authority_view.hpp 1544 1 function 4HEN1ajFF2C24FYgGLXT2dgqH48z public regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 lvalue-reference named identifier 2HrCakn2VFWrwzuwmx1m5Dq5CgYg ostream identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std lvalue-reference named identifier 2HrCakn2VFWrwzuwmx1m5Dq5CgYg ostream identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std os lvalue-reference named identifier 2fwXocwnoAG9WDGbqM3quKphV1qq authority_view a normal << operator<< boost/url/params_encoded_base.hpp include/boost/url/params_encoded_base.hpp 597 1 function 3Zmm3wPTignm7rohkCu6EcUy41zD regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 lvalue-reference named identifier 2HrCakn2VFWrwzuwmx1m5Dq5CgYg ostream identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std lvalue-reference named identifier 2HrCakn2VFWrwzuwmx1m5Dq5CgYg ostream identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std os lvalue-reference named identifier 44gF3RWPKyorxySQWG1hnA4vjiJu params_encoded_base qp normal << operator<< boost/url/params_base.hpp include/boost/url/params_base.hpp 566 1 function 3hwNw4CTARP139dQnJwscTg76Dzv regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 lvalue-reference named identifier 2HrCakn2VFWrwzuwmx1m5Dq5CgYg ostream identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std lvalue-reference named identifier 2HrCakn2VFWrwzuwmx1m5Dq5CgYg ostream identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std os lvalue-reference named identifier 3JqzyR89pExMFqZFBHMskoM3dq3x params_base qp normal << operator<< boost/url/segments_encoded_base.hpp include/boost/url/segments_encoded_base.hpp 337 1 function Kx2JRfqi5BkiXJCgoozmq6GWAL5 regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 lvalue-reference named identifier 2HrCakn2VFWrwzuwmx1m5Dq5CgYg ostream identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std lvalue-reference named identifier 2HrCakn2VFWrwzuwmx1m5Dq5CgYg ostream identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std os lvalue-reference named identifier 3P1yc8wQhLivRSyTPUbRYh2dtWLg segments_encoded_base ps normal << operator<< boost/url/segments_base.hpp include/boost/url/segments_base.hpp 329 1 function 3avuwaQjDC7fskR8E1objWGmMBne regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 lvalue-reference named identifier 2HrCakn2VFWrwzuwmx1m5Dq5CgYg ostream identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std lvalue-reference named identifier 2HrCakn2VFWrwzuwmx1m5Dq5CgYg ostream identifier 2gQYpYhLmwB2jja6qUZm6ZYuK3Xy std os lvalue-reference named identifier 2ozZGf8LNFZmRaMXAL5TZg2G1emh segments_base ps normal << operator== boost/url/authority_view.hpp include/boost/url/authority_view.hpp 1367 5 overloads EweXU6CdQNznpRpRAAX7dEk8PbR public regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 == 4XXMaqfgz9sYsAYkpbRLMs12phav 4NyHbGPF8j37AC3t4BfnHymNjQeG djvNtSboH7Njf6eBMYgoGWTtPJH 31PQG59s9GnXskXKYY6hCbYuwBB2 32NzB82hdxbUmnZMhHJ182sYaeUi GhudPV3CuyCeCKSftvpKEQLQtJ4 46BQAdxnkiLRk4tua9zvjBVNBxhG 33dbp77PAPLZseM4KaAT4LooxSC9 named identifier bool bool operator== boost/url/ipv6_address.hpp include/boost/url/ipv6_address.hpp 308 5 function 4XXMaqfgz9sYsAYkpbRLMs12phav public regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 named identifier bool bool lvalue-reference named identifier 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T ipv6_address a1 lvalue-reference named identifier 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T ipv6_address a2 normal == operator== boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 259 5 function 4NyHbGPF8j37AC3t4BfnHymNjQeG public regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 named identifier bool bool lvalue-reference named identifier 4Xmd9k1GBKGKQj6PYc1qdt4tMUae ipv4_address a1 lvalue-reference named identifier 4Xmd9k1GBKGKQj6PYc1qdt4tMUae ipv4_address a2 normal == operator== boost/url/decode_view.hpp include/boost/url/decode_view.hpp 659 5 function djvNtSboH7Njf6eBMYgoGWTtPJH public regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 named identifier bool bool lvalue-reference named identifier S lhs lvalue-reference named identifier UXcENkB7t9T6PDWy1z6kk8ej8kT decode_view rhs normal constexpr == operator== boost/url/decode_view.hpp include/boost/url/decode_view.hpp 642 5 function 31PQG59s9GnXskXKYY6hCbYuwBB2 public regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 named identifier bool bool lvalue-reference named identifier UXcENkB7t9T6PDWy1z6kk8ej8kT decode_view lhs lvalue-reference named identifier S rhs normal constexpr == operator== boost/url/decode_view.hpp include/boost/url/decode_view.hpp 625 5 function 32NzB82hdxbUmnZMhHJ182sYaeUi public regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 named identifier bool bool lvalue-reference named identifier UXcENkB7t9T6PDWy1z6kk8ej8kT decode_view lhs lvalue-reference named identifier UXcENkB7t9T6PDWy1z6kk8ej8kT decode_view rhs normal constexpr == operator== boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2484 5 function GhudPV3CuyCeCKSftvpKEQLQtJ4 public regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 48MaMwY7JqeST8Mfy8WBA7wGLSzT reference static_url_base 2egpzk38s9q8jE4fNG71Y15WvAVC reference url 75qVNpuBHShJ8KKEUv4RCrwxEAB reference url_base 2TREmHUMfZeMQz9yyw5HzqB91APN reference url_view 3hrVvoVYoDkX9t3w9abTXxDqGRaW named identifier bool bool lvalue-reference named identifier 27ryuyAvvRyzfzgketja5uQcFBcK url_view_base u0 lvalue-reference named identifier 27ryuyAvvRyzfzgketja5uQcFBcK url_view_base u1 normal == operator== boost/url/authority_view.hpp include/boost/url/authority_view.hpp 1367 5 function 33dbp77PAPLZseM4KaAT4LooxSC9 public regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 named identifier bool bool lvalue-reference named identifier 2fwXocwnoAG9WDGbqM3quKphV1qq authority_view a0 lvalue-reference named identifier 2fwXocwnoAG9WDGbqM3quKphV1qq authority_view a1 normal == operator!= boost/url/authority_view.hpp include/boost/url/authority_view.hpp 1391 5 overloads 25qqadXNgBGpEFccRzomfgrC8yBY public regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 != 2beF2UXb4tELnBeQCioogEDXvNDQ eRFRDqqybWetB8bXwFU4a1ePZ6y 3drLUq3sbeAJXfMPokq9WVQXMyLw 2Ly6x2BtsMf6bzrVCPEDrHUsbJVU 2pQCaj8jtjk5KUeUkYgwoVvaeZXU tkwNEJdWJqwprh85787u3xpyauu 4VLNtjVPizL2BSJyy3wj95h8PqTs mW4oaqgPMtffuauFEkbWRJyy8C4 named identifier bool bool operator!= boost/url/ipv6_address.hpp include/boost/url/ipv6_address.hpp 323 5 function 2beF2UXb4tELnBeQCioogEDXvNDQ public regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 named identifier bool bool lvalue-reference named identifier 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T ipv6_address a1 lvalue-reference named identifier 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T ipv6_address a2 normal != operator!= boost/url/ipv4_address.hpp include/boost/url/ipv4_address.hpp 274 5 function eRFRDqqybWetB8bXwFU4a1ePZ6y public regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 named identifier bool bool lvalue-reference named identifier 4Xmd9k1GBKGKQj6PYc1qdt4tMUae ipv4_address a1 lvalue-reference named identifier 4Xmd9k1GBKGKQj6PYc1qdt4tMUae ipv4_address a2 normal != operator!= boost/url/decode_view.hpp include/boost/url/decode_view.hpp 726 5 function 3drLUq3sbeAJXfMPokq9WVQXMyLw public regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 named identifier bool bool lvalue-reference named identifier S lhs lvalue-reference named identifier UXcENkB7t9T6PDWy1z6kk8ej8kT decode_view rhs normal constexpr != operator!= boost/url/decode_view.hpp include/boost/url/decode_view.hpp 709 5 function 2Ly6x2BtsMf6bzrVCPEDrHUsbJVU public regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 named identifier bool bool lvalue-reference named identifier UXcENkB7t9T6PDWy1z6kk8ej8kT decode_view lhs lvalue-reference named identifier S rhs normal constexpr != operator!= boost/url/decode_view.hpp include/boost/url/decode_view.hpp 692 5 function 2pQCaj8jtjk5KUeUkYgwoVvaeZXU public regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 named identifier bool bool lvalue-reference named identifier UXcENkB7t9T6PDWy1z6kk8ej8kT decode_view lhs lvalue-reference named identifier UXcENkB7t9T6PDWy1z6kk8ej8kT decode_view rhs normal constexpr != operator!= boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2528 5 function tkwNEJdWJqwprh85787u3xpyauu public regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 48MaMwY7JqeST8Mfy8WBA7wGLSzT reference static_url_base 2egpzk38s9q8jE4fNG71Y15WvAVC reference url 75qVNpuBHShJ8KKEUv4RCrwxEAB reference url_base 2TREmHUMfZeMQz9yyw5HzqB91APN reference url_view 3hrVvoVYoDkX9t3w9abTXxDqGRaW named identifier bool bool lvalue-reference named identifier 27ryuyAvvRyzfzgketja5uQcFBcK url_view_base u0 lvalue-reference named identifier 27ryuyAvvRyzfzgketja5uQcFBcK url_view_base u1 normal != operator!= boost/url/authority_view.hpp include/boost/url/authority_view.hpp 1391 5 function mW4oaqgPMtffuauFEkbWRJyy8C4 public regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 named identifier bool bool lvalue-reference named identifier 2fwXocwnoAG9WDGbqM3quKphV1qq authority_view a0 lvalue-reference named identifier 2fwXocwnoAG9WDGbqM3quKphV1qq authority_view a1 normal != operator< boost/url/authority_view.hpp include/boost/url/authority_view.hpp 1415 5 overloads 2HRJhYcLkr4Mm6M4RsvesRoDbXim public regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 < oLoRXUbcXcariYoA6KQAwyL6FVk zniu77oNHTZyKKJY6jvcymun57i 292XgpMBwSR1rEb5p6AXNu4Kgpoz 22wNuw5VxKWrVLMDGM9VPFjJshU6 3M1WdaS44GQP8N9STNo8SUrQes9H named identifier bool bool operator< boost/url/decode_view.hpp include/boost/url/decode_view.hpp 793 5 function oLoRXUbcXcariYoA6KQAwyL6FVk public regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 named identifier bool bool lvalue-reference named identifier S lhs lvalue-reference named identifier UXcENkB7t9T6PDWy1z6kk8ej8kT decode_view rhs normal constexpr < operator< boost/url/decode_view.hpp include/boost/url/decode_view.hpp 776 5 function zniu77oNHTZyKKJY6jvcymun57i public regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 named identifier bool bool lvalue-reference named identifier UXcENkB7t9T6PDWy1z6kk8ej8kT decode_view lhs lvalue-reference named identifier S rhs normal constexpr < operator< boost/url/decode_view.hpp include/boost/url/decode_view.hpp 759 5 function 292XgpMBwSR1rEb5p6AXNu4Kgpoz public regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 named identifier bool bool lvalue-reference named identifier UXcENkB7t9T6PDWy1z6kk8ej8kT decode_view lhs lvalue-reference named identifier UXcENkB7t9T6PDWy1z6kk8ej8kT decode_view rhs normal constexpr < operator< boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2572 5 function 22wNuw5VxKWrVLMDGM9VPFjJshU6 public regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 48MaMwY7JqeST8Mfy8WBA7wGLSzT reference static_url_base 2egpzk38s9q8jE4fNG71Y15WvAVC reference url 75qVNpuBHShJ8KKEUv4RCrwxEAB reference url_base 2TREmHUMfZeMQz9yyw5HzqB91APN reference url_view 3hrVvoVYoDkX9t3w9abTXxDqGRaW named identifier bool bool lvalue-reference named identifier 27ryuyAvvRyzfzgketja5uQcFBcK url_view_base u0 lvalue-reference named identifier 27ryuyAvvRyzfzgketja5uQcFBcK url_view_base u1 normal < operator< boost/url/authority_view.hpp include/boost/url/authority_view.hpp 1415 5 function 3M1WdaS44GQP8N9STNo8SUrQes9H public regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 named identifier bool bool lvalue-reference named identifier 2fwXocwnoAG9WDGbqM3quKphV1qq authority_view a0 lvalue-reference named identifier 2fwXocwnoAG9WDGbqM3quKphV1qq authority_view a1 normal < operator<= boost/url/authority_view.hpp include/boost/url/authority_view.hpp 1439 5 overloads 3WxbG8kXgRFxkzzyxQFypyYEiuQk public regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 <= 2XZBfyvXdaob531WGj8yhbYDkzmG 4APsbBP2DhCNQjH12Tn46E6sr6R9 CgQ8dpCCveSUdsSA7HGTkyc4bfS 3QqsgavNMQTmxMW1t9qAoAocshM6 KrTct9qjuEP7hibe7nz1KZyF7Dv named identifier bool bool operator<= boost/url/decode_view.hpp include/boost/url/decode_view.hpp 860 5 function 2XZBfyvXdaob531WGj8yhbYDkzmG public regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 named identifier bool bool lvalue-reference named identifier S lhs lvalue-reference named identifier UXcENkB7t9T6PDWy1z6kk8ej8kT decode_view rhs normal constexpr <= operator<= boost/url/decode_view.hpp include/boost/url/decode_view.hpp 843 5 function 4APsbBP2DhCNQjH12Tn46E6sr6R9 public regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 named identifier bool bool lvalue-reference named identifier UXcENkB7t9T6PDWy1z6kk8ej8kT decode_view lhs lvalue-reference named identifier S rhs normal constexpr <= operator<= boost/url/decode_view.hpp include/boost/url/decode_view.hpp 826 5 function CgQ8dpCCveSUdsSA7HGTkyc4bfS public regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 named identifier bool bool lvalue-reference named identifier UXcENkB7t9T6PDWy1z6kk8ej8kT decode_view lhs lvalue-reference named identifier UXcENkB7t9T6PDWy1z6kk8ej8kT decode_view rhs normal constexpr <= operator<= boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2616 5 function 3QqsgavNMQTmxMW1t9qAoAocshM6 public regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 48MaMwY7JqeST8Mfy8WBA7wGLSzT reference static_url_base 2egpzk38s9q8jE4fNG71Y15WvAVC reference url 75qVNpuBHShJ8KKEUv4RCrwxEAB reference url_base 2TREmHUMfZeMQz9yyw5HzqB91APN reference url_view 3hrVvoVYoDkX9t3w9abTXxDqGRaW named identifier bool bool lvalue-reference named identifier 27ryuyAvvRyzfzgketja5uQcFBcK url_view_base u0 lvalue-reference named identifier 27ryuyAvvRyzfzgketja5uQcFBcK url_view_base u1 normal <= operator<= boost/url/authority_view.hpp include/boost/url/authority_view.hpp 1439 5 function KrTct9qjuEP7hibe7nz1KZyF7Dv public regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 named identifier bool bool lvalue-reference named identifier 2fwXocwnoAG9WDGbqM3quKphV1qq authority_view a0 lvalue-reference named identifier 2fwXocwnoAG9WDGbqM3quKphV1qq authority_view a1 normal <= operator> boost/url/authority_view.hpp include/boost/url/authority_view.hpp 1463 5 overloads 4RCn3DDKRk73T6wL2oYD2oBAstJR public regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 > 6tmzXudNnQwDhTyhcBfTEA8KCMZ 3JQn9uwJsMU3oTGagkPoFXwuBKMf oi6dJJ1yraHpxNJWjD3hoadotrG 3CgAf4w5dyww6CMhGWkJm1fJiHum 2z1vSrMfNsaXSpXNN7S4sKgdsAwS named identifier bool bool operator> boost/url/decode_view.hpp include/boost/url/decode_view.hpp 927 5 function 6tmzXudNnQwDhTyhcBfTEA8KCMZ public regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 named identifier bool bool lvalue-reference named identifier S lhs lvalue-reference named identifier UXcENkB7t9T6PDWy1z6kk8ej8kT decode_view rhs normal constexpr > operator> boost/url/decode_view.hpp include/boost/url/decode_view.hpp 910 5 function 3JQn9uwJsMU3oTGagkPoFXwuBKMf public regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 named identifier bool bool lvalue-reference named identifier UXcENkB7t9T6PDWy1z6kk8ej8kT decode_view lhs lvalue-reference named identifier S rhs normal constexpr > operator> boost/url/decode_view.hpp include/boost/url/decode_view.hpp 893 5 function oi6dJJ1yraHpxNJWjD3hoadotrG public regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 named identifier bool bool lvalue-reference named identifier UXcENkB7t9T6PDWy1z6kk8ej8kT decode_view lhs lvalue-reference named identifier UXcENkB7t9T6PDWy1z6kk8ej8kT decode_view rhs normal constexpr > operator> boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2660 5 function 3CgAf4w5dyww6CMhGWkJm1fJiHum public regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 48MaMwY7JqeST8Mfy8WBA7wGLSzT reference static_url_base 2egpzk38s9q8jE4fNG71Y15WvAVC reference url 75qVNpuBHShJ8KKEUv4RCrwxEAB reference url_base 2TREmHUMfZeMQz9yyw5HzqB91APN reference url_view 3hrVvoVYoDkX9t3w9abTXxDqGRaW named identifier bool bool lvalue-reference named identifier 27ryuyAvvRyzfzgketja5uQcFBcK url_view_base u0 lvalue-reference named identifier 27ryuyAvvRyzfzgketja5uQcFBcK url_view_base u1 normal > operator> boost/url/authority_view.hpp include/boost/url/authority_view.hpp 1463 5 function 2z1vSrMfNsaXSpXNN7S4sKgdsAwS public regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 named identifier bool bool lvalue-reference named identifier 2fwXocwnoAG9WDGbqM3quKphV1qq authority_view a0 lvalue-reference named identifier 2fwXocwnoAG9WDGbqM3quKphV1qq authority_view a1 normal > operator>= boost/url/authority_view.hpp include/boost/url/authority_view.hpp 1487 5 overloads 2iM8g9kTAvadg6T8ZbSNPerCByPZ public regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 >= 3BKiKXz24757315qSDWs5sC96oYK 3CrvrwFxEeAquQA9rVv6mwxG9W1s 2T4jKJco3hzVpTuxyYhP5wUxSGes 2V16XgrptBcWFtoZaJ3DExhQXY6 2qvRTQyEphNFQZSvMzCwe757weAA named identifier bool bool operator>= boost/url/decode_view.hpp include/boost/url/decode_view.hpp 994 5 function 3BKiKXz24757315qSDWs5sC96oYK public regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 named identifier bool bool lvalue-reference named identifier S lhs lvalue-reference named identifier UXcENkB7t9T6PDWy1z6kk8ej8kT decode_view rhs normal constexpr >= operator>= boost/url/decode_view.hpp include/boost/url/decode_view.hpp 977 5 function 3CrvrwFxEeAquQA9rVv6mwxG9W1s public regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 named identifier bool bool lvalue-reference named identifier UXcENkB7t9T6PDWy1z6kk8ej8kT decode_view lhs lvalue-reference named identifier S rhs normal constexpr >= operator>= boost/url/decode_view.hpp include/boost/url/decode_view.hpp 960 5 function 2T4jKJco3hzVpTuxyYhP5wUxSGes public regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 named identifier bool bool lvalue-reference named identifier UXcENkB7t9T6PDWy1z6kk8ej8kT decode_view lhs lvalue-reference named identifier UXcENkB7t9T6PDWy1z6kk8ej8kT decode_view rhs normal constexpr >= operator>= boost/url/url_view_base.hpp include/boost/url/url_view_base.hpp 2704 5 function 2V16XgrptBcWFtoZaJ3DExhQXY6 public regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 48MaMwY7JqeST8Mfy8WBA7wGLSzT reference static_url_base 2egpzk38s9q8jE4fNG71Y15WvAVC reference url 75qVNpuBHShJ8KKEUv4RCrwxEAB reference url_base 2TREmHUMfZeMQz9yyw5HzqB91APN reference url_view 3hrVvoVYoDkX9t3w9abTXxDqGRaW named identifier bool bool lvalue-reference named identifier 27ryuyAvvRyzfzgketja5uQcFBcK url_view_base u0 lvalue-reference named identifier 27ryuyAvvRyzfzgketja5uQcFBcK url_view_base u1 normal >= operator>= boost/url/authority_view.hpp include/boost/url/authority_view.hpp 1487 5 function 2qvRTQyEphNFQZSvMzCwe757weAA public regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 named identifier bool bool lvalue-reference named identifier 2fwXocwnoAG9WDGbqM3quKphV1qq authority_view a0 lvalue-reference named identifier 2fwXocwnoAG9WDGbqM3quKphV1qq authority_view a1 normal >= absolute_uri_rule boost/url/rfc/absolute_uri_rule.hpp include/boost/url/rfc/absolute_uri_rule.hpp 69 1 variable 48v2goykSGwK1v9STZJpo6jjTuxW regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 35v7twCJmdtKy88BJf2RKo7i4tri 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 35v7twCJmdtKy88BJf2RKo7i4tri text , reference parse_absolute_uri 2ARWB82XdRYexehQmFQZjcEKzoSi text , reference url_view 3hrVvoVYoDkX9t3w9abTXxDqGRaW text . named identifier 28DZBeCCfnFAp6BDdvTvfydAa9cs absolute_uri_rule_t identifier 3jVzhUTY78j9Azdaoqzm3EeWXkEU implementation_defined {} authority_rule boost/url/rfc/authority_rule.hpp include/boost/url/rfc/authority_rule.hpp 62 1 variable 32VVcQFEhxqnXpaLAaf9VCsLxUkr regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 35v7twCJmdtKy88BJf2RKo7i4tri 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 2fwXocwnoAG9WDGbqM3quKphV1qq text , reference grammar::parse 35v7twCJmdtKy88BJf2RKo7i4tri text , reference parse_authority 2eeZHdWXgsV3fMDoL3MrbjDNWopq text . named identifier cTXppJW6xt15m8djAPDdgb4DDYU authority_rule_t identifier 3jVzhUTY78j9Azdaoqzm3EeWXkEU implementation_defined {} gen_delim_chars boost/url/rfc/gen_delim_chars.hpp include/boost/url/rfc/gen_delim_chars.hpp 44 1 variable iR6LspA69mvSF536xn6sd3cfwu8 regular 2ejQGW57K8g7MFJhHAwPt5aumoLa heading text Example 1 paragraph text Character sets are used with rules and the functions reference grammar::find_if 3XhMv27X469neaTG5KKaz2w1eJ1W text and reference grammar::find_if_not 3H7zQeHPown6VJxU8o7M8oV2cAgJ 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 3XhMv27X469neaTG5KKaz2w1eJ1W text , reference grammar::find_if_not 3H7zQeHPown6VJxU8o7M8oV2cAgJ text , reference grammar::parse 35v7twCJmdtKy88BJf2RKo7i4tri text , reference pct_encoded_rule 3YbQmLbv9k5hQejotb1EQGfGvbSp text . named identifier 4LnTx5EKsVwNijs6E9BugA6EwaZF lut_chars identifier 3xgiPUvbkGK69EKtHNfc9suQevEU grammar ":/?#[]@" ignore_case boost/url/ignore_case.hpp include/boost/url/ignore_case.hpp 29 1 variable 3qSXNyNHTb9MsSXvAjVCvfvrgLhw regular 2ejQGW57K8g7MFJhHAwPt5aumoLa paragraph text This value may be optionally passed to functions accepting a parameter of type reference ignore_case_param wxnor5Tun8FXFjfB7Jm4ghwuNS9 text to indicate that comparisons should be case-insensitive. brief text Ignore case when comparing named identifier 2LPgbGCfKKnahA45gG6zVjG9WUcA ignore_case_t identifier 3jVzhUTY78j9Azdaoqzm3EeWXkEU implementation_defined {} ipv4_address_rule boost/url/rfc/ipv4_address_rule.hpp include/boost/url/rfc/ipv4_address_rule.hpp 71 1 variable it6B79qPoGNqdsdLCd4XteaXCL9 regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 35v7twCJmdtKy88BJf2RKo7i4tri 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 4Xmd9k1GBKGKQj6PYc1qdt4tMUae text , reference parse_ipv4_address 45AWvW23tadRhrV2Rr5Wwg5c83dx text , reference grammar::parse 35v7twCJmdtKy88BJf2RKo7i4tri text . named identifier 3ExxwPTESczMzTf2489HBSWA6zEG ipv4_address_rule_t identifier 3jVzhUTY78j9Azdaoqzm3EeWXkEU implementation_defined {} ipv6_address_rule boost/url/rfc/ipv6_address_rule.hpp include/boost/url/rfc/ipv6_address_rule.hpp 79 1 variable QK3agZDmGM1BdHqFkerviQEKvKH regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 35v7twCJmdtKy88BJf2RKo7i4tri 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 2eQhbg7Rx6d9PQtGtrFCAFiQKP6T text , reference parse_ipv6_address 2WWWLGhxBBf6EtKLCdxA28UdXFJ1 text , reference grammar::parse 35v7twCJmdtKy88BJf2RKo7i4tri text . named identifier 3mrY4amrXsM7dFmSAbFhqjKG4YM ipv6_address_rule_t identifier 3jVzhUTY78j9Azdaoqzm3EeWXkEU implementation_defined {} no_value boost/url/param.hpp include/boost/url/param.hpp 36 1 variable TXZvizo9ikqMQ3HygeHisBPEJ15 regular 2ejQGW57K8g7MFJhHAwPt5aumoLa brief text Constant indicating no value in a param named identifier 4DwiW6tfGAuwSbZpXpoaKSA3VizJ no_value_t {} origin_form_rule boost/url/rfc/origin_form_rule.hpp include/boost/url/rfc/origin_form_rule.hpp 68 1 variable 3DgP78orKFq8Q1iGscjBtBswa56h regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 35v7twCJmdtKy88BJf2RKo7i4tri 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 35v7twCJmdtKy88BJf2RKo7i4tri text , reference parse_origin_form YwftbCXGz1kG5uRUguacNEwrkaP text , reference url_view 3hrVvoVYoDkX9t3w9abTXxDqGRaW text . named identifier 45Uw1N3BcEHkXLQpcFvhe9pSM9K origin_form_rule_t identifier 3jVzhUTY78j9Azdaoqzm3EeWXkEU implementation_defined {} pchars boost/url/rfc/pchars.hpp include/boost/url/rfc/pchars.hpp 45 1 variable 42eTmvy8HvVVvNVPdDoa76n3UmQW regular 2ejQGW57K8g7MFJhHAwPt5aumoLa heading text Example 1 paragraph text Character sets are used with rules and the functions reference grammar::find_if 3XhMv27X469neaTG5KKaz2w1eJ1W text and reference grammar::find_if_not 3H7zQeHPown6VJxU8o7M8oV2cAgJ 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 3XhMv27X469neaTG5KKaz2w1eJ1W text , reference grammar::find_if_not 3H7zQeHPown6VJxU8o7M8oV2cAgJ text , reference grammar::parse 35v7twCJmdtKy88BJf2RKo7i4tri text , reference pct_encoded_rule 3YbQmLbv9k5hQejotb1EQGfGvbSp text . auto auto unreserved_chars + sub_delim_chars + ':' + '@' query_rule boost/url/rfc/query_rule.hpp include/boost/url/rfc/query_rule.hpp 70 1 variable 4Fq39ThcWdj4r5uCUrQeszNi4Yzf regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 35v7twCJmdtKy88BJf2RKo7i4tri 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 35v7twCJmdtKy88BJf2RKo7i4tri text , reference params_encoded_view 3w4FJjjADY3EEHqUmBj5mvDKqdEB text . named identifier 4EYgSxFF8chLwEJtNc7Ufxbe6yKa query_rule_t identifier 3jVzhUTY78j9Azdaoqzm3EeWXkEU implementation_defined {} relative_ref_rule boost/url/rfc/relative_ref_rule.hpp include/boost/url/rfc/relative_ref_rule.hpp 64 1 variable 21nqX1C987QTr3KX6K9pY8iBbWfJ regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 35v7twCJmdtKy88BJf2RKo7i4tri 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 35v7twCJmdtKy88BJf2RKo7i4tri text , reference parse_relative_ref u1SFmy6a6wtXTYxrMnssMwa7K6G text , reference url_view 3hrVvoVYoDkX9t3w9abTXxDqGRaW text . named identifier 3YViMX5KP1ZZd5Jp7dKx9J4RG8C7 relative_ref_rule_t identifier 3jVzhUTY78j9Azdaoqzm3EeWXkEU implementation_defined {} reserved_chars boost/url/rfc/reserved_chars.hpp include/boost/url/rfc/reserved_chars.hpp 39 1 variable cw6C7WHL2uNn5JnsspM2qAHKNbt regular 2ejQGW57K8g7MFJhHAwPt5aumoLa heading text Example 1 paragraph text Character sets are used with rules and the functions reference grammar::find_if 3XhMv27X469neaTG5KKaz2w1eJ1W text and reference grammar::find_if_not 3H7zQeHPown6VJxU8o7M8oV2cAgJ 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 3XhMv27X469neaTG5KKaz2w1eJ1W text , reference grammar::find_if_not 3H7zQeHPown6VJxU8o7M8oV2cAgJ text , reference grammar::parse 35v7twCJmdtKy88BJf2RKo7i4tri text , reference pct_encoded_rule 3YbQmLbv9k5hQejotb1EQGfGvbSp text . auto auto ~unreserved_chars sub_delim_chars boost/url/rfc/sub_delim_chars.hpp include/boost/url/rfc/sub_delim_chars.hpp 45 1 variable 2H1MfGiECvLAki16SCP9AAnDgsdX regular 2ejQGW57K8g7MFJhHAwPt5aumoLa heading text Example 1 paragraph text Character sets are used with rules and the functions reference grammar::find_if 3XhMv27X469neaTG5KKaz2w1eJ1W text and reference grammar::find_if_not 3H7zQeHPown6VJxU8o7M8oV2cAgJ 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 3XhMv27X469neaTG5KKaz2w1eJ1W text , reference grammar::find_if_not 3H7zQeHPown6VJxU8o7M8oV2cAgJ text , reference grammar::parse 35v7twCJmdtKy88BJf2RKo7i4tri text , reference pct_encoded_rule 3YbQmLbv9k5hQejotb1EQGfGvbSp text . named identifier 4LnTx5EKsVwNijs6E9BugA6EwaZF lut_chars identifier 3xgiPUvbkGK69EKtHNfc9suQevEU grammar "!$&()*+,;=\x27" unreserved_chars boost/url/rfc/unreserved_chars.hpp include/boost/url/rfc/unreserved_chars.hpp 44 1 variable 3U1VJchaHf6kHuVX7q3rr33jE4fW regular 2ejQGW57K8g7MFJhHAwPt5aumoLa heading text Example 1 paragraph text Character sets are used with rules and the functions reference grammar::find_if 3XhMv27X469neaTG5KKaz2w1eJ1W text and reference grammar::find_if_not 3H7zQeHPown6VJxU8o7M8oV2cAgJ 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 3XhMv27X469neaTG5KKaz2w1eJ1W text , reference grammar::find_if_not 3H7zQeHPown6VJxU8o7M8oV2cAgJ text , reference grammar::parse 35v7twCJmdtKy88BJf2RKo7i4tri text , reference pct_encoded_rule 3YbQmLbv9k5hQejotb1EQGfGvbSp text . named identifier 4LnTx5EKsVwNijs6E9BugA6EwaZF lut_chars identifier 3xgiPUvbkGK69EKtHNfc9suQevEU grammar "ABCDEFGHIJKLMNOPQRSTUVWXYZ" "abcdefghijklmnopqrstuvwxyz" "0123456789" "-._~" uri_reference_rule boost/url/rfc/uri_reference_rule.hpp include/boost/url/rfc/uri_reference_rule.hpp 67 1 variable 23tY9bZN8SibU8Z2Hwu1KgZeLxsU regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 35v7twCJmdtKy88BJf2RKo7i4tri 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 35v7twCJmdtKy88BJf2RKo7i4tri text , reference parse_uri_reference 4KCrVrNi2iTJ15zBNtvdSNip4rmV text , reference url_view 3hrVvoVYoDkX9t3w9abTXxDqGRaW text . named identifier 2K5avjP9r9DGYDgSW2ZNECviGYR2 uri_reference_rule_t identifier 3jVzhUTY78j9Azdaoqzm3EeWXkEU implementation_defined {} uri_rule boost/url/rfc/uri_rule.hpp include/boost/url/rfc/uri_rule.hpp 64 1 variable 1bj9jipu5RbWBZYRqwfGNT1eJWu regular 2ejQGW57K8g7MFJhHAwPt5aumoLa 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 35v7twCJmdtKy88BJf2RKo7i4tri 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 35v7twCJmdtKy88BJf2RKo7i4tri text , reference parse_uri 2nNq8RtS22vhgfkFAo8dGh6NW87n text , reference url_view 3hrVvoVYoDkX9t3w9abTXxDqGRaW text . named identifier RwQNqC8gZnDgSLJ1xxVX2bdnvfj uri_rule_t identifier 3jVzhUTY78j9Azdaoqzm3EeWXkEU implementation_defined {}