Moduleyesod-form-1.7.11Haskell2010

Yesod.Form.Input

Provides for getting input from either GET or POST params without generating HTML forms. For more information, see: http://www.yesodweb.com/book/forms#forms_kinds_of_forms.

1 type
6 values

Packageyesod-form-1.7.11
Exports7
LanguageHaskell2010
LicenceMIT
SourceInput.hs

newtypenewtype FormInput (m :: Type -> Type) a

Type for a form which parses a value of type a with the base monad m (usually your Handler). Can compose this using its Applicative instance.

Constructors

FormInput
- unFormInput :: HandlerSite m -> [Text] -> Env -> FileEnv -> m (Either DText a)

Instances2Functor, Applicative

Monad m => Functor (FormInput m)Defined in yesod-form-1.7.11 · Yesod.Form.Input
Monad m => Applicative (FormInput m)Defined in yesod-form-1.7.11 · Yesod.Form.Input

valuerunInputGet :: MonadHandler m => FormInput m a -> m a

Run a FormInput on the GET parameters (i.e., query string). If parsing fails, calls invalidArgs.

valuerunInputGetResult :: MonadHandler m => FormInput m a -> m (FormResult a)

Run a FormInput on the GET parameters (i.e., query string). Does not throw exceptions on failure.

Since 1.4.1

valuerunInputPost :: MonadHandler m => FormInput m a -> m a

Run a FormInput on the POST parameters (i.e., request body). If parsing fails, calls invalidArgs.

valuerunInputPostResult :: MonadHandler m => FormInput m a -> m (FormResult a)

Run a FormInput on the POST parameters (i.e., request body). Does not throw exceptions on failure.

valueireq

:: (Monad m, RenderMessage (HandlerSite m) FormMessage)
=> Field m a
-> Text
name of the field
-> FormInput m a

Promote a Field into a FormInput, requiring that the value be present and valid.

valueiopt :: Monad m => Field m a -> Text -> FormInput m (Maybe a)

Promote a Field into a FormInput, with its presence being optional. If the value is present but does not parse correctly, the form will still fail.