boost::urls::url_base::set_params

Set the query params

Synopsis

Declared in header <boost/url/url_base.hpp>

url_base&
set_params(
    std::initializer_list<param_view> ps,
    encoding_opts opts = = {}) noexcept;

Description

This sets the query params to the list of param_view, which can be empty.

An empty list of params is distinct from having no params.

Reserved characters in the string are percent-escaped in the result.

Example

assert( url( "http://example.com" ).set_params( {"id", "42"} ).query() == "id=42" );

Postconditions

this->has_query() == true

Exception Safety

Strong guarantee. Calls to allocate may throw.

Complexity

Linear.

BNF

query           = *( pchar / "/" / "?" )

query-param     = key [ "=" value ]
query-params    = [ query-param ] *( "&" query-param )

Specification

  • link:https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 >3.4. Query (rfc3986)</a> @li <a href=[://en.wikipedia.org/wiki/Query_string" >Query string (Wikipedia)]

Parameters

Name Description

ps

The params to set.

opts

The options for encoding.