Network.MiniHTTP.URL

Description

This module contains a structure for representing web URLs. We don't try to be a fully general URI parser (so no mailto: etc), but it's a lot better than Network.URI for dealing with HTTP(S)

Synopsis

Documentation

data URL Source

A web URL

Constructors

URL
Fields urlScheme :: Scheme urlUser :: Maybe ByteString urlPassword :: Maybe ByteString urlHost :: Host urlPort :: Int defaults based on the scheme urlPath :: ByteString does not include leading `/` urlArguments :: Map ByteString ByteString urlFragment :: Maybe ByteString doesn't include '#'

Instances

Eq URL
Show URL

data RelativeURL Source

This is a relative URL. It just copies (and renames) the last three members of URL. However, it's good to keep these two different types of URL apart in the type system.

Constructors

RelativeURL
Fields rurlPath :: ByteString does not include leading `/` rurlArguments :: Map ByteString ByteString rurlFragment :: Maybe ByteString

Instances

Eq RelativeURL
Show RelativeURL

data Scheme Source

The transport layer to be used

Constructors

HTTP
HTTPS

Instances

Eq Scheme
Show Scheme

data Host Source

The host where the resource can be found

Constructors

IPv4Literal HostAddress
IPv6Literal HostAddress6
Hostname ByteString

Instances

Eq Host
Show Host

toRelative :: URL -> RelativeURL Source

Extract a relative URL from a URL

parse :: ByteString -> Maybe URL Source

Parse a URL

parseRelative :: ByteString -> Maybe RelativeURL Source

Parse a relative URL

parseArguments :: ByteString -> Maybe (Map ByteString ByteString)Source

Parse just an arguments map. Can be useful for POST requests. Warning: it occurs to be that the arguments in a POST request might include unescaped '#' symbols. In a URL that would be illegal, but the parser may need to be reworked for that.

serialise :: URL -> ByteString Source

Convert a URL to a ByteString. It's the same as show, except for the type of the return.

serialiseRelative :: RelativeURL -> ByteString Source

serialiseArguments :: Map ByteString ByteString -> ByteString Source

Serialise just an arguments map. Can be useful for POST requests.