[#boost-urls-params_encoded_view]
= xref:boost.adoc[boost]::xref:boost/urls.adoc[urls]::params&lowbar;encoded&lowbar;view
:relfileprefix: ../../
:mrdocs:

Non&hyphen;owning encoded query parameter view

== Synopsis

Declared in `&lt;https://www.github.com/boostorg/url/blob/develop/include/boost/url/params_encoded_view.hpp#Lundefined[boost&sol;url&sol;params&lowbar;encoded&lowbar;view&period;hpp]&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class params&lowbar;encoded&lowbar;view
    : public xref:boost/urls/params_encoded_base.adoc[params&lowbar;encoded&lowbar;base]
----

== Description

This read&hyphen;only range exposes the raw percent&hyphen;encoded key&sol;value pairs stored in a query string&period; It does not copy the underlying buffer&semi; callers must ensure the referenced character storage outlives the view&period;

== Example

[,cpp]
----
url_view u( "?first=John&last=Doe" );

params_encoded_view p = u.encoded_params();
----
Iteration yields xref:boost/urls/param_pct_view.adoc[`param&lowbar;pct&lowbar;view`] values, so encoded strings and escape validation are preserved for callers that want exact bytes&period;

== Iterator Invalidation

Changes to the underlying character buffer can invalidate iterators which reference it&period;

== Base Classes

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

| `xref:boost/urls/params_encoded_base.adoc[params&lowbar;encoded&lowbar;base]`
| Percent&hyphen;encoded query helper base
|===

== Types

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

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:boost/urls/params_encoded_view/2constructor-0b.adoc[`params&lowbar;encoded&lowbar;view`]         [.small]#[constructor]#
| Constructor
| xref:boost/urls/params_encoded_view/operator_assign.adoc[`operator&equals;`] 
| Assignment
| 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&lowbar;last`] 
| Find a matching key
| xref:boost/urls/params_encoded_base/get_or.adoc[`get&lowbar;or`] 
| Return the value for a key or a fallback
| xref:boost/urls/params_encoded_base/size.adoc[`size`] 
| Return the number of params
| xref:boost/urls/params_encoded_view/2conversion.adoc[`operator params&lowbar;view`] 
| Conversion
|===

== Static Member Functions

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

== Friends

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

| `xref:boost/urls/parse_query.adoc[boost::urls::parse&lowbar;query]`
| Parse a string and return an encoded params view
| `xref:boost/urls/params_encoded_ref.adoc[boost::urls::params&lowbar;encoded&lowbar;ref]`
| Mutable encoded query parameter proxy
| `xref:boost/urls/params_view.adoc[boost::urls::params&lowbar;view]`
| Non&hyphen;owning decoded query parameter view
| `xref:boost/urls/url_view_base.adoc[boost::urls::url&lowbar;view&lowbar;base]`
| Common functionality for containers
|===


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