xrpl::base64 Namespace Reference

Functions
char const *	getAlphabet ()
signed char const *	getInverse ()
constexpr std::size_t	encodedSize (std::size_t n)
	Returns max chars needed to encode a base64 string.
constexpr std::size_t	decodedSize (std::size_t n)
	Returns max bytes needed to decode a base64 string.
std::size_t	encode (void *dest, void const *src, std::size_t len)
	Encode a series of octets as a padded, base64 string.
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.

Function Documentation

getAlphabet()

char const * xrpl::base64::getAlphabet

(

)

Definition at line 48 of file libxrpl/basics/base64.cpp.

getInverse()

signed char const * xrpl::base64::getInverse

(

)

Definition at line 56 of file libxrpl/basics/base64.cpp.

encodedSize()

std::size_t xrpl::base64::encodedSize ( std::size_t n )

constexpr

Returns max chars needed to encode a base64 string.

Definition at line 81 of file libxrpl/basics/base64.cpp.

decodedSize()

std::size_t xrpl::base64::decodedSize ( std::size_t n )

constexpr

Returns max bytes needed to decode a base64 string.

Definition at line 88 of file libxrpl/basics/base64.cpp.

encode()

std::size_t xrpl::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 106 of file libxrpl/basics/base64.cpp.

decode()

std::pair< std::size_t, std::size_t > xrpl::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 157 of file libxrpl/basics/base64.cpp.