Control.CollectErrors.Type

Documentation

data CollectErrors es v

A wrapper around values which can accommodate a list of (potential) errors that have (maybe) occurred during the computation of a value. A value may be missing, leaving only the error(s).

Such error collection allows one to write expressions with partial functions (ie functions that fail for some inputs) instead of branching after each application of such function. Dealing with the errors can be moved outside the expression. If the error data contain enough information, their list can be used to trace the source of the errors.

Constructors

CollectErrors

Fields

• getMaybeValue :: Maybe v
• getErrors :: es

Instances

Generic1 (CollectErrors es :: Type -> Type)

Defined in Control.CollectErrors.Type

Associated Types

type Rep1 (CollectErrors es) :: k -> Type

Methods

from1 :: forall (a :: k). CollectErrors es a -> Rep1 (CollectErrors es) a

to1 :: forall (a :: k). Rep1 (CollectErrors es) a -> CollectErrors es a

Monoid es => CanTakeErrors es (CollectErrors es t)

Defined in Control.CollectErrors.Type

Methods

takeErrors :: es -> CollectErrors es t -> CollectErrors es t

takeErrorsNoValue :: es -> CollectErrors es t

Monoid es => Applicative (CollectErrors es)

Defined in Control.CollectErrors.Type

Methods

pure :: a -> CollectErrors es a

(<*>) :: CollectErrors es (a -> b) -> CollectErrors es a -> CollectErrors es b

liftA2 :: (a -> b -> c) -> CollectErrors es a -> CollectErrors es b -> CollectErrors es c

(*>) :: CollectErrors es a -> CollectErrors es b -> CollectErrors es b

(<*) :: CollectErrors es a -> CollectErrors es b -> CollectErrors es a

Functor (CollectErrors es)

Defined in Control.CollectErrors.Type

Methods

fmap :: (a -> b) -> CollectErrors es a -> CollectErrors es b

(<$) :: a -> CollectErrors es b -> CollectErrors es a

Monoid es => Monad (CollectErrors es)

Defined in Control.CollectErrors.Type

Methods

(>>=) :: CollectErrors es a -> (a -> CollectErrors es b) -> CollectErrors es b

(>>) :: CollectErrors es a -> CollectErrors es b -> CollectErrors es b

return :: a -> CollectErrors es a

(Floating v, Ord v, Show v) => Floating (CN v)

Defined in Numeric.CollectErrors.PreludeInstances

Methods

pi :: CN v

exp :: CN v -> CN v

log :: CN v -> CN v

sqrt :: CN v -> CN v

(**) :: CN v -> CN v -> CN v

logBase :: CN v -> CN v -> CN v

sin :: CN v -> CN v

cos :: CN v -> CN v

tan :: CN v -> CN v

asin :: CN v -> CN v

acos :: CN v -> CN v

atan :: CN v -> CN v

sinh :: CN v -> CN v

cosh :: CN v -> CN v

tanh :: CN v -> CN v

asinh :: CN v -> CN v

acosh :: CN v -> CN v

atanh :: CN v -> CN v

log1p :: CN v -> CN v

expm1 :: CN v -> CN v

log1pexp :: CN v -> CN v

log1mexp :: CN v -> CN v

(Fractional v, Eq v) => Fractional (CN v)

Defined in Numeric.CollectErrors.PreludeInstances

Methods

(/) :: CN v -> CN v -> CN v

recip :: CN v -> CN v

fromRational :: Rational -> CN v

(Integral v, Ord v, Show v) => Integral (CN v)

Defined in Numeric.CollectErrors.PreludeInstances

Methods

quot :: CN v -> CN v -> CN v

rem :: CN v -> CN v -> CN v

div :: CN v -> CN v -> CN v

mod :: CN v -> CN v -> CN v

quotRem :: CN v -> CN v -> (CN v, CN v)

divMod :: CN v -> CN v -> (CN v, CN v)

toInteger :: CN v -> Integer

CanClearPotentialErrors (CN t)

Defined in Numeric.CollectErrors.Type

Methods

clearPotentialErrors :: CN t -> CN t

NFData es => NFData1 (CollectErrors es)

Defined in Control.CollectErrors.Type

Methods

liftRnf :: (a -> ()) -> CollectErrors es a -> ()

(Arbitrary t, Monoid es) => Arbitrary (CollectErrors es t)

Defined in Control.CollectErrors.Type

Methods

arbitrary :: Gen (CollectErrors es t)

shrink :: CollectErrors es t -> [CollectErrors es t]

(CanBeErrors es, Bounded v) => Bounded (CollectErrors es v)

Defined in Control.CollectErrors.PreludeInstances

Methods

minBound :: CollectErrors es v

maxBound :: CollectErrors es v

(CanBeErrors es, Enum v) => Enum (CollectErrors es v)

Defined in Control.CollectErrors.PreludeInstances

Methods

succ :: CollectErrors es v -> CollectErrors es v

pred :: CollectErrors es v -> CollectErrors es v

toEnum :: Int -> CollectErrors es v

fromEnum :: CollectErrors es v -> Int

enumFrom :: CollectErrors es v -> [CollectErrors es v]

enumFromThen :: CollectErrors es v -> CollectErrors es v -> [CollectErrors es v]

enumFromTo :: CollectErrors es v -> CollectErrors es v -> [CollectErrors es v]

enumFromThenTo :: CollectErrors es v -> CollectErrors es v -> CollectErrors es v -> [CollectErrors es v]

Generic (CollectErrors es v)

Defined in Control.CollectErrors.Type

Associated Types

type Rep (CollectErrors es v) :: Type -> Type

Methods

from :: CollectErrors es v -> Rep (CollectErrors es v) x

to :: Rep (CollectErrors es v) x -> CollectErrors es v

(CanBeErrors es, Num v) => Num (CollectErrors es v)

Defined in Control.CollectErrors.PreludeInstances

Methods

(+) :: CollectErrors es v -> CollectErrors es v -> CollectErrors es v

(-) :: CollectErrors es v -> CollectErrors es v -> CollectErrors es v

(*) :: CollectErrors es v -> CollectErrors es v -> CollectErrors es v

negate :: CollectErrors es v -> CollectErrors es v

abs :: CollectErrors es v -> CollectErrors es v

signum :: CollectErrors es v -> CollectErrors es v

fromInteger :: Integer -> CollectErrors es v

(CanBeErrors es, Real v) => Real (CollectErrors es v)

Defined in Control.CollectErrors.PreludeInstances

Methods

toRational :: CollectErrors es v -> Rational

(Show v, CanBeErrors es) => Show (CollectErrors es v)

Defined in Control.CollectErrors.Type

Methods

showsPrec :: Int -> CollectErrors es v -> ShowS

show :: CollectErrors es v -> String

showList :: [CollectErrors es v] -> ShowS

CanTestErrorsCertain es => CanTestErrorsCertain (CollectErrors es v)

Defined in Control.CollectErrors.Type

Methods

hasCertainError :: CollectErrors es v -> Bool

CanTestErrorsPresent es => CanTestErrorsPresent (CollectErrors es v)

Defined in Control.CollectErrors.Type

Methods

hasError :: CollectErrors es v -> Bool

(NFData v, NFData es) => NFData (CollectErrors es v)

Defined in Control.CollectErrors.Type

Methods

rnf :: CollectErrors es v -> ()

(CanBeErrors es, Eq v) => Eq (CollectErrors es v)

Defined in Control.CollectErrors.PreludeInstances

Methods

(==) :: CollectErrors es v -> CollectErrors es v -> Bool

(/=) :: CollectErrors es v -> CollectErrors es v -> Bool

(CanBeErrors es, Ord v) => Ord (CollectErrors es v)

Defined in Control.CollectErrors.PreludeInstances

Methods

compare :: CollectErrors es v -> CollectErrors es v -> Ordering

(<) :: CollectErrors es v -> CollectErrors es v -> Bool

(<=) :: CollectErrors es v -> CollectErrors es v -> Bool

(>) :: CollectErrors es v -> CollectErrors es v -> Bool

(>=) :: CollectErrors es v -> CollectErrors es v -> Bool

max :: CollectErrors es v -> CollectErrors es v -> CollectErrors es v

min :: CollectErrors es v -> CollectErrors es v -> CollectErrors es v

type Rep1 (CollectErrors es :: Type -> Type)

Defined in Control.CollectErrors.Type

type Rep1 (CollectErrors es :: Type -> Type) = D1 ('MetaData "CollectErrors" "Control.CollectErrors.Type" "collect-errors-0.1.6.0-10q3pF0DPUmBtUmcUYSc7q" 'False) (C1 ('MetaCons "CollectErrors" 'PrefixI 'True) (S1 ('MetaSel ('Just "getMaybeValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec1 Maybe) :*: S1 ('MetaSel ('Just "getErrors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 es)))

type Rep (CollectErrors es v)

Defined in Control.CollectErrors.Type

type Rep (CollectErrors es v) = D1 ('MetaData "CollectErrors" "Control.CollectErrors.Type" "collect-errors-0.1.6.0-10q3pF0DPUmBtUmcUYSc7q" 'False) (C1 ('MetaCons "CollectErrors" 'PrefixI 'True) (S1 ('MetaSel ('Just "getMaybeValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe v)) :*: S1 ('MetaSel ('Just "getErrors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 es)))

class CanTestErrorsCertain es where

Methods

hasCertainError :: es -> Bool

Instances

CanTestErrorsCertain NumErrorLevel

Defined in Numeric.CollectErrors.Type

Methods

hasCertainError :: NumErrorLevel -> Bool

CanTestErrorsCertain NumErrors

Defined in Numeric.CollectErrors.Type

Methods

hasCertainError :: NumErrors -> Bool

CanTestErrorsCertain es => CanTestErrorsCertain (Set es)

Defined in Control.CollectErrors.Type

Methods

hasCertainError :: Set es -> Bool

CanTestErrorsCertain es => CanTestErrorsCertain [es]

Defined in Control.CollectErrors.Type

Methods

hasCertainError :: [es] -> Bool

CanTestErrorsCertain es => CanTestErrorsCertain (CollectErrors es v)

Defined in Control.CollectErrors.Type

Methods

hasCertainError :: CollectErrors es v -> Bool

class CanTestErrorsPresent es where

Methods

hasError :: es -> Bool

Instances

CanTestErrorsPresent NumErrors

Defined in Numeric.CollectErrors.Type

Methods

hasError :: NumErrors -> Bool

CanTestErrorsPresent (Set es)

Defined in Control.CollectErrors.Type

Methods

hasError :: Set es -> Bool

CanTestErrorsPresent [es]

Defined in Control.CollectErrors.Type

Methods

hasError :: [es] -> Bool

CanTestErrorsPresent es => CanTestErrorsPresent (CollectErrors es v)

Defined in Control.CollectErrors.Type

Methods

hasError :: CollectErrors es v -> Bool

type CanBeErrors es = (Monoid es, Eq es, Show es, CanTestErrorsCertain es, CanTestErrorsPresent es)

noValue :: es -> CollectErrors es v

removeValue :: Monoid es => CollectErrors es v -> es -> CollectErrors es v

Take a CE-value, add new errors into it and remove the value, if any

prependErrors :: Monoid es => es -> CollectErrors es v -> CollectErrors es v

unCollectErrors :: Show es => CollectErrors es p -> p

Unsafe way to get a value out of the CollectErrors wrapper.

(~!) :: Show es => CollectErrors es p -> p

Unsafe way to get a value out of the CollectErrors wrapper.

toEither :: CanBeErrors es => CollectErrors es v -> Either es v

A safe way to get a value out of the CollectErrors wrapper.

withErrorOrValue :: CanBeErrors es => (es -> t) -> (v -> t) -> CollectErrors es v -> t

filterValuesWithoutError :: CanBeErrors es => [CollectErrors es v] -> [v]

lift :: Monoid es => (a -> b) -> CollectErrors es a -> CollectErrors es b

liftCE :: Monoid es => (a -> CollectErrors es c) -> CollectErrors es a -> CollectErrors es c

liftPair :: Monoid es => (a -> (c, d)) -> CollectErrors es a -> (CollectErrors es c, CollectErrors es d)

lift2 :: Monoid es => (a -> b -> c) -> CollectErrors es a -> CollectErrors es b -> CollectErrors es c

lift2CE :: Monoid es => (a -> b -> CollectErrors es c) -> CollectErrors es a -> CollectErrors es b -> CollectErrors es c

lift1T :: Monoid es => (a -> b -> c) -> CollectErrors es a -> b -> CollectErrors es c

lift1TCE :: Monoid es => (a -> b -> CollectErrors es c) -> CollectErrors es a -> b -> CollectErrors es c

liftT1 :: Monoid es => (a -> b -> c) -> a -> CollectErrors es b -> CollectErrors es c

liftT1CE :: Monoid es => (a -> b -> CollectErrors es c) -> a -> CollectErrors es b -> CollectErrors es c

lift2pair :: Monoid es => (a -> b -> (c, d)) -> CollectErrors es a -> CollectErrors es b -> (CollectErrors es c, CollectErrors es d)

lift1Tpair :: Monoid es => (a -> b -> (c, d)) -> CollectErrors es a -> b -> (CollectErrors es c, CollectErrors es d)

liftT1pair :: Monoid es => (a -> b -> (c, d)) -> a -> CollectErrors es b -> (CollectErrors es c, CollectErrors es d)

liftTakeErrors :: CanTakeErrors es t2 => (t1 -> t2) -> CollectErrors es t1 -> t2

class CanTakeErrors es t where

Methods

takeErrors :: es -> t -> t

takeErrorsNoValue :: es -> t

Instances

Monoid es => CanTakeErrors es (CollectErrors es t)

Defined in Control.CollectErrors.Type

Methods

takeErrors :: es -> CollectErrors es t -> CollectErrors es t

takeErrorsNoValue :: es -> CollectErrors es t

(CanTakeErrors es t1, CanTakeErrors es t2) => CanTakeErrors es (t1, t2)

Defined in Control.CollectErrors.Type

Methods

takeErrors :: es -> (t1, t2) -> (t1, t2)

takeErrorsNoValue :: es -> (t1, t2)