A view representing query parameters in a URL
class params_encoded_ref
: public params_encoded_base;
Declared in file <boost/url/params_encoded_ref.hpp> at line 73
| Name | Description |
|---|---|
| iterator |
| Name | Description |
|---|---|
| const_iterator | iterator |
| value_type | The value type |
| reference | The reference type |
| const_reference | The reference type |
| size_type | An unsigned integer type to represent sizes. |
| difference_type | A signed integer type used to represent differences. |
| Name | Description |
|---|---|
| buffer | Return the query corresponding to these params |
| empty | Return true if there are no params |
| size | Return the number of params |
| begin | Return an iterator to the beginning |
| end | Return an iterator to the end |
| contains | Return true if a matching key exists |
| count | Return the number of matching keys |
| find | Find a matching key |
| find | Find a matching key |
| find_last | Find a matching key |
| find_last | Find a matching key |
| 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 | Assign params |
| assign | Assign params |
| append | Append params |
| append | Append params |
| append | Append params |
| insert | Insert params |
| insert | Insert params |
| insert | Insert params |
| erase | Erase params |
| erase | Erase params |
| erase | Erase params |
| replace | Replace params |
| replace | Replace params |
| replace | Replace params |
| unset | Remove the value on an element |
| set | Set a value |
| set | Set a value |
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.
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.
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: