[#boost-urls-params_encoded_base]
= xref:boost.adoc[boost]::xref:boost/urls.adoc[urls]::params_encoded_base
:relfileprefix: ../../
:mrdocs:

Percent‐encoded query helper base

== Synopsis

Declared in `<https://www.github.com/boostorg/url/blob/develop/include/boost/url/params_encoded_base.hpp#Lundefined[boost/url/params_encoded_base.hpp]>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class params_encoded_base;
----

== Description

This base implements the shared percent‐encoded query parameter view functionality used by xref:boost/urls/params_encoded_view.adoc[`params_encoded_view`] and xref:boost/urls/params_encoded_ref.adoc[`params_encoded_ref`]. It cannot be instantiated directly; instead, use one of those containers or the corresponding ref adaptors.

== Containers

* xref:boost/urls/params_ref.adoc[`params_ref`]
* xref:boost/urls/params_view.adoc[`params_view`]
* xref:boost/urls/params_encoded_ref.adoc[`params_encoded_ref`]
* xref:boost/urls/params_encoded_view.adoc[`params_encoded_view`]

== Types

[cols="1,4"]
|===
| Name| Description
| xref:boost/urls/params_encoded_base/iterator.adoc[`iterator`] 
| A Bidirectional iterator to a query parameter
| xref:boost/urls/params_encoded_base/const_iterator.adoc[`const_iterator`] 
| A Bidirectional iterator to a query parameter
| xref:boost/urls/params_encoded_base/const_reference.adoc[`const_reference`] 
| The reference type
| xref:boost/urls/params_encoded_base/difference_type.adoc[`difference_type`] 
| A signed integer type used to represent differences.
| xref:boost/urls/params_encoded_base/reference.adoc[`reference`] 
| The reference type
| xref:boost/urls/params_encoded_base/size_type.adoc[`size_type`] 
| An unsigned integer type to represent sizes.
| xref:boost/urls/params_encoded_base/value_type.adoc[`value_type`] 
| The value type
|===

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:boost/urls/params_encoded_base/begin.adoc[`begin`] 
| Return an iterator to the beginning
| xref:boost/urls/params_encoded_base/buffer.adoc[`buffer`] 
| Return the query corresponding to these params
| xref:boost/urls/params_encoded_base/contains.adoc[`contains`] 
| Return true if a matching key exists
| xref:boost/urls/params_encoded_base/count.adoc[`count`] 
| Return the number of matching keys
| xref:boost/urls/params_encoded_base/empty.adoc[`empty`] 
| Return true if there are no params
| xref:boost/urls/params_encoded_base/end.adoc[`end`] 
| Return an iterator to the end
| xref:boost/urls/params_encoded_base/find-0c.adoc[`find`] 
| Find a matching key
| xref:boost/urls/params_encoded_base/find_last-0b.adoc[`find_last`] 
| Find a matching key
| xref:boost/urls/params_encoded_base/get_or.adoc[`get_or`] 
| Return the value for a key or a fallback
| xref:boost/urls/params_encoded_base/size.adoc[`size`] 
| Return the number of params
|===

== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:boost/urls/params_encoded_base/max_size.adoc[`max_size`] 
| Return the maximum number of characters possible
|===

== Friends

[cols="1,4"]
|===
|Name|Description

| `xref:boost/urls/params_encoded_view.adoc[boost::urls::params_encoded_view]`
| Non‐owning encoded query parameter view
| `xref:boost/urls/params_encoded_ref.adoc[boost::urls::params_encoded_ref]`
| Mutable encoded query parameter proxy
| `xref:boost/urls/url_view_base.adoc[boost::urls::url_view_base]`
| Common functionality for containers
|===

== Derived Classes

[cols="1,4"]
|===
|Name|Description

| xref:boost/urls/params_encoded_ref.adoc[`params_encoded_ref`]
| Mutable encoded query parameter proxy
| xref:boost/urls/params_encoded_view.adoc[`params_encoded_view`]
| Non‐owning encoded query parameter view
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#