Copyright	(c) 2023-2024 Apotheca Labs (c) 2024-2025 Haskell Foundation
License	BSD-3-Clause
Maintainer	joris@well-typed.com, leo@apotheca.io
Stability	experimental
Portability	POSIX
Safe Haskell	None
Language	GHC2021

Botan.Low.Error

Contents

Error codes
Exception hierarchy
Individual exceptions

Description

This module is based on the Return codes section of the C Botan FFI documentation.

Synopsis

data BotanErrorCode
botanErrorDescription :: BotanErrorCode -> IO ByteString
newtype BotanErrorMessage = BotanErrorMessage ByteString
botanErrorLastExceptionMessage :: IO BotanErrorMessage
data SomeBotanException = Exception e => SomeBotanException e
toBotanException :: Exception e => e -> SomeException
fromBotanException :: Exception e => SomeException -> Maybe e
data InvalidInputException = InvalidInputException BotanErrorCode BotanErrorMessage CallStack
data BadMACException = BadMACException BotanErrorCode BotanErrorMessage CallStack
data InsufficientBufferSpaceException = InsufficientBufferSpaceException BotanErrorCode BotanErrorMessage CallStack
data StringConversionException = StringConversionException BotanErrorCode BotanErrorMessage CallStack
data ExceptionThrownException = ExceptionThrownException BotanErrorCode BotanErrorMessage CallStack
data OutOfMemoryException = OutOfMemoryException BotanErrorCode BotanErrorMessage CallStack
data SystemErrorException = SystemErrorException BotanErrorCode BotanErrorMessage CallStack
data InternalErrorException = InternalErrorException BotanErrorCode BotanErrorMessage CallStack
data BadFlagException = BadFlagException BotanErrorCode BotanErrorMessage CallStack
data NullPointerException = NullPointerException BotanErrorCode BotanErrorMessage CallStack
data BadParameterException = BadParameterException BotanErrorCode BotanErrorMessage CallStack
data KeyNotSetException = KeyNotSetException BotanErrorCode BotanErrorMessage CallStack
data InvalidKeyLengthException = InvalidKeyLengthException BotanErrorCode BotanErrorMessage CallStack
data InvalidObjectStateException = InvalidObjectStateException BotanErrorCode BotanErrorMessage CallStack
data NotImplementedException = NotImplementedException BotanErrorCode BotanErrorMessage CallStack
data InvalidObjectException = InvalidObjectException BotanErrorCode BotanErrorMessage CallStack
data UnknownException = UnknownException BotanErrorCode BotanErrorMessage CallStack

Error codes

data BotanErrorCode Source #

Instances

Instances details

Show BotanErrorCode Source #
Instance details Defined in Botan.Low.Error.Internal Methods showsPrec :: Int -> BotanErrorCode -> ShowS show :: BotanErrorCode -> String showList :: [BotanErrorCode] -> ShowS
Eq BotanErrorCode Source #
Instance details Defined in Botan.Low.Error.Internal Methods (==) :: BotanErrorCode -> BotanErrorCode -> Bool (/=) :: BotanErrorCode -> BotanErrorCode -> Bool

botanErrorDescription :: BotanErrorCode -> IO ByteString Source #

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

newtype BotanErrorMessage Source #

Constructors

BotanErrorMessage ByteString

Instances

Instances details

Show BotanErrorMessage Source #
Instance details Defined in Botan.Low.Error.Internal Methods showsPrec :: Int -> BotanErrorMessage -> ShowS show :: BotanErrorMessage -> String showList :: [BotanErrorMessage] -> ShowS

botanErrorLastExceptionMessage :: IO BotanErrorMessage Source #

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

Exception hierarchy

data SomeBotanException Source #

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

Constructors

Exception e => SomeBotanException e

Instances

Instances details

Exception SomeBotanException Source #
Instance details Defined in Botan.Low.Error.Internal Methods toException :: SomeBotanException -> SomeException fromException :: SomeException -> Maybe SomeBotanException displayException :: SomeBotanException -> String backtraceDesired :: SomeBotanException -> Bool
Show SomeBotanException Source #
Instance details Defined in Botan.Low.Error.Internal Methods showsPrec :: Int -> SomeBotanException -> ShowS show :: SomeBotanException -> String showList :: [SomeBotanException] -> ShowS

toBotanException :: Exception e => e -> SomeException Source #

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

Individual exceptions

data InvalidInputException Source #

Constructors

InvalidInputException BotanErrorCode BotanErrorMessage CallStack

Instances

Instances details

Exception InvalidInputException Source #
Instance details Defined in Botan.Low.Error.Internal Methods toException :: InvalidInputException -> SomeException fromException :: SomeException -> Maybe InvalidInputException displayException :: InvalidInputException -> String backtraceDesired :: InvalidInputException -> Bool
Show InvalidInputException Source #
Instance details Defined in Botan.Low.Error.Internal Methods showsPrec :: Int -> InvalidInputException -> ShowS show :: InvalidInputException -> String showList :: [InvalidInputException] -> ShowS

data BadMACException Source #

Constructors

BadMACException BotanErrorCode BotanErrorMessage CallStack

Instances

Instances details

Exception BadMACException Source #
Instance details Defined in Botan.Low.Error.Internal Methods toException :: BadMACException -> SomeException fromException :: SomeException -> Maybe BadMACException displayException :: BadMACException -> String backtraceDesired :: BadMACException -> Bool
Show BadMACException Source #
Instance details Defined in Botan.Low.Error.Internal Methods showsPrec :: Int -> BadMACException -> ShowS show :: BadMACException -> String showList :: [BadMACException] -> ShowS

data InsufficientBufferSpaceException Source #

Constructors

InsufficientBufferSpaceException BotanErrorCode BotanErrorMessage CallStack

Instances

Instances details

Exception InsufficientBufferSpaceException Source #
Instance details Defined in Botan.Low.Error.Internal Methods toException :: InsufficientBufferSpaceException -> SomeException fromException :: SomeException -> Maybe InsufficientBufferSpaceException displayException :: InsufficientBufferSpaceException -> String backtraceDesired :: InsufficientBufferSpaceException -> Bool
Show InsufficientBufferSpaceException Source #
Instance details Defined in Botan.Low.Error.Internal Methods showsPrec :: Int -> InsufficientBufferSpaceException -> ShowS show :: InsufficientBufferSpaceException -> String showList :: [InsufficientBufferSpaceException] -> ShowS

data StringConversionException Source #

Constructors

StringConversionException BotanErrorCode BotanErrorMessage CallStack

Instances

Instances details

Exception StringConversionException Source #
Instance details Defined in Botan.Low.Error.Internal Methods toException :: StringConversionException -> SomeException fromException :: SomeException -> Maybe StringConversionException displayException :: StringConversionException -> String backtraceDesired :: StringConversionException -> Bool
Show StringConversionException Source #
Instance details Defined in Botan.Low.Error.Internal Methods showsPrec :: Int -> StringConversionException -> ShowS show :: StringConversionException -> String showList :: [StringConversionException] -> ShowS

data ExceptionThrownException Source #

Constructors

ExceptionThrownException BotanErrorCode BotanErrorMessage CallStack

Instances

Instances details

Exception ExceptionThrownException Source #
Instance details Defined in Botan.Low.Error.Internal Methods toException :: ExceptionThrownException -> SomeException fromException :: SomeException -> Maybe ExceptionThrownException displayException :: ExceptionThrownException -> String backtraceDesired :: ExceptionThrownException -> Bool
Show ExceptionThrownException Source #
Instance details Defined in Botan.Low.Error.Internal Methods showsPrec :: Int -> ExceptionThrownException -> ShowS show :: ExceptionThrownException -> String showList :: [ExceptionThrownException] -> ShowS

data OutOfMemoryException Source #

Constructors

OutOfMemoryException BotanErrorCode BotanErrorMessage CallStack

Instances

Instances details

Exception OutOfMemoryException Source #
Instance details Defined in Botan.Low.Error.Internal Methods toException :: OutOfMemoryException -> SomeException fromException :: SomeException -> Maybe OutOfMemoryException displayException :: OutOfMemoryException -> String backtraceDesired :: OutOfMemoryException -> Bool
Show OutOfMemoryException Source #
Instance details Defined in Botan.Low.Error.Internal Methods showsPrec :: Int -> OutOfMemoryException -> ShowS show :: OutOfMemoryException -> String showList :: [OutOfMemoryException] -> ShowS

data SystemErrorException Source #

Constructors

SystemErrorException BotanErrorCode BotanErrorMessage CallStack

Instances

Instances details

Exception SystemErrorException Source #
Instance details Defined in Botan.Low.Error.Internal Methods toException :: SystemErrorException -> SomeException fromException :: SomeException -> Maybe SystemErrorException displayException :: SystemErrorException -> String backtraceDesired :: SystemErrorException -> Bool
Show SystemErrorException Source #
Instance details Defined in Botan.Low.Error.Internal Methods showsPrec :: Int -> SystemErrorException -> ShowS show :: SystemErrorException -> String showList :: [SystemErrorException] -> ShowS

data InternalErrorException Source #

Constructors

InternalErrorException BotanErrorCode BotanErrorMessage CallStack

Instances

Instances details

Exception InternalErrorException Source #
Instance details Defined in Botan.Low.Error.Internal Methods toException :: InternalErrorException -> SomeException fromException :: SomeException -> Maybe InternalErrorException displayException :: InternalErrorException -> String backtraceDesired :: InternalErrorException -> Bool
Show InternalErrorException Source #
Instance details Defined in Botan.Low.Error.Internal Methods showsPrec :: Int -> InternalErrorException -> ShowS show :: InternalErrorException -> String showList :: [InternalErrorException] -> ShowS

data BadFlagException Source #

Constructors

BadFlagException BotanErrorCode BotanErrorMessage CallStack

Instances

Instances details

Exception BadFlagException Source #
Instance details Defined in Botan.Low.Error.Internal Methods toException :: BadFlagException -> SomeException fromException :: SomeException -> Maybe BadFlagException displayException :: BadFlagException -> String backtraceDesired :: BadFlagException -> Bool
Show BadFlagException Source #
Instance details Defined in Botan.Low.Error.Internal Methods showsPrec :: Int -> BadFlagException -> ShowS show :: BadFlagException -> String showList :: [BadFlagException] -> ShowS

data NullPointerException Source #

Constructors

NullPointerException BotanErrorCode BotanErrorMessage CallStack

Instances

Instances details

Exception NullPointerException Source #
Instance details Defined in Botan.Low.Error.Internal Methods toException :: NullPointerException -> SomeException fromException :: SomeException -> Maybe NullPointerException displayException :: NullPointerException -> String backtraceDesired :: NullPointerException -> Bool
Show NullPointerException Source #
Instance details Defined in Botan.Low.Error.Internal Methods showsPrec :: Int -> NullPointerException -> ShowS show :: NullPointerException -> String showList :: [NullPointerException] -> ShowS

data BadParameterException Source #

Constructors

BadParameterException BotanErrorCode BotanErrorMessage CallStack

Instances

Instances details

Exception BadParameterException Source #
Instance details Defined in Botan.Low.Error.Internal Methods toException :: BadParameterException -> SomeException fromException :: SomeException -> Maybe BadParameterException displayException :: BadParameterException -> String backtraceDesired :: BadParameterException -> Bool
Show BadParameterException Source #
Instance details Defined in Botan.Low.Error.Internal Methods showsPrec :: Int -> BadParameterException -> ShowS show :: BadParameterException -> String showList :: [BadParameterException] -> ShowS

data KeyNotSetException Source #

Constructors

KeyNotSetException BotanErrorCode BotanErrorMessage CallStack

Instances

Instances details

Exception KeyNotSetException Source #
Instance details Defined in Botan.Low.Error.Internal Methods toException :: KeyNotSetException -> SomeException fromException :: SomeException -> Maybe KeyNotSetException displayException :: KeyNotSetException -> String backtraceDesired :: KeyNotSetException -> Bool
Show KeyNotSetException Source #
Instance details Defined in Botan.Low.Error.Internal Methods showsPrec :: Int -> KeyNotSetException -> ShowS show :: KeyNotSetException -> String showList :: [KeyNotSetException] -> ShowS

data InvalidKeyLengthException Source #

Constructors

InvalidKeyLengthException BotanErrorCode BotanErrorMessage CallStack

Instances

Instances details

Exception InvalidKeyLengthException Source #
Instance details Defined in Botan.Low.Error.Internal Methods toException :: InvalidKeyLengthException -> SomeException fromException :: SomeException -> Maybe InvalidKeyLengthException displayException :: InvalidKeyLengthException -> String backtraceDesired :: InvalidKeyLengthException -> Bool
Show InvalidKeyLengthException Source #
Instance details Defined in Botan.Low.Error.Internal Methods showsPrec :: Int -> InvalidKeyLengthException -> ShowS show :: InvalidKeyLengthException -> String showList :: [InvalidKeyLengthException] -> ShowS

data InvalidObjectStateException Source #

Constructors

InvalidObjectStateException BotanErrorCode BotanErrorMessage CallStack

Instances

Instances details

Exception InvalidObjectStateException Source #
Instance details Defined in Botan.Low.Error.Internal Methods toException :: InvalidObjectStateException -> SomeException fromException :: SomeException -> Maybe InvalidObjectStateException displayException :: InvalidObjectStateException -> String backtraceDesired :: InvalidObjectStateException -> Bool
Show InvalidObjectStateException Source #
Instance details Defined in Botan.Low.Error.Internal Methods showsPrec :: Int -> InvalidObjectStateException -> ShowS show :: InvalidObjectStateException -> String showList :: [InvalidObjectStateException] -> ShowS

data NotImplementedException Source #

Constructors

NotImplementedException BotanErrorCode BotanErrorMessage CallStack

Instances

Instances details

Exception NotImplementedException Source #
Instance details Defined in Botan.Low.Error.Internal Methods toException :: NotImplementedException -> SomeException fromException :: SomeException -> Maybe NotImplementedException displayException :: NotImplementedException -> String backtraceDesired :: NotImplementedException -> Bool
Show NotImplementedException Source #
Instance details Defined in Botan.Low.Error.Internal Methods showsPrec :: Int -> NotImplementedException -> ShowS show :: NotImplementedException -> String showList :: [NotImplementedException] -> ShowS

data InvalidObjectException Source #

Constructors

InvalidObjectException BotanErrorCode BotanErrorMessage CallStack

Instances

Instances details

Exception InvalidObjectException Source #
Instance details Defined in Botan.Low.Error.Internal Methods toException :: InvalidObjectException -> SomeException fromException :: SomeException -> Maybe InvalidObjectException displayException :: InvalidObjectException -> String backtraceDesired :: InvalidObjectException -> Bool
Show InvalidObjectException Source #
Instance details Defined in Botan.Low.Error.Internal Methods showsPrec :: Int -> InvalidObjectException -> ShowS show :: InvalidObjectException -> String showList :: [InvalidObjectException] -> ShowS

data UnknownException Source #

Constructors

UnknownException BotanErrorCode BotanErrorMessage CallStack

Instances

Instances details

Exception UnknownException Source #
Instance details Defined in Botan.Low.Error.Internal Methods toException :: UnknownException -> SomeException fromException :: SomeException -> Maybe UnknownException displayException :: UnknownException -> String backtraceDesired :: UnknownException -> Bool
Show UnknownException Source #
Instance details Defined in Botan.Low.Error.Internal Methods showsPrec :: Int -> UnknownException -> ShowS show :: UnknownException -> String showList :: [UnknownException] -> ShowS