Botan.Low.Error

Documentation

type BotanErrorCode = CInt

Botan error code data type

pattern Success :: BotanErrorCode

pattern InvalidIdentifier :: BotanErrorCode

pattern InvalidInput :: BotanErrorCode

pattern BadMAC :: BotanErrorCode

pattern InsufficientBufferSpace :: BotanErrorCode

pattern StringConversionError :: BotanErrorCode

pattern ExceptionThrown :: BotanErrorCode

pattern OutOfMemory :: BotanErrorCode

pattern SystemError :: BotanErrorCode

pattern InternalError :: BotanErrorCode

pattern BadFlag :: BotanErrorCode

pattern NullPointer :: BotanErrorCode

pattern BadParameter :: BotanErrorCode

pattern KeyNotSet :: BotanErrorCode

pattern InvalidKeyLength :: BotanErrorCode

pattern InvalidObjectState :: BotanErrorCode

pattern NotImplemented :: BotanErrorCode

pattern InvalidObject :: BotanErrorCode

pattern TLSError :: BotanErrorCode

pattern HttpError :: BotanErrorCode

pattern RoughtimeError :: BotanErrorCode

pattern UnknownError :: BotanErrorCode

botanErrorDescription :: BotanErrorCode -> IO ByteString

Convert an error code into a string. Returns "Unknown error" if the error code is not a known one.

botanErrorLastExceptionMessage :: IO ErrorMessage

Returns a static string stored in a thread local variable which contains the last exception message thrown. WARNING: This string buffer is overwritten on the next call to the FFI layer

data SomeBotanException

The SomeBotanException type is the root of the botan exception type hierarchy.

Constructors

forall e.Exception e => SomeBotanException e

Instances

Exception SomeBotanException

Defined in Botan.Low.Error

Methods

toException :: SomeBotanException -> SomeException

fromException :: SomeException -> Maybe SomeBotanException

displayException :: SomeBotanException -> String

Show SomeBotanException

Defined in Botan.Low.Error

Methods

showsPrec :: Int -> SomeBotanException -> ShowS

show :: SomeBotanException -> String

showList :: [SomeBotanException] -> ShowS

toBotanException :: Exception e => e -> SomeException

fromBotanException :: Exception e => SomeException -> Maybe e

data InvalidInputException

Constructors

InvalidInputException BotanErrorCode ErrorMessage CallStack

Instances

Exception InvalidInputException

Defined in Botan.Low.Error

Methods

toException :: InvalidInputException -> SomeException

fromException :: SomeException -> Maybe InvalidInputException

displayException :: InvalidInputException -> String

Show InvalidInputException

Defined in Botan.Low.Error

Methods

showsPrec :: Int -> InvalidInputException -> ShowS

show :: InvalidInputException -> String

showList :: [InvalidInputException] -> ShowS

data BadMACException

Constructors

BadMACException BotanErrorCode ErrorMessage CallStack

Instances

Exception BadMACException

Defined in Botan.Low.Error

Methods

toException :: BadMACException -> SomeException

fromException :: SomeException -> Maybe BadMACException

displayException :: BadMACException -> String

Show BadMACException

Defined in Botan.Low.Error

Methods

showsPrec :: Int -> BadMACException -> ShowS

show :: BadMACException -> String

showList :: [BadMACException] -> ShowS

data InsufficientBufferSpaceException

Constructors

InsufficientBufferSpaceException BotanErrorCode ErrorMessage CallStack

Instances

Exception InsufficientBufferSpaceException

Defined in Botan.Low.Error

Methods

toException :: InsufficientBufferSpaceException -> SomeException

fromException :: SomeException -> Maybe InsufficientBufferSpaceException

displayException :: InsufficientBufferSpaceException -> String

Show InsufficientBufferSpaceException

Defined in Botan.Low.Error

Methods

showsPrec :: Int -> InsufficientBufferSpaceException -> ShowS

show :: InsufficientBufferSpaceException -> String

showList :: [InsufficientBufferSpaceException] -> ShowS

data StringConversionException

Constructors

StringConversionException BotanErrorCode ErrorMessage CallStack

Instances

Exception StringConversionException

Defined in Botan.Low.Error

Methods

toException :: StringConversionException -> SomeException

fromException :: SomeException -> Maybe StringConversionException

displayException :: StringConversionException -> String

Show StringConversionException

Defined in Botan.Low.Error

Methods

showsPrec :: Int -> StringConversionException -> ShowS

show :: StringConversionException -> String

showList :: [StringConversionException] -> ShowS

data ExceptionThrownException

Constructors

ExceptionThrownException BotanErrorCode ErrorMessage CallStack

Instances

Exception ExceptionThrownException

Defined in Botan.Low.Error

Methods

toException :: ExceptionThrownException -> SomeException

fromException :: SomeException -> Maybe ExceptionThrownException

displayException :: ExceptionThrownException -> String

Show ExceptionThrownException

Defined in Botan.Low.Error

Methods

showsPrec :: Int -> ExceptionThrownException -> ShowS

show :: ExceptionThrownException -> String

showList :: [ExceptionThrownException] -> ShowS

data OutOfMemoryException

Constructors

OutOfMemoryException BotanErrorCode ErrorMessage CallStack

Instances

Exception OutOfMemoryException

Defined in Botan.Low.Error

Methods

toException :: OutOfMemoryException -> SomeException

fromException :: SomeException -> Maybe OutOfMemoryException

displayException :: OutOfMemoryException -> String

Show OutOfMemoryException

Defined in Botan.Low.Error

Methods

showsPrec :: Int -> OutOfMemoryException -> ShowS

show :: OutOfMemoryException -> String

showList :: [OutOfMemoryException] -> ShowS

data SystemErrorException

Constructors

SystemErrorException BotanErrorCode ErrorMessage CallStack

Instances

Exception SystemErrorException

Defined in Botan.Low.Error

Methods

toException :: SystemErrorException -> SomeException

fromException :: SomeException -> Maybe SystemErrorException

displayException :: SystemErrorException -> String

Show SystemErrorException

Defined in Botan.Low.Error

Methods

showsPrec :: Int -> SystemErrorException -> ShowS

show :: SystemErrorException -> String

showList :: [SystemErrorException] -> ShowS

data InternalErrorException

Constructors

InternalErrorException BotanErrorCode ErrorMessage CallStack

Instances

Exception InternalErrorException

Defined in Botan.Low.Error

Methods

toException :: InternalErrorException -> SomeException

fromException :: SomeException -> Maybe InternalErrorException

displayException :: InternalErrorException -> String

Show InternalErrorException

Defined in Botan.Low.Error

Methods

showsPrec :: Int -> InternalErrorException -> ShowS

show :: InternalErrorException -> String

showList :: [InternalErrorException] -> ShowS

data BadFlagException

Constructors

BadFlagException BotanErrorCode ErrorMessage CallStack

Instances

Exception BadFlagException

Defined in Botan.Low.Error

Methods

toException :: BadFlagException -> SomeException

fromException :: SomeException -> Maybe BadFlagException

displayException :: BadFlagException -> String

Show BadFlagException

Defined in Botan.Low.Error

Methods

showsPrec :: Int -> BadFlagException -> ShowS

show :: BadFlagException -> String

showList :: [BadFlagException] -> ShowS

data NullPointerException

Constructors

NullPointerException BotanErrorCode ErrorMessage CallStack

Instances

Exception NullPointerException

Defined in Botan.Low.Error

Methods

toException :: NullPointerException -> SomeException

fromException :: SomeException -> Maybe NullPointerException

displayException :: NullPointerException -> String

Show NullPointerException

Defined in Botan.Low.Error

Methods

showsPrec :: Int -> NullPointerException -> ShowS

show :: NullPointerException -> String

showList :: [NullPointerException] -> ShowS

data BadParameterException

Constructors

BadParameterException BotanErrorCode ErrorMessage CallStack

Instances

Exception BadParameterException

Defined in Botan.Low.Error

Methods

toException :: BadParameterException -> SomeException

fromException :: SomeException -> Maybe BadParameterException

displayException :: BadParameterException -> String

Show BadParameterException

Defined in Botan.Low.Error

Methods

showsPrec :: Int -> BadParameterException -> ShowS

show :: BadParameterException -> String

showList :: [BadParameterException] -> ShowS

data KeyNotSetException

Constructors

KeyNotSetException BotanErrorCode ErrorMessage CallStack

Instances

Exception KeyNotSetException

Defined in Botan.Low.Error

Methods

toException :: KeyNotSetException -> SomeException

fromException :: SomeException -> Maybe KeyNotSetException

displayException :: KeyNotSetException -> String

Show KeyNotSetException

Defined in Botan.Low.Error

Methods

showsPrec :: Int -> KeyNotSetException -> ShowS

show :: KeyNotSetException -> String

showList :: [KeyNotSetException] -> ShowS

data InvalidKeyLengthException

Constructors

InvalidKeyLengthException BotanErrorCode ErrorMessage CallStack

Instances

Exception InvalidKeyLengthException

Defined in Botan.Low.Error

Methods

toException :: InvalidKeyLengthException -> SomeException

fromException :: SomeException -> Maybe InvalidKeyLengthException

displayException :: InvalidKeyLengthException -> String

Show InvalidKeyLengthException

Defined in Botan.Low.Error

Methods

showsPrec :: Int -> InvalidKeyLengthException -> ShowS

show :: InvalidKeyLengthException -> String

showList :: [InvalidKeyLengthException] -> ShowS

data InvalidObjectStateException

Constructors

InvalidObjectStateException BotanErrorCode ErrorMessage CallStack

Instances

Exception InvalidObjectStateException

Defined in Botan.Low.Error

Methods

toException :: InvalidObjectStateException -> SomeException

fromException :: SomeException -> Maybe InvalidObjectStateException

displayException :: InvalidObjectStateException -> String

Show InvalidObjectStateException

Defined in Botan.Low.Error

Methods

showsPrec :: Int -> InvalidObjectStateException -> ShowS

show :: InvalidObjectStateException -> String

showList :: [InvalidObjectStateException] -> ShowS

data NotImplementedException

Constructors

NotImplementedException BotanErrorCode ErrorMessage CallStack

Instances

Exception NotImplementedException

Defined in Botan.Low.Error

Methods

toException :: NotImplementedException -> SomeException

fromException :: SomeException -> Maybe NotImplementedException

displayException :: NotImplementedException -> String

Show NotImplementedException

Defined in Botan.Low.Error

Methods

showsPrec :: Int -> NotImplementedException -> ShowS

show :: NotImplementedException -> String

showList :: [NotImplementedException] -> ShowS

data InvalidObjectException

Constructors

InvalidObjectException BotanErrorCode ErrorMessage CallStack

Instances

Exception InvalidObjectException

Defined in Botan.Low.Error

Methods

toException :: InvalidObjectException -> SomeException

fromException :: SomeException -> Maybe InvalidObjectException

displayException :: InvalidObjectException -> String

Show InvalidObjectException

Defined in Botan.Low.Error

Methods

showsPrec :: Int -> InvalidObjectException -> ShowS

show :: InvalidObjectException -> String

showList :: [InvalidObjectException] -> ShowS

data UnknownException

Constructors

UnknownException BotanErrorCode ErrorMessage CallStack

Instances

Exception UnknownException

Defined in Botan.Low.Error

Methods

toException :: UnknownException -> SomeException

fromException :: SomeException -> Maybe UnknownException

displayException :: UnknownException -> String

Show UnknownException

Defined in Botan.Low.Error

Methods

showsPrec :: Int -> UnknownException -> ShowS

show :: UnknownException -> String

showList :: [UnknownException] -> ShowS

throwBotanError :: HasCallStack => BotanErrorCode -> IO a

throwBotanIfNegative :: HasCallStack => IO BotanErrorCode -> IO BotanErrorCode

throwBotanIfNegative_ :: HasCallStack => IO BotanErrorCode -> IO ()

throwBotanCatchingSuccess :: HasCallStack => IO BotanErrorCode -> IO Bool

throwBotanCatchingBool :: HasCallStack => IO BotanErrorCode -> IO Bool

throwBotanCatchingInt :: HasCallStack => IO BotanErrorCode -> IO Int

throwBotanErrorWithCallstack :: BotanErrorCode -> CallStack -> IO a

tryBotan :: IO a -> IO (Either SomeBotanException a)

catchBotan :: IO a -> (SomeBotanException -> IO a) -> IO a

handleBotan :: (SomeBotanException -> IO a) -> IO a -> IO a