Cryptolens Client API for C++
Public Member Functions | List of all members
cryptolens_io::v20190401::basic_Error Class Reference

#include <basic_Error.hpp>

Inheritance diagram for cryptolens_io::v20190401::basic_Error:
Inheritance graph
[legend]

Public Member Functions

 basic_Error (basic_Error const &e)=delete
 
basic_Erroroperator= (basic_Error const &e)=delete
 
 operator bool () const
 
virtual int get_subsystem (api::main api) const noexcept
 
virtual int get_reason (api::main api) const noexcept
 
virtual size_t get_extra (api::main api) const noexcept
 
virtual void reset (api::main api)
 
virtual void set (api::main api, int subsystem)
 
virtual void set (api::main api, int subsystem, int reason)
 
virtual void set (api::main api, int subsystem, int reason, size_t extra)
 
virtual void set_call (api::main api, int call)
 

Detailed Description

This error is used by all methods in this library that can fail.

Several things are provided:

Member Function Documentation

◆ operator bool()

cryptolens_io::v20190401::basic_Error::operator bool ( ) const
inlineexplicit

Explicit conversion to bool allowing the object to be used in e.g. control flow statements.

Returns true if an error has occured, false otherwise.

◆ reset()

virtual void cryptolens_io::v20190401::basic_Error::reset ( api::main  api)
inlinevirtual

Can be used to reset the Error object to the initial state.

Can be used for reusing the same Error object after an error has occured.


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