set

Set a value

Synopsis

params_encoded_base::iterator
set(
    pct_string_view key,
    pct_string_view value,
    ignore_case_param ic = = {});

Declared in file <include/boost/url/params_encoded_ref.hpp> on line 951

Defined in file <src/params_encoded_ref.cpp> on line 197

Description

This function performs one of two actions depending on the value of this->contains( key, ic ).

  • 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,

  • If key is not contained in the view, then the function apppends the param { key, value }. All iterators are invalidated.

    The strings passed in must not come from the element being replaced, or else the behavior is undefined.

Example

url u( "?id=42&id=69" );

u.encoded_params().set( "id", "none" );

assert( u.encoded_params().count( "id" ) == 1 );

Postconditions

this->count( key, ic ) == 1 && this->find( key, ic )->value == value

Complexity

Linear in this->url().encoded_query().size().

Exception Safety

Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input.