Virgil Security Crypto library  2.0.7
Public Member Functions | List of all members
virgil::crypto::VirgilCryptoException Class Reference

This only exception that crypto library can produce. More...

#include <VirgilCryptoException.h>

Inheritance diagram for virgil::crypto::VirgilCryptoException:

Public Member Functions

 VirgilCryptoException (int ev, const std::error_category &ecat)
 Initialize Exception with specific error code and correspond error category. More...
 
 VirgilCryptoException (int ev, const std::error_category &ecat, const std::string &what)
 Initialize Exception with specific error code, correspond error category, and error description. More...
 
 VirgilCryptoException (int ev, const std::error_category &ecat, const char *what)
 Initialize Exception with specific error code, correspond error category, and error description. More...
 
const std::error_condition & condition () const
 
const char * what () const noexcept override
 

Detailed Description

This only exception that crypto library can produce.

To determine the real exception reason, error codes with conjuction with error category are used. Error codes can be found in the enumeration VirgilCryptoError.

Constructor & Destructor Documentation

virgil::crypto::VirgilCryptoException::VirgilCryptoException ( int  ev,
const std::error_category &  ecat 
)

Initialize Exception with specific error code and correspond error category.

Parameters
evError value (code).
ecatError category.
virgil::crypto::VirgilCryptoException::VirgilCryptoException ( int  ev,
const std::error_category &  ecat,
const std::string &  what 
)

Initialize Exception with specific error code, correspond error category, and error description.

Parameters
evError value (code).
ecatError category.
whatAdditional error description.
virgil::crypto::VirgilCryptoException::VirgilCryptoException ( int  ev,
const std::error_category &  ecat,
const char *  what 
)

Initialize Exception with specific error code, correspond error category, and error description.

Parameters
evError value (code).
ecatError category.
whatAdditional error description.

Member Function Documentation

const std::error_condition& virgil::crypto::VirgilCryptoException::condition ( ) const

Get underlying error condition.

Returns
Error condition.
const char* virgil::crypto::VirgilCryptoException::what ( ) const
overridenoexcept

Get string identifying exception.

Returns
null terminated character sequence that may be used to identify the exception.

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