HTTPurple.Headers

newtype RequestHeaders

The RequestHeaders type is a wrapper for a map that represents the set of headers in an HTTP request. A request header contains maximum one value per key.

Constructors

• RequestHeaders (Map CaseInsensitiveString String)

Instances

• Newtype RequestHeaders _
• Lookup RequestHeaders String String

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

• Show RequestHeaders

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

• Eq RequestHeaders

  Compare two RequestHeaders objects by comparing the underlying Objects.

• Semigroup RequestHeaders

  Allow one RequestHeaders objects to be appended to another.

newtype ResponseHeaders

The ResponseHeaders type is a wrapper for a map that represents the set of headers in an HTTP response. A response header can contain multiple values per key, e.g. in the case of multiple Set-Cookie directives.

Constructors

• ResponseHeaders (Map CaseInsensitiveString (Array String))

Instances

• Semigroup ResponseHeaders

  Allow one ResponseHeaders objects to be appended to another.

• Show ResponseHeaders

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

• Eq ResponseHeaders

  Compare two ResponseHeaders objects by comparing the underlying Objects.

class ToHeaders r  where

Members

• headers :: r -> ResponseHeaders

  Create ResponseHeaders from a record, an Array (Tuple String String) or an Array (Tuple String (Array String))

Instances

• ToHeaders (Array (Tuple String String))
• ToHeaders (Array (Tuple String (Array String)))
• (RowToList r rl, ToHeadersHelper r rl) => ToHeaders (Record r)

class ToHeadersHelper :: forall k. Row Type -> k -> Constraintclass ToHeadersHelper r rl  where

Members

• headersImpl :: Proxy rl -> Record r -> ResponseHeaders

Instances

• ToHeadersHelper r Nil
• (IsSymbol sym, RowToList r rl, RowToList tail tailRL, Cons sym String tail r, Lacks sym tail, ToHeadersHelper tail tailRL) => ToHeadersHelper r (Cons sym String tailRL)
• (IsSymbol sym, RowToList r rl, RowToList tail tailRL, Cons sym (Array String) tail r, Lacks sym tail, ToHeadersHelper tail tailRL) => ToHeadersHelper r (Cons sym (Array String) tailRL)

empty :: ResponseHeaders

Return a ResponseHeaders containing no headers.

header :: String -> String -> ResponseHeaders

Create a singleton header from a key-value pair.

mkRequestHeader :: String -> String -> RequestHeaders

Create a singleton header from a key-value pair. This is intended mainly for internal use.

mkRequestHeaders :: Array (Tuple String String) -> RequestHeaders

Convert an Array of Tuples of 2 Strings to a RequestHeaders object. This is intended mainly for internal use.

read :: Request -> RequestHeaders

Get the headers out of a HTTP RequestHeaders object.

toResponseHeaders :: RequestHeaders -> ResponseHeaders

Copy the request headers to the response headers This is intended mainly for internal use.

write :: Response -> ResponseHeaders -> Effect Unit

Given an HTTP Response and a ResponseHeaders object, return an effect that will write the ResponseHeaders to the Response.