Safe Haskell	Trustworthy
Language	Haskell2010

Universum.Debug

Description

Functions for debugging. If you left these functions in your code then warning is generated to remind you about left usages. Also, some functions (and data types) are convenient for prototyping.

Synopsis

data Undefined = Undefined
error :: forall (r :: RuntimeRep). forall (a :: TYPE r). HasCallStack => Text -> a
trace :: Text -> a -> a
traceM :: Monad m => Text -> m ()
traceId :: Text -> Text
traceIdWith :: (a -> Text) -> a -> a
traceShow :: Show a => a -> b -> b
traceShowId :: Show a => a -> a
traceShowIdWith :: Show s => (a -> s) -> a -> a
traceShowM :: (Show a, Monad m) => a -> m ()
undefined :: forall (r :: RuntimeRep). forall (a :: TYPE r). HasCallStack => a

Documentation

data Undefined #

Warning: Undefined type remains in code

Similar to undefined but data type.

Constructors

Undefined

Warning: Undefined type remains in code

Instances

Bounded Undefined #
Instance details Defined in Universum.Debug Methods minBound :: Undefined # maxBound :: Undefined #
Enum Undefined #
Instance details Defined in Universum.Debug Methods succ :: Undefined -> Undefined # pred :: Undefined -> Undefined # toEnum :: Int -> Undefined # fromEnum :: Undefined -> Int # enumFrom :: Undefined -> [Undefined] # enumFromThen :: Undefined -> Undefined -> [Undefined] # enumFromTo :: Undefined -> Undefined -> [Undefined] # enumFromThenTo :: Undefined -> Undefined -> Undefined -> [Undefined] #
Eq Undefined #
Instance details Defined in Universum.Debug Methods (==) :: Undefined -> Undefined -> Bool # (/=) :: Undefined -> Undefined -> Bool #
Data Undefined #
Instance details Defined in Universum.Debug Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Undefined -> c Undefined # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Undefined # toConstr :: Undefined -> Constr # dataTypeOf :: Undefined -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Undefined) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Undefined) # gmapT :: (forall b. Data b => b -> b) -> Undefined -> Undefined # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Undefined -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Undefined -> r # gmapQ :: (forall d. Data d => d -> u) -> Undefined -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Undefined -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Undefined -> m Undefined # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Undefined -> m Undefined # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Undefined -> m Undefined #
Ord Undefined #
Instance details Defined in Universum.Debug Methods compare :: Undefined -> Undefined -> Ordering # (<) :: Undefined -> Undefined -> Bool # (<=) :: Undefined -> Undefined -> Bool # (>) :: Undefined -> Undefined -> Bool # (>=) :: Undefined -> Undefined -> Bool # max :: Undefined -> Undefined -> Undefined # min :: Undefined -> Undefined -> Undefined #
Read Undefined #
Instance details Defined in Universum.Debug Methods readsPrec :: Int -> ReadS Undefined # readList :: ReadS [Undefined] # readPrec :: ReadPrec Undefined # readListPrec :: ReadPrec [Undefined] #
Show Undefined #
Instance details Defined in Universum.Debug Methods showsPrec :: Int -> Undefined -> ShowS # show :: Undefined -> String # showList :: [Undefined] -> ShowS #
Generic Undefined #
Instance details Defined in Universum.Debug Associated Types type Rep Undefined :: Type -> Type # Methods from :: Undefined -> Rep Undefined x # to :: Rep Undefined x -> Undefined #
type Rep Undefined #
Instance details Defined in Universum.Debug type Rep Undefined = D1 (MetaData "Undefined" "Universum.Debug" "universum-1.5.0-9MJuGSCTA5xHG1BGuS7nNH" False) (C1 (MetaCons "Undefined" PrefixI False) (U1 :: Type -> Type))

error :: forall (r :: RuntimeRep). forall (a :: TYPE r). HasCallStack => Text -> a #

error that takes Text as an argument.

trace :: Text -> a -> a #

Warning: trace remains in code

Version of trace that leaves a warning and takes Text.

traceM :: Monad m => Text -> m () #

Warning: traceM remains in code

Version of traceM that leaves a warning and takes Text.

traceId :: Text -> Text #

Warning: traceId remains in code

Version of traceId that leaves a warning.

traceIdWith :: (a -> Text) -> a -> a #

Warning: traceIdWith remains in code

Version of traceId that leaves a warning. Useful to tag printed data, for instance:

traceIdWith (x -> "My data: " <> show x) (veryLargeExpression)

This is especially useful with custom formatters:

traceIdWith (x -> "My data: " <> pretty x) (veryLargeExpression)

traceShow :: Show a => a -> b -> b #

Warning: traceShow remains in code

Version of traceShow that leaves a warning.

traceShowId :: Show a => a -> a #

Warning: traceShowId remains in code

Version of traceShowId that leaves a warning.

traceShowIdWith :: Show s => (a -> s) -> a -> a #

Warning: traceShowIdWith remains in code

Version of traceShowId that leaves a warning. Useful to tag printed data, for instance:

traceShowIdWith ("My data: ", ) (veryLargeExpression)

traceShowM :: (Show a, Monad m) => a -> m () #

Warning: traceShowM remains in code

Version of traceShowM that leaves a warning.

undefined :: forall (r :: RuntimeRep). forall (a :: TYPE r). HasCallStack => a #

Warning: undefined function remains in code (or use error)

undefined that leaves a warning in code on every usage.