mirror of
https://github.com/trafi/maybe-result-cpp
synced 2024-11-22 02:32:02 +01:00
Initial files.
This commit is contained in:
commit
6df8f76748
18
.clang-format
Normal file
18
.clang-format
Normal file
@ -0,0 +1,18 @@
|
|||||||
|
---
|
||||||
|
Language: Cpp
|
||||||
|
BasedOnStyle: WebKit
|
||||||
|
AllowAllParametersOfDeclarationOnNextLine: true
|
||||||
|
BinPackArguments: false
|
||||||
|
BinPackParameters: false
|
||||||
|
ColumnLimit: 100
|
||||||
|
ConstructorInitializerAllOnOneLineOrOnePerLine: true
|
||||||
|
Cpp11BracedListStyle: true
|
||||||
|
AllowShortBlocksOnASingleLine: false
|
||||||
|
AllowShortFunctionsOnASingleLine: false
|
||||||
|
AlignAfterOpenBracket: true
|
||||||
|
AlwaysBreakAfterDefinitionReturnType: None
|
||||||
|
AlwaysBreakTemplateDeclarations: true
|
||||||
|
IndentCaseLabels: true
|
||||||
|
PenaltyReturnTypeOnItsOwnLine: 300
|
||||||
|
NamespaceIndentation: All
|
||||||
|
Standard: Cpp11
|
1
.gitignore
vendored
Normal file
1
.gitignore
vendored
Normal file
@ -0,0 +1 @@
|
|||||||
|
.idea/
|
5
CMakeLists.txt
Normal file
5
CMakeLists.txt
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
cmake_minimum_required(VERSION 3.3)
|
||||||
|
project(maybe_result)
|
||||||
|
|
||||||
|
add_subdirectory(src)
|
||||||
|
add_subdirectory(tests)
|
201
LICENSE-APACHE
Normal file
201
LICENSE-APACHE
Normal file
@ -0,0 +1,201 @@
|
|||||||
|
Apache License
|
||||||
|
Version 2.0, January 2004
|
||||||
|
http://www.apache.org/licenses/
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||||
|
|
||||||
|
1. Definitions.
|
||||||
|
|
||||||
|
"License" shall mean the terms and conditions for use, reproduction,
|
||||||
|
and distribution as defined by Sections 1 through 9 of this document.
|
||||||
|
|
||||||
|
"Licensor" shall mean the copyright owner or entity authorized by
|
||||||
|
the copyright owner that is granting the License.
|
||||||
|
|
||||||
|
"Legal Entity" shall mean the union of the acting entity and all
|
||||||
|
other entities that control, are controlled by, or are under common
|
||||||
|
control with that entity. For the purposes of this definition,
|
||||||
|
"control" means (i) the power, direct or indirect, to cause the
|
||||||
|
direction or management of such entity, whether by contract or
|
||||||
|
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||||
|
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||||
|
|
||||||
|
"You" (or "Your") shall mean an individual or Legal Entity
|
||||||
|
exercising permissions granted by this License.
|
||||||
|
|
||||||
|
"Source" form shall mean the preferred form for making modifications,
|
||||||
|
including but not limited to software source code, documentation
|
||||||
|
source, and configuration files.
|
||||||
|
|
||||||
|
"Object" form shall mean any form resulting from mechanical
|
||||||
|
transformation or translation of a Source form, including but
|
||||||
|
not limited to compiled object code, generated documentation,
|
||||||
|
and conversions to other media types.
|
||||||
|
|
||||||
|
"Work" shall mean the work of authorship, whether in Source or
|
||||||
|
Object form, made available under the License, as indicated by a
|
||||||
|
copyright notice that is included in or attached to the work
|
||||||
|
(an example is provided in the Appendix below).
|
||||||
|
|
||||||
|
"Derivative Works" shall mean any work, whether in Source or Object
|
||||||
|
form, that is based on (or derived from) the Work and for which the
|
||||||
|
editorial revisions, annotations, elaborations, or other modifications
|
||||||
|
represent, as a whole, an original work of authorship. For the purposes
|
||||||
|
of this License, Derivative Works shall not include works that remain
|
||||||
|
separable from, or merely link (or bind by name) to the interfaces of,
|
||||||
|
the Work and Derivative Works thereof.
|
||||||
|
|
||||||
|
"Contribution" shall mean any work of authorship, including
|
||||||
|
the original version of the Work and any modifications or additions
|
||||||
|
to that Work or Derivative Works thereof, that is intentionally
|
||||||
|
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||||
|
or by an individual or Legal Entity authorized to submit on behalf of
|
||||||
|
the copyright owner. For the purposes of this definition, "submitted"
|
||||||
|
means any form of electronic, verbal, or written communication sent
|
||||||
|
to the Licensor or its representatives, including but not limited to
|
||||||
|
communication on electronic mailing lists, source code control systems,
|
||||||
|
and issue tracking systems that are managed by, or on behalf of, the
|
||||||
|
Licensor for the purpose of discussing and improving the Work, but
|
||||||
|
excluding communication that is conspicuously marked or otherwise
|
||||||
|
designated in writing by the copyright owner as "Not a Contribution."
|
||||||
|
|
||||||
|
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||||
|
on behalf of whom a Contribution has been received by Licensor and
|
||||||
|
subsequently incorporated within the Work.
|
||||||
|
|
||||||
|
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
copyright license to reproduce, prepare Derivative Works of,
|
||||||
|
publicly display, publicly perform, sublicense, and distribute the
|
||||||
|
Work and such Derivative Works in Source or Object form.
|
||||||
|
|
||||||
|
3. Grant of Patent License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
(except as stated in this section) patent license to make, have made,
|
||||||
|
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||||
|
where such license applies only to those patent claims licensable
|
||||||
|
by such Contributor that are necessarily infringed by their
|
||||||
|
Contribution(s) alone or by combination of their Contribution(s)
|
||||||
|
with the Work to which such Contribution(s) was submitted. If You
|
||||||
|
institute patent litigation against any entity (including a
|
||||||
|
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||||
|
or a Contribution incorporated within the Work constitutes direct
|
||||||
|
or contributory patent infringement, then any patent licenses
|
||||||
|
granted to You under this License for that Work shall terminate
|
||||||
|
as of the date such litigation is filed.
|
||||||
|
|
||||||
|
4. Redistribution. You may reproduce and distribute copies of the
|
||||||
|
Work or Derivative Works thereof in any medium, with or without
|
||||||
|
modifications, and in Source or Object form, provided that You
|
||||||
|
meet the following conditions:
|
||||||
|
|
||||||
|
(a) You must give any other recipients of the Work or
|
||||||
|
Derivative Works a copy of this License; and
|
||||||
|
|
||||||
|
(b) You must cause any modified files to carry prominent notices
|
||||||
|
stating that You changed the files; and
|
||||||
|
|
||||||
|
(c) You must retain, in the Source form of any Derivative Works
|
||||||
|
that You distribute, all copyright, patent, trademark, and
|
||||||
|
attribution notices from the Source form of the Work,
|
||||||
|
excluding those notices that do not pertain to any part of
|
||||||
|
the Derivative Works; and
|
||||||
|
|
||||||
|
(d) If the Work includes a "NOTICE" text file as part of its
|
||||||
|
distribution, then any Derivative Works that You distribute must
|
||||||
|
include a readable copy of the attribution notices contained
|
||||||
|
within such NOTICE file, excluding those notices that do not
|
||||||
|
pertain to any part of the Derivative Works, in at least one
|
||||||
|
of the following places: within a NOTICE text file distributed
|
||||||
|
as part of the Derivative Works; within the Source form or
|
||||||
|
documentation, if provided along with the Derivative Works; or,
|
||||||
|
within a display generated by the Derivative Works, if and
|
||||||
|
wherever such third-party notices normally appear. The contents
|
||||||
|
of the NOTICE file are for informational purposes only and
|
||||||
|
do not modify the License. You may add Your own attribution
|
||||||
|
notices within Derivative Works that You distribute, alongside
|
||||||
|
or as an addendum to the NOTICE text from the Work, provided
|
||||||
|
that such additional attribution notices cannot be construed
|
||||||
|
as modifying the License.
|
||||||
|
|
||||||
|
You may add Your own copyright statement to Your modifications and
|
||||||
|
may provide additional or different license terms and conditions
|
||||||
|
for use, reproduction, or distribution of Your modifications, or
|
||||||
|
for any such Derivative Works as a whole, provided Your use,
|
||||||
|
reproduction, and distribution of the Work otherwise complies with
|
||||||
|
the conditions stated in this License.
|
||||||
|
|
||||||
|
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||||
|
any Contribution intentionally submitted for inclusion in the Work
|
||||||
|
by You to the Licensor shall be under the terms and conditions of
|
||||||
|
this License, without any additional terms or conditions.
|
||||||
|
Notwithstanding the above, nothing herein shall supersede or modify
|
||||||
|
the terms of any separate license agreement you may have executed
|
||||||
|
with Licensor regarding such Contributions.
|
||||||
|
|
||||||
|
6. Trademarks. This License does not grant permission to use the trade
|
||||||
|
names, trademarks, service marks, or product names of the Licensor,
|
||||||
|
except as required for reasonable and customary use in describing the
|
||||||
|
origin of the Work and reproducing the content of the NOTICE file.
|
||||||
|
|
||||||
|
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||||
|
agreed to in writing, Licensor provides the Work (and each
|
||||||
|
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||||
|
implied, including, without limitation, any warranties or conditions
|
||||||
|
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||||
|
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||||
|
appropriateness of using or redistributing the Work and assume any
|
||||||
|
risks associated with Your exercise of permissions under this License.
|
||||||
|
|
||||||
|
8. Limitation of Liability. In no event and under no legal theory,
|
||||||
|
whether in tort (including negligence), contract, or otherwise,
|
||||||
|
unless required by applicable law (such as deliberate and grossly
|
||||||
|
negligent acts) or agreed to in writing, shall any Contributor be
|
||||||
|
liable to You for damages, including any direct, indirect, special,
|
||||||
|
incidental, or consequential damages of any character arising as a
|
||||||
|
result of this License or out of the use or inability to use the
|
||||||
|
Work (including but not limited to damages for loss of goodwill,
|
||||||
|
work stoppage, computer failure or malfunction, or any and all
|
||||||
|
other commercial damages or losses), even if such Contributor
|
||||||
|
has been advised of the possibility of such damages.
|
||||||
|
|
||||||
|
9. Accepting Warranty or Additional Liability. While redistributing
|
||||||
|
the Work or Derivative Works thereof, You may choose to offer,
|
||||||
|
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||||
|
or other liability obligations and/or rights consistent with this
|
||||||
|
License. However, in accepting such obligations, You may act only
|
||||||
|
on Your own behalf and on Your sole responsibility, not on behalf
|
||||||
|
of any other Contributor, and only if You agree to indemnify,
|
||||||
|
defend, and hold each Contributor harmless for any liability
|
||||||
|
incurred by, or claims asserted against, such Contributor by reason
|
||||||
|
of your accepting any such warranty or additional liability.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
APPENDIX: How to apply the Apache License to your work.
|
||||||
|
|
||||||
|
To apply the Apache License to your work, attach the following
|
||||||
|
boilerplate notice, with the fields enclosed by brackets "{}"
|
||||||
|
replaced with your own identifying information. (Don't include
|
||||||
|
the brackets!) The text should be enclosed in the appropriate
|
||||||
|
comment syntax for the file format. We also recommend that a
|
||||||
|
file or class name and description of purpose be included on the
|
||||||
|
same "printed page" as the copyright notice for easier
|
||||||
|
identification within third-party archives.
|
||||||
|
|
||||||
|
Copyright {yyyy} {name of copyright owner}
|
||||||
|
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
you may not use this file except in compliance with the License.
|
||||||
|
You may obtain a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
See the License for the specific language governing permissions and
|
||||||
|
limitations under the License.
|
19
LICENSE-MIT
Normal file
19
LICENSE-MIT
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
Copyright (c) 2016 TRAFI
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in
|
||||||
|
all copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||||
|
THE SOFTWARE.
|
58
README.md
Normal file
58
README.md
Normal file
@ -0,0 +1,58 @@
|
|||||||
|
# Maybe Result
|
||||||
|
|
||||||
|
Maybe Result is a return value wrapper that can contain either a value
|
||||||
|
`T` or error `E`. It borrows ideas heavily from the [C++17's
|
||||||
|
`std::experimental::optional`][optional], [Rust's std::result](result) and
|
||||||
|
the [`std::expected`][expected] that was proposed but not yet accepted
|
||||||
|
for C++17.
|
||||||
|
|
||||||
|
[optional]: http://en.cppreference.com/w/cpp/experimental/optional
|
||||||
|
[result]: https://doc.rust-lang.org/std/result/
|
||||||
|
[expected]: https://github.com/ptal/expected
|
||||||
|
|
||||||
|
### How is it different from `std::experimental::optional`?
|
||||||
|
|
||||||
|
Has a value for error instead of `nullopt`.
|
||||||
|
|
||||||
|
### How is it different from `std::expected`?
|
||||||
|
|
||||||
|
It does not require the error to be an exception, and does not fall back to
|
||||||
|
exceptions. All values must be checked, similar to `std::experimental::optional`.
|
||||||
|
|
||||||
|
## Setting up
|
||||||
|
|
||||||
|
This is header-only library. We recommend to add `src` to included directories,
|
||||||
|
so that the include would be:
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
#include <maybe/result.hpp>
|
||||||
|
```
|
||||||
|
|
||||||
|
A C++ compiler shat supports C++14 is required.
|
||||||
|
You can use `-std=c++14` flag for sufficiently recent versions of
|
||||||
|
`GCC` or `CLANG`.
|
||||||
|
|
||||||
|
__Warning! Library is highly experimental and is not guaranteed to work.__
|
||||||
|
|
||||||
|
## Running tests
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cmake .
|
||||||
|
make tests && ./tests/tests
|
||||||
|
```
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
Licensed under either of
|
||||||
|
|
||||||
|
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
|
||||||
|
* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
|
||||||
|
|
||||||
|
at your option.
|
||||||
|
|
||||||
|
### Contribution
|
||||||
|
|
||||||
|
Unless you explicitly state otherwise, any contribution intentionally
|
||||||
|
submitted for inclusion in the work by you, as defined in the Apache-2.0
|
||||||
|
license, shall be dual licensed as above, without any additional terms or
|
||||||
|
conditions.
|
7
src/CMakeLists.txt
Normal file
7
src/CMakeLists.txt
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
set(TARGET "maybe_result")
|
||||||
|
|
||||||
|
add_library(${TARGET} INTERFACE)
|
||||||
|
|
||||||
|
target_include_directories(${TARGET}
|
||||||
|
INTERFACE .
|
||||||
|
)
|
15
src/maybe/result.fwd.hpp
Normal file
15
src/maybe/result.fwd.hpp
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2016 TRAFI
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0, <LICENSE-APACHE or
|
||||||
|
* http://apache.org/licenses/LICENSE-2.0> or the MIT license <LICENSE-MIT or
|
||||||
|
* http://opensource.org/licenses/MIT>, at your option. This file may not be
|
||||||
|
* copied, modified, or distributed except according to those terms.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
#pragma once
|
||||||
|
|
||||||
|
namespace maybe {
|
||||||
|
template <typename T, typename E> class result;
|
||||||
|
}
|
203
src/maybe/result.hpp
Normal file
203
src/maybe/result.hpp
Normal file
@ -0,0 +1,203 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2016 TRAFI
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0, <LICENSE-APACHE or
|
||||||
|
* http://apache.org/licenses/LICENSE-2.0> or the MIT license <LICENSE-MIT or
|
||||||
|
* http://opensource.org/licenses/MIT>, at your option. This file may not be
|
||||||
|
* copied, modified, or distributed except according to those terms.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
#pragma once
|
||||||
|
|
||||||
|
#include <stdexcept>
|
||||||
|
#include <string>
|
||||||
|
|
||||||
|
#include "result.fwd.hpp"
|
||||||
|
|
||||||
|
namespace maybe {
|
||||||
|
|
||||||
|
namespace internal {
|
||||||
|
enum class Value { OK, ERR, NONE };
|
||||||
|
struct Placeholder {
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
class bad_result_access : public std::logic_error {
|
||||||
|
public:
|
||||||
|
explicit bad_result_access(const std::string& what_arg) : logic_error{what_arg}
|
||||||
|
{
|
||||||
|
}
|
||||||
|
explicit bad_result_access(const char* what_arg) : logic_error{what_arg}
|
||||||
|
{
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
// workaround: std utility functions aren't constexpr yet
|
||||||
|
template <class T>
|
||||||
|
inline constexpr T&& constexpr_forward(typename std::remove_reference<T>::type& t) noexcept
|
||||||
|
{
|
||||||
|
return static_cast<T&&>(t);
|
||||||
|
}
|
||||||
|
|
||||||
|
template <class T>
|
||||||
|
inline constexpr T&& constexpr_forward(typename std::remove_reference<T>::type&& t) noexcept
|
||||||
|
{
|
||||||
|
static_assert(!std::is_lvalue_reference<T>::value, "!!");
|
||||||
|
return static_cast<T&&>(t);
|
||||||
|
}
|
||||||
|
|
||||||
|
template <typename T, typename E>
|
||||||
|
class result final {
|
||||||
|
public:
|
||||||
|
result() : tag(internal::Value::NONE)
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
/** ok initializer */
|
||||||
|
result(T&& value, internal::Placeholder) : tag(internal::Value::OK)
|
||||||
|
{
|
||||||
|
init_ok(std::forward<T>(value));
|
||||||
|
}
|
||||||
|
|
||||||
|
/** err initializer */
|
||||||
|
result(internal::Placeholder, E&& value) : tag(internal::Value::ERR)
|
||||||
|
{
|
||||||
|
init_err(std::forward<T>(value));
|
||||||
|
}
|
||||||
|
|
||||||
|
/** copy constructor */
|
||||||
|
result(const result& other) noexcept
|
||||||
|
{
|
||||||
|
copy_from(other);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** copy assignment */
|
||||||
|
result& operator=(const result& other) noexcept
|
||||||
|
{
|
||||||
|
clear();
|
||||||
|
copy_from(other);
|
||||||
|
return *this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** move constructor */
|
||||||
|
result(result&& other) noexcept
|
||||||
|
{
|
||||||
|
set_from(other);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** move assignment */
|
||||||
|
result& operator=(result&& other) noexcept
|
||||||
|
{
|
||||||
|
clear();
|
||||||
|
set_from(other);
|
||||||
|
return *this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** destructor */
|
||||||
|
~result<T, E>()
|
||||||
|
{
|
||||||
|
clear();
|
||||||
|
};
|
||||||
|
|
||||||
|
/** helper constructor for ok value */
|
||||||
|
constexpr static result<T, E> ok(T&& value) noexcept
|
||||||
|
{
|
||||||
|
return result<T, E>(std::forward<T>(value), internal::Placeholder{});
|
||||||
|
}
|
||||||
|
|
||||||
|
/** helper constructor for err value */
|
||||||
|
constexpr static result<T, E> err(E&& err) noexcept
|
||||||
|
{
|
||||||
|
return result<T, E>(internal::Placeholder{}, std::forward<E>(err));
|
||||||
|
}
|
||||||
|
|
||||||
|
constexpr bool is_ok() const noexcept
|
||||||
|
{
|
||||||
|
return tag == internal::Value::OK;
|
||||||
|
}
|
||||||
|
|
||||||
|
constexpr bool is_err() const noexcept
|
||||||
|
{
|
||||||
|
return tag == internal::Value::ERR;
|
||||||
|
}
|
||||||
|
|
||||||
|
constexpr T const& ok_value() const&
|
||||||
|
{
|
||||||
|
return is_ok() ? ok_val : (throw bad_result_access("bad ok result access"), ok_val);
|
||||||
|
}
|
||||||
|
|
||||||
|
constexpr T& ok_value() &
|
||||||
|
{
|
||||||
|
return is_ok() ? ok_val : (throw bad_result_access("bad ok result access"), ok_val);
|
||||||
|
}
|
||||||
|
|
||||||
|
constexpr E const& err_value() const&
|
||||||
|
{
|
||||||
|
return is_err() ? err_val
|
||||||
|
: (throw bad_result_access("bad err result access"), err_val);
|
||||||
|
}
|
||||||
|
|
||||||
|
constexpr E& err_value() &
|
||||||
|
{
|
||||||
|
return is_err() ? err_val
|
||||||
|
: (throw bad_result_access("bad err result access"), err_val);
|
||||||
|
}
|
||||||
|
|
||||||
|
template <class V>
|
||||||
|
constexpr T ok_value_or(V&& v) const&
|
||||||
|
{
|
||||||
|
return is_ok() ? ok_val : static_cast<T>(constexpr_forward<V>(v));
|
||||||
|
}
|
||||||
|
|
||||||
|
template <class V>
|
||||||
|
constexpr E err_value_or(V&& v) const&
|
||||||
|
{
|
||||||
|
return is_err() ? err_val : static_cast<E>(constexpr_forward<V>(v));
|
||||||
|
}
|
||||||
|
|
||||||
|
explicit constexpr operator bool() const noexcept
|
||||||
|
{
|
||||||
|
return is_ok();
|
||||||
|
}
|
||||||
|
|
||||||
|
constexpr T* ok_dataptr() const noexcept
|
||||||
|
{
|
||||||
|
return std::addressof(ok_val);
|
||||||
|
}
|
||||||
|
|
||||||
|
constexpr E* err_dataptr() const noexcept
|
||||||
|
{
|
||||||
|
return std::addressof(err_val);
|
||||||
|
}
|
||||||
|
|
||||||
|
private:
|
||||||
|
constexpr void copy_from(const result<T, E>& other) noexcept;
|
||||||
|
constexpr void set_from(result<T, E>& other) noexcept;
|
||||||
|
constexpr void init_ok(T&& value) noexcept;
|
||||||
|
constexpr void init_err(T&& value) noexcept;
|
||||||
|
constexpr void clear() noexcept;
|
||||||
|
|
||||||
|
internal::Value tag;
|
||||||
|
union {
|
||||||
|
T ok_val;
|
||||||
|
E err_val;
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
template <typename T, typename E>
|
||||||
|
constexpr bool operator==(const result<T, E>& x, const result<T, E>& y)
|
||||||
|
{
|
||||||
|
return x.is_ok() && y.is_ok()
|
||||||
|
? *x.ok_dataptr() == *y.ok_dataptr()
|
||||||
|
: (x.is_err() && y.is_err() ? *x.err_dataptr() == *y.err_dataptr() : false);
|
||||||
|
}
|
||||||
|
|
||||||
|
template <typename T, typename E>
|
||||||
|
constexpr bool operator!=(const result<T, E>& x, const result<T, E>& y)
|
||||||
|
{
|
||||||
|
return !(x == y);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#include "result.inline.hpp"
|
83
src/maybe/result.inline.hpp
Normal file
83
src/maybe/result.inline.hpp
Normal file
@ -0,0 +1,83 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2016 TRAFI
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0, <LICENSE-APACHE or
|
||||||
|
* http://apache.org/licenses/LICENSE-2.0> or the MIT license <LICENSE-MIT or
|
||||||
|
* http://opensource.org/licenses/MIT>, at your option. This file may not be
|
||||||
|
* copied, modified, or distributed except according to those terms.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
#pragma once
|
||||||
|
|
||||||
|
#include "result.hpp"
|
||||||
|
|
||||||
|
template <typename T, typename E>
|
||||||
|
constexpr void maybe::result<T, E>::copy_from(const result<T, E>& other) noexcept
|
||||||
|
{
|
||||||
|
using maybe::internal::Value;
|
||||||
|
|
||||||
|
switch (other.tag) {
|
||||||
|
case Value::OK:
|
||||||
|
init_ok(*other.ok_dataptr());
|
||||||
|
break;
|
||||||
|
case Value::ERR:
|
||||||
|
init_err(*other.err_dataptr());
|
||||||
|
break;
|
||||||
|
default:
|
||||||
|
tag = Value::NONE;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
template <typename T, typename E>
|
||||||
|
constexpr void maybe::result<T, E>::set_from(result<T, E>& other) noexcept
|
||||||
|
{
|
||||||
|
using maybe::internal::Value;
|
||||||
|
|
||||||
|
switch (other.tag) {
|
||||||
|
case Value::OK:
|
||||||
|
init_ok(std::move(other.ok_val));
|
||||||
|
break;
|
||||||
|
case Value::ERR:
|
||||||
|
init_err(std::move(other.err_val));
|
||||||
|
break;
|
||||||
|
default:
|
||||||
|
tag = Value::NONE;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
other.tag = Value::NONE;
|
||||||
|
}
|
||||||
|
|
||||||
|
template <typename T, typename E>
|
||||||
|
constexpr void maybe::result<T, E>::init_ok(T&& value) noexcept
|
||||||
|
{
|
||||||
|
tag = maybe::internal::Value::OK;
|
||||||
|
::new (static_cast<void*>(ok_dataptr())) T(std::forward<T>(value));
|
||||||
|
}
|
||||||
|
|
||||||
|
template <typename T, typename E>
|
||||||
|
constexpr void maybe::result<T, E>::init_err(T&& value) noexcept
|
||||||
|
{
|
||||||
|
tag = maybe::internal::Value::ERR;
|
||||||
|
::new (static_cast<void*>(err_dataptr())) T(std::forward<T>(value));
|
||||||
|
}
|
||||||
|
|
||||||
|
template <typename T, typename E>
|
||||||
|
constexpr void maybe::result<T, E>::clear() noexcept
|
||||||
|
{
|
||||||
|
using maybe::internal::Value;
|
||||||
|
|
||||||
|
switch (tag) {
|
||||||
|
case Value::OK:
|
||||||
|
(&this->ok_val)->T::~T();
|
||||||
|
tag = Value::NONE;
|
||||||
|
break;
|
||||||
|
case internal::Value::ERR:
|
||||||
|
(&this->err_val)->E::~E();
|
||||||
|
tag = Value::NONE;
|
||||||
|
break;
|
||||||
|
default:
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
12
tests/CMakeLists.txt
Normal file
12
tests/CMakeLists.txt
Normal file
@ -0,0 +1,12 @@
|
|||||||
|
set(TARGET "tests")
|
||||||
|
|
||||||
|
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++14")
|
||||||
|
|
||||||
|
add_executable(${TARGET}
|
||||||
|
main.cpp
|
||||||
|
maybe_result_tests.cpp
|
||||||
|
)
|
||||||
|
|
||||||
|
target_include_directories(${TARGET}
|
||||||
|
PUBLIC $<TARGET_PROPERTY:maybe_result,INTERFACE_INCLUDE_DIRECTORIES>
|
||||||
|
)
|
10203
tests/catch.hpp
Normal file
10203
tests/catch.hpp
Normal file
File diff suppressed because it is too large
Load Diff
11
tests/main.cpp
Normal file
11
tests/main.cpp
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
#define CATCH_CONFIG_MAIN
|
||||||
|
#include "catch.hpp"
|
||||||
|
|
||||||
|
/*
|
||||||
|
Exactly one source file must #define either CATCH_CONFIG_MAIN or CATCH_CONFIG_RUNNER before
|
||||||
|
#include-ing Catch.
|
||||||
|
In this file do not write any test cases!
|
||||||
|
In most cases that means this file will just contain two lines (the #define and the #include).
|
||||||
|
|
||||||
|
https://github.com/philsquared/Catch/blob/master/docs/tutorial.md
|
||||||
|
*/
|
197
tests/maybe_result_tests.cpp
Normal file
197
tests/maybe_result_tests.cpp
Normal file
@ -0,0 +1,197 @@
|
|||||||
|
#include "catch.hpp"
|
||||||
|
|
||||||
|
#include <functional>
|
||||||
|
#include <maybe/result.hpp>
|
||||||
|
#include <memory>
|
||||||
|
#include <sstream>
|
||||||
|
|
||||||
|
using maybe::result;
|
||||||
|
|
||||||
|
class NoCopy final {
|
||||||
|
public:
|
||||||
|
NoCopy(NoCopy&& other)
|
||||||
|
{
|
||||||
|
flag = other.flag;
|
||||||
|
destructor_fun = std::move(other.destructor_fun);
|
||||||
|
other.destructor_fun = nullptr;
|
||||||
|
}
|
||||||
|
NoCopy& operator=(NoCopy&& other) = default;
|
||||||
|
|
||||||
|
NoCopy(int flag, std::function<void()> destructor_fun)
|
||||||
|
: flag(flag), destructor_fun(destructor_fun)
|
||||||
|
{
|
||||||
|
}
|
||||||
|
~NoCopy()
|
||||||
|
{
|
||||||
|
if (destructor_fun != nullptr) {
|
||||||
|
destructor_fun();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
int get_flag()
|
||||||
|
{
|
||||||
|
return this->flag;
|
||||||
|
}
|
||||||
|
|
||||||
|
private:
|
||||||
|
int flag;
|
||||||
|
std::function<void()> destructor_fun;
|
||||||
|
};
|
||||||
|
|
||||||
|
TEST_CASE("maybe_result_tests")
|
||||||
|
{
|
||||||
|
SECTION("created ok result returns ok value")
|
||||||
|
{
|
||||||
|
auto res = result<int, int>::ok(12);
|
||||||
|
REQUIRE(res.is_ok());
|
||||||
|
REQUIRE(!res.is_err());
|
||||||
|
REQUIRE(res);
|
||||||
|
REQUIRE(res.ok_value() == 12);
|
||||||
|
|
||||||
|
auto other_ok = result<int, int>::ok(12);
|
||||||
|
REQUIRE(res == other_ok);
|
||||||
|
|
||||||
|
auto other_different_ok = result<int, int>::ok(42);
|
||||||
|
REQUIRE(res != other_different_ok);
|
||||||
|
}
|
||||||
|
|
||||||
|
SECTION("created err result returns err value")
|
||||||
|
{
|
||||||
|
auto res = result<int, int>::err(12);
|
||||||
|
REQUIRE(res.is_err());
|
||||||
|
REQUIRE(!res.is_ok());
|
||||||
|
REQUIRE(!res);
|
||||||
|
REQUIRE(res.err_value() == 12);
|
||||||
|
|
||||||
|
auto other_err = result<int, int>::err(12);
|
||||||
|
REQUIRE(res == other_err);
|
||||||
|
|
||||||
|
auto other_different_err = result<int, int>::err(42);
|
||||||
|
REQUIRE(res != other_different_err);
|
||||||
|
}
|
||||||
|
|
||||||
|
SECTION("created ok not equal created result")
|
||||||
|
{
|
||||||
|
auto ok = result<int, int>::ok(12);
|
||||||
|
auto err = result<int, int>::err(12);
|
||||||
|
REQUIRE(ok != err);
|
||||||
|
}
|
||||||
|
|
||||||
|
SECTION("throws exception if invalid value accessed")
|
||||||
|
{
|
||||||
|
auto ok = result<int, int>::ok(12);
|
||||||
|
auto err = result<int, int>::err(12);
|
||||||
|
REQUIRE_THROWS(ok.err_value());
|
||||||
|
REQUIRE_THROWS(err.ok_value());
|
||||||
|
}
|
||||||
|
|
||||||
|
SECTION("returns default values")
|
||||||
|
{
|
||||||
|
auto ok = result<int, int>::ok(12);
|
||||||
|
auto err = result<int, int>::err(12);
|
||||||
|
REQUIRE(ok.ok_value_or(42) == 12);
|
||||||
|
REQUIRE(err.err_value_or(42) == 12);
|
||||||
|
REQUIRE(ok.err_value_or(42) == 42);
|
||||||
|
REQUIRE(err.ok_value_or(42) == 42);
|
||||||
|
}
|
||||||
|
|
||||||
|
SECTION("destroys ok value correctly")
|
||||||
|
{
|
||||||
|
std::ostringstream ss;
|
||||||
|
|
||||||
|
{
|
||||||
|
result<NoCopy, NoCopy>::ok(NoCopy(0, [&] { ss << "[ok]"; }));
|
||||||
|
}
|
||||||
|
|
||||||
|
REQUIRE(ss.str() == "[ok]");
|
||||||
|
}
|
||||||
|
|
||||||
|
SECTION("destroys err value correctly")
|
||||||
|
{
|
||||||
|
std::ostringstream ss;
|
||||||
|
|
||||||
|
{
|
||||||
|
result<NoCopy, NoCopy>::err(NoCopy(0, [&] { ss << "[err]"; }));
|
||||||
|
}
|
||||||
|
|
||||||
|
REQUIRE(ss.str() == "[err]");
|
||||||
|
}
|
||||||
|
|
||||||
|
SECTION("nocopy ok to ok is moved correctly")
|
||||||
|
{
|
||||||
|
std::ostringstream ss;
|
||||||
|
|
||||||
|
{
|
||||||
|
auto val = result<NoCopy, NoCopy>::ok(NoCopy(0, [&] { ss << "[first]"; }));
|
||||||
|
val = result<NoCopy, NoCopy>::ok(NoCopy(42, [&] { ss << "[second]"; }));
|
||||||
|
REQUIRE(val.ok_value().get_flag() == 42);
|
||||||
|
}
|
||||||
|
|
||||||
|
REQUIRE(ss.str() == "[first][second]");
|
||||||
|
}
|
||||||
|
|
||||||
|
SECTION("nocopy err to err is moved correctly")
|
||||||
|
{
|
||||||
|
std::ostringstream ss;
|
||||||
|
|
||||||
|
{
|
||||||
|
auto val = result<NoCopy, NoCopy>::err(NoCopy(0, [&] { ss << "[first]"; }));
|
||||||
|
val = result<NoCopy, NoCopy>::err(NoCopy(42, [&] { ss << "[second]"; }));
|
||||||
|
REQUIRE(val.err_value().get_flag() == 42);
|
||||||
|
}
|
||||||
|
|
||||||
|
REQUIRE(ss.str() == "[first][second]");
|
||||||
|
}
|
||||||
|
|
||||||
|
SECTION("nocopy ok to err is moved correctly")
|
||||||
|
{
|
||||||
|
std::ostringstream ss;
|
||||||
|
|
||||||
|
{
|
||||||
|
auto val = result<NoCopy, NoCopy>::err(NoCopy(0, [&] { ss << "[first]"; }));
|
||||||
|
val = result<NoCopy, NoCopy>::ok(NoCopy(42, [&] { ss << "[second]"; }));
|
||||||
|
REQUIRE(val.ok_value().get_flag() == 42);
|
||||||
|
}
|
||||||
|
|
||||||
|
REQUIRE(ss.str() == "[first][second]");
|
||||||
|
}
|
||||||
|
|
||||||
|
SECTION("nocopy err to ok is moved correctly")
|
||||||
|
{
|
||||||
|
std::ostringstream ss;
|
||||||
|
|
||||||
|
{
|
||||||
|
auto val = result<NoCopy, NoCopy>::ok(NoCopy(0, [&] { ss << "[first]"; }));
|
||||||
|
val = result<NoCopy, NoCopy>::err(NoCopy(42, [&] { ss << "[second]"; }));
|
||||||
|
REQUIRE(val.err_value().get_flag() == 42);
|
||||||
|
}
|
||||||
|
|
||||||
|
REQUIRE(ss.str() == "[first][second]");
|
||||||
|
}
|
||||||
|
|
||||||
|
SECTION("nocopy ok to none is moved correctly")
|
||||||
|
{
|
||||||
|
std::ostringstream ss;
|
||||||
|
|
||||||
|
{
|
||||||
|
result<NoCopy, NoCopy> val;
|
||||||
|
val = result<NoCopy, NoCopy>::ok(NoCopy(42, [&] { ss << "[ok]"; }));
|
||||||
|
REQUIRE(val.ok_value().get_flag() == 42);
|
||||||
|
}
|
||||||
|
|
||||||
|
REQUIRE(ss.str() == "[ok]");
|
||||||
|
}
|
||||||
|
|
||||||
|
SECTION("nocopy err to none is moved correctly")
|
||||||
|
{
|
||||||
|
std::ostringstream ss;
|
||||||
|
|
||||||
|
{
|
||||||
|
result<NoCopy, NoCopy> val;
|
||||||
|
val = result<NoCopy, NoCopy>::err(NoCopy(42, [&] { ss << "[err]"; }));
|
||||||
|
REQUIRE(val.err_value().get_flag() == 42);
|
||||||
|
}
|
||||||
|
|
||||||
|
REQUIRE(ss.str() == "[err]");
|
||||||
|
}
|
||||||
|
}
|
Loading…
Reference in New Issue
Block a user