params_view

A view representing query parameters in a URL

Synopsis

class params_view : public params_base;

Declared in file <boost/url/params_view.hpp> at line 47

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 referenced character buffer.

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_view

Constructor

params_view

Constructor

params_view

Constructor

params_view

Constructor

params_view

Constructor

operator=

Assignment

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_view p = u.params();

Percent escapes in strings returned when dereferencing iterators are automatically decoded.

Iterator Invalidation

Changes to the underlying character buffer can invalidate iterators which reference it.