License	BSD-style
Maintainer	Vincent Hanquez <vincent@snarc.org>
Stability	experimental
Portability	portable
Safe Haskell	Safe-Inferred
Language	Haskell2010

Basement.Exception

Description

Common part for vectors

Synopsis

data OutOfBound = OutOfBound OutOfBoundOperation Int Int
data OutOfBoundOperation
- = OOB_Read
- | OOB_Write
- | OOB_MemSet
- | OOB_MemCopy
- | OOB_Index
isOutOfBound :: Offset ty -> CountOf ty -> Bool
outOfBound :: OutOfBoundOperation -> Offset ty -> CountOf ty -> a
primOutOfBound :: PrimMonad prim => OutOfBoundOperation -> Offset ty -> CountOf ty -> prim a
data InvalidRecast = InvalidRecast RecastSourceSize RecastDestinationSize
newtype RecastSourceSize = RecastSourceSize Int
newtype RecastDestinationSize = RecastDestinationSize Int
data NonEmptyCollectionIsEmpty = NonEmptyCollectionIsEmpty

Documentation

data OutOfBound Source #

Exception during an operation accessing the vector out of bound

Represent the type of operation, the index accessed, and the total length of the vector.

Constructors

OutOfBound OutOfBoundOperation Int Int

Instances

Instances details

Exception OutOfBound Source #
Instance details Defined in Basement.Exception Methods toException :: OutOfBound -> SomeException # fromException :: SomeException -> Maybe OutOfBound # displayException :: OutOfBound -> String #
Show OutOfBound Source #
Instance details Defined in Basement.Exception Methods showsPrec :: Int -> OutOfBound -> ShowS # show :: OutOfBound -> String # showList :: [OutOfBound] -> ShowS #

data OutOfBoundOperation Source #

The type of operation that triggers an OutOfBound exception.

OOB_Index: reading an immutable vector
OOB_Read: reading a mutable vector
OOB_Write: write a mutable vector
OOB_MemCopy: copying a vector
OOB_MemSet: initializing a mutable vector

Constructors

OOB_Read
OOB_Write
OOB_MemSet
OOB_MemCopy
OOB_Index

Instances

Instances details

Show OutOfBoundOperation Source #
Instance details Defined in Basement.Exception Methods showsPrec :: Int -> OutOfBoundOperation -> ShowS # show :: OutOfBoundOperation -> String # showList :: [OutOfBoundOperation] -> ShowS #
Eq OutOfBoundOperation Source #
Instance details Defined in Basement.Exception Methods (==) :: OutOfBoundOperation -> OutOfBoundOperation -> Bool # (/=) :: OutOfBoundOperation -> OutOfBoundOperation -> Bool #

isOutOfBound :: Offset ty -> CountOf ty -> Bool Source #

outOfBound :: OutOfBoundOperation -> Offset ty -> CountOf ty -> a Source #

primOutOfBound :: PrimMonad prim => OutOfBoundOperation -> Offset ty -> CountOf ty -> prim a Source #

data InvalidRecast Source #

Constructors

InvalidRecast RecastSourceSize RecastDestinationSize

Instances

Instances details

Exception InvalidRecast Source #
Instance details Defined in Basement.Exception Methods toException :: InvalidRecast -> SomeException # fromException :: SomeException -> Maybe InvalidRecast # displayException :: InvalidRecast -> String #
Show InvalidRecast Source #
Instance details Defined in Basement.Exception Methods showsPrec :: Int -> InvalidRecast -> ShowS # show :: InvalidRecast -> String # showList :: [InvalidRecast] -> ShowS #

newtype RecastSourceSize Source #

Constructors

RecastSourceSize Int

Instances

Instances details

Show RecastSourceSize Source #
Instance details Defined in Basement.Exception Methods showsPrec :: Int -> RecastSourceSize -> ShowS # show :: RecastSourceSize -> String # showList :: [RecastSourceSize] -> ShowS #
Eq RecastSourceSize Source #
Instance details Defined in Basement.Exception Methods (==) :: RecastSourceSize -> RecastSourceSize -> Bool # (/=) :: RecastSourceSize -> RecastSourceSize -> Bool #

newtype RecastDestinationSize Source #

Constructors

RecastDestinationSize Int

Instances

Instances details

Show RecastDestinationSize Source #
Instance details Defined in Basement.Exception Methods showsPrec :: Int -> RecastDestinationSize -> ShowS # show :: RecastDestinationSize -> String # showList :: [RecastDestinationSize] -> ShowS #
Eq RecastDestinationSize Source #
Instance details Defined in Basement.Exception Methods (==) :: RecastDestinationSize -> RecastDestinationSize -> Bool # (/=) :: RecastDestinationSize -> RecastDestinationSize -> Bool #

data NonEmptyCollectionIsEmpty Source #

Exception for using NonEmpty assertion with an empty collection

Constructors

NonEmptyCollectionIsEmpty

Instances

Instances details

Exception NonEmptyCollectionIsEmpty Source #
Instance details Defined in Basement.Exception Methods toException :: NonEmptyCollectionIsEmpty -> SomeException # fromException :: SomeException -> Maybe NonEmptyCollectionIsEmpty # displayException :: NonEmptyCollectionIsEmpty -> String #
Show NonEmptyCollectionIsEmpty Source #
Instance details Defined in Basement.Exception Methods showsPrec :: Int -> NonEmptyCollectionIsEmpty -> ShowS # show :: NonEmptyCollectionIsEmpty -> String # showList :: [NonEmptyCollectionIsEmpty] -> ShowS #