params_encoded_view

A view representing query parameters in a URL

Synopsis

class params_encoded_view : public params_encoded_base;

Declared in file <boost/url/params_encoded_view.hpp> at line 54

Types

Name Description
iterator

Types

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.

Member Functions

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_view

Constructor

params_encoded_view

Constructor

params_encoded_view

Constructor

operator=

Assignment

operator params_view

Conversion

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 character buffer. The caller is responsible for ensuring that the lifetime of the buffer extends until it is no longer referenced.

Example

url_view u( "?first=John&last=Doe" ); params_encoded_view 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.