Module

Erl.Cowboy.Handlers.Rest

Package: erl-cowboy
Repository: purerl/purescript-erl-cowboy

#InitResult Source

data InitResult :: Type -> Type

#initResult Source

initResult :: forall a. a -> Req -> InitResult a

#InitHandler Source

type InitHandler c s = EffectFn2 Req c (InitResult s)

#TerminateHandler Source

type TerminateHandler s = EffectFn3 TerminateReason Req s TerminateResult

#RestResult Source

data RestResult :: Type -> Type -> Type

RestResult r s is the result of a rest callback with result r and state s

#restResult Source

restResult :: forall r s. r -> s -> Req -> RestResult r s

#stop Source

stop :: forall r s. s -> Req -> RestResult r s

#switchHandler Source

switchHandler :: forall r s. NativeModuleName -> s -> Req -> RestResult r s

#RestHandler Source

type RestHandler r s = EffectFn2 Req s (RestResult r s)

#AllowedMethodsHandler Source

type AllowedMethodsHandler s = RestHandler (List String) s

Handler for allowed_methods callback

#AllowedMissingPostHandler Source

type AllowedMissingPostHandler s = RestHandler Boolean s

Handler for allow_missing_post callback

#CharsetsProvidedHandler Source

type CharsetsProvidedHandler s = RestHandler (List String) s

Handler for charsets_provided callback

#ContentType Source

data ContentType

Constructors

#ContentTypeParams Source

data ContentTypeParams

Constructors

AnyParams
ContentTypeParams (List (Tuple2 String String))

#ContentTypesAcceptedResult Source

data ContentTypesAcceptedResult :: Type

#AcceptCallback Source

newtype AcceptCallback

Constructors

AcceptCallback Atom

#contentTypesAcceptedResult Source

contentTypesAcceptedResult :: List (Tuple2 ContentType AcceptCallback) -> ContentTypesAcceptedResult

#ContentTypesAcceptedHandler Source

type ContentTypesAcceptedHandler s = RestHandler ContentTypesAcceptedResult s

Handler for content_types_accepted callback

#ContentTypesProvidedResult Source

data ContentTypesProvidedResult :: Type

#ProvideCallback Source

newtype ProvideCallback

Constructors

ProvideCallback Atom

#contentTypesProvidedResult Source

contentTypesProvidedResult :: List (Tuple2 ContentType ProvideCallback) -> ContentTypesProvidedResult

#ContentTypesProvidedHandler Source

type ContentTypesProvidedHandler s = RestHandler ContentTypesProvidedResult s

Handler for content_types_provided callback

#DeleteCompletedHandler Source

type DeleteCompletedHandler s = RestHandler Boolean s

Handler for delete_completed callback

#DeleteResourceHandler Source

type DeleteResourceHandler s = RestHandler Boolean s

Handler for delete_resource callback

#ForbiddenHandler Source

type ForbiddenHandler s = RestHandler Boolean s

Handler for expires callback Handler for forbidden callback

#ETag Source

data ETag

Strong or weak etag

Constructors

Strong String
Weak String

#GenerateEtagHandler Source

type GenerateEtagHandler s = RestHandler ETag s

Handler for generate_etag callback

#IsAuthorizedResponse Source

data IsAuthorizedResponse :: Type

#authorized Source

authorized :: IsAuthorizedResponse

#unauthorized Source

unauthorized :: String -> IsAuthorizedResponse

#IsAuthorizedHandler Source

type IsAuthorizedHandler s = RestHandler IsAuthorizedResponse s

Handler for is_authorized callback

#IsConflictHandler Source

type IsConflictHandler s = RestHandler Boolean s

Handler for _ callback

#KnownMethodsHandler Source

type KnownMethodsHandler s = RestHandler (List String) s

Handler for _ callback

#LanguagesProvidedHandler Source

type LanguagesProvidedHandler s = RestHandler (List String) s

Handler for _ callback

#MalformedRequestHandler Source

type MalformedRequestHandler s = RestHandler Boolean s

Handler for _ callback Handler for _ callback

#MovedResult Source

data MovedResult :: Type

#notMoved Source

notMoved :: MovedResult

#moved Source

moved :: String -> MovedResult

#MovedPermanentlyHandler Source

type MovedPermanentlyHandler s = RestHandler MovedResult s

Handler for moved_permanently callback

#MovedTemporarilyHandler Source

type MovedTemporarilyHandler s = RestHandler MovedResult s

Handler for moved_temporarily callback

#MultipleChoicesHandler Source

type MultipleChoicesHandler s = RestHandler Boolean s

Handler for multiple_choices callback

#OptionsResponse Source

data OptionsResponse :: Type

#optionsResponse Source

optionsResponse :: OptionsResponse

#OptionsHandler Source

type OptionsHandler s = RestHandler OptionsResponse s

Handler for options callback

#PreviouslyExistedHandler Source

type PreviouslyExistedHandler s = RestHandler Boolean s

Handler for previously_existed callback

#ResourceExistsHandler Source

type ResourceExistsHandler s = RestHandler Boolean s

Handler for resource_exists callback

#ServiceAvailableHandler Source

type ServiceAvailableHandler s = RestHandler Boolean s

Handler for service_available callback

#UriTooLongHandler Source

type UriTooLongHandler s = RestHandler Boolean s

Handler for uri_too_long callback

#ValidContentHeadersHandler Source

type ValidContentHeadersHandler s = RestHandler Boolean s

Handler for valid_content_headers callback

#ValidEntityLengthHandler Source

type ValidEntityLengthHandler s = RestHandler Boolean s

Handler for valid_entity_length callback

#VariancesHandler Source

type VariancesHandler s = RestHandler (List String) s

Handler for variances callback

#CowboyRestBehaviour Source

type CowboyRestBehaviour = Behaviour "cowboy_rest"

#cowboyRestBehaviour Source

cowboyRestBehaviour :: forall a s. { init :: InitHandler a s } -> CowboyRestBehaviour

A cowboy_rest behaviour. Note that while may callbacks are defined only init is mandatory

Modules: Attribute; Cowboy.Static; Erl.Cowboy; Erl.Cowboy.Handler; Erl.Cowboy.Handlers.Common; Erl.Cowboy.Handlers.Loop; Erl.Cowboy.Handlers.Rest; Erl.Cowboy.Handlers.Simple; Erl.Cowboy.Handlers.WebSocket; Erl.Cowboy.Req; Erl.Cowboy.Req.Monad; Erl.Cowboy.Routes