boost::urls::params_view::params_view

Constructor

Synopsis

Declared in <boost/url/params_view.hpp>

params_view(
    core::string_view s,
    encoding_opts opt);
cpp

Description

This function constructs params from a valid query parameter string, which can contain percent escapes.

This instance will use the specified encoding_opts when the values are decoded.

Unlike the parameters in URLs, the string passed here should not start with "?". Upon construction, the view will reference the character buffer pointed to by s. The caller is responsible for ensuring that the lifetime of the buffer extends until it is no longer referenced.

Example

encoding_opts opt;
opt.space_as_plus = true;
params_view qp( "name=John+Doe", opt );
cpp

Effects

return params_view(parse_query( s ).value(), opt);
cpp

Postconditions

this->buffer().data() == s.data()
cpp

Complexity

Linear in s.

Exception Safety

Exceptions thrown on invalid input.

BNF

query-params    = [ query-param ] *( "&" query-param )

query-param     = key [ "=" value ]
cpp

Specification

Exceptions

Name

Thrown on

system_error

s contains an invalid query parameter string.

Parameters

Name

Description

s

The string to parse.

opt

The options for decoding. If this parameter is omitted, space_as_plus is used.

Created with MrDocs