Inheritance diagram for iox::cxx::expected< void, ErrorType >:
Collaboration diagram for iox::cxx::expected< void, ErrorType >:
Additional Inherited Members | |
 Public Member Functions inherited from iox::cxx::expected< ErrorType > | |
| expected ()=delete | |
| default ctor is deleted since you have to clearly state if the expected contains a success value or an error value | |
| expected (const expected &) noexcept=default | |
| the copy constructor calls the copy constructor of the contained success value or the error value - depending on what is stored in the expected | |
| expected (expected &&rhs) noexcept | |
| the move constructor calls the move constructor of the contained success value or the error value - depending on what is stored in the expected | |
| ~expected () noexcept=default | |
| calls the destructor of the success value or error value - depending on what is stored in the expected | |
| expected & | operator= (const expected &) noexcept |
| calls the copy assignment operator of the contained success value or the error value - depending on what is stored in the expected | |
| expected & | operator= (expected &&rhs) noexcept |
| calls the move assignment operator of the contained success value or the error value - depending on what is stored in the expected | |
| expected (const success< void > &successValue) noexcept | |
| constructs an expected which is signaling success | |
| expected (const error< ErrorType > &errorValue) noexcept | |
| constructs an expected which is signaling an error and stores the error value provided by errorValue | |
| expected (error< ErrorType > &&errorValue) noexcept | |
| constructs an expected which is signaling an error and stores the error value provided by value | |
| operator bool () const noexcept | |
| returns true if the expected contains an error otherwise false | |
| bool | has_error () const noexcept |
| returns true if the expected contains an error otherwise false | |
| ErrorType & | get_error () &noexcept |
| returns a reference to the contained error value, if the expected does not contain an error this is undefined behavior | |
| const ErrorType & | get_error () const &noexcept |
| returns a const reference to the contained error value, if the expected does not contain an error this is undefined behavior | |
| ErrorType && | get_error () &&noexcept |
| returns a rvalue reference to the contained error value, if the expected does not contain an error this is undefined behavior | |
| const expected & | or_else (const cxx::function_ref< void(ErrorType &)> &callable) const noexcept |
| if the expected does contain an error the given callable is called and a reference to the ErrorType is given as an argument to the callable | |
| expected & | or_else (const cxx::function_ref< void(ErrorType &)> &callable) noexcept |
| if the expected does contain an error the given callable is called and a reference to the ErrorType is given as an argument to the callable | |
| const expected & | and_then (const cxx::function_ref< void()> &callable) const noexcept |
| if the expected does contain a success value the given callable is called and a reference to the expected is given as an argument to the callable | |
| expected & | and_then (const cxx::function_ref< void()> &callable) noexcept |
| if the expected does contain a success value the given callable is called and a reference to the expected is given as an argument to the callable | |
| Static Public Member Functions inherited from iox::cxx::expected< ErrorType > | |
| static expected | create_value () noexcept |
| creates an expected which is signaling success | |
| template<typename... Targs> | |
| static expected | create_error (Targs &&... args) noexcept |
| creates an expected which is signaling an error and perfectly forwards the args to the constructor of lErrorType | |
The documentation for this class was generated from the following file:
- iceoryx_hoofs/cxx/expected.hpp
