baseN Namespace Reference

Functions
void	digitsMap (const char *digits, uint8_t digits_size, uint8_t *map)
bool	isValid (const char *str, size_t str_size, const uint8_t *map) noexcept
bool	isValid (std::string_view str, const uint8_t *map) noexcept
size_t	sizeEncoded (std::span< const uint8_t > data, uint8_t base)
size_t	sizeDecoded (std::string_view str, uint8_t base, const char *digits)
size_t	encode (const uint8_t *data, size_t data_size, char *str, size_t str_size, uint8_t base, const char *digits)
std::string	encode (std::span< const uint8_t > data, uint8_t base, const char *digits)
size_t	decode (const char *str, size_t str_size, uint8_t *data, size_t data_size, uint8_t base, const char *digits, const uint8_t *map)
std::vector< uint8_t >	decode (std::string_view str, uint8_t base, const char *digits, const uint8_t *map)

Function Documentation

digitsMap()

void baseN::digitsMap	(	const char *	digits,
		uint8_t	digits_size,
		uint8_t *	map )

Parameters

digits	char[base] array of digits
digits_size	size of digits array. Equals to base
map	[out] uint8_t[256] array, where at an index equal to the value of the symbol is the index of this symbol in the digits array. 255 if there is no symbol

Exceptions

basen::Exception(ALPH_COLLISION)

if alphabet contain same chars

isValid() [1/2]

bool baseN::isValid ( const char * str, size_t str_size, const uint8_t * map )

noexcept

Parameters

str	[in] pointer to string
str_size
map	uint8_t[256] array, where at an index equal to the value of the symbol is the index of this symbol in the digits array. 255 if there is no symbol

Returns

that string doesn't contain unnecessary symbols

isValid() [2/2]

bool baseN::isValid ( std::string_view str, const uint8_t * map )

noexcept

Parameters

str	string or string_view which you want to decode
map	uint8_t[256] array, where at an index equal to the value of the symbol is the index of this symbol in the digits array. 255 if there is no symbol

Returns

that string doesn't contain unnecessary symbols

sizeEncoded()

size_t baseN::sizeEncoded	(	std::span< const uint8_t >	data,
		uint8_t	base )

Parameters

data	vector or span of data which you want to encode
base	from 1 to 255

Returns

estimated size after encoding

Exceptions

basen::Exception(BASE)

if base < 2 || base > 254

sizeDecoded()

size_t baseN::sizeDecoded	(	std::string_view	str,
		uint8_t	base,
		const char *	digits )

Parameters

str	string or string_view which you want to decode
base	from 1 to 255
digits	char[base] array of digits

Returns

estimated size after decoding

Exceptions

basen::Exception(BASE)	if base < 2 || base > 254
basen::Exception(OVERFLOW)	if if there is an overflow

encode() [1/2]

size_t baseN::encode	(	const uint8_t *	data,
		size_t	data_size,
		char *	str,
		size_t	str_size,
		uint8_t	base,
		const char *	digits )

Parameters

data	[in] pointer to data which you want encode
data_size
str	[out] pointer to string for encoded data output
str_size
base	from 1 to 255
digits	char[base] array of digits std::vector<uint8_t> data; std::string str(baseN::sizeEncoded(data, 58), ' '); auto offset = baseN::encode(data.data(), data.size(), str.data(), str.size(), 58, base58::digits); // deleting leading zeroes str.erase(str.begin(), str.begin() + offset);

Returns

number of leading chars, which should be trimmed

Exceptions

basen::Exception(BASE)

if base < 2 || base > 254

Warning

contain leading zeros, returns count of them

encode() [2/2]

std::string baseN::encode	(	std::span< const uint8_t >	data,
		uint8_t	base,
		const char *	digits )

Parameters

data	vector or span of data which you want to encode
base	from 1 to 255
digits	char[base] array of digits std::vector<uint8_t> data; auto str = baseN::encode(data, 58, base58::digits);

Returns

encoded string

decode() [1/2]

size_t baseN::decode	(	const char *	str,
		size_t	str_size,
		uint8_t *	data,
		size_t	data_size,
		uint8_t	base,
		const char *	digits,
		const uint8_t *	map )

Parameters

str	[in] pointer to string which you want decode
str_size
data	[out] pointer to data for encoded string output
data_size
base	from 1 to 255
digits	char[base] array of digits
map	uint8_t[256] array, where at an index equal to the value of the symbol is the index of this symbol in the digits array. 255 if there is no symbol std::string str; std::vector<uint8_t> data(baseN::sizeDecoded(str, 58)); auto offset = baseN::decode(str.data(), str.size(), data.data(), data.size(), 58, base58::digits, base58::map); // deleting leading zeroes data.erase(data.begin(), data.begin() + offset);

Returns

number of leading chars, which should be trimmed

Exceptions

basen::Exception(BASE)	if base < 2 || base > 254
basen::Exception(OUT_OF_ALPH)	if out of alphabet

Warning

contain leading zeros, returns count of them

decode() [2/2]

std::vector< uint8_t > baseN::decode	(	std::string_view	str,
		uint8_t	base,
		const char *	digits,
		const uint8_t *	map )

Parameters

str	string or string_view which you want to decode
base	from 1 to 255
digits	char[base] array of digits
map	uint8_t[256] array, where at an index equal to the value of the symbol is the index of this symbol in the digits array. 255 if there is no symbol std::string str; auto data = baseN::decode(str, 58, base58::digits, base58::map);

Returns

decoded data