Safe Haskell	None
Language	Haskell2010

Trasa.Form

Contents

Orphan instances

Synopsis

newtype FormData a = FormData {
- getFormData :: HashMap Text [Text]
}
class FormError input err where
- commonFormError :: CommonFormError input -> err
newtype TrasaFormT m a = TrasaFormT {
- getTrasaFormT :: ReaderT FormType (TrasaT m) a
}
data FormType
- = Get
- | Post (Maybe (HashMap Text [Text]))
type TrasaForm a = Form (TrasaFormT IO) QueryParam TrasaFormError (Html ()) a
data TrasaFormError = TrasaFormError {
- trasaFormErrorType :: Maybe (CommonFormError QueryParam)
- trasaFormErrorText :: Text
}
bodyFormData :: BodyCodec (FormData a)
liftParser :: (Text -> Either Text a) -> QueryParam -> Either TrasaFormError a
liftToForm :: Monad m => TrasaT m a -> TrasaFormT m a
reform :: (MonadIO m, Monoid view) => ([(Text, Text)] -> view -> view) -> Text -> Form (TrasaFormT m) QueryParam err view a -> TrasaT m (Result err a, view)
reformPost :: (MonadIO m, Monoid view) => ([(Text, Text)] -> view -> view) -> Text -> Maybe (FormData a) -> Form (TrasaFormT m) QueryParam err view a -> TrasaT m (Result err a, view)
trasaFormView :: Monad m => Text -> Form (TrasaFormT m) QueryParam err view a -> TrasaT m view
textError :: Text -> TrasaFormError

Documentation

newtype FormData a Source #

Constructors

FormData
Fields getFormData :: HashMap Text [Text]

Instances

Eq (FormData a) Source #
Instance details Defined in Trasa.Form Methods (==) :: FormData a -> FormData a -> Bool # (/=) :: FormData a -> FormData a -> Bool #
Ord (FormData a) Source #
Instance details Defined in Trasa.Form Methods compare :: FormData a -> FormData a -> Ordering # (<) :: FormData a -> FormData a -> Bool # (<=) :: FormData a -> FormData a -> Bool # (>) :: FormData a -> FormData a -> Bool # (>=) :: FormData a -> FormData a -> Bool # max :: FormData a -> FormData a -> FormData a # min :: FormData a -> FormData a -> FormData a #
Show (FormData a) Source #
Instance details Defined in Trasa.Form Methods showsPrec :: Int -> FormData a -> ShowS # show :: FormData a -> String # showList :: [FormData a] -> ShowS #
Semigroup (FormData a) Source #
Instance details Defined in Trasa.Form Methods (<>) :: FormData a -> FormData a -> FormData a # sconcat :: NonEmpty (FormData a) -> FormData a # stimes :: Integral b => b -> FormData a -> FormData a #
Monoid (FormData a) Source #
Instance details Defined in Trasa.Form Methods mempty :: FormData a # mappend :: FormData a -> FormData a -> FormData a # mconcat :: [FormData a] -> FormData a #

class FormError input err where #

A Class to lift a CommonFormError into an application-specific error type

Methods

commonFormError :: CommonFormError input -> err #

Instances

FormError Text Text
Instance details Defined in Ditto.Backend Methods commonFormError :: CommonFormError Text -> Text #
FormError QueryParam TrasaFormError Source #
Instance details Defined in Trasa.Form Methods commonFormError :: CommonFormError QueryParam -> TrasaFormError #

newtype TrasaFormT m a Source #

a newtype over TrasaT which allows it to have different environments for GET and POST requests

Constructors

TrasaFormT
Fields getTrasaFormT :: ReaderT FormType (TrasaT m) a

Instances

MonadTrans TrasaFormT Source #
Instance details Defined in Trasa.Form Methods lift :: Monad m => m a -> TrasaFormT m a #
Monad m => MonadReader FormType (TrasaFormT m) Source #
Instance details Defined in Trasa.Form Methods ask :: TrasaFormT m FormType # local :: (FormType -> FormType) -> TrasaFormT m a -> TrasaFormT m a # reader :: (FormType -> a) -> TrasaFormT m a #
Monad m => Monad (TrasaFormT m) Source #
Instance details Defined in Trasa.Form Methods (>>=) :: TrasaFormT m a -> (a -> TrasaFormT m b) -> TrasaFormT m b # (>>) :: TrasaFormT m a -> TrasaFormT m b -> TrasaFormT m b # return :: a -> TrasaFormT m a # fail :: String -> TrasaFormT m a #
Functor m => Functor (TrasaFormT m) Source #
Instance details Defined in Trasa.Form Methods fmap :: (a -> b) -> TrasaFormT m a -> TrasaFormT m b # (<$) :: a -> TrasaFormT m b -> TrasaFormT m a #
Monad m => Applicative (TrasaFormT m) Source #
Instance details Defined in Trasa.Form Methods pure :: a -> TrasaFormT m a # (<>) :: TrasaFormT m (a -> b) -> TrasaFormT m a -> TrasaFormT m b # liftA2 :: (a -> b -> c) -> TrasaFormT m a -> TrasaFormT m b -> TrasaFormT m c # (>) :: TrasaFormT m a -> TrasaFormT m b -> TrasaFormT m b # (<*) :: TrasaFormT m a -> TrasaFormT m b -> TrasaFormT m a #
(Alternative m, Monad m) => Alternative (TrasaFormT m) Source #
Instance details Defined in Trasa.Form Methods empty :: TrasaFormT m a # (<\|>) :: TrasaFormT m a -> TrasaFormT m a -> TrasaFormT m a # some :: TrasaFormT m a -> TrasaFormT m [a] # many :: TrasaFormT m a -> TrasaFormT m [a] #
Monad m => Environment (TrasaFormT m) QueryParam Source #
Instance details Defined in Trasa.Form Methods environment :: FormId -> TrasaFormT m (Value QueryParam) #

data FormType Source #

a GET request, or a POST request which may hav the untyped FormData

Constructors

Get
Post (Maybe (HashMap Text [Text]))

Instances

Monad m => MonadReader FormType (TrasaFormT m) Source #
Instance details Defined in Trasa.Form Methods ask :: TrasaFormT m FormType # local :: (FormType -> FormType) -> TrasaFormT m a -> TrasaFormT m a # reader :: (FormType -> a) -> TrasaFormT m a #

type TrasaForm a = Form (TrasaFormT IO) QueryParam TrasaFormError (Html ()) a Source #

a type alias for the most common type of form using trasa-form

data TrasaFormError Source #

trasa-form's form error type: may have a CommonFormError, will have an error message

Constructors

TrasaFormError
Fields trasaFormErrorType :: Maybe (CommonFormError QueryParam) trasaFormErrorText :: Text

Instances

Show TrasaFormError Source #
Instance details Defined in Trasa.Form Methods showsPrec :: Int -> TrasaFormError -> ShowS # show :: TrasaFormError -> String # showList :: [TrasaFormError] -> ShowS #
IsString TrasaFormError Source #
Instance details Defined in Trasa.Form Methods fromString :: String -> TrasaFormError #
ToHtml TrasaFormError Source #
Instance details Defined in Trasa.Form Methods toHtml :: Monad m => TrasaFormError -> HtmlT m () # toHtmlRaw :: Monad m => TrasaFormError -> HtmlT m () #
FormError QueryParam TrasaFormError Source #
Instance details Defined in Trasa.Form Methods commonFormError :: CommonFormError QueryParam -> TrasaFormError #

bodyFormData :: BodyCodec (FormData a) Source #

this is a BodyCodec, the intended use is to get the request body without using wai black magic to pass to POST forms

liftParser :: (Text -> Either Text a) -> QueryParam -> Either TrasaFormError a Source #

lift a function which parses Text into a function which parses a QueryParam

liftToForm :: Monad m => TrasaT m a -> TrasaFormT m a Source #

lift a TrasaT to a TrasaFormT

reform Source #

Arguments

:: (MonadIO m, Monoid view)
=> ([(Text, Text)] -> view -> view)	wrap raw form html inside a form tag
-> Text	form name prefix
-> Form (TrasaFormT m) QueryParam err view a	the formlet
-> TrasaT m (Result err a, view)

run a Form with the GET method

reformPost Source #

Arguments

:: (MonadIO m, Monoid view)
=> ([(Text, Text)] -> view -> view)	wrap raw form html inside a form tag
-> Text	form name prefix
-> Maybe (FormData a)
-> Form (TrasaFormT m) QueryParam err view a	the formlet
-> TrasaT m (Result err a, view)

run a Form with the POST method

trasaFormView :: Monad m => Text -> Form (TrasaFormT m) QueryParam err view a -> TrasaT m view Source #

viewForm helper function

textError :: Text -> TrasaFormError Source #

convert Text to a TrasaFormError

Orphan instances

Show QueryParam Source #
Instance details Methods showsPrec :: Int -> QueryParam -> ShowS # show :: QueryParam -> String # showList :: [QueryParam] -> ShowS #
FormInput QueryParam Source #
Instance details Associated Types type FileType QueryParam :: Type # Methods getInputString :: FormError QueryParam err => QueryParam -> Either err String # getInputStrings :: QueryParam -> [String] # getInputText :: FormError QueryParam err => QueryParam -> Either err Text # getInputTexts :: QueryParam -> [Text] # getInputFile :: FormError QueryParam err => QueryParam -> Either err (FileType QueryParam) #
MonadIO m => Environment (TrasaT m) QueryParam Source #
Instance details Methods environment :: FormId -> TrasaT m (Value QueryParam) #