101 lines
4.2 KiB
C++
101 lines
4.2 KiB
C++
#pragma once
|
|
|
|
#include <cstdint>
|
|
#include <span>
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
namespace baseN
|
|
{
|
|
/**
|
|
* @param str [in] pointer to string
|
|
* @param str_size
|
|
* @param map int8_t[256] array, where at an index equal to the value of the symbol is the index of this symbol in the digits array. -1 if there is no symbol
|
|
* @return that string doesn't contain unnecessary symbols
|
|
*/
|
|
bool isValid(const char *str, uint64_t str_size, const int8_t *map) noexcept;
|
|
/**
|
|
* @param str string or string_view which you want to decode
|
|
* @param map int8_t[256] array, where at an index equal to the value of the symbol is the index of this symbol in the digits array. -1 if there is no symbol
|
|
* @return that string doesn't contain unnecessary symbols
|
|
*/
|
|
bool isValid(std::string_view str, const int8_t *map) noexcept;
|
|
|
|
/**
|
|
* @param data vector or span of data which you want to encode
|
|
* @param base from 1 to 255
|
|
* @return estimated size after encoding
|
|
*/
|
|
uint64_t sizeEncoded(std::span<const uint8_t> data, uint8_t base);
|
|
/**
|
|
* @param str string or string_view which you want to decode
|
|
* @param base from 1 to 255
|
|
* @param digits char[base] array of digits
|
|
* @return estimated size after decoding
|
|
*/
|
|
uint64_t sizeDecoded(std::string_view str, uint8_t base, const char *digits) noexcept;
|
|
|
|
/**
|
|
* @param data [in] pointer to data which you want encode
|
|
* @param data_size
|
|
* @param str [out] pointer to string for encoded data output
|
|
* @param str_size
|
|
* @param base from 1 to 255
|
|
* @param digits char[base] array of digits
|
|
* @code{cpp}
|
|
* 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);
|
|
* @endcode
|
|
* @return number of leading chars, which should be trimmed
|
|
* @warning contain leading zeros, returns count of them
|
|
*/
|
|
uint64_t encode(const uint8_t *data, uint64_t data_size, char *str, uint64_t str_size, uint8_t base, const char *digits);
|
|
/**
|
|
* @param data vector or span of data which you want to encode
|
|
* @param base from 1 to 255
|
|
* @param digits char[base] array of digits
|
|
* @code{cpp}
|
|
* std::vector<uint8_t> data;
|
|
* auto str = baseN::encode(data, 58, base58::digits);
|
|
* @endcode
|
|
* @return encoded string
|
|
*/
|
|
std::string encode(std::span<const uint8_t> data, uint8_t base, const char *digits) noexcept;
|
|
|
|
/**
|
|
* @param str [in] pointer to string which you want decode
|
|
* @param str_size
|
|
* @param data [out] pointer to data for encoded string output
|
|
* @param data_size
|
|
* @param base from 1 to 255
|
|
* @param digits char[base] array of digits
|
|
* @param map int8_t[256] array, where at an index equal to the value of the symbol is the index of this symbol in the digits array. -1 if there is no symbol
|
|
* @code{cpp}
|
|
* 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);
|
|
* @endcode
|
|
* @return number of leading chars, which should be trimmed
|
|
* @warning contain leading zeros, returns count of them
|
|
*/
|
|
uint64_t decode(const char *str, uint64_t str_size, uint8_t *data, uint64_t data_size, uint8_t base, const char *digits, const int8_t *map);
|
|
/**
|
|
* @param str string or string_view which you want to decode
|
|
* @param base from 1 to 255
|
|
* @param digits char[base] array of digits
|
|
* @param map int8_t[256] array, where at an index equal to the value of the symbol is the index of this symbol in the digits array. -1 if there is no symbol
|
|
* @code{cpp}
|
|
* std::string str;
|
|
* auto data = baseN::decode(str, 58, base58::digits, base58::map);
|
|
* @endcode
|
|
* @return decoded data
|
|
*/
|
|
std::vector<uint8_t> decode(std::string_view str, uint8_t base, const char *digits, const int8_t *map) noexcept;
|
|
} |