Safe Haskell	Safe
Language	Haskell2010

Network.HTTP.Link.Types

Description

The data type definitions for the HTTP Link header.

Synopsis

Documentation

The link attribute key.

Constructors

Instances

Eq LinkParam Source #
Instance details Defined in Network.HTTP.Link.Types Methods (==) :: LinkParam -> LinkParam -> Bool # (/=) :: LinkParam -> LinkParam -> Bool #
Show LinkParam Source #
Instance details Defined in Network.HTTP.Link.Types Methods showsPrec :: Int -> LinkParam -> ShowS # show :: LinkParam -> String # showList :: [LinkParam] -> ShowS #

A single link containing some representation of a URL.

Since: 1.1.0

Constructors

Instances

ToHttpApiData Link Source #
Instance details Defined in Network.HTTP.Link Methods toUrlPiece :: Link -> Text # toEncodedUrlPiece :: Link -> Builder # toHeader :: Link -> ByteString # toQueryParam :: Link -> Text #
Eq uri => Eq (GLink uri) Source #
Instance details Defined in Network.HTTP.Link.Types Methods (==) :: GLink uri -> GLink uri -> Bool # (/=) :: GLink uri -> GLink uri -> Bool #
Show uri => Show (GLink uri) Source #
Instance details Defined in Network.HTTP.Link.Types Methods showsPrec :: Int -> GLink uri -> ShowS # show :: GLink uri -> String # showList :: [GLink uri] -> ShowS #
ToHttpApiData [Link] Source #
Instance details Defined in Network.HTTP.Link Methods toUrlPiece :: [Link] -> Text # toEncodedUrlPiece :: [Link] -> Builder # toHeader :: [Link] -> ByteString # toQueryParam :: [Link] -> Text #

class IsURI uri where Source #

Types that can represent URLs.

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

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

Since: 1.1.0

Methods

Instances

IsURI Text Source #
Instance details Defined in Network.HTTP.Link.Types Methods uriFromText :: Text -> Either String Text Source #
IsURI URI Source #
Instance details Defined in Network.HTTP.Link.Types Methods uriFromText :: Text -> Either String URI Source #

A single link containing a network-uri URI. Most of this library is specialized to this case.

Extracts the URI from the link.

Extracts the parameters from the link.