LIEF: Library to Instrument Executable Formats Version 0.15.1
Loading...
Searching...
No Matches
errors.hpp
Go to the documentation of this file.
1/* Copyright 2021 - 2024 R. Thomas
2 * Copyright 2021 - 2024 Quarkslab
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16#ifndef LIEF_ERROR_H
17#define LIEF_ERROR_H
18#include <cstdint>
19#include <LIEF/third-party/expected.hpp>
20#include <cstdint>
21
23enum class lief_errors : uint32_t {
24 read_error = 1,
28
31
35
39
41 /*
42 * When adding a new error, do not forget
43 * to update the Python bindings as well (pyErr.cpp) and Rust bindings:
44 * lief/src/error.rs
45 */
46};
47
48const char* to_string(lief_errors err);
49
51inline tl::unexpected<lief_errors> make_error_code(lief_errors e) {
52 return tl::make_unexpected(e);
53}
54
55
56namespace LIEF {
73template<typename T>
74using result = tl::expected<T, lief_errors>;
75
77template<class T>
79 return err.error();
80}
81
83template<class T>
85 return err.error();
86}
87
89struct ok_t {};
90
92inline ok_t ok() {
93 return ok_t{};
94}
95
109
110inline bool is_ok(const ok_error_t& val) {
111 return val.has_value();
112}
113
114inline bool is_err(const ok_error_t& val) {
115 return !is_ok(val);
116}
117
118}
119
120
121
122
123
124#endif
lief_errors
LIEF error codes definition.
Definition errors.hpp:23
tl::unexpected< lief_errors > make_error_code(lief_errors e)
Create an standard error code from lief_errors.
Definition errors.hpp:51
const char * to_string(lief_errors err)
LIEF namespace.
Definition Abstract/Binary.hpp:32
result< ok_t > ok_error_t
Opaque structure that is used by LIEF to avoid writing result<void> f(...). Instead,...
Definition errors.hpp:108
bool is_ok(const ok_error_t &val)
Definition errors.hpp:110
lief_errors get_error(result< T > &err)
Get the error code associated with the result.
Definition errors.hpp:78
ok_t ok()
Return success for function with return type ok_error_t.
Definition errors.hpp:92
bool is_err(const ok_error_t &val)
Definition errors.hpp:114
lief_errors as_lief_err(result< T > &err)
Return the lief_errors when the provided result<T> is an error.
Definition errors.hpp:84
tl::expected< T, lief_errors > result
Wrapper that contains an Object (T) or an error.
Definition errors.hpp:74
Opaque structure used by ok_error_t.
Definition errors.hpp:89