Text.Reform.Result

Module for the core result type, and related functions

Documentation

data Result e ok

Type for failing computations

Constructors

Error [(FormRange, e)]

Ok ok

Instances

Monad (Result e)

Functor (Result e)

Applicative (Result e)

(Eq e, Eq ok) => Eq (Result e ok)

(Show e, Show ok) => Show (Result e ok)

getResult :: Result e ok -> Maybe ok

convert a Result to Maybe discarding the error message on Error

data FormId

An ID used to identify forms

Instances

Eq FormId

Ord FormId

Show FormId

zeroId :: String -> FormId

The zero ID, i.e. the first ID that is usable

mapId :: ([Integer] -> [Integer]) -> FormId -> FormId

map a function over the [Integer] inside a FormId

formIdList :: FormId -> [Integer]

Stack indicating field. Head is most specific to this item

data FormRange

A range of ID's to specify a group of forms

Constructors

FormRange FormId FormId

Instances

Eq FormRange

Show FormRange

incrementFormId :: FormId -> FormId

Increment a form ID

unitRange :: FormId -> FormRange

create a FormRange from a FormId

isInRange

Arguments

:: FormId

Id to check for

-> FormRange

Range

-> Bool

If the range contains the id

Check if a FormId is contained in a FormRange

isSubRange

Arguments

:: FormRange

Sub-range

-> FormRange

Larger range

-> Bool

If the sub-range is contained in the larger range

Check if a FormRange is contained in another FormRange

retainErrors :: FormRange -> [(FormRange, e)] -> [e]

Select the errors for a certain range

retainChildErrors :: FormRange -> [(FormRange, e)] -> [e]

Select the errors originating from this form or from any of the children of this form