LuminescentDreams.Data.URI

A URI parsing library

Documentation

renderQuery

Arguments

:: Bool

prepend question mark?

-> Query

-> ByteString

Convert Query to ByteString.

newtype Protocol

Protocol is a basic protocol string, such as "http" or "ftp"

Constructors

Protocol

Fields

• _protocol :: Text

Instances

Eq Protocol

Methods

(==) :: Protocol -> Protocol -> Bool

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

Show Protocol

Methods

showsPrec :: Int -> Protocol -> ShowS

show :: Protocol -> String

showList :: [Protocol] -> ShowS

IsString Protocol

Methods

fromString :: String -> Protocol

newtype FQDN

FQDN is the complete hostname of the server

Constructors

FQDN

Fields

• _fqdn :: Text

Instances

Eq FQDN

Methods

(==) :: FQDN -> FQDN -> Bool

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

Show FQDN

Methods

showsPrec :: Int -> FQDN -> ShowS

show :: FQDN -> String

showList :: [FQDN] -> ShowS

IsString FQDN

Methods

fromString :: String -> FQDN

newtype Port

Optional, but Port allows one to specify a non-default port for a URI

Constructors

Port

Fields

• _port :: Int

Instances

Eq Port

Methods

(==) :: Port -> Port -> Bool

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

Num Port

Methods

(+) :: Port -> Port -> Port

(-) :: Port -> Port -> Port

(*) :: Port -> Port -> Port

negate :: Port -> Port

abs :: Port -> Port

signum :: Port -> Port

fromInteger :: Integer -> Port

Show Port

Methods

showsPrec :: Int -> Port -> ShowS

show :: Port -> String

showList :: [Port] -> ShowS

newtype PathParts

The path section of the URI, divided into one element per subdirectory

Constructors

PathParts

Fields

• _pathParts :: [Text]

Instances

Eq PathParts

Methods

(==) :: PathParts -> PathParts -> Bool

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

Show PathParts

Methods

showsPrec :: Int -> PathParts -> ShowS

show :: PathParts -> String

showList :: [PathParts] -> ShowS

Monoid PathParts

Methods

mempty :: PathParts

mappend :: PathParts -> PathParts -> PathParts

mconcat :: [PathParts] -> PathParts

data URI

A straightforward URI data type

TODO: need to support usernames and passwords as part of the URI, such as postgres:/username:password@localhost:5432my_database

Instances

Eq URI

Methods

(==) :: URI -> URI -> Bool

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

Show URI

Methods

showsPrec :: Int -> URI -> ShowS

show :: URI -> String

showList :: [URI] -> ShowS

Default URI

Methods

def :: URI

uriPath :: Lens' URI Text

uriPath treats the path portion of the URI as a single string. This is more common and natural most of the time.

parseURI :: Text -> Either String URI

Parse a URI from Text, returning either an error or a complete URI

TODO: Rebuild these functions for easy ByteString, Text, String parsing and rendering

parseURI' :: String -> Either String URI

Parse a URI from a String, returning either an error or a complete URI

renderURI :: URI -> ByteString

Render a URI to a ByteString - I chose bytestrings because they are so frequently required in HTTP libraries.