This class template implements the Base32 encoding as defined in RFC 4648 for a given character type and encoding alphabet. More...

Public Types
typedef charT	char_type
	The encoding character type. More...

typedef traits	traits_type
	The character encoding traits type. More...

typedef traits::int_type	int_type
	An integral type representing an octet. More...

Static Public Member Functions
template<class InputIterator , class OutputIterator >
static OutputIterator	encode (InputIterator first, InputIterator last, OutputIterator result, bool pad=true)
	Encodes a range of octets. More...

template<class InputIterator , class OutputIterator >
static OutputIterator	encode_lower (InputIterator first, InputIterator last, OutputIterator result, bool pad=true)
	Encodes a range of octets using the lowercase encoding alphabet. More...

template<class InputIterator , class OutputIterator >
static OutputIterator	encode_upper (InputIterator first, InputIterator last, OutputIterator result, bool pad=true)
	Encodes a range of octets using the uppercase encoding alphabet. More...

template<class InputIterator , class OutputIterator >
static OutputIterator	decode (InputIterator first, InputIterator last, OutputIterator result)
	Decodes a range of characters. More...

template<class InputIterator , class OutputIterator , class Predicate >
static OutputIterator	decode (InputIterator first, InputIterator last, OutputIterator result, Predicate skip)
	Decodes a range of characters. More...

template<class sizeT >
static sizeT	max_encode_size (sizeT n)
	Computes the maximum length of an encoded character sequence. More...

template<class sizeT >
static sizeT	max_decode_size (sizeT n)
	Computes the maximum length of a decoded octet sequence. More...

Detailed Description

template<class charT, class traits = base32_traits<charT>>
class stlencoders::base32< charT, traits >

This class template implements the Base32 encoding as defined in RFC 4648 for a given character type and encoding alphabet.

The Base32 encoding is designed to represent arbitrary sequences of octets in a form that needs to be case insensitive but that need not be human readable.

The encoding process represents 40-bit groups of input data as output strings of 8 encoded characters. Proceeding from left to right, a 40-bit input group is formed by concatenating 5 8-bit input groups. These 40 bits are then treated as 8 concatenated 5-bit groups, each of which is translated into a single character in the Base32 alphabet.

Template Parameters

charT	the encoding character type
traits	the character encoding traits type

Member Typedef Documentation

template<class charT , class traits = base32_traits<charT>>

typedef charT stlencoders::base32< charT, traits >::char_type

The encoding character type.

template<class charT , class traits = base32_traits<charT>>

typedef traits::int_type stlencoders::base32< charT, traits >::int_type

An integral type representing an octet.

template<class charT , class traits = base32_traits<charT>>

typedef traits stlencoders::base32< charT, traits >::traits_type

The character encoding traits type.

Member Function Documentation

template<class charT , class traits = base32_traits<charT>>

template<class InputIterator , class OutputIterator >

static OutputIterator stlencoders::base32< charT, traits >::decode	(	InputIterator	first,
		InputIterator	last,
		OutputIterator	result
	)

inlinestatic

Decodes a range of characters.

Template Parameters

InputIterator	an iterator type satisfying input iterator requirements and referring to elements implicitly convertible to char_type
OutputIterator	an iterator type satisfying output iterator requirements

Parameters

first	an input iterator to the first position in the character range to be decoded
last	an input iterator to the final position in the character range to be decoded
result	an output iterator to the decoded octet range

Returns: an output iterator referring to one past the last value assigned to the output range

Exceptions

invalid_character	if a character not in the encoding alphabet is encountered
invalid_length	if the input range contains an invalid number of encoding characters

template<class charT , class traits = base32_traits<charT>>

template<class InputIterator , class OutputIterator , class Predicate >

static OutputIterator stlencoders::base32< charT, traits >::decode	(	InputIterator	first,
		InputIterator	last,
		OutputIterator	result,
		Predicate	skip
	)

inlinestatic

Decodes a range of characters.

For every character c not in the encoding alphabet,

if skip(c) evaluates to true, the character is ignored
if c equals traits::pad(), returns
otherwise, throws invalid_character

Template Parameters

InputIterator	an iterator type satisfying input iterator requirements and referring to elements implicitly convertible to char_type
OutputIterator	an iterator type satisfying output iterator requirements
Predicate	a predicate type

Parameters

first	an input iterator to the first position in the character range to be decoded
last	an input iterator to the final position in the character range to be decoded
result	an output iterator to the decoded octet range
skip	a function object that, when applied to a value of type char_type, returns a value testable as `true`

Returns: an output iterator referring to one past the last value assigned to the output range

Exceptions

invalid_character	if a character not in the encoding alphabet is encountered
invalid_length	if the input range contains an invalid number of encoding characters

template<class charT , class traits = base32_traits<charT>>

template<class InputIterator , class OutputIterator >

static OutputIterator stlencoders::base32< charT, traits >::encode	(	InputIterator	first,
		InputIterator	last,
		OutputIterator	result,
		bool	pad = `true`
	)

inlinestatic

Encodes a range of octets.

Template Parameters

InputIterator	an iterator type satisfying input iterator requirements and referring to elements implicitly convertible to int_type
OutputIterator	an iterator type satisfying output iterator requirements

Parameters

first	an input iterator to the first position in the octet range to be encoded
last	an input iterator to the final position in the octet range to be encoded
result	an output iterator to the encoded character range
pad	if `true`, performs padding at the end of the encoded character range

Returns: an output iterator referring to one past the last value assigned to the output range

template<class charT , class traits = base32_traits<charT>>

template<class InputIterator , class OutputIterator >

static OutputIterator stlencoders::base32< charT, traits >::encode_lower	(	InputIterator	first,
		InputIterator	last,
		OutputIterator	result,
		bool	pad = `true`
	)

inlinestatic

Encodes a range of octets using the lowercase encoding alphabet.

Template Parameters

InputIterator	an iterator type satisfying input iterator requirements and referring to elements implicitly convertible to int_type
OutputIterator	an iterator type satisfying output iterator requirements

Parameters

first	an input iterator to the first position in the octet range to be encoded
last	an input iterator to the final position in the octet range to be encoded
result	an output iterator to the encoded character range
pad	if `true`, performs padding at the end of the encoded character range

Returns: an output iterator referring to one past the last value assigned to the output range

template<class charT , class traits = base32_traits<charT>>

template<class InputIterator , class OutputIterator >

static OutputIterator stlencoders::base32< charT, traits >::encode_upper	(	InputIterator	first,
		InputIterator	last,
		OutputIterator	result,
		bool	pad = `true`
	)

inlinestatic

Encodes a range of octets using the uppercase encoding alphabet.

Template Parameters

InputIterator	an iterator type satisfying input iterator requirements and referring to elements implicitly convertible to int_type
OutputIterator	an iterator type satisfying output iterator requirements

Parameters

first	an input iterator to the first position in the octet range to be encoded
last	an input iterator to the final position in the octet range to be encoded
result	an output iterator to the encoded character range
pad	if `true`, performs padding at the end of the encoded character range

Returns: an output iterator referring to one past the last value assigned to the output range

template<class charT , class traits = base32_traits<charT>>

template<class sizeT >

static sizeT stlencoders::base32< charT, traits >::max_decode_size ( sizeT n)

inlinestatic

Computes the maximum length of a decoded octet sequence.

Template Parameters

sizeT an integral type

Parameters

n	the length of the input character sequence

Returns: the maximum length of the decoded octet sequence

template<class charT , class traits = base32_traits<charT>>

template<class sizeT >

static sizeT stlencoders::base32< charT, traits >::max_encode_size ( sizeT n)

inlinestatic

Computes the maximum length of an encoded character sequence.

Template Parameters

sizeT an integral type

Parameters

n	the length of the input octet sequence

Returns: the maximum length of the encoded character sequence

Public Types

Static Public Member Functions

Detailed Description

template<class charT, class traits = base32_traits<charT>> class stlencoders::base32< charT, traits >

Member Typedef Documentation

Member Function Documentation

template<class charT, class traits = base32_traits<charT>>
class stlencoders::base32< charT, traits >