base_n::decode_algorithm

Defined in header <mgs/base_n/decode_algorithm.hpp>.

template <base_n::encoding_traits Traits, codecs::input_source IS>
class decode_algorithm;

The class template decode_algorithm provides a generic implementation for BaseN decoding, and models codecs::input_source.

The encoding’s characteristics are provided via the Traits template parameter.


Valid padding policies are:

  • padding_policy::none - Only non-padded input is considered valid.

  • padding_policy::required - Only padded input is considered valid.

  • padding_policy::optional - Both padded and non-padded are considered valid.

Template parameters

Name

Description

Traits

Encoding traits, must model base_n::encoding_traits.

IS

Input source type, must model codecs::input_source.

Member functions

Name

Description

(constructor)

Constructs an algorithm function object

read

Fills a buffer with decoded output

max_remaining_size

Computes the maximum number of remaining bytes