params_encoded

params_encoded_view

A view representing query parameters in a URL.

Synopsis

Defined in header <boost/url/params_encoded_view.hpp>

class params_encoded_view :
    public params_encoded_base

Types

Name	Description
const_iterator	A Bidirectional iterator to a query parameter.
const_reference	The reference type.
difference_type	A signed integer type used to represent differences.
iterator	A Bidirectional iterator to a query parameter.
reference	The reference type.
size_type	An unsigned integer type to represent sizes.
value_type	The value type.

Member Functions

Name	Description
begin	Return an iterator to the beginning.
buffer	Return the query corresponding to these params.
contains	Return true if a matching key exists.
count	Return the number of matching keys.
empty	Return true if there are no params.
end	Return an iterator to the end.
find	Find a matching key.
find_last	Find a matching key.
operator=	Assignment.
operator params_view	Conversion.
params_encoded_view [constructor]	Constructor.
size	Return the number of params.

Static Member Functions

Name	Description
max_size	Return the maximum number of characters possible.

Friends

Name	Description
parse_query	Parse a string and return an encoded params view.

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.

Convenience header <boost/url.hpp>