ripple::base64 Namespace Reference

Functions
char const *	get_alphabet ()
signed char const *	get_inverse ()
constexpr std::size_t	encoded_size (std::size_t n)
	Returns max chars needed to encode a base64 string. More...
constexpr std::size_t	decoded_size (std::size_t n)
	Returns max bytes needed to decode a base64 string. More...
std::size_t	encode (void *dest, void const *src, std::size_t len)
	Encode a series of octets as a padded, base64 string. More...
std::pair< std::size_t, std::size_t >	decode (void *dest, char const *src, std::size_t len)
	Decode a padded base64 string into a series of octets. More...

Function Documentation

get_alphabet()

char const* ripple::base64::get_alphabet

(

)

Definition at line 67 of file base64.cpp.

get_inverse()

signed char const* ripple::base64::get_inverse

(

)

Definition at line 75 of file base64.cpp.

encoded_size()

constexpr std::size_t ripple::base64::encoded_size ( std::size_t  n )

constexpr

Returns max chars needed to encode a base64 string.

Definition at line 115 of file base64.cpp.

decoded_size()

constexpr std::size_t ripple::base64::decoded_size ( std::size_t  n )

constexpr

Returns max bytes needed to decode a base64 string.

Definition at line 121 of file base64.cpp.

encode()

std::size_t ripple::base64::encode	(	void *	dest,
		void const *	src,
		std::size_t	len
	)

Encode a series of octets as a padded, base64 string.

The resulting string will not be null terminated.

Requires

The memory pointed to by out points to valid memory of at least encoded_size(len) bytes.

Returns

The number of characters written to out. This will exclude any null termination.

Definition at line 139 of file base64.cpp.

decode()

std::pair<std::size_t, std::size_t> ripple::base64::decode	(	void *	dest,
		char const *	src,
		std::size_t	len
	)

Decode a padded base64 string into a series of octets.

Requires

The memory pointed to by out points to valid memory of at least decoded_size(len) bytes.

Returns

The number of octets written to out, and the number of characters read from the input string, expressed as a pair.

Definition at line 189 of file base64.cpp.