Network.HTTP.Forwarded

Parsing and Serialization of Forwarded HTTP header values.

Documentation

data Forwarded

Representation of Forwarded header data All field are optional

Constructors

Forwarded

Fields

• forwardedBy :: Maybe ByteString
• forwardedFor :: Maybe ByteString
• forwardedHost :: Maybe ByteString
• forwardedProto :: Maybe (CI ByteString)

Instances

Eq Forwarded

Defined in Network.HTTP.Forwarded

Methods

(==) :: Forwarded -> Forwarded -> Bool

(/=) :: Forwarded -> Forwarded -> Bool

Show Forwarded

Defined in Network.HTTP.Forwarded

Methods

showsPrec :: Int -> Forwarded -> ShowS

show :: Forwarded -> String

showList :: [Forwarded] -> ShowS

parseForwarded :: ByteString -> Forwarded

Parse ByteString to Forwarded header Note that this function works with the values of the header only. Extraction of value from header depends what representation of headers you're using.

In case of Wai you can extract headers as following:

:set -XOverloadedStrings
import Network.Wai
import Network.HTTP.Forwarded
getForwarded req = parseForwarded <$> "forwarded" `lookup` requestHeaders req
:t getForwarded
getForwarded :: Request -> Maybe Forwarded

serializeForwarded :: Forwarded -> ByteString

Serialize Forwarded data type back to ByteString representation.