Ditto.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)

Defined in Ditto.Result

Methods

(>>=) :: Result e a -> (a -> Result e b) -> Result e b

(>>) :: Result e a -> Result e b -> Result e b

return :: a -> Result e a

fail :: String -> Result e a

Functor (Result e)

Defined in Ditto.Result

Methods

fmap :: (a -> b) -> Result e a -> Result e b

(<$) :: a -> Result e b -> Result e a

Applicative (Result e)

Defined in Ditto.Result

Methods

pure :: a -> Result e a

(<*>) :: Result e (a -> b) -> Result e a -> Result e b

liftA2 :: (a -> b -> c) -> Result e a -> Result e b -> Result e c

(*>) :: Result e a -> Result e b -> Result e b

(<*) :: Result e a -> Result e b -> Result e a

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

Defined in Ditto.Result

Methods

(==) :: Result e ok -> Result e ok -> Bool

(/=) :: Result e ok -> Result e ok -> Bool

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

Defined in Ditto.Result

Methods

showsPrec :: Int -> Result e ok -> ShowS

show :: Result e ok -> String

showList :: [Result e ok] -> ShowS

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

Constructors

FormId

Fields

• formPrefix :: String

  Global prefix for the form

• formIdList :: NonEmpty Integer

  Stack indicating field. Head is most specific to this item

FormIdCustom String

Instances

Eq FormId

Defined in Ditto.Result

Methods

(==) :: FormId -> FormId -> Bool

(/=) :: FormId -> FormId -> Bool

Ord FormId

Defined in Ditto.Result

Methods

compare :: FormId -> FormId -> Ordering

(<) :: FormId -> FormId -> Bool

(<=) :: FormId -> FormId -> Bool

(>) :: FormId -> FormId -> Bool

(>=) :: FormId -> FormId -> Bool

max :: FormId -> FormId -> FormId

min :: FormId -> FormId -> FormId

Show FormId

Defined in Ditto.Result

Methods

showsPrec :: Int -> FormId -> ShowS

show :: FormId -> String

showList :: [FormId] -> ShowS

zeroId :: String -> FormId

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

mapId :: (NonEmpty Integer -> NonEmpty Integer) -> FormId -> FormId

map a function over the NonEmpty Integer inside a FormId

data FormRange

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

Constructors

FormRange FormId FormId

Instances

Eq FormRange

Defined in Ditto.Result

Methods

(==) :: FormRange -> FormRange -> Bool

(/=) :: FormRange -> FormRange -> Bool

Show FormRange

Defined in Ditto.Result

Methods

showsPrec :: Int -> FormRange -> ShowS

show :: FormRange -> String

showList :: [FormRange] -> ShowS

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