Common functionality for query parameter containers

Synopsis

Declared in <boost/url/params_base.hpp>

class params_base;

Types

Name

Description

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

Name

Description

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

size

Return the number of params

Static Member Functions

Name

Description

max_size

Return the maximum number of characters possible

Friends

Name

Description

boost::urls::params_view

A view representing query parameters in a URL

boost::urls::params_ref

A view representing query parameters in a URL

boost::urls::url_view_base

Common functionality for containers

Derived Classes

Name

Description

params_ref

A view representing query parameters in a URL

params_view

A view representing query parameters in a URL

Description

The library uses this base class to provide common member functions for containers of query parameters.

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

Containers

  • params_ref

  • params_view

  • params_encoded_ref

  • params_encoded_view

Created with MrDocs