boost::urls::params_base

Decoded query parameter helper base

Synopsis

Declared in <boost/url/params_base.hpp>
class params_base;

Description

This base centralizes the read-only, percent-decoded query parameter algorithms (iteration, lookup, counting) that are shared by params_view and params_ref.

This class should not be instantiated directly; Instead, use one of the containers or functions:

Containers

Types

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

Member Functions

NameDescription
begin Return an iterator to the beginning
buffer Return the referenced character buffer.
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
get_or Return the value for a key or a fallback
size Return the number of params

Static Member Functions

NameDescription
max_size Return the maximum number of characters possible

Friends

|===
Name Description
params_view Non-owning decoded query parameter view
params_ref Mutable decoded query parameter proxy
url_view_base Common functionality for containers

Derived Classes

Name Description
params_ref Mutable decoded query parameter proxy
params_view Non-owning decoded query parameter view