boost::urls::encode

Return a percent‐encoded string

Synopsis

Declared in <boost/url/encode.hpp>

template<
    string_token::StringToken StringToken = string_token::return_string,
    grammar::CharSet CS>
StringToken::result_type
encode(
    core::string_view s,
    CS const& unreserved,
    encoding_opts opt = {},
    StringToken&& token = {}) noexcept;
cpp

Description

This function applies percent‐encoding to the string using the given options and character set, and returns the result as a string when called with default arguments.

Example

encoding_opts opt;
opt.space_as_plus = true;
std::string s = encode( "My Stuff", opt, pchars );

assert( s == "My+Stuff" );
cpp

Exception Safety

Calls to allocate may throw.

Specification

Return Value

The string

Parameters

Name

Description

s

The string to encode.

unreserved

The set of characters that is not percent‐encoded.

opt

The options for encoding. If this parameter is omitted, the default options are used.

token

A string token.

See Also

encode, encoded_size, encoding_opts,

Created with MrDocs