https://github.com/loliGothicK/mitama-cpp-result
A Library that provides `result<T, E>` and `maybe<T>` and monadic functions for them.
https://github.com/loliGothicK/mitama-cpp-result
Last synced: 3 months ago
JSON representation
A Library that provides `result<T, E>` and `maybe<T>` and monadic functions for them.
- Host: GitHub
- URL: https://github.com/loliGothicK/mitama-cpp-result
- Owner: loliGothicK
- License: mit
- Created: 2018-09-21T09:38:48.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2025-01-16T17:35:35.000Z (6 months ago)
- Last Synced: 2025-01-16T18:53:16.421Z (6 months ago)
- Language: C++
- Homepage:
- Size: 6.51 MB
- Stars: 50
- Watchers: 6
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# mitama-cpp-result
**mitama-cpp-result** is the C++20 libraries for error handling without exceptions.
**mitama-cpp-result** provides `result`, `maybe`, and associated monadic functions
(like [Result](https://doc.rust-lang.org/std/result/enum.Result.html)
and [Option](https://doc.rust-lang.org/std/option/enum.Option.html) in Programming Language Rust).
## Test Status
[](https://github.com/LoliGothick/mitama-cpp-result/actions/workflows/full-test.yml)
## Installation
Read [Installation](https://loligothick.github.io/mitama-cpp-result/#installation) in [the User Reference](https://loligothick.github.io/mitama-cpp-result/).
## Contributing
### Development
```shell
$ 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
```shell
$ cmake -B build -DBUILD_TESTING=ON
$ make -C build -j $(nproc)
$ cd build
$ ctest --output-on-failure
```
### Run linter
```shell
$ cabin lint --exclude Catch2
```
### Run formatter
```shell
$ cabin fmt --exclude Catch2
```
### Build the latest document (requires [poetry](https://python-poetry.org/))
```shell
mitama-cpp-result> $ cd docs
mitama-cpp-result/docs> $ poetry install --no-root
mitama-cpp-result/docs> $ poetry run mkdocs serve
```