[#boost-urls-encode-04]
= xref:boost.adoc[boost]::xref:boost/urls.adoc[urls]::encode
:relfileprefix: ../../
:mrdocs:


Return a percent‐encoded string

== Synopsis


Declared in `<https://www.github.com/boostorg/url/blob/develop/include/boost/url/encode.hpp#L183[boost/url/encode.hpp]>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    xref:boost/urls/string_token.adoc[string_token]::xref:boost/urls/string_token/StringToken.adoc[StringToken] StringToken = xref:boost/urls/string_token.adoc[string_token]::xref:boost/urls/string_token/return_string.adoc[return_string],
    xref:boost/urls/grammar.adoc[grammar]::xref:boost/urls/grammar/CharSet.adoc[CharSet] CS>
StringToken::result_type
encode(
    core::string_view s,
    CS const& unreserved,
    xref:boost/urls/encoding_opts.adoc[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.


=== Example

[,cpp]
----
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

* link:https://datatracker.ietf.org/doc/html/rfc3986#section-2.1[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


xref:boost/urls/encode-04.adoc[encode],        xref:boost/urls/encoded_size.adoc[encoded_size],        xref:boost/urls/encoding_opts.adoc[encoding_opts],






[.small]#Created with https://www.mrdocs.com[MrDocs]#