HTTPure

newtype Headers

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

Instances

• Lookup Headers String String

  Given a string, return a Maybe containing the value of the matching header, if there is any.

• Show Headers

  Allow a Headers to be represented as a string. This string is formatted in HTTP headers format.

• Eq Headers

  Compare two Headers objects by comparing the underlying StrMaps.

• Semigroup Headers

  Allow one Headers objects to be appended to another.

headers :: Array (Tuple String String) -> Headers

Convert an Array of Tuples of 2 Strings to a Headers object.

header :: String -> String -> Headers

Create a singleton header from a key-value pair.

empty :: Headers

Return a Headers containing nothing.

lookup :: forall c k r. Lookup c k r => c -> k -> Maybe r

Given some type and a key on that type, extract some value that corresponds to that key.

has :: forall r k c. Lookup (c r) k r => c r -> k -> Boolean

This simple helper works on any Lookup instance, where the container set has a single type variable, and returns a Boolean indicating if the given key matches any value in the given container.

at :: forall r k c. Monoid r => Lookup c k r => c -> k -> r

This simple helper works on any Lookup instance where the return type is a Monoid, and is the same as lookup except that it returns a t instead of a Maybe t. If lookup would return Nothing, then at returns mempty.

Operator alias for HTTPure.Lookup.at (left-associative / precedence 8)

Expose at as the infix operator !@

Operator alias for HTTPure.Lookup.has (left-associative / precedence 8)

Expose has as the infix operator !?

Operator alias for HTTPure.Lookup.lookup (left-associative / precedence 8)

!! is inspired by !! in Data.Array, but note that it differs from !! in Data.Array in that you can use !! for any other instance of Lookup.

data Method

These are the HTTP methods that HTTPure understands.

Constructors

• Get
• Post
• Put
• Delete
• Head
• Connect
• Options
• Trace
• Patch

Instances

• Generic Method
• Eq Method
• Show Method

  Convert a constructor to a String.

type Path = Array String

The Path type is just sugar for an Array of String segments that are sent in a request and indicates the path of the resource being requested. Note that this type has an implementation of Lookup for Int keys defined by lookupArray in Lookup.purs because lookupArray is defined for any Array of Monoids. So you can do something like path !! 2 to get the path segment at index 2.

type Request = { body :: Body, headers :: Headers, method :: Method, path :: Path, query :: Query }

The Request type is a Record type that includes fields for accessing the different parts of the HTTP request.

fullPath :: Request -> String

Return the full resolved path, including query parameters. This may not match the requested path--for instance, if there are empty path segments in the request--but it is equivalent.

type ResponseM e = Aff (HTTPureEffects 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.

variantAlsoNegotiates' :: forall e. Headers -> ResponseM e

506 with headers

variantAlsoNegotiates :: forall e. ResponseM e

506

useProxy' :: forall e. Headers -> Body -> ResponseM e

305 with headers

useProxy :: forall e. Body -> ResponseM e

305

upgradeRequired' :: forall e. Headers -> ResponseM e

426 with headers

upgradeRequired :: forall e. ResponseM e

426

unsupportedMediaType' :: forall e. Headers -> ResponseM e

415 with headers

unsupportedMediaType :: forall e. ResponseM e

415

unprocessableEntity' :: forall e. Headers -> ResponseM e

422 with headers

unprocessableEntity :: forall e. ResponseM e

422

unavailableForLegalReasons' :: forall e. Headers -> ResponseM e

451 with headers

unavailableForLegalReasons :: forall e. ResponseM e

451

unauthorized' :: forall e. Headers -> ResponseM e

401 with headers

unauthorized :: forall e. ResponseM e

401

uRITooLong' :: forall e. Headers -> ResponseM e

414 with headers

uRITooLong :: forall e. ResponseM e

414

tooManyRequests' :: forall e. Headers -> ResponseM e

429 with headers

tooManyRequests :: forall e. ResponseM e

429

temporaryRedirect' :: forall e. Headers -> Body -> ResponseM e

307 with headers

temporaryRedirect :: forall e. Body -> ResponseM e

307

switchingProtocols' :: forall e. Headers -> ResponseM e

101 with headers

switchingProtocols :: forall e. ResponseM e

101

serviceUnavailable' :: forall e. Headers -> ResponseM e

503 with headers

serviceUnavailable :: forall e. ResponseM e

503

seeOther' :: forall e. Headers -> Body -> ResponseM e

303 with headers

seeOther :: forall e. Body -> ResponseM e

303

response' :: forall e. Status -> Headers -> Body -> ResponseM e

The same as response but with headers.

response :: forall e. Status -> Body -> ResponseM e

For custom response statuses or providing a body for response codes that don't typically send one.

resetContent' :: forall e. Headers -> ResponseM e

205 with headers

resetContent :: forall e. ResponseM e

205

requestTimeout' :: forall e. Headers -> ResponseM e

408 with headers

requestTimeout :: forall e. ResponseM e

408

requestHeaderFieldsTooLarge' :: forall e. Headers -> ResponseM e

431 with headers

requestHeaderFieldsTooLarge :: forall e. ResponseM e

431

rangeNotSatisfiable' :: forall e. Headers -> ResponseM e

416 with headers

rangeNotSatisfiable :: forall e. ResponseM e

416

proxyAuthenticationRequired' :: forall e. Headers -> ResponseM e

407 with headers

proxyAuthenticationRequired :: forall e. ResponseM e

407

processing' :: forall e. Headers -> ResponseM e

102 with headers

processing :: forall e. ResponseM e

102

preconditionRequired' :: forall e. Headers -> ResponseM e

428 with headers

preconditionRequired :: forall e. ResponseM e

428

preconditionFailed' :: forall e. Headers -> ResponseM e

412 with headers

preconditionFailed :: forall e. ResponseM e

412

permanentRedirect' :: forall e. Headers -> Body -> ResponseM e

308 with headers

permanentRedirect :: forall e. Body -> ResponseM e

308

paymentRequired' :: forall e. Headers -> ResponseM e

402 with headers

paymentRequired :: forall e. ResponseM e

402

payloadTooLarge' :: forall e. Headers -> ResponseM e

413 with headers

payloadTooLarge :: forall e. ResponseM e

413

partialContent' :: forall e. Headers -> Body -> ResponseM e

206 with headers

partialContent :: forall e. Body -> ResponseM e

206

ok' :: forall e. Headers -> Body -> ResponseM e

200 with headers

ok :: forall e. Body -> ResponseM e

200

notModified' :: forall e. Headers -> ResponseM e

304 with headers

notModified :: forall e. ResponseM e

304

notImplemented' :: forall e. Headers -> ResponseM e

501 with headers

notImplemented :: forall e. ResponseM e

501

notFound' :: forall e. Headers -> ResponseM e

404 with headers

notFound :: forall e. ResponseM e

404

notExtended' :: forall e. Headers -> ResponseM e

510 with headers

notExtended :: forall e. ResponseM e

510

notAcceptable' :: forall e. Headers -> ResponseM e

406 with headers

notAcceptable :: forall e. ResponseM e

406

nonAuthoritativeInformation' :: forall e. Headers -> Body -> ResponseM e

203 with headers

nonAuthoritativeInformation :: forall e. Body -> ResponseM e

203

noContent' :: forall e. Headers -> ResponseM e

204 with headers

noContent :: forall e. ResponseM e

204

networkAuthenticationRequired' :: forall e. Headers -> ResponseM e

511 with headers

networkAuthenticationRequired :: forall e. ResponseM e

511

multipleChoices' :: forall e. Headers -> Body -> ResponseM e

300 with headers

multipleChoices :: forall e. Body -> ResponseM e

300

multiStatus' :: forall e. Headers -> Body -> ResponseM e

207 with headers

multiStatus :: forall e. Body -> ResponseM e

207

movedPermanently' :: forall e. Headers -> Body -> ResponseM e

301 with headers

movedPermanently :: forall e. Body -> ResponseM e

301

misdirectedRequest' :: forall e. Headers -> ResponseM e

421 with headers

misdirectedRequest :: forall e. ResponseM e

421

methodNotAllowed' :: forall e. Headers -> ResponseM e

405 with headers

methodNotAllowed :: forall e. ResponseM e

405

loopDetected' :: forall e. Headers -> ResponseM e

508 with headers

loopDetected :: forall e. ResponseM e

508

locked' :: forall e. Headers -> ResponseM e

423 with headers

locked :: forall e. ResponseM e

423

lengthRequired' :: forall e. Headers -> ResponseM e

411 with headers

lengthRequired :: forall e. ResponseM e

411

internalServerError' :: forall e. Headers -> Body -> ResponseM e

500 with headers

internalServerError :: forall e. Body -> ResponseM e

500

insufficientStorage' :: forall e. Headers -> ResponseM e

507 with headers

insufficientStorage :: forall e. ResponseM e

507

imATeapot' :: forall e. Headers -> ResponseM e

418 with headers

imATeapot :: forall e. ResponseM e

418

iMUsed' :: forall e. Headers -> Body -> ResponseM e

226 with headers

iMUsed :: forall e. Body -> ResponseM e

226

hTTPVersionNotSupported' :: forall e. Headers -> ResponseM e

505 with headers

hTTPVersionNotSupported :: forall e. ResponseM e

505

gone' :: forall e. Headers -> ResponseM e

410 with headers

gone :: forall e. ResponseM e

410

gatewayTimeout' :: forall e. Headers -> ResponseM e

504 with headers

gatewayTimeout :: forall e. ResponseM e

504

found' :: forall e. Headers -> Body -> ResponseM e

302 with headers

found :: forall e. Body -> ResponseM e

302

forbidden' :: forall e. Headers -> ResponseM e

403 with headers

forbidden :: forall e. ResponseM e

403

failedDependency' :: forall e. Headers -> ResponseM e

424 with headers

failedDependency :: forall e. ResponseM e

424

expectationFailed' :: forall e. Headers -> ResponseM e

417 with headers

expectationFailed :: forall e. ResponseM e

417

emptyResponse' :: forall e. Status -> Headers -> ResponseM e

The same as emptyResponse but with headers.

emptyResponse :: forall e. Status -> ResponseM e

The same as response but without a body.

created' :: forall e. Headers -> ResponseM e

201 with headers

created :: forall e. ResponseM e

201

continue' :: forall e. Headers -> ResponseM e

100 with headers

continue :: forall e. ResponseM e

100

conflict' :: forall e. Headers -> Body -> ResponseM e

409 with headers

conflict :: forall e. Body -> ResponseM e

409

badRequest' :: forall e. Headers -> Body -> ResponseM e

400 with headers

badRequest :: forall e. Body -> ResponseM e

400

badGateway' :: forall e. Headers -> ResponseM e

502 with headers

badGateway :: forall e. ResponseM e

502

alreadyReported' :: forall e. Headers -> ResponseM e

208 with headers

alreadyReported :: forall e. ResponseM e

208

accepted' :: forall e. Headers -> ResponseM e

202 with headers

accepted :: forall e. ResponseM e

202

type ServerM e = Eff (HTTPureEffects 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 a ServerM containing effects to run after the server has booted (usually logging). Returns an ServerM containing the server's effects.