Erl.Cowboy.Handlers.Rest

data InitResult t0

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

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

type TerminateHandler s = EffectFn3 TerminateReason Req s TerminateResult

data RestResult t0 t1

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

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

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

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

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

type AllowedMethodsHandler s = RestHandler (List String) s

Handler for allowed_methods callback

type AllowedMissingPostHandler s = RestHandler Boolean s

Handler for allow_missing_post callback

type CharsetsProvidedHandler s = RestHandler (List String) s

Handler for charsets_provided callback

data ContentType

Constructors

• ContentType String String ContentTypeParams
• SimpleContentType String

data ContentTypeParams

Constructors

• AnyParams
• ContentTypeParams (List (Tuple2 String String))

data ContentTypesAcceptedResult

newtype AcceptCallback

Constructors

• AcceptCallback Atom

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

type ContentTypesAcceptedHandler s = RestHandler ContentTypesAcceptedResult s

Handler for content_types_accepted callback

data ContentTypesProvidedResult

newtype ProvideCallback

Constructors

• ProvideCallback Atom

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

type ContentTypesProvidedHandler s = RestHandler ContentTypesProvidedResult s

Handler for content_types_provided callback

type DeleteCompletedHandler s = RestHandler Boolean s

Handler for delete_completed callback

type DeleteResourceHandler s = RestHandler Boolean s

Handler for delete_resource callback

type ForbiddenHandler s = RestHandler Boolean s

Handler for expires callback Handler for forbidden callback

data ETag

Strong or weak etag

Constructors

• Strong String
• Weak String

type GenerateEtagHandler s = RestHandler ETag s

Handler for generate_etag callback

data IsAuthorizedResponse

authorized :: IsAuthorizedResponse

unauthorized :: String -> IsAuthorizedResponse

type IsAuthorizedHandler s = RestHandler IsAuthorizedResponse s

Handler for is_authorized callback

type IsConflictHandler s = RestHandler Boolean s

Handler for _ callback

type KnownMethodsHandler s = RestHandler (List String) s

Handler for _ callback

type LanguagesProvidedHandler s = RestHandler (List String) s

Handler for _ callback

type MalformedRequestHandler s = RestHandler Boolean s

Handler for _ callback Handler for _ callback

data MovedResult

notMoved :: MovedResult

moved :: String -> MovedResult

type MovedPermanentlyHandler s = RestHandler MovedResult s

Handler for moved_permanently callback

type MovedTemporarilyHandler s = RestHandler MovedResult s

Handler for moved_temporarily callback

type MultipleChoicesHandler s = RestHandler Boolean s

Handler for multiple_choices callback

data OptionsResponse

optionsResponse :: OptionsResponse

type OptionsHandler s = RestHandler OptionsResponse s

Handler for options callback

type PreviouslyExistedHandler s = RestHandler Boolean s

Handler for previously_existed callback

type ResourceExistsHandler s = RestHandler Boolean s

Handler for resource_exists callback

type ServiceAvailableHandler s = RestHandler Boolean s

Handler for service_available callback

type UriTooLongHandler s = RestHandler Boolean s

Handler for uri_too_long callback

type ValidContentHeadersHandler s = RestHandler Boolean s

Handler for valid_content_headers callback

type ValidEntityLengthHandler s = RestHandler Boolean s

Handler for valid_entity_length callback

type VariancesHandler s = RestHandler (List String) s

Handler for variances callback

type CowboyRestBehaviour = Behaviour "cowboy_rest"

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

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