iceoryx_hoofs 2.0.3
List of all members
iox::cxx::expected< void, ErrorType > Class Template Reference
Inheritance diagram for iox::cxx::expected< void, ErrorType >:
Inheritance graph
[legend]
Collaboration diagram for iox::cxx::expected< void, ErrorType >:
Collaboration graph
[legend]

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
 
expectedoperator= (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
 
expectedoperator= (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 More...
 
 expected (const error< ErrorType > &errorValue) noexcept
 constructs an expected which is signaling an error and stores the error value provided by errorValue More...
 
 expected (error< ErrorType > &&errorValue) noexcept
 constructs an expected which is signaling an error and stores the error value provided by value More...
 
 operator bool () const noexcept
 returns true if the expected contains an error otherwise false More...
 
bool has_error () const noexcept
 returns true if the expected contains an error otherwise false More...
 
ErrorType & get_error () &noexcept
 returns a reference to the contained error value, if the expected does not contain an error this is undefined behavior More...
 
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 More...
 
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 More...
 
const expectedor_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 More...
 
expectedor_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 More...
 
const expectedand_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 More...
 
expectedand_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 More...
 
- Static Public Member Functions inherited from iox::cxx::expected< ErrorType >
static expected create_value () noexcept
 creates an expected which is signaling success More...
 
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 More...
 

The documentation for this class was generated from the following file: