YukiWorkshop / cpp-base64X

Probably the most convenient & powerful C++ base64 library.

cpp-base64X

Probably the most convenient & powerful C++ base64 library.

Features

• Elegant & intuitive API
• Converts from/to different types
• Streamed operation
• Hardware accelerated

Requirements

Reasonably new versions of:

• C++17 compatible compiler
• CMake

Install

Use of the CPM package manager is recommended:

include(cmake/CPM.cmake)

CPMAddPackage(
        NAME cpp-base64X
        GITHUB_REPOSITORY YukiWorkshop/cpp-base64X
        VERSION 0.0.2
)

target_include_directories(your_project PUBLIC ${cpp-base64X_SOURCE_DIR})
target_link_libraries(your_project cpp-base64X)

Usage

#include <cpp-base64X.hpp>

using namespace YukiWorkshop;

One-time conversion:

auto s = Base64X::encode("Hello").as<std::string>();
auto s2 = Base64X::decode(s).as<std::string>();

You can use different input/output types. But the return type is limited to container types which element size is 1 (uint8_t, char, etc).

Note that you can only decode containers which element size is 1 (uint8_t, char, etc).

From vectors instead of strings:

std::vector<uint8_t> v = {0xaa, 0x55, 0x01, 0x02, 0x03};
auto s = Base64X::encode(v).as<std::vector<uint8_t>>();
std::vector<uint8_t> v2 = Base64X::decode(s).as_vector<uint8_t>();

And even vectors with doubles inside:

std::vector<double> v = {3.14159265357, 42.42, 233.233, 666.666};
auto s = Base64X::encode(v).as<std::vector<uint8_t>>();
auto v2 = Base64X::decode(s).as_vector<double>();
for (auto &it : v2) {
    std::cout << it << " ";
}

Stream operators:

std::string out;
Base64X::Encoder<std::string> e;
e >> out; // Set output target
e << "Hey guys, "
  << "this is Austin!"
  << nullptr; // Use nullptr for EOF

The classic equivalent of above:

std::string out;
Base64X::Encoder<std::string> e;
out += e.encode("Hey guys, ");
out += e.encode("this is Austin!");
out += e.finalize();

License

MIT

Acknowledgements

This library makes use of aklomp/base64, which is a great C base64 library.