Clash.XException.Internal

XException: An exception for uninitialized values

>>> show (errorX "undefined" :: Integer, 4 :: Int)
"(*** Exception: X: undefined
CallStack (from HasCallStack):
...
>>> showX (errorX "undefined" :: Integer, 4 :: Int)
"(undefined,4)"

Documentation

newtype XException

An exception representing an "uninitialized" value.

Constructors

XException String

Instances

Show XException

Defined in Clash.XException.Internal

Methods

showsPrec :: Int -> XException -> ShowS

show :: XException -> String

showList :: [XException] -> ShowS

Exception XException

Defined in Clash.XException.Internal

Methods

toException :: XException -> SomeException

fromException :: SomeException -> Maybe XException

displayException :: XException -> String

Printing XExceptions as undefined

showsX :: ShowX a => a -> ShowS

Like shows, but values that normally throw an XException are converted to undefined, instead of error'ing out with an exception.

showsPrecXWith :: (Int -> a -> ShowS) -> Int -> a -> ShowS

Use when you want to create a ShowX instance where:

• There is no Generic instance for your data type
• The Generic derived ShowX method would traverse into the (hidden) implementation details of your data type, and you just want to show the entire value as undefined.

Can be used like:

data T = ...

instance Show T where ...

instance ShowX T where
  showsPrecX = showsPrecXWith showsPrec

showXWith :: (a -> ShowS) -> a -> ShowS

Internals

class GShowX f where

Minimal complete definition

gshowsPrecX

Methods

gshowsPrecX :: ShowType -> Int -> f a -> ShowS

isNullary :: f a -> Bool

Instances

GShowX (U1 :: Type -> Type)

Defined in Clash.XException.Internal

Methods

gshowsPrecX :: ShowType -> Int -> U1 a -> ShowS

isNullary :: U1 a -> Bool

GShowX (UChar :: Type -> Type)

Defined in Clash.XException.Internal

Methods

gshowsPrecX :: ShowType -> Int -> UChar a -> ShowS

isNullary :: UChar a -> Bool

GShowX (UDouble :: Type -> Type)

Defined in Clash.XException.Internal

Methods

gshowsPrecX :: ShowType -> Int -> UDouble a -> ShowS

isNullary :: UDouble a -> Bool

GShowX (UFloat :: Type -> Type)

Defined in Clash.XException.Internal

Methods

gshowsPrecX :: ShowType -> Int -> UFloat a -> ShowS

isNullary :: UFloat a -> Bool

GShowX (UInt :: Type -> Type)

Defined in Clash.XException.Internal

Methods

gshowsPrecX :: ShowType -> Int -> UInt a -> ShowS

isNullary :: UInt a -> Bool

GShowX (UWord :: Type -> Type)

Defined in Clash.XException.Internal

Methods

gshowsPrecX :: ShowType -> Int -> UWord a -> ShowS

isNullary :: UWord a -> Bool

ShowX c => GShowX (K1 i c :: Type -> Type)

Defined in Clash.XException.Internal

Methods

gshowsPrecX :: ShowType -> Int -> K1 i c a -> ShowS

isNullary :: K1 i c a -> Bool

(GShowX a, GShowX b) => GShowX (a :+: b)

Defined in Clash.XException.Internal

Methods

gshowsPrecX :: ShowType -> Int -> (a :+: b) a0 -> ShowS

isNullary :: (a :+: b) a0 -> Bool

(GShowX a, GShowX b) => GShowX (a :*: b)

Defined in Clash.XException.Internal

Methods

gshowsPrecX :: ShowType -> Int -> (a :*: b) a0 -> ShowS

isNullary :: (a :*: b) a0 -> Bool

GShowX a => GShowX (M1 D d a)

Defined in Clash.XException.Internal

Methods

gshowsPrecX :: ShowType -> Int -> M1 D d a a0 -> ShowS

isNullary :: M1 D d a a0 -> Bool

(GShowX a, Constructor c) => GShowX (M1 C c a)

Defined in Clash.XException.Internal

Methods

gshowsPrecX :: ShowType -> Int -> M1 C c a a0 -> ShowS

isNullary :: M1 C c a a0 -> Bool

(Selector s, GShowX a) => GShowX (M1 S s a)

Defined in Clash.XException.Internal

Methods

gshowsPrecX :: ShowType -> Int -> M1 S s a a0 -> ShowS

isNullary :: M1 S s a a0 -> Bool

class GDeepErrorX f where

Methods

gDeepErrorX :: HasCallStack => String -> f a

Instances

GDeepErrorX (V1 :: Type -> Type)

Defined in Clash.XException.Internal

Methods

gDeepErrorX :: HasCallStack => String -> V1 a

GDeepErrorX (U1 :: Type -> Type)

Defined in Clash.XException.Internal

Methods

gDeepErrorX :: HasCallStack => String -> U1 a

NFDataX c => GDeepErrorX (K1 i c :: Type -> Type)

Defined in Clash.XException.Internal

Methods

gDeepErrorX :: HasCallStack => String -> K1 i c a

GDeepErrorX (f :+: g)

Defined in Clash.XException.Internal

Methods

gDeepErrorX :: HasCallStack => String -> (f :+: g) a

(GDeepErrorX f, GDeepErrorX g) => GDeepErrorX (f :*: g)

Defined in Clash.XException.Internal

Methods

gDeepErrorX :: HasCallStack => String -> (f :*: g) a

GDeepErrorX a => GDeepErrorX (M1 m d a)

Defined in Clash.XException.Internal

Methods

gDeepErrorX :: HasCallStack => String -> M1 m d a a0

class GHasUndefined f where

Methods

gHasUndefined :: f a -> Bool

Instances

GHasUndefined (V1 :: Type -> Type)

Defined in Clash.XException.Internal

Methods

gHasUndefined :: V1 a -> Bool

GHasUndefined (U1 :: Type -> Type)

Defined in Clash.XException.Internal

Methods

gHasUndefined :: U1 a -> Bool

NFDataX a => GHasUndefined (K1 i a :: Type -> Type)

Defined in Clash.XException.Internal

Methods

gHasUndefined :: K1 i a a0 -> Bool

(GHasUndefined a, GHasUndefined b) => GHasUndefined (a :+: b)

Defined in Clash.XException.Internal

Methods

gHasUndefined :: (a :+: b) a0 -> Bool

(GHasUndefined a, GHasUndefined b) => GHasUndefined (a :*: b)

Defined in Clash.XException.Internal

Methods

gHasUndefined :: (a :*: b) a0 -> Bool

GHasUndefined a => GHasUndefined (M1 i c a)

Defined in Clash.XException.Internal

Methods

gHasUndefined :: M1 i c a a0 -> Bool

class GEnsureSpine f where

Methods

gEnsureSpine :: f a -> f a

Instances

GEnsureSpine (V1 :: Type -> Type)

Defined in Clash.XException.Internal

Methods

gEnsureSpine :: V1 a -> V1 a

GEnsureSpine (U1 :: Type -> Type)

Defined in Clash.XException.Internal

Methods

gEnsureSpine :: U1 a -> U1 a

NFDataX a => GEnsureSpine (K1 i a :: Type -> Type)

Defined in Clash.XException.Internal

Methods

gEnsureSpine :: K1 i a a0 -> K1 i a a0

(GEnsureSpine a, GEnsureSpine b) => GEnsureSpine (a :+: b)

Defined in Clash.XException.Internal

Methods

gEnsureSpine :: (a :+: b) a0 -> (a :+: b) a0

(GEnsureSpine a, GEnsureSpine b) => GEnsureSpine (a :*: b)

Defined in Clash.XException.Internal

Methods

gEnsureSpine :: (a :*: b) a0 -> (a :*: b) a0

GEnsureSpine a => GEnsureSpine (M1 i c a)

Defined in Clash.XException.Internal

Methods

gEnsureSpine :: M1 i c a a0 -> M1 i c a a0

class GNFDataX arity f where

Hidden internal type-class. Adds a generic implementation for the "NFData" part of NFDataX

Methods

grnfX :: RnfArgs arity a -> f a -> ()

Instances

GNFDataX One Par1

Defined in Clash.XException.Internal

Methods

grnfX :: RnfArgs One a -> Par1 a -> ()

GNFDataX arity (U1 :: Type -> Type)

Defined in Clash.XException.Internal

Methods

grnfX :: RnfArgs arity a -> U1 a -> ()

GNFDataX arity (V1 :: Type -> Type)

Defined in Clash.XException.Internal

Methods

grnfX :: RnfArgs arity a -> V1 a -> ()

NFDataX1 f => GNFDataX One (Rec1 f)

Defined in Clash.XException.Internal

Methods

grnfX :: RnfArgs One a -> Rec1 f a -> ()

(GNFDataX arity a, GNFDataX arity b) => GNFDataX arity (a :+: b)

Defined in Clash.XException.Internal

Methods

grnfX :: RnfArgs arity a0 -> (a :+: b) a0 -> ()

(GNFDataX arity a, GNFDataX arity b) => GNFDataX arity (a :*: b)

Defined in Clash.XException.Internal

Methods

grnfX :: RnfArgs arity a0 -> (a :*: b) a0 -> ()

NFDataX a => GNFDataX arity (K1 i a :: Type -> Type)

Defined in Clash.XException.Internal

Methods

grnfX :: RnfArgs arity a0 -> K1 i a a0 -> ()

GNFDataX arity a => GNFDataX arity (M1 i c a)

Defined in Clash.XException.Internal

Methods

grnfX :: RnfArgs arity a0 -> M1 i c a a0 -> ()

(NFDataX1 f, GNFDataX One g) => GNFDataX One (f :.: g)

Defined in Clash.XException.Internal

Methods

grnfX :: RnfArgs One a -> (f :.: g) a -> ()

data Zero

data One

Instances

GNFDataX One Par1

Defined in Clash.XException.Internal

Methods

grnfX :: RnfArgs One a -> Par1 a -> ()

NFDataX1 f => GNFDataX One (Rec1 f)

Defined in Clash.XException.Internal

Methods

grnfX :: RnfArgs One a -> Rec1 f a -> ()

(NFDataX1 f, GNFDataX One g) => GNFDataX One (f :.: g)

Defined in Clash.XException.Internal

Methods

grnfX :: RnfArgs One a -> (f :.: g) a -> ()

data ShowType

Constructors

Rec

Tup

Pref

Inf String

data RnfArgs arity a where

Constructors

RnfArgs0 :: RnfArgs Zero a

RnfArgs1 :: (a -> ()) -> RnfArgs One a

class NFDataX1 f where

A class of functors that can be fully evaluated, according to semantics of NFDataX.

Minimal complete definition

Nothing

Methods

liftRnfX :: (a -> ()) -> f a -> ()

liftRnfX should reduce its argument to normal form (that is, fully evaluate all sub-components), given an argument to reduce a arguments, and then return ().

See rnfX for the generic deriving.

default liftRnfX :: (Generic1 f, GNFDataX One (Rep1 f)) => (a -> ()) -> f a -> ()

showListX__ :: (a -> ShowS) -> [a] -> ShowS

genericShowsPrecX :: (Generic a, GShowX (Rep a)) => Int -> a -> ShowS