Untitled :: Boost.URL

Class params_ref

A view representing query parameters in a URL

Synopsis

class params_ref
    : public params_base;

Declared in file <include/boost/url/impl/params_encoded_base.hpp> on line 20

Defined in file <include/boost/url/params_ref.hpp> on line 80

Member Functions

Name

Description

Constructor

Constructor

Assignment

Assignment

operator params_view

Conversion

url

Return the referenced url

clear

Clear the contents of the container

Assign elements

Assign elements

Append elements

Append elements

Append elements

Insert elements

Insert elements

Insert elements

Erase elements

Erase elements

Erase elements

Replace elements

Replace elements

Replace elements

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. Percent escapes in strings returned when dereferencing iterators are automatically decoded. Reserved characters in strings supplied to modifier functions are automatically percent-escaped.

Example

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

params_ref p = u.params();

Iterator Invalidation

Changes to the underlying character buffer can invalidate iterators which reference it. Modifications made through the container invalidate some or all iterators:

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