boost::urls::params_encoded_base::find

Find a matching key

Synopsis

Declared in <boost/url/params_encoded_base.hpp>

iterator
find(
    pct_string_view key,
    ignore_case_param ic = = {}) const noexcept;

» more…​

iterator
find(
    iterator from,
    pct_string_view key,
    ignore_case_param ic = = {}) const noexcept;

» more…​

Description

This function examines the parameters in the container to find a match for the specified key, which may contain percent escapes. The comparison is performed as if all escaped characters were decoded first.

The search starts from the first param and proceeds forward until either the key is found or the end of the range is reached, in which case end() is returned.

assert( url_view( "?first=John&last=Doe" ).encoded_params().find( "First", ignore_case )->value == "John" );
return this->find( this->begin(), key, ic );

Linear in this->buffer().size().

Exceptions thrown on invalid input.

Exceptions

Name Thrown on

`key`

contains an invalid percent-encoding.

Return Value

an iterator to the param

Parameters

Name Description

key

The key to match. By default, a case-sensitive comparison is used.

ic

An optional parameter. If the value xref:/boost/urls/ignore_case.adoc[ignore_case is passed here, the comparison is case-insensitive. ]

from

The position to begin the search from. This can be `end()`.

Created with MrDocs