encode

Return a percent-encoded string

Synopsis

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

Declared in file <include/boost/url/encode.hpp> on line 184

Defined in file <include/boost/url/impl/encode.hpp> on line 250

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" );

Exception Safety

Calls to allocate may throw.

Specification