boost::urls::encoded_size :: Boost Libraries Documentation

# boost::urls::encoded_size

Return the buffer size needed for percent‐encoding

## Synopsis

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

    template<grammar::CharSet CS>
    std::size_t
    encoded_size(
        core::string_view s,
        CS const& allowed,
        encoding_opts opt = {}) noexcept;

## Description

This function returns the exact number of bytes necessary to store the result of applying percent‐encoding to the string using the given options and character set. No encoding is actually performed.

## Example

    assert( encoded_size( "My Stuff", pchars ) == 10 );

## Exception Safety

Throws nothing.

## Specification

- 2.1. Percent‐Encoding (rfc3986)

## Return Value

The number of bytes needed, excluding any null terminator.

## Parameters

Name | Description
s | The string to measure.
allowed | The set of characters that is not percent‐encoded.
opt | The options for encoding. If this parameter is omitted, the default options are be used.

## See Also

`encode`, `encoding_opts`, `make_pct_string_view`.

Created with MrDocs