HTTPure

type Headers = StrMap String

The Headers type is just sugar for a StrMap of Strings that represents the set of headers sent or received in an HTTP request or response.

lookup :: Headers -> String -> String

Return the value of the given header.

data Request

A Request is a method along with headers, a path, and sometimes a body.

Constructors

• Get Headers Path
• Post Headers Path Body
• Put Headers Path Body
• Delete Headers Path
• Head Headers Path
• Connect Headers Path Body
• Options Headers Path
• Trace Headers Path
• Patch Headers Path Body

Instances

• Show Request

  When using show on a Request, print the method and the path.

type ResponseM e = HTTPureM e Response

The ResponseM type simply conveniently wraps up an HTTPure monad that returns a response. This type is the return type of all router/route methods.

data Response

A response is a status and headers, and for some statuses, a body. You can use the data constructor Response to send non-standard status codes.

Constructors

• Response Int Headers Body
• Continue Headers
• SwitchingProtocols Headers
• Processing Headers
• OK Headers Body
• Created Headers
• Accepted Headers
• NonAuthoritativeInformation Headers Body
• NoContent Headers
• ResetContent Headers
• PartialContent Headers Body
• MultiStatus Headers Body
• AlreadyReported Headers
• IMUsed Headers Body
• MultipleChoices Headers Body
• MovedPermanently Headers Body
• Found Headers Body
• SeeOther Headers Body
• NotModified Headers
• UseProxy Headers Body
• TemporaryRedirect Headers Body
• PermanentRedirect Headers Body
• BadRequest Headers Body
• Unauthorized Headers
• PaymentRequired Headers
• Forbidden Headers
• NotFound Headers
• MethodNotAllowed Headers
• NotAcceptable Headers
• ProxyAuthenticationRequired Headers
• RequestTimeout Headers
• Conflict Headers Body
• Gone Headers
• LengthRequired Headers
• PreconditionFailed Headers
• PayloadTooLarge Headers
• URITooLong Headers
• UnsupportedMediaType Headers
• RangeNotSatisfiable Headers
• ExpectationFailed Headers
• ImATeapot Headers
• MisdirectedRequest Headers
• UnprocessableEntity Headers
• Locked Headers
• FailedDependency Headers
• UpgradeRequired Headers
• PreconditionRequired Headers
• TooManyRequests Headers
• RequestHeaderFieldsTooLarge Headers
• UnavailableForLegalReasons Headers
• InternalServerError Headers Body
• NotImplemented Headers
• BadGateway Headers
• ServiceUnavailable Headers
• GatewayTimeout Headers
• HTTPVersionNotSupported Headers
• VariantAlsoNegotiates Headers
• InsufficientStorage Headers
• LoopDetected Headers
• NotExtended Headers
• NetworkAuthenticationRequired Headers

type ServerM e = HTTPureM e Unit

The ServerM type simply conveniently wraps up an HTTPure monad that returns a Unit. This type is the return type of the HTTPure serve and related methods.

type SecureServerM e = ServerM (fs :: FS | e)

The SecureServerM type is the same as the ServerM type, but it includes effects for working with the filesystem (to load the key and certificate).

serve' :: forall e. Int -> String -> String -> (Request -> ResponseM (fs :: FS | e)) -> SecureServerM e -> SecureServerM e

Create and start an SSL server. This method is the same as serve, but takes additional SSL arguments. The arguments in order are:

1. A port number
2. A path to a cert file
3. A path to a private key file
4. A handler method which maps Request to ResponseM
5. A callback to call when the server is up

serve :: forall e. Int -> (Request -> ResponseM e) -> ServerM e -> ServerM e

Create and start a server. This is the main entry point for HTTPure. Takes a port number on which to listen, a function mapping Request to ResponseM, and an HTTPureM containing effects to run after the server has booted (usually logging). Returns an HTTPureM containing the server's effects.