boost::urls::encode

Return a percent-encoded string

Synopsis

Declared in <include/boost/url/encode.hpp>

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

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.

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

Calls to allocate may throw.

  • 2.1. Percent-Encoding (rfc3986)
  • 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