README.md

mitama-cpp-result

mitama-cpp-result is the C++20 libraries for error handling without exceptions.

mitama-cpp-result provides result<T, E>, maybe<T>, and associated monadic functions (like Result and Option in Programming Language Rust).

Test Status

Installation

Read Installation in the User Reference.

Contributing

Development

$ cmake -B build -DBUILD_TESTING=ON -DCMAKE_EXPORT_COMPILE_COMMANDS=ON
$ make -C build -j $(nproc)
$ ln -s $PWD/build/compile_commands.json $PWD

Run tests

$ cmake -B build -DBUILD_TESTING=ON
$ make -C build -j $(nproc)
$ cd build
$ ctest --output-on-failure

Run linter

$ cabin lint --exclude Catch2

Run formatter

$ cabin fmt --exclude Catch2

Build the latest document (requires poetry)

mitama-cpp-result> $ cd docs
mitama-cpp-result/docs> $ poetry install --no-root
mitama-cpp-result/docs> $ poetry run mkdocs serve