Network.HTTP.Link.Types

The data type definitions for the HTTP Link header.

Documentation

data LinkParam

The link attribute key.

Constructors

Rel

Anchor

Rev

Hreflang

Media

Title

Title'

ContentType

Other Text

Instances

Eq LinkParam

Defined in Network.HTTP.Link.Types

Methods

(==) :: LinkParam -> LinkParam -> Bool

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

Show LinkParam

Defined in Network.HTTP.Link.Types

Methods

showsPrec :: Int -> LinkParam -> ShowS

show :: LinkParam -> String

showList :: [LinkParam] -> ShowS

data Link uri

A single link containing some representation of a URL.

Constructors

Link uri [(LinkParam, Text)]

Instances

Eq uri => Eq (Link uri)

Defined in Network.HTTP.Link.Types

Methods

(==) :: Link uri -> Link uri -> Bool

(/=) :: Link uri -> Link uri -> Bool

Show uri => Show (Link uri)

Defined in Network.HTTP.Link.Types

Methods

showsPrec :: Int -> Link uri -> ShowS

show :: Link uri -> String

showList :: [Link uri] -> ShowS

IsURI uri => ToHttpApiData [Link uri]

Defined in Network.HTTP.Link

Methods

toUrlPiece :: [Link uri] -> Text

toEncodedUrlPiece :: [Link uri] -> Builder

toHeader :: [Link uri] -> ByteString

toQueryParam :: [Link uri] -> Text

IsURI uri => ToHttpApiData (Link uri)

Defined in Network.HTTP.Link

Methods

toUrlPiece :: Link uri -> Text

toEncodedUrlPiece :: Link uri -> Builder

toHeader :: Link uri -> ByteString

toQueryParam :: Link uri -> Text

class IsURI uri where

Types that can represent URLs.

For example, to parse links containing Text.URI.URI from the modern-uri package, simply define the orphan instance:

   instance IsURI Modern.URI where
       uriFromText = left displayException . mkURI
       uriToText = render

Since: 1.1.0

Methods

uriFromText :: Text -> Either String uri

uriToText :: uri -> Text

Instances

IsURI Text

Defined in Network.HTTP.Link.Types

Methods

uriFromText :: Text -> Either String Text

uriToText :: Text -> Text

IsURI URI

Defined in Network.HTTP.Link.Types

Methods

uriFromText :: Text -> Either String URI

uriToText :: URI -> Text

href :: IsURI uri => Link uri -> uri

Extracts the URI from the link.

linkParams :: Link uri -> [(LinkParam, Text)]

Extracts the parameters from the link.