Untitled :: Boost.URL

Class params_encoded_ref

A view representing query parameters in a URL

Synopsis

class params_encoded_ref
    : public params_encoded_base;

Defined in file <include/boost/url/params_encoded_ref.hpp> on line 73

Member Functions

Name

Description

params_encoded_ref

Constructor

operator=

Assignment

operator=

Assignment

operator params_encoded_view

Conversion

url

Return the referenced url

clear

Clear the contents of the container

Assign params

Assign params

Append params

Append params

Append params

Insert params

Insert params

Insert params

Erase params

Erase params

Erase params

Replace params

Replace params

Replace params

Remove the value on an element

set

Set a value

set

Set a value

Friends

Name

Description

url_base

Description

Objects of this type are used to interpret the query parameters as a bidirectional view of key value pairs. The view does not retain ownership of the elements and instead references the original url. The caller is responsible for ensuring that the lifetime of the referenced url extends until it is no longer referenced. The view is modifiable; calling non-const members causes changes to the referenced url.

Example

url u( "?first=John&last=Doe" );

params_encoded_ref p = u.encoded_params();

Strings produced when elements are returned have type param_pct_view and represent encoded strings. Strings passed to member functions may contain percent escapes, and throw exceptions on invalid inputs.

Iterator Invalidation

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:

append : Only end().
assign, clear, operator= : All params.
erase : Erased params and all params after (including end()).
insert : All params at or after the insertion point (including end()).
replace, set : Modified params and all params after (including end()).