Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gregorykogan/result
result is a C++ library that provides a Result type, which can be used to return and propagate errors. It's inspired by Rust's Result type.
https://github.com/gregorykogan/result
auto-documentation cpp doxygen doxygen-documentation doxygen-theme error-handling functional-programming modern-cpp result-type
Last synced: 1 day ago
JSON representation
result is a C++ library that provides a Result type, which can be used to return and propagate errors. It's inspired by Rust's Result type.
- Host: GitHub
- URL: https://github.com/gregorykogan/result
- Owner: GregoryKogan
- License: gpl-3.0
- Created: 2023-12-18T10:48:34.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-02-19T11:07:56.000Z (9 months ago)
- Last Synced: 2024-02-19T12:39:22.301Z (9 months ago)
- Topics: auto-documentation, cpp, doxygen, doxygen-documentation, doxygen-theme, error-handling, functional-programming, modern-cpp, result-type
- Language: C++
- Homepage: https://gregorykogan.github.io/result/
- Size: 324 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# result
Result-CPP is a C++ library that provides a `Result` type, which can be used to return and propagate errors. It's inspired by Rust's `std::Result` type.
It's a header-only library, so you can just copy the `result.h` file into your project and start using it.
Or you can use it as a git submodule.
Or fetch it with [FetchContent](https://cmake.org/cmake/help/latest/module/FetchContent.html) if you're using CMake.
## Documentation
You can find the documentation [here](https://gregorykogan.github.io/result-cpp/).
And the project's repo [here](https://github.com/GregoryKogan/result-cpp).
It's auto generated with [Doxygen](https://www.doxygen.nl/index.html) by GitHub Actions and hosted on GitHub Pages.
It uses the [Doxygen Awesome](https://jothepro.github.io/doxygen-awesome-css/) theme, that I customized to use Tokyo Night palette.
## Features
- `Result` type for returning and propagating errors.
- `Ok` and `Err` static methods for creating successful and unsuccessful `Result` objects respectively.
- `is_ok` and `is_err` methods for checking if the `Result` is successful or unsuccessful.
- `unwrap`, `unwrap_or` and `unwrap_err` methods for extracting the value or error from the `Result`.
## Usage
```cpp
#include
#include "result.h"
res::Result divide(int a, int b) {
if (b == 0) {
return res::Err(std::string("Division by zero"));
} else {
return res::Ok(a / b);
}
}
int main() {
auto result = divide(10, 2);
if (result.is_ok()) {
std::cout << "Result: " << result.unwrap() << '\n';
} else {
std::cout << "Error: " << result.unwrap_err() << '\n';
}
}
```
You can find many other use cases within [/tests](https://github.com/GregoryKogan/result-cpp/tree/main/tests) directory
## Contributing
I'm not planning to write any more features for this library, but I will gladly accept any pull requests that add new features or fix bugs.